oauth1 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca906e79f1d51b69b98d0b74a942eeaa9ec5666
-  data.tar.gz: cd36870a23d68a0fc888c3a1ed55e4a551436dda
+  metadata.gz: 9e1478cf15e24757ee13844ef6f016018b3b67d2
+  data.tar.gz: 92cb424fc754762c2cf415257f4147fe9d4ab7e6
 SHA512:
-  metadata.gz: eb8b8819e07b01661fc2ab05a1865fb857e4580b0a9233bb63d79a17780b05bca59542987e7ad5d20210e8b1a7b768304875f4728b3b12981d972aa6c55aed43
-  data.tar.gz: cc6b1c07a31934fb4c741cad7a528c0cb3c1fad0de8a8455ab68f3cb9adbe07c5297e64ccee46b0545e633b0f67f86cd664351a242b3fc4c90f436a960e8d160
+  metadata.gz: 3de5d792698b6133079ec7687717474911a8c4711125ad466ea8af8e60dbd407d7a16883d0d2caeb3045dac0dd0782c3d80a51153f619542312ffed165d1ba57
+  data.tar.gz: a3c611a190c7e5f8df6964ee9e5abb0cfdaab4bed454e92f7424e82305cde7938d0ff3b6760c9dea0c57af6091dda9c99624241a133eec44abe50b1760ed2457

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,10 @@
+[![Build Status](https://travis-ci.org/lunks/oauth1.svg?branch=master)](https://travis-ci.org/lunks/oauth1)
+[![Dependency Status](https://gemnasium.com/lunks/oauth1.svg)](https://gemnasium.com/lunks/oauth1)
+[![Code Climate](https://codeclimate.com/github/lunks/oauth1/badges/gpa.svg)](https://codeclimate.com/github/lunks/oauth1)
+
 # OAuth1
 
-Simple OAuth 1.0 helper. Take a look at the specs on how to use it.
+Simple helper that helps you build the url needed to authenticate into a service using OAuth 1.0.
 
 ## Installation
 
@@ -16,6 +20,25 @@ Or install it yourself as:
 
     $ gem install oauth1
 
+## Usage
+
+    # Setup data
+    method = :get
+    domain_url = 'http://some.app.com/auth/'
+    user_date = { uid: user_email + encrypted_password }
+    oauth_config = { consumer_key: ENV['OAUTH_KEY'], consumer_secret: ENV['OAUTH_SECRET'] }
+
+    # Usage
+    oauth = Oauth::Helper.new(method, domain_url, user_data, oauth_config)
+
+    # Returns
+    oauth.signature_base # Returns the signature appended in the auth url
+    oauth.full_url       # The proper url used for authentication
+
+
+After that, all you need to do is to redirect the user to `oauth.full_url`.
+
+
 ## Contributing
 
 1. Fork it

data/lib/oauth1/helper.rb

@@ -3,6 +3,7 @@ require 'addressable/uri'
 require 'cgi'
 require 'base64'
 require 'openssl'
+require 'securerandom'
 
 module OAuth1
   class Helper
@@ -13,24 +14,21 @@ module OAuth1
         version: "1.0",
         signature_method: 'HMAC-SHA1',
         timestamp: Time.now.to_i.to_s,
-        nonce: SecureRandom.uuid,
-        token: ""
+        nonce: SecureRandom.uuid
       })
 
       @consumer_secret = options.delete(:consumer_secret)
+      @token_secret = options.delete(:token_secret)
       @url_params = params.merge(prepend_oauth_to_key(options))
-
       @method = method.to_s.upcase
       @url = Addressable::URI.parse(url)
     end
 
     def signature_base
+      @url_params.delete(:oauth_signature)
       [@method, @url.to_s, url_with_params.query].map{|v| CGI.escape(v) }.join('&')
     end
 
-    def append_signature_to_params
-      @url_params[:oauth_signature] = hmac_sha1_signature("#{CGI.escape(@consumer_secret)}&", signature_base)
-    end
 
     def full_url
       append_signature_to_params
@@ -38,16 +36,24 @@ module OAuth1
     end
 
     private
+      def key
+        @token_secret ? "#{CGI.escape(@consumer_secret)}&#{CGI.escape(@token_secret)}" : "#{CGI.escape(@consumer_secret)}&"
+      end
+
       def url_with_params
         @url.dup.tap{|url| url.query_values = url_params}
       end
 
+      def append_signature_to_params
+        @url_params[:oauth_signature] = hmac_sha1_signature(key, signature_base)
+      end
+
       def prepend_oauth_to_key(options)
         Hash[options.map{|key, value| ["oauth_#{key}".to_sym, value]}]
       end
 
       def hmac_sha1_signature(key, signature_string)
-        digest = OpenSSL::Digest::Digest.new('sha1')
+        digest = OpenSSL::Digest.new('sha1')
         hmac = OpenSSL::HMAC.digest(digest, key, signature_string)
         Base64.encode64(hmac).chomp.gsub(/\n/, '')
       end

data/lib/oauth1/version.rb

@@ -1,3 +1,3 @@
 module OAuth1
-  VERSION = "0.0.1"
+  VERSION = '0.0.3'
 end

data/spec/oauth1/helper_spec.rb

@@ -1,66 +1,66 @@
 require 'spec_helper'
 
 describe OAuth1::Helper do
-  let(:url) { "http://example.com" }
-  let(:params) { {my_special_param: "params"} }
-  let(:consumer_key) { "some_key" }
-  let(:consumer_secret) { "some_secret" }
+  let(:url) { 'http://example.com' }
+  let(:params) { {user_specified_param: 'params'} }
+  let(:consumer_key) { 'some_key' }
+  let(:consumer_secret) { 'some_secret' }
 
   let(:helper) { OAuth1::Helper.new(:get, url, params, {consumer_key: consumer_key, consumer_secret: consumer_secret}) }
 
-  describe "#url_params" do
+  describe '#url_params' do
     let(:url_params) { helper.url_params }
-    it "prepends oauth_ to option keys" do
-      url_params.keys.should include(:oauth_consumer_key)
+
+    it 'prepends "oauth_" to option keys' do
+      expect(url_params.keys).to include(:oauth_consumer_key)
     end
 
-    it "has some default options" do
-      url_params.keys.should include(:oauth_version)
+    it 'has some default options' do
+      expect(url_params.keys).to include(:oauth_version)
     end
 
-    it "doesn't include the consumer_secret" do
-      url_params.keys.should_not include("oauth_consumer_secret")
+    it 'does not include the consumer_secret' do
+      expect(url_params.keys).to_not include('oauth_consumer_secret')
     end
 
-    it "has oauth_token as an empty string" do
-      url_params[:oauth_token].should eq("")
+    it 'does not have oauth_token as a param' do
+      expect(url_params[:oauth_token]).to be_nil
     end
-  end
 
-  describe "#url_params" do
-    let(:url_params) { helper.url_params }
-    it "returns an array with the options and the params" do
-      url_params.should have(7).params
+    it 'returns an array with the options and the params' do
+      expect(url_params.keys).to have(6).items
     end
 
-    it "has the user-specified params" do
-      url_params.keys.should include(:my_special_param)
+    it 'has any user specified params' do
+      expect(url_params.keys).to include(:user_specified_param)
     end
   end
 
-  describe "#signature_base" do
+  describe '#signature_base' do
     let(:signature_base) { helper.signature_base }
-    it "returns an escaped string with method" do
-      signature_base.should match(/GET/)
+
+    it { expect(signature_base).to be_a(String) }
+
+    it 'contains the http method' do
+      expect(signature_base).to match(/GET/)
     end
 
-    it "returns an escaped string with url" do
-      signature_base.should match(/example.com/)
+    it 'contains the url' do
+      expect(signature_base).to match(/example.com/)
     end
 
-    it "returns an escaped string with the params" do
-      signature_base.should match(/oauth_consumer_key/)
-      signature_base.should match(/my_special_param/)
+    it 'contains the params' do
+      expect(signature_base).to match(/oauth_consumer_key/)
+      expect(signature_base).to match(/user_specified_param/)
     end
   end
 
-  describe "#full_url" do
+  describe '#full_url' do
     let(:full_url) { helper.full_url }
-    it "returns the url with the params for auth" do
-      full_url.should match(/oauth_consumer_key=#{consumer_key}/)
-      full_url.should match(/oauth_signature_method=HMAC-SHA1/)
-      full_url.should match(/oauth_signature=/)
-      full_url.should match(/my_special_param/)
-    end
+
+    it { expect(full_url).to match(/oauth_consumer_key=#{consumer_key}/) }
+    it { expect(full_url).to match(/oauth_signature_method=HMAC-SHA1/) }
+    it { expect(full_url).to match(/oauth_signature=/) }
+    it { expect(full_url).to match(/user_specified_param/) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oauth1
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Matheus Bras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - .gitignore
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: In case you need to craft an OAuth 1.0 URL with HMAC-SHA1, this may be helpful.