node-linked-in - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

api/v1/apidocs.js

@@ -463,6 +463,6 @@ /** section: linked
 /** section: linked
- * mixin company
+ * mixin companies
  **/
 /** section: linked
- *  company#all(msg, callback)
+ *  companies#all(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -484,3 +484,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#get(msg, callback)
+ *  companies#get(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -499,3 +499,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getByUniversalName(msg, callback)
+ *  companies#getByUniversalName(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -514,3 +514,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getByEmailDomain(msg, callback)
+ *  companies#getByEmailDomain(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -529,3 +529,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getUpdate(msg, callback)
+ *  companies#getUpdate(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -547,3 +547,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getUpdateComments(msg, callback)
+ *  companies#getUpdateComments(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -564,3 +564,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getUpdateCommentsLike(msg, callback)
+ *  companies#getUpdateCommentsLike(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -581,3 +581,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#addShare(msg, callback)
+ *  companies#addShare(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -597,3 +597,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getShareEnabled(msg, callback)
+ *  companies#getShareEnabled(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -612,3 +612,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getCurrentShareEnabled(msg, callback)
+ *  companies#getCurrentShareEnabled(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -627,3 +627,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getHistoricalFollowersStatistics(msg, callback)
+ *  companies#getHistoricalFollowersStatistics(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -645,3 +645,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getHistoricalStatusUpdate(msg, callback)
+ *  companies#getHistoricalStatusUpdate(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -665,3 +665,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getStatistics(msg, callback)
+ *  companies#getStatistics(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -680,3 +680,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#getNumFollowers(msg, callback)
+ *  companies#getNumFollowers(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -699,3 +699,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#addShareComment(msg, callback)
+ *  companies#addShareComment(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -715,3 +715,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#likeShareComment(msg, callback)
+ *  companies#likeShareComment(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -731,3 +731,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#addUpdateComment(msg, callback)
+ *  companies#addUpdateComment(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -748,3 +748,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  company#search(msg, callback)
+ *  companies#search(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -912,6 +912,6 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- * mixin share
+ * mixin shares
  **/
 /** section: linked
- *  share#add(msg, callback)
+ *  shares#add(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -930,3 +930,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#getNetworksUpdates(msg, callback)
+ *  shares#getNetworksUpdates(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -952,3 +952,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#getNetworksStats(msg, callback)
+ *  shares#getNetworksStats(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -967,3 +967,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#getNetworksUpdatesComments(msg, callback)
+ *  shares#getNetworksUpdatesComments(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -982,3 +982,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#getNetworksUpdatesLike(msg, callback)
+ *  shares#getNetworksUpdatesLike(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -997,3 +997,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#addShareComment(msg, callback)
+ *  shares#addShareComment(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -1013,3 +1013,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#likeShareComment(msg, callback)
+ *  shares#likeShareComment(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -1029,3 +1029,3 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
 /** section: linked
- *  share#addNetworkUpdate(msg, callback)
+ *  shares#addNetworkUpdate(msg, callback)
  *      - msg (Object): Object that contains the parameters and their values to be sent to the server.
@@ -1032,0 +1032,0 @@ *      - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.

api/v1/communicationsTest.js

@@ -0,0 +0,0 @@ "use strict";

api/v1/companyTest.js

@@ -0,0 +0,0 @@ "use strict";

api/v1/groupsTest.js

@@ -0,0 +0,0 @@ "use strict";

api/v1/jobsTest.js

@@ -0,0 +0,0 @@ "use strict";

api/v1/peopleTest.js

@@ -0,0 +0,0 @@ "use strict";

api/v1/routes.json

@@ -5,3 +5,3 @@ {
       "name": "Linkedin",
-      "description": "A Node.JS module, which provides an object oriented wrapper for the Linked API.",
+      "description": "A Node.JS module, which provides an object oriented wrapper for the LinkedIn API.",
       "protocol": "https",
@@ -751,3 +751,3 @@ "host": "api.linkedin.com",
   },
-  "company": {
+  "companies": {
     "all": {
@@ -1061,3 +1061,3 @@ "url": "/companies",
   },
-  "share": {
+  "shares": {
     "add": {            
@@ -1064,0 +1064,0 @@ "url": "/people/~/shares",

api/v1/shareTest.js

@@ -0,0 +0,0 @@ "use strict";

generate.js

@@ -0,0 +0,0 @@ #!/usr/bin/env node

index.js

 var Linkedin = require("./lib/core/linkedin.js");
 
 module.exports = Linkedin;

lib/core/client.js

@@ -0,0 +0,0 @@ "use strict";

lib/core/error.js

@@ -0,0 +0,0 @@ var Util = require("util");

lib/core/linkedin.js

@@ -44,5 +44,5 @@ "use strict";
  *                  "name": "Github",
- *                  "description": "A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API.",
+ *                  "description": "A Node.JS module, which provides an object oriented wrapper for the LinkedIn API.",
  *                  "protocol": "https",
- *                  "host": "api.github.com",
+ *                  "host": "api.linkedin.com",
  *                  "port": 443,
@@ -114,3 +114,13 @@ *                  "dateFormat": "YYYY-MM-DDTHH:MM:SSZ",
  *
- *      client.getCurrent({}, function(err, ret) {
+ *      var Linkedin = require('node-linked-in');
+ *
+ *      var cfg = {version: "1", pathPrefix:"v1"};
+ *      var linkedin = new Linkedin(cfg);
+ *      // oauth2 authentication then:      
+ *      linkedin.authenticate({
+ *        type: "oauth",
+ *        token: accessToken
+ *      });
+ *
+ *      linkedin.getCurrent({}, function(err, ret) {
  *          // do something with the result here.
@@ -120,3 +130,3 @@ *      });
  *      // or to fetch a specfic member:
- *      client.getMember({
+ *      linkedin.getMember({
  *          "id": "abcde"
@@ -123,0 +133,0 @@ *      }, function(err, ret) {

lib/core/router.js

@@ -0,0 +0,0 @@ "use strict";

lib/core/tunnel.js

@@ -0,0 +0,0 @@ 'use strict';

lib/core/util.js

@@ -0,0 +0,0 @@ /** section: github

package.json

 {
     "name" : "node-linked-in",
-    "version" : "0.0.4",
+    "version" : "0.0.5",
     "description" : "NodeJS wrapper for the LinkedIn API",
@@ -5,0 +5,0 @@ "author": "Julien Valéry <[e-mail]>",

README.md

@@ -8,3 +8,3 @@ node-linked-in [![NPM version](https://badge.fury.io/js/node-linked-in.png)](http://badge.fury.io/js/node-linked-in)  [![Total views](https://sourcegraph.com/api/repos/github.com/darul75/node-linked-in/counters/views.png)](https://sourcegraph.com/github.com/darul75/node-linked-in)
 
-Because ecchymose in the nose. I needed something but on server side.
+Because provided one is not friendly.
 
@@ -92,2 +92,25 @@ ## API
 
+## Namespaces
+
+```javascript
+var linkedin = new Linkedin(cfg);
+
+// following namespaces expose methods for each linked api features
+linkedin.people
+linkedin.groups
+linkedin.companies
+linkedin.jobs
+linkedin.shares
+linkedin.communications
+```
+
+## Implemented APIs
+
+* [People](https://developer.linkedin.com/documents/people) - [doc](http://darul75.github.io/node-linked-in/#people)
+* [Groups](https://developer.linkedin.com/documents/groups) - [doc](http://darul75.github.io/node-linked-in/#groups)
+* [Companies](https://developer.linkedin.com/documents/companies) - [doc](http://darul75.github.io/node-linked-in/#companies)
+* [Jobs](https://developer.linkedin.com/documents/jobs) - [doc](http://darul75.github.io/node-linked-in/#people)
+* [Share](https://developer.linkedin.com/documents/share-and-social-stream) [doc](http://darul75.github.io/node-linked-in/#shares)
+* [Communications](https://developer.linkedin.com/documents/communications) [doc](http://darul75.github.io/node-linked-in/#communications)
+
 ## Metrics
@@ -94,0 +117,0 @@

test/oauth.js

@@ -254,3 +254,3 @@ var http = require("http");
 
-app.get('/company', function (req, res) {
+app.get('/companies', function (req, res) {
   var q = queue(1);
@@ -264,33 +264,33 @@ var ignoreError = function (task, callback) {
   var companyCurrent = function(cb) {
-    testFnTmpl(linkedin.company.all, {}, cb);    
+    testFnTmpl(linkedin.companies.all, {}, cb);    
   };
   var companyOneAndFields = function(cb) {
-    testFnTmpl(linkedin.company.get, {'company-id': 1337, 'url-field-selector': ':(id,name)'}, cb);    
+    testFnTmpl(linkedin.companies.get, {'company-id': 1337, 'url-field-selector': ':(id,name)'}, cb);    
   };
   var companyOne = function(cb) {
-    testFnTmpl(linkedin.company.get, {'company-id': 1337}, cb);    
+    testFnTmpl(linkedin.companies.get, {'company-id': 1337}, cb);    
   };
   var companyUniversalName = function(cb) {
-    testFnTmpl(linkedin.company.getByUniversalName, {"universal-name": 'linkedin'}, cb);    
+    testFnTmpl(linkedin.companies.getByUniversalName, {"universal-name": 'linkedin'}, cb);    
   };
   var companyEmailDomain = function(cb) {
-    testFnTmpl(linkedin.company.getByEmailDomain, {"email-domain": 'linkedin.com'}, cb);    
+    testFnTmpl(linkedin.companies.getByEmailDomain, {"email-domain": 'linkedin.com'}, cb);    
   };
   var companyCurrentIsAdmin = function(cb) {
-    testFnTmpl(linkedin.company.all, {'is-company-admin': true}, cb);    
+    testFnTmpl(linkedin.companies.all, {'is-company-admin': true}, cb);    
   };
   var companyMixed = function(cb) {
-    testFnTmpl(linkedin.company.all, {'url-field-selector': '::(162479,universal-name=linkedin)'}, cb);    
+    testFnTmpl(linkedin.companies.all, {'url-field-selector': '::(162479,universal-name=linkedin)'}, cb);    
   };
   var companyOneUpdate = function(cb) {
-    testFnTmpl(linkedin.company.getUpdate, {'company-id': 1337}, cb);    
+    testFnTmpl(linkedin.companies.getUpdate, {'company-id': 1337}, cb);    
   };
   var companyOneUpdatePagination = function(cb) {
-    testFnTmpl(linkedin.company.getUpdate, {'company-id': 1337, "start":0, "count":5}, cb);    
+    testFnTmpl(linkedin.companies.getUpdate, {'company-id': 1337, "start":0, "count":5}, cb);    
   };
   var companyOneUpdateEventType = function(cb) {
-    testFnTmpl(linkedin.company.getUpdate, {'company-id': 1337,'event-type': 'status-update'}, cb);    
+    testFnTmpl(linkedin.companies.getUpdate, {'company-id': 1337,'event-type': 'status-update'}, cb);    
   };
   var companyOneUpdateComments = function(cb) {
-    testFnTmpl(linkedin.company.getUpdate, {'company-id': 1337,'company-update-key': 'UPDATE-c162479-5953413562058702849',
+    testFnTmpl(linkedin.companies.getUpdate, {'company-id': 1337,'company-update-key': 'UPDATE-c162479-5953413562058702849',
       'event-type': 'CMPY'}, cb);    
@@ -297,0 +297,0 @@ };

No alert changes

Improved metrics

Total package byte prevSize

558288

increased by1.75%

Number of package files

34

increased by6.25%

Lines of code

5197

increased by8.23%

Number of lines in readme file

141

increased by19.49%

No dependency changes