oauth-1.0a - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "oauth-1.0a",
-  "version": "0.0.1",
-  "description": "OAuth 1.0a Request Authorizer",
+  "version": "0.0.2",
+  "description": "OAuth 1.0a Request Authorizer for Node and Browser. Send OAuth request with your favorite HTTP client (request, jQuery.ajax...)",
   "scripts": {
@@ -11,5 +11,6 @@ "test": "mocha",
   "keywords": [
-    "OAuth",
+    "oauth",
     "1.0a",
-    "OAuth1.0a"
+    "oauth1.0a",
+    "authorize"
   ],
@@ -21,3 +22,6 @@ "author": "Ddo",
     "chai": "~1.8.1"
+  },
+  "dependencies": {
+    "crypto-js": "~3.1.2-2"
   }
-}
+}

README.md

 oauth-1.0a
 ==========
 
-OAuth 1.0a Request Authorizer
+OAuth 1.0a Request Authorizer for **Node** and **Browser**
+
+Send OAuth request with your favorite HTTP client ([request](https://github.com/mikeal/request), [jQuery.ajax](http://api.jquery.com/jQuery.ajax/)...)
+
+## Quick Start
+
+Setup
+```js
+var oauth = new OAuth({
+    consumer: {
+        public: '<your consumer key>',
+        secret: '<your consumer secret>'
+    },
+    signature_method: '<signature method>' //HMAC-SHA1 or PLAINTEXT ...
+});
+```
+
+Get OAuth request data then you can use with your http client easily :)
+```js
+oauth.authorizer(request, token);
+```
+
+Or if you want to get as a header key-value data
+```js
+oauth.toHeader(oauth_data);
+```
+
+
+##Installation
+
+###Node.js
+    $ npm install oauth-1.0a
+    
+###Browser
+Download oauth-1.0a.js [here](https://github.com/joeddo/oauth-1.0a)
+
+    <script src="http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/hmac-sha1.js"></script>
+    <script src="http://crypto-js.googlecode.com/svn/tags/3.1.2/build/components/enc-base64-min.js"></script>
+    <script src="oauth-1.0a.js"></script>
+
+##Examples
+
+###Work with [request](https://github.com/mikeal/request) (Node.js)
+
+Depencies
+
+```js
+var request = require('request');
+var OAuth   = require('oauth-1.0a');
+```
+
+Init
+```js
+var oauth = new OAuth({
+    consumer: {
+        public: 'xvz1evFS4wEEPTGEFPHBog',
+        secret: 'kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw'
+    },
+    signature_method: 'HMAC-SHA1'
+});
+```
+
+Your request data
+```js
+var request_data = {
+	url: 'https://api.twitter.com/1/statuses/update.json?include_entities=true',
+    method: 'POST',
+    data: {
+        status: 'Hello Ladies + Gentlemen, a signed OAuth request!'
+    }
+};
+```
+
+Your token
+```js
+var token = {
+    public: '370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb',
+    secret: 'LswwdoUaIvS8ltyTt5jkRh4J50vUPVVHtR2YPi5kE'
+};
+```
+
+Call a request
+
+```js
+request({
+	url: request_data.url,
+	method: request_data.method,
+	data: oauth.authorizer(request_data, token)
+}, function(error, response, body) {
+	//process your data here
+});
+```
+
+Or if you want to send OAuth data as header
+
+```js
+request({
+	url: request_data.url,
+	method: request_data.method,
+	data: request_data.data,
+	header: oauth.toHeader(oauth.authorizer(request_data, token))
+}, function(error, response, body) {
+	//process your data here
+});
+```
+
+###Work with [jQuery.ajax](http://api.jquery.com/jQuery.ajax/) (Browser)
+
+Init
+```js
+var oauth = new OAuth({
+    consumer: {
+        public: 'xvz1evFS4wEEPTGEFPHBog',
+        secret: 'kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw'
+    },
+    signature_method: 'HMAC-SHA1'
+});
+```
+
+Your request data
+```js
+var request_data = {
+	url: 'https://api.twitter.com/1/statuses/update.json?include_entities=true',
+    method: 'POST',
+    data: {
+        status: 'Hello Ladies + Gentlemen, a signed OAuth request!'
+    }
+};
+```
+
+Your token
+```js
+var token = {
+    public: '370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb',
+    secret: 'LswwdoUaIvS8ltyTt5jkRh4J50vUPVVHtR2YPi5kE'
+};
+```
+
+Call a request
+
+```js
+$.ajax({
+	url: request_data.url,
+	type: request_data.method,
+	data: oauth.authorizer(request_data, token)
+}).done(function(data) {
+	//process your data here
+});
+```
+
+Or if you want to send OAuth data as header
+
+```js
+$.ajax({
+	url: request_data.url,
+	type: request_data.method,
+	data: request_data.data,
+	header: oauth.toHeader(oauth.authorizer(request_data, token))
+}).done(function(data) {
+	//process your data here
+});
+```
+##Notes
+
+**If you want a easier way to handle your OAuth request. Please visit [SimpleOAuth](https://github.com/joeddo/SimpleOAuth), it's a wrapper of this project, some features:**
+
+* Request Token method
+* Get Authorize link method
+* Access Token method
+* OAuth 2.0 support
+* Simpler syntax:
+
+Node.js:
+
+```js
+request(simple_oauth.do({
+    method: 'GET',
+    url: 'https://api.twitter.com/1.1/statuses/user_timeline.json',
+}, function(error, response, body) {
+	//process your data here
+});
+```
+
+jQuery:
+
+```js
+$.ajax(simple_oauth.do({
+    method: 'GET',
+    url: 'https://api.twitter.com/1.1/statuses/user_timeline.json',
+}.done(function(data) {
+	//process your data here
+});
+```
+
+##Todo
+* RSA-SHA1 signature method
+
+##Depencies
+* Browser: [crypto-js](https://code.google.com/p/crypto-js/)
+* Node: [crypto-js](https://github.com/evanvosberg/crypto-js)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16253

increased by961.59%

Number of package files

7

increased by133.33%

Lines of code

302

increased byInfinity%

Number of lines in readme file

203

increased by3960%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedcrypto-js@~3.1.2-2

• + Addedcrypto-js@3.1.8(transitive)