feat: add new samples and review model and other calls

Author: raul-casallas

README.adoc

@@ -57,13 +57,26 @@ Clone the repository:
 
 - `$ git clone https://github.com/modzy/sdk-javascript.git`
 
-++++
-<p>Use <a href=https://yarnpkg.com/ style="text-decoration:none">yarn</a> to package and install the SDK. </p>
-++++
+Use https://yarnpkg.com/[yarn] to package and install the SDK:
+
+Globally:
+
+- `$ yarn global add ./sdk-javascript`
+
+In an existing project (directly from github):
+
+- `$ yarn add modzy/sdk-javascript`
+
+
+Or you can use https://nodejs.org/[npm]:
+
+Globally
+
+- `$ npm install -g ./sdk-javascript`
 
-- `$ yarn add ./sdk-javascript`
+In an existing project (directly from github):
 
-//no reference to node.js in here but it is in contributing.
+- `$ yarn install modzy/sdk-javascript`
 
 == Initialize
 
@@ -76,6 +89,12 @@ link:https://models.modzy.com/docs/users-keys/api-keys/retrieve-users-api-keys[L
 
 [source, js]
 ----
+const keys = await modzyClient.getAccountingClient().getAPIKeys('your@email.com');
+keys.forEach(
+    keys => {
+      console.log(JSON.stringify(model));
+    }
+);
 ----
 
 The *body* is the prefix’s complement and it’s required to perform API requests. Since it’s not stored on Modzy’s servers, it cannot be recovered. Make sure to save it securely. If lost, you can link:https://models.modzy.com/docs/users-keys/api-keys/replace-API-key[replace the API key's body].
@@ -84,6 +103,9 @@ link:https://models.modzy.com/docs/users-keys/api-keys/retrieve-full-API-key[Ret
 
 [source, js]
 ----
+
+const hash = await modzyClient.getAccountingClient().getKeyBody('yourKey');
+console.log("The hash is: "+hash);
 ----
 
 Get authenticated with your API key:
@@ -116,15 +138,12 @@ link:https://models.modzy.com/docs/marketplace/models/retrieve-models[List model
 
 [source, js]
 ----
-try{
-    const models = await modzyClient.getAllModels();
-    models.forEach(
-        model => {
-          console.log(JSON.stringify(model));
-        }
-    );
-}
-
+const models = await modzyClient.getAllModels();
+models.forEach(
+    model => {
+      console.log(JSON.stringify(model));
+    }
+);
 ----
 
 Tags help categorize and filter models. They make model browsing easier.
@@ -133,14 +152,24 @@ link:https://models.modzy.com/docs/marketplace/tags/retrieve-tags[List tags]:
 
 [source, js]
 ----
-
+const tags = await modzyClient.getAllTags();
+tags.forEach(
+    tag => {
+      console.log(JSON.stringify(tag));
+    }
+);
 ----
 
 link:https://models.modzy.com/docs/marketplace/tags/retrieve-models-by-tags[List models by tag]:
 
 [source, js]
 ----
-
+const tagsModels = await modzyClient.getTagsAndModels("language_and_text");
+tagsModels.models.forEach(
+    model => {
+        console.log(JSON.stringify(model));
+    }
+);
 ----
 
 === Get a model's details
@@ -165,7 +194,17 @@ link:https://models.modzy.com/docs/marketplace/versions/retrieve-version-details
 
 [source, js]
 ----
-
+let modelVersion = await modzyClient.getModelVersion("ed542963de", "0.0.27");
+console.log("inputs:");
+for(key in modelVersion.inputs){
+    let input = modelVersion.inputs[key];
+    console.log(`  key ${input.name}, type ${input.acceptedMediaTypes}, description: ${input.description}`);
+}
+console.log("outputs:");
+for(key in modelVersion.outputs){
+    let output = modelVersion.outputs[key];
+    console.log(`  key ${output.name}, type ${output.mediaType}, description: ${output.description}`);
+}
 ----
 
 === Submit a job and get results

contributing.adoc

@@ -86,7 +86,7 @@ Clone the repository:
 
 Install dependencies:
 
-- `$ yarn install`
+- `$ yarn install` or `$ npm install`
 
 Create a branch for your awesome new feature:
 
@@ -134,19 +134,23 @@ MODZY_API_KEY=my_key.modzy
 
 Run tests:
 
-- `$ yarn test`
+- `$ yarn test` or `$ npm test`
 
 Or specify the test that you want to run:
 
 - `$ yarn test -- model-client.test.js`
 
