Skip to content

Commit 488c098

Browse files
author
Pavel Roslovets
committed
v0.3.3
1 parent a7f4a45 commit 488c098

6 files changed

Lines changed: 19 additions & 38 deletions

File tree

‎+WEB/+API/Update.m‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ function Update(force)
33
if nargin < 1
44
force = 0;
55
end
6-
UT = MATLABWEBAPIUpdater;
6+
TU = MATLABWEBAPIUpdater;
77
if ~force
8-
UT.update();
8+
TU.update();
99
else
10-
UT.installweb();
10+
TU.installweb();
1111
end

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
data/*auth_data*
22
work
33
**/*.asv
4-
**/helpsearch-v3
4+
**/helpsearch-v3
5+
*.mltbx

‎MATLAB-WEB-API.prj‎

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<param.summary>Work with WEB services directly from MATLAB</param.summary>
88
<param.description>Work with existed WEB-services API or create your own</param.description>
99
<param.screenshot>${PROJECT_ROOT}\doc\MATLAB-WEB-API.png</param.screenshot>
10-
<param.version>0.3.2</param.version>
10+
<param.version>0.3.3</param.version>
1111
<param.output>${PROJECT_ROOT}\MATLAB WEB API.mltbx</param.output>
1212
<param.products.name />
1313
<param.products.id />
@@ -28,22 +28,9 @@ cover.png
2828
data/*_data*
2929
MATLABWEBAPIDev.m
3030
dev_on.m
31-
%
32-
% A single file in a subfolder of the toolbox folder:
33-
% example/.svn
34-
%
35-
% All files in a subfolder of the toolbox folder:
36-
% example/*
37-
%
38-
% All files of a certain name in all subfolders of the toolbox folder:
39-
% **/.svn
40-
%
41-
% All files matching a pattern in all subfolders of the toolbox folder:
42-
% **/*.bak
43-
%
44-
MATLABWEBAPIDev
4531
install.m
46-
installweb.m</param.exclude.filters>
32+
installweb.m
33+
**/helpsearch-v3</param.exclude.filters>
4734
<param.exclude.pcodedmfiles>true</param.exclude.pcodedmfiles>
4835
<param.examples />
4936
<param.demosxml />
@@ -116,6 +103,8 @@ installweb.m</param.exclude.filters>
116103
<file>${PROJECT_ROOT}\doc</file>
117104
<file>${PROJECT_ROOT}\examples</file>
118105
<file>${PROJECT_ROOT}\info.xml</file>
106+
<file>${PROJECT_ROOT}\install.m</file>
107+
<file>${PROJECT_ROOT}\installweb.m</file>
119108
<file>${PROJECT_ROOT}\MATLAB-WEB-API.mltbx</file>
120109
<file>${PROJECT_ROOT}\MATLAB-WEB-API.prj</file>
121110
<file>${PROJECT_ROOT}\MATLABWEBAPIDev.m</file>

‎README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,11 @@ Framework for building handy WEB APIs to work with any WEB services from MATLAB
3737
In MATLAB execute:
3838

3939
```matlab
40-
r = webread('https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest');
41-
websave(r.assets.name, r.assets.browser_download_url);
42-
open(r.assets.name)
40+
eval(webread('https://exponenta.ru/install/web'))
4341
```
4442
#### 2nd approach (install from scratch)
4543