+With npm:
+
+- `$ npm test -- model-client.test.js`
+
 === 4. Document your changes
 
 Add supporting documentation for your code.
 
 === 5. Transpile the code
 
-- `$ yarn build`
+- `$ yarn build` or `$ npm run-script build`
 
 === 6. Send a pull request
 

package.json

@@ -1,22 +1,37 @@
 {
   "name": "modzy-sdk",
-  "version": "1.0.1",
+  "version": "0.7.2",
+  "description": "Javascript SDK for Modzy",
   "main": "dist/main.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/modzy/sdk-javascript.git"
+  },
+  "keywords": [
+    "Modzy",
+    "SDK"
+  ],
+  "author": "Modzy",
+  "bugs": {
+    "url": "https://github.com/modzy/sdk-javascript/issues"
+  },
+  "homepage": "https://github.com/modzy/sdk-javascript#readme",
   "scripts": {
     "docs": "jsdoc -c jsdoc.json",
     "build": "babel src --out-dir=dist",
     "test": "jest --detectOpenHandles"
   },
   "dependencies": {
-    "axios": "^0.19.2",
+    "axios": "^0.21.1",
     "dotenv": "^8.2.0",
-    "log4js": "^6.1.2"
+    "log4js": "^6.1.2",
+    "string-similarity": "^4.0.4"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.4",
     "@babel/core": "^7.8.7",
     "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/preset-env": "^7.8.7",    
+    "@babel/preset-env": "^7.8.7",
     "babel-jest": "^25.1.0",
     "jest": "^25.1.0",
     "jsdoc": "^3.6.4"

samples/model_samples.js

@@ -48,13 +48,14 @@ async function modelsSample(){
     models = await modzyClient.getModels(
         /*modelId*/null, /*author*/'Open Source', /*createdByEmail*/null, /*name*/'Image', /*description*/null, 
         /*isActive*/true, /*isExpired*/null, /*isRecommended*/null, /*lastActiveDateTime*/null, /*expirationDateTime*/null,
-        /*page*/null, /*perPage*/100, /*direction*/null, /*sortBy*/null);
+        /*page*/null, /*perPage*/1, /*direction*/null, /*sortBy*/null);
     logger.info( `Active open source models which name starts with 'Image' ${models.length}` );
     // Get model details
     // the models route didn't return much info about the models, just modelId, latestVersion and versions:
     for( mKey in models){
         let model = models[mKey];
-        logger.info(Object.keys(model).toString().replace('\n', ' '));
+        //logger.info(Object.keys(model).toString().replace('\n', ' '));
+        logger.info(model);
         // In order to get more info about the models you need to get the details by identifier
         model = await modzyClient.getModel(model.modelId);
         // then you'll get all the details about the model

src/accounting-client.js

@@ -0,0 +1,70 @@
+const axios  = require('axios').default;
+const logger = require('log4js').getLogger("modzy.accounting-client");
+
+const ApiError = require('./api-error.js');
+
+/**
+ * Utility class that mask the interaction with the model api
+ */
+class AccountingClient{
+
+    /**
+     * Create a ModelClient
+     * @param {string} baseURL - base url of modzy api (i.e.: https://modzy.url/api)
+     * @param {string} apiKey  - api key to access modzy
+     */
+    constructor(baseURL, apiKey){
+        this.baseURL = baseURL + ( baseURL.endsWith('/') ? "" : "/" ) + "accounting";
+        this.apiKey  = apiKey;
+    }
+
+    getAPIKeys(email){
+        if( email !== null && typeof email !== "string" ){
+            throw("the email param should be a not empty string");
+        }
+        const requestURL = `${this.baseURL}/access-keys/user/${email}`;
+        logger.debug(`getAPIKeys(${email}) GET ${requestURL}`);
+        return axios.get(
+            requestURL,
+            {headers: {'Authorization':`ApiKey ${this.apiKey}`}}
+        )
+            .then(
+                ( response )=>{
+                    logger.info(`getAPIKeys(${email}) :: ${response.status} ${response.statusText}`);
+                    return response.data;
+                }
+            )
+            .catch(
+                ( error )=>{
+                    throw( new ApiError( error ) );
+                }
+            );
+    }
+
+    getKeyBody(key){
+        if( key !== null && typeof key !== "string" ){
+            throw("the key param should be a not empty string");
+        }
+        const requestURL = `${this.baseURL}/access-keys/${key}/hash`;
+        logger.debug(`getAPIKeys(${key}) GET ${requestURL}`);
+        return axios.post(
+            requestURL,
+            {},
+            {headers: {'Authorization':`ApiKey ${this.apiKey}`}}
+        )
+            .then(
+                ( response )=>{
+                    logger.info(`getKeyBody(${key}) :: ${response.status} ${response.statusText}`);
+                    return response.data;
+                }
+            )
+            .catch(
+                ( error )=>{
+                    throw( new ApiError( error ) );
+                }
+            );
+    }
+
+}
+
+module.exports = AccountingClient;

src/main.js

@@ -4,17 +4,19 @@ const ModelClient = require('./model-client.js');
 const TagClient = require( './tag-client.js');
 const JobClient = require('./job-client.js');
 const ResultClient = require('./result-client.js');
+const AccountingClient = require('./accounting-client.js');
 const ModzyClient = require('./modzy-client.js');
 const ApiError = require('./api-error.js');
 
 /**
- * @type {{TagClient: TagClient, ResultClient: ResultClient, ModelClient: ModelClient, ModzyClient: ModzyClient, ApiError: ApiError, JobClient: JobClient}}
+ * @type {{TagClient: TagClient, ResultClient: ResultClient, ModelClient: ModelClient, AccountingClient: AccountingClient, ModzyClient: ModzyClient, ApiError: ApiError, JobClient: JobClient}}
  */
 module.exports = {
     ModelClient,
     TagClient,
     JobClient,
     ResultClient,
+    AccountingClient,
     ModzyClient,
     ApiError
 };

src/model-client.js

@@ -2,6 +2,7 @@ const axios  = require('axios').default;
 const logger = require('log4js').getLogger("modzy.model-client");
 
 const ApiError = require('./api-error.js');
+const stringSimilarity = require("string-similarity");
 
 /**
  * Utility class that mask the interaction with the model api
@@ -198,14 +199,33 @@ class ModelClient{
     getModelByName(name){
         return this.getModels(
           null, null, null, name,
-            null, null, null, null, null, null,
-            null, null, null, null
+            null, true, null, null, null, null,
+            null, 20, null, "name"
         )
             .then(
                     (models) => {
                         logger.debug(`getModelByName(${name}) models ${models.length}`);
                         if( models !== null && models.length > 0 ){
-                            logger.debug(`getModelByName(${name}) model ${models[0].modelId}`);
+                            if( models.length > 1 ){
+                                return Promise.all(
+                                    models.map( model => this.getModel(model.modelId))
+                                ).then(
+                                    models2 => {
+                                        models2 = models2.map(
+                                            model => {
+                                                model.distance = stringSimilarity.compareTwoStrings(name, model.name);
+                                                return model;
+                                            }
+                                        ).sort(
+                                            (a,b) => a.distance - b.distance
+                                        );
+                                        models2.forEach(model=>logger.debug(`${model.modelId} ${model.name} ${model.distance}`));
+                                        logger.debug(`getModelByName(${name}) model ${models2[models2.length-1].modelId} :: ${models2[models2.length-1].name}`);
+                                        return models2[models2.length-1];
+                                    }
+                                );
+                            }
+                            logger.debug(`getModelByName(${name}) model ${models[0].modelId} `);
                             return this.getModel(models[0].modelId);
                         }
                         else{

src/modzy-client.js

@@ -4,6 +4,7 @@ const logger = require('log4js').getLogger("modzy");
 const ModelClient = require('./model-client.js');
 const TagClient = require('./tag-client.js');
 const JobClient = require('./job-client.js');
+const AccountingClient = require('./accounting-client.js');
 const ResultClient = require('./result-client.js');
 
 /**
@@ -31,6 +32,7 @@ class ModzyClient {
 		this.tagClient = new TagClient(baseURL, apiKey);
 		this.jobClient = new JobClient(baseURL, apiKey);
 		this.resultClient = new ResultClient(baseURL, apiKey);
+		this.accountingClient = new AccountingClient(baseURL, apiKey);
 	}
 
     /**
@@ -72,6 +74,15 @@ class ModzyClient {
 		return this.resultClient;
 	}
 
+	/**
+	 * Get the accounting client initialized
+	 * @see {@link AccountingClient}
+	 * @returns {AccountingClient}
+	 */
+	getAccountingClient(){
+		return this.accountingClient;
+	}
+
 	/**     	
 	 * @see {@link ModelClient#getAllModels}
 	 */