46-
* Download [MATLAB-WEB-API.mltbx](https://github.com/ETMC-Exponenta/MATLAB-WEB-API/raw/master/MATLAB-WEB-API.mltbx)
44+
* Download [MATLAB-WEB-API.mltbx](https://roslovets.github.io/ghbin#ETMC-Exponenta/MATLAB-WEB-API#MATLAB-WEB-API.mltbx)
4745
* Open it
4846

4947
#### 3rd approach (update installed)
@@ -116,13 +114,11 @@ WEB.API.Doc
116114
В MATLAB выполните:
117115

118116
```matlab
119-
r = webread('https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest');
120-
websave(r.assets.name, r.assets.browser_download_url);
121-
open(r.assets.name)
117+
eval(webread('https://exponenta.ru/install/web'))
122118
```
123119
#### Способ 2 (установка с нуля)
124120

125-
* Скачайте [MATLAB-WEB-API.mltbx](https://github.com/ETMC-Exponenta/MATLAB-WEB-API/raw/master/MATLAB-WEB-API.mltbx)
121+
* Скачайте [MATLAB-WEB-API.mltbx](https://roslovets.github.io/ghbin#ETMC-Exponenta/MATLAB-WEB-API#MATLAB-WEB-API.mltbx)
126122
* Откройте его
127123

128124
#### Способ 3 (обновление)

‎doc/GettingStarted.html‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@
55
.S3 { margin: 10px 0px 20px; padding-left: 0px; font-family: Helvetica, Arial, sans-serif; font-size: 14px; }
66
.S4 { margin-left: 56px; line-height: 21px; min-height: 0px; text-align: left; white-space: pre-wrap; }
77
.CodeBlock { background-color: #F7F7F7; margin: 10px 0 10px 0;}
8-
.S5 { border-left: 1px solid rgb(233, 233, 233); border-right: 1px solid rgb(233, 233, 233); border-top: 1px solid rgb(233, 233, 233); border-bottom: 0px none rgb(0, 0, 0); border-radius: 4px 4px 0px 0px; padding: 6px 45px 0px 13px; line-height: 17.234px; min-height: 18px; white-space: nowrap; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
9-
.S6 { border-left: 1px solid rgb(233, 233, 233); border-right: 1px solid rgb(233, 233, 233); border-top: 0px none rgb(0, 0, 0); border-bottom: 0px none rgb(0, 0, 0); border-radius: 0px; padding: 0px 45px 0px 13px; line-height: 17.234px; min-height: 18px; white-space: nowrap; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
10-
.S7 { border-left: 1px solid rgb(233, 233, 233); border-right: 1px solid rgb(233, 233, 233); border-top: 0px none rgb(0, 0, 0); border-bottom: 1px solid rgb(233, 233, 233); border-radius: 0px 0px 4px 4px; padding: 0px 45px 4px 13px; line-height: 17.234px; min-height: 18px; white-space: nowrap; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
11-
.S8 { margin: 10px 10px 9px 4px; padding: 0px; line-height: 21px; min-height: 0px; white-space: pre-wrap; color: rgb(0, 0, 0); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 14px; font-weight: 400; text-align: left; }
12-
.S9 { border-left: 1px solid rgb(233, 233, 233); border-right: 1px solid rgb(233, 233, 233); border-top: 1px solid rgb(233, 233, 233); border-bottom: 1px solid rgb(233, 233, 233); border-radius: 4px; padding: 6px 45px 4px 13px; line-height: 17.234px; min-height: 18px; white-space: nowrap; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
13-
.S10 { border-left: 0px none rgb(0, 0, 0); border-right: 0px none rgb(0, 0, 0); border-top: 0px none rgb(0, 0, 0); border-bottom: 0px none rgb(0, 0, 0); border-radius: 0px; padding: 0px; line-height: 16px; min-height: 0px; white-space: pre; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 12px; }</style></head><body><div class = rtcContent><h1 class = 'S0'><span>MATLAB WEB API</span></h1><h2 class = 'S1'><span>Description</span></h2><div class = 'S2'><span>Framework for building handy WEB APIs to work with any WEB services from MATLAB.</span></div><div class = 'S2'><a href = "https://www.mathworks.com/matlabcentral/fileexchange/68611"><span>Follow project on MathWorks File Exchange</span></a></div><h2 class = 'S1'><span>Features</span></h2><ul class = 'S3'><li class = 'S4'><span>Set of methods, templates and examples for quick creation of WEB API to work with any WEB service from MATLAB </span></li><li class = 'S4'><span>Library to work with WEB requests </span></li><li class = 'S4'><span>Support of OAuth 1.0, OAuth 2.0 access protocols</span></li></ul><h2 class = 'S1'><span>WEB APIs</span></h2><div class = 'S2'><span style=' font-weight: bold;'>At the moment, the work with services is partially done:</span></div><ul class = 'S3'><li class = 'S4'><a href = "https://www.bing.com/maps"><span>Bing Maps</span></a><span> - Mapping Service </span></li><li class = 'S4'><a href = "http://data.gov.ru/"><span>Data.gov.ru</span></a><span> - Open Data of Russian Federation </span></li><li class = 'S4'><a href = "http://flickr.com/"><span>Flickr</span></a><span> - Photo Hosting (OAuth 1.0) </span></li><li class = 'S4'><a href = "http://hh.com/"><span>HeadHunter</span></a><span> - Russian Recruiting Service </span></li><li class = 'S4'><a href = "http://ip-api.com/"><span>ip-api.com</span></a><span> - IP Geolocation </span></li><li class = 'S4'><a href = "http://www.netsuite.com/portal/home.shtml"><span>NetSuite</span></a><span> - CRM System (OAuth 1.0) </span></li><li class = 'S4'><a href = "https://openweathermap.org/"><span>OpenWeatherMap</span></a><span> - Weather Service </span></li><li class = 'S4'><a href = "http://restcountries.eu/"><span>REST Countries</span></a><span> - Countries Information </span></li><li class = 'S4'><a href = "https://uinames.com/"><span>uinames.com</span></a><span> - Random names generator </span></li><li class = 'S4'><a href = "https://vk.com/"><span>VK</span></a><span> - Russian Social Network (OAuth 2.0)</span></li></ul><h2 class = 'S1'><span>How to install</span></h2><h2 class = 'S1'><span style=' font-weight: bold;'>* For use only *</span></h2><div class = 'S2'><span style=' font-weight: bold;'>1st approach (install from scratch)</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>r = webread(</span><span style="color: rgb(160, 32, 240);">'https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest'</span><span>);</span></span></div></div><div class="inlineWrapper"><div class = 'S6'><span style="white-space: pre;"><span>websave(r.assets.name, r.assets.browser_download_url);</span></span></div></div><div class="inlineWrapper"><div class = 'S7'><span style="white-space: pre;"><span>open(r.assets.name)</span></span></div></div></div><div class = 'S8'><span style=' font-weight: bold;'>2nd approach (install from scratch)</span></div><ul class = 'S3'><li class = 'S4'><span>Download </span><a href = "https://github.com/ETMC-Exponenta/MATLAB-WEB-API/raw/master/MATLAB-WEB-API.mltbx"><span>MATLAB-WEB-API.mltbx</span></a></li><li class = 'S4'><span>Open it</span></li></ul><div class = 'S2'><span style=' font-weight: bold;'>3rd approach (update installed)</span></div><div class = 'S2'><span>Check the current and latest versions:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S9'><span style="white-space: pre;"><span>WEB.API.Ver</span></span></div></div></div><div class = 'S8'><span>Update to the latest version:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S9'><span style="white-space: pre;"><span>WEB.API.Update</span></span></div></div></div><h2 class = 'S1'><span>* For development *</span></h2><ul class = 'S3'><li class = 'S4'><span>Install</span><span> </span><a href = "https://git-scm.com/downloads"><span>Git</span></a></li><li class = 'S4'><a href = "https://git-scm.com/book/en/v2/Getting-Started-Git-Basics"><span>Learn</span></a><span> </span><span>how to use Git</span></li><li class = 'S4'><span>In OS command line execute:</span></li></ul><div class = 'preformatted-matlab' style = 'margin: 10px 3px 10px 55px; padding: 10px 10px 10px 5px; '><div class = 'S10'><span style="white-space: pre;"><span>git </span><span style="color: rgb(160, 32, 240);">clone https://github.com/ETMC-Exponenta/MATLAB-WEB-API.git</span></span></div></div><h2 class = 'S1'><span>Where to start</span></h2><div class = 'S2'><span>Start with</span><span> examples:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S9'><span style="white-space: pre;"><span>WEB.API.Examples</span></span></div></div></div><div class = 'S8'><span style=' font-style: italic;'>Note: to work with some WEB Services you need to register and get access keys. See particular Service Developer documentation</span></div><div class = 'S2'><span>Examine documentation:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S9'><span style="white-space: pre;"><span>WEB.API.Doc</span></span></div></div></div><h2 class = 'S1'><span>Join us</span></h2><div class = 'S2'><span>Together we will add more of services API and improve the existing!</span></div><div class = 'S2'><a href = "https://github.com/ETMC-Exponenta/MATLAB-WEB-API"><span>Project on GitHub</span></a></div></div>
8+
.S5 { border-left: 1px solid rgb(233, 233, 233); border-right: 1px solid rgb(233, 233, 233); border-top: 1px solid rgb(233, 233, 233); border-bottom: 1px solid rgb(233, 233, 233); border-radius: 4px; padding: 6px 45px 4px 13px; line-height: 17.234px; min-height: 18px; white-space: nowrap; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; }
9+
.S6 { margin: 10px 10px 9px 4px; padding: 0px; line-height: 21px; min-height: 0px; white-space: pre-wrap; color: rgb(0, 0, 0); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 14px; font-weight: 400; text-align: left; }
10+
.S7 { border-left: 0px none rgb(0, 0, 0); border-right: 0px none rgb(0, 0, 0); border-top: 0px none rgb(0, 0, 0); border-bottom: 0px none rgb(0, 0, 0); border-radius: 0px; padding: 0px; line-height: 16px; min-height: 0px; white-space: pre; color: rgb(0, 0, 0); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 12px; }</style></head><body><div class = rtcContent><h1 class = 'S0'><span>MATLAB WEB API</span></h1><h2 class = 'S1'><span>Description</span></h2><div class = 'S2'><span>Framework for building handy WEB APIs to work with any WEB services from MATLAB.</span></div><div class = 'S2'><a href = "https://www.mathworks.com/matlabcentral/fileexchange/68611"><span>Follow project on MathWorks File Exchange</span></a></div><h2 class = 'S1'><span>Features</span></h2><ul class = 'S3'><li class = 'S4'><span>Set of methods, templates and examples for quick creation of WEB API to work with any WEB service from MATLAB </span></li><li class = 'S4'><span>Library to work with WEB requests </span></li><li class = 'S4'><span>Support of OAuth 1.0, OAuth 2.0 access protocols</span></li></ul><h2 class = 'S1'><span>WEB APIs</span></h2><div class = 'S2'><span style=' font-weight: bold;'>At the moment, the work with services is partially done:</span></div><ul class = 'S3'><li class = 'S4'><a href = "https://www.bing.com/maps"><span>Bing Maps</span></a><span> - Mapping Service </span></li><li class = 'S4'><a href = "http://data.gov.ru/"><span>Data.gov.ru</span></a><span> - Open Data of Russian Federation </span></li><li class = 'S4'><a href = "http://flickr.com/"><span>Flickr</span></a><span> - Photo Hosting (OAuth 1.0) </span></li><li class = 'S4'><a href = "http://hh.com/"><span>HeadHunter</span></a><span> - Russian Recruiting Service </span></li><li class = 'S4'><a href = "http://ip-api.com/"><span>ip-api.com</span></a><span> - IP Geolocation </span></li><li class = 'S4'><a href = "http://www.netsuite.com/portal/home.shtml"><span>NetSuite</span></a><span> - CRM System (OAuth 1.0) </span></li><li class = 'S4'><a href = "https://openweathermap.org/"><span>OpenWeatherMap</span></a><span> - Weather Service </span></li><li class = 'S4'><a href = "http://restcountries.eu/"><span>REST Countries</span></a><span> - Countries Information </span></li><li class = 'S4'><a href = "https://uinames.com/"><span>uinames.com</span></a><span> - Random names generator </span></li><li class = 'S4'><a href = "https://vk.com/"><span>VK</span></a><span> - Russian Social Network (OAuth 2.0)</span></li></ul><h2 class = 'S1'><span>How to install</span></h2><h2 class = 'S1'><span style=' font-weight: bold;'>* For use only *</span></h2><div class = 'S2'><span style=' font-weight: bold;'>1st approach (install from scratch)</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>eval(webread(</span><span style="color: rgb(160, 32, 240);">'https://exponenta.ru/install/web'</span><span>))</span></span></div></div></div><div class = 'S6'><span style=' font-weight: bold;'>2nd approach (install from scratch)</span></div><ul class = 'S3'><li class = 'S4'><span>Download </span><a href = "https://roslovets.github.io/ghbin#ETMC-Exponenta/MATLAB-WEB-API#MATLAB-WEB-API.mltbx"><span>MATLAB-WEB-API.mltbx</span></a></li><li class = 'S4'><span>Open it</span></li></ul><div class = 'S2'><span style=' font-weight: bold;'>3rd approach (update installed)</span></div><div class = 'S2'><span>Check the current and latest versions:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>WEB.API.Ver</span></span></div></div></div><div class = 'S6'><span>Update to the latest version:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>WEB.API.Update</span></span></div></div></div><h2 class = 'S1'><span>* For development *</span></h2><ul class = 'S3'><li class = 'S4'><span>Install</span><span> </span><a href = "https://git-scm.com/downloads"><span>Git</span></a></li><li class = 'S4'><a href = "https://git-scm.com/book/en/v2/Getting-Started-Git-Basics"><span>Learn</span></a><span> </span><span>how to use Git</span></li><li class = 'S4'><span>In OS command line execute:</span></li></ul><div class = 'preformatted-matlab' style = 'margin: 10px 3px 10px 55px; padding: 10px 10px 10px 5px; '><div class = 'S7'><span style="white-space: pre;"><span>git </span><span style="color: rgb(160, 32, 240);">clone https://github.com/ETMC-Exponenta/MATLAB-WEB-API.git</span></span></div></div><h2 class = 'S1'><span>Where to start</span></h2><div class = 'S2'><span>Start with</span><span> examples:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>WEB.API.Examples</span></span></div></div></div><div class = 'S6'><span style=' font-style: italic;'>Note: to work with some WEB Services you need to register and get access keys. See particular Service Developer documentation</span></div><div class = 'S2'><span>Examine documentation:</span></div><div class="CodeBlock"><div class="inlineWrapper"><div class = 'S5'><span style="white-space: pre;"><span>WEB.API.Doc</span></span></div></div></div><h2 class = 'S1'><span>Join us</span></h2><div class = 'S2'><span>Together we will add more of services API and improve the existing!</span></div><div class = 'S2'><a href = "https://github.com/ETMC-Exponenta/MATLAB-WEB-API"><span>Project on GitHub</span></a></div></div>
1411
<br>
1512
<!--
1613
##### SOURCE BEGIN #####
@@ -44,13 +41,11 @@
4441
%% ** For use only **
4542
% *1st approach (install from scratch)*
4643
47-
r = webread('https://api.github.com/repos/ETMC-Exponenta/MATLAB-WEB-API/releases/latest');
48-
websave(r.assets.name, r.assets.browser_download_url);
49-
open(r.assets.name)
44+
eval(webread('https://exponenta.ru/install/web'))
5045
%%
5146
% *2nd approach (install from scratch)*
5247
%%
53-
% * Download <https://github.com/ETMC-Exponenta/MATLAB-WEB-API/raw/master/MATLAB-WEB-API.mltbx
48+
% * Download <https://roslovets.github.io/ghbin#ETMC-Exponenta/MATLAB-WEB-API#MATLAB-WEB-API.mltbx
5449
% MATLAB-WEB-API.mltbx>
5550
% * Open it
5651
%%

‎doc/GettingStarted.mlx‎

-30 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)