OpenAuth2 0.0.1

data/lib/open_auth2/provider/google.rb

@@ -0,0 +1,28 @@
+module OpenAuth2
+  module Provider
+    module Google
+      Options = {
+        :authorize_url  => 'https://accounts.google.com',
+        :code_url       => 'https://accounts.google.com',
+        :authorize_path => '/o/oauth2/auth',
+        :redirect_uri   => 'http://localhost:9393/google/callback',
+        :token_path     => '/o/oauth2/token',
+        :endpoint       => 'https://www.googleapis.com'
+      }
+
+      def self.parse(config, body)
+        json                    = JSON.parse(body)
+
+        config.access_token     = json['access_token']
+        config.token_arrived_at = Time.now
+        config.token_expires_at = Time.now+3600
+
+        # google sends refresh_token when getting access_token, but not
+        # when refreshing
+        unless config.refresh_token
+          config.refresh_token = json['refresh_token']
+        end
+      end
+    end
+  end
+end

data/lib/open_auth2/token.rb

@@ -0,0 +1,150 @@
+module OpenAuth2
+
+  # Used to get Access/Refresh tokens from OAuth server.
+  class Token
+    extend DelegateToConfig
+    include Connection
+
+    # Use it to set @config. Unlike Client, no error is raised since
+    # this is not part of public api. This will be called from
+    # Client#token internally only.
+    #
+    # Accepts:
+    #   config: OpenAuth2::Config object
+    #
+    # Returns: self.
+    #
+    def initialize(config)
+      @config      = config
+      @faraday_url = authorize_url
+
+      self
+    end
+
+    # Packages the info from config & passed in arguments into an url
+    # that user has to visit to authorize this app.
+    #
+    # Examples:
+    #   token.build_code_url
+    #   #=> 'http://...'
+    #
+    #   # or
+    #   token.build_code_url(:scope => 'publish_stream')
+    #
+    # Accepts:
+    #   params: (optional) Hash of additional config to be bundled into
+    #           the url.
+    #
+    # Returns: String (url).
+    #
+    def build_code_url(params={})
+      url = URI::HTTPS.build(:host  => host,
+                             :path  => authorize_path,
+                             :query => encoded_body(params))
+
+      url.to_s
+    end
+
+    # Make request to OAuth server for access token & ask @config to
+    # parse it. @config delegates that to the appropriate provider.
+    #
+    # We ask @config since the format of response differs between
+    # OAuth servers widely.
+    #
+    # Accepts:
+    #   params: (optional) Hash of additional config to be sent with
+    #           request.
+    #
+    # Returns: ?.
+    #
+    def get(params={})
+      body        = get_body_hash(params)
+      raw_request = post(body)
+
+      parse(raw_request)
+    end
+
+    # Make request to OAuth server to refresh the access token &
+    # ask @config to parse it.
+    #
+    # Accepts:
+    #   params: (optional) Hash of additional config to be sent with
+    #           request.
+    #
+    # Returns: ?.
+    #
+    def refresh(params={})
+      body        = refresh_body_hash(params)
+      raw_request = post(body)
+
+      parse(raw_request)
+    end
+
+    def token_expired?
+      token_expires_at > Time.now
+    rescue
+      nil
+    end
+
+    private
+
+    # We use URI#parse to get rid of those pesky extra /.
+    def host
+      URI.parse(code_url).host
+    end
+
+    # Make travel safe.
+    def encoded_body(params)
+      URI.encode_www_form(url_body_hash(params))
+    end
+
+    # Combine default options & user arguments.
+    def url_body_hash(params)
+
+      # user can define scope as String or Array
+      joined_scope = scope.join(',') if scope.respond_to?(:join)
+
+      {
+        :response_type => response_type,
+        :client_id     => client_id,
+        :redirect_uri  => redirect_uri,
+        :scope         => joined_scope
+      }.merge(params)
+    end
+
+    # TODO: learn about merge vs merge!
+    def get_body_hash(params)
+      {
+        :client_id      => client_id,
+        :client_secret  => client_secret,
+        :code           => code,
+        :grant_type     => access_token_grant_name,
+        :redirect_uri   => redirect_uri
+      }.merge(params)
+    end
+
+    def refresh_body_hash(params)
+       {
+         :client_id         => client_id,
+         :client_secret     => client_secret,
+         :grant_type        => refresh_token_grant_name,
+         refresh_token_name => refresh_token
+       }.merge(params)
+    end
+
+    # Makes the actual request. connection is the Faraday object.
+    def post(body)
+      connection.post do |conn|
+        conn.headers["Content-Type"] = "application/x-www-form-urlencoded"
+        conn.headers["Accept"]       = "application/json"
+        conn.url(token_path)
+        conn.body = body
+      end
+    end
+
+    def parse(response)
+      @config.parse(response.body)
+      response
+    end
+  end
+end

data/lib/open_auth2/version.rb

@@ -0,0 +1,3 @@
+module OpenAuth2
+  VERSION = '0.0.1'
+end

data/open_auth2.gemspec

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+require './lib/open_auth2/version'
+
+Gem::Specification.new do |s|
+  s.name              = "OpenAuth2"
+  s.version           = OpenAuth2::VERSION
+  s.authors           = ["Senthil A"]
+  s.email             = ["senthil196@gmail.com"]
+  s.homepage          = "https://github.com/senthilnambi/OpenAuth2"
+  s.description       = %q{OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby.}
+  s.summary           = %q{OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby. The goal is a simple, well documented, easy to use interface for all your OAuth2 needs.}
+
+  s.rubyforge_project = "OpenAuth2"
+
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- spec/*`.split("\n")
+  s.executables       = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+
+  s.require_paths     = ["lib"]
+
+  s.add_dependency 'faraday',             '~> 0.7'
+  s.add_dependency 'activesupport',       '~> 3.2'
+
+  s.add_development_dependency 'rake',    '~> 0.9'
+  s.add_development_dependency 'rspec',   '~> 2.8'
+  s.add_development_dependency 'vcr',     '~> 1.11'
+  s.add_development_dependency 'fakeweb', '~> 1.3'
+  s.add_development_dependency 'timecop', '~> 0.3'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    License
+    Rakefile
+    Readme.markdown
+    Spec.markdown
+    examples/fb.rb
+    examples/google.rb
+    lib/open_auth2.rb
+    lib/open_auth2/client.rb
+    lib/open_auth2/config.rb
+    lib/open_auth2/connection.rb
+    lib/open_auth2/delegate_to_config.rb
+    lib/open_auth2/provider.rb
+    lib/open_auth2/provider/base.rb
+    lib/open_auth2/provider/default.rb
+    lib/open_auth2/provider/facebook.rb
+    lib/open_auth2/provider/google.rb
+    lib/open_auth2/token.rb
+    lib/open_auth2/version.rb
+    open_auth2.gemspec
+    spec/client_spec.rb
+    spec/config_spec.rb
+    spec/facebook/client_spec.rb
+    spec/facebook/token_spec.rb
+    spec/fixtures/creds.rb
+    spec/fixtures/vcr/fb/access_token.yml
+    spec/fixtures/vcr/fb/cocacola.yml
+    spec/fixtures/vcr/fb/me.yml
+    spec/fixtures/vcr/fb/post.yml
+    spec/fixtures/vcr/fb/refresh_token.yml
+    spec/fixtures/vcr/goog/access_token.yml
+    spec/fixtures/vcr/goog/list.yml
+    spec/fixtures/vcr/goog/post.yml
+    spec/fixtures/vcr/goog/refresh_token.yml
+    spec/google/client_spec.rb
+    spec/google/token_spec.rb
+    spec/spec_helper.rb
+    spec/token_spec.rb
+  ]
+  # = MANIFEST =
+end

data/spec/client_spec.rb

@@ -0,0 +1,110 @@
+require 'open_auth2'
+require 'spec_helper'
+
+describe OpenAuth2::Client do
+  let(:config) do
+    OpenAuth2::Config.new do |c|
+      c.provider     = :facebook
+      c.access_token = :access_token
+    end
+  end
+
+  context '#initialize' do
+    it 'accepts config as argument' do
+      subject = described_class.new(config)
+      subject.config.should == config
+    end
+
+    it 'accepts config via block' do
+      subject = described_class.new do |c|
+        c.config = config
+      end
+    end
+
+    it 'raises NoConfigObject' do
+      expect do
+        subject = described_class.new
+      end.to raise_error(OpenAuth2::NoConfigObject)
+    end
+
+    it 'raises UnknownConfigObject' do
+      expect do
+        subject = described_class.new('string')
+      end.to raise_error(OpenAuth2::UnknownConfigObject)
+    end
+
+    it 'sets @faraday_url' do
+      subject.faraday_url.should == 'https://graph.facebook.com'
+    end
+  end
+
+  context '#configure' do
+    it 'accepts a block to set/overwrite config' do
+      subject.configure do |c|
+        c.access_token  = :access_token
+        c.refresh_token = :refresh_token
+      end
+
+      subject.access_token.should  == :access_token
+      subject.refresh_token.should == :refresh_token
+    end
+
+    it 'raises NoConfigObject' do
+      expect do
+        subject = described_class.new(config)
+        subject.configure {|c| c.config = nil }
+      end.to raise_error(OpenAuth2::NoConfigObject)
+    end
+
+    it 'raises UnknownConfigObject' do
+      expect do
+        subject = described_class.new(config)
+        subject.configure {|c| c.config = 'string' }
+      end.to raise_error(OpenAuth2::UnknownConfigObject)
+    end
+  end
+
+  context '#token' do
+    it 'returns OpenAuth2::Token object' do
+      subject.token.should be_an(OpenAuth2::Token)
+    end
+  end
+
+  context '#build_code_url' do
+    it 'delegates to OpenAuth2::Token' do
+      OpenAuth2::Token.any_instance.should_receive(:build_code_url)
+      subject.build_code_url
+    end
+  end
+
+  subject { described_class.new(config) }
+
+  context OpenAuth2::DelegateToConfig do
+    it 'delegates Options getter methods' do
+      subject.authorize_url.should == 'https://graph.facebook.com'
+    end
+
+    it 'delegates Options setter methods' do
+      url = 'http://facebook.com'
+      subject.authorize_url = url
+
+      subject.authorize_url.should == url
+    end
+
+    it 'overwritten Options stays that way' do
+      config.access_token.should == :access_token
+    end
+  end
+
+  context OpenAuth2::Connection do
+    it 'returns Faraday::Connection object' do
+      subject.connection.should be_a(Faraday::Connection)
+    end
+
+    it 'yields Faraday::Connection object' do
+      subject.connection do |f|
+        f.response :logger
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,119 @@
+require 'open_auth2'
+require 'spec_helper'
+
+describe OpenAuth2::Config do
+  subject { described_class.new }
+
+  it 'overwrites default values' do
+    overwrite_response_type
+    subject.response_type.should == :overwritten
+  end
+
+  context '#initialize' do
+    subject do
+      described_class.new do |c|
+        c.client_id = :set_in_new
+      end
+    end
+
+    it 'sets default as provider' do
+      subject.provider.should == :default
+    end
+
+    it 'accepts a block to set config' do
+      subject.client_id.should == :set_in_new
+    end
+  end
+
+  context '#configure' do
+    it 'accepts a block to set/overwrite config' do
+      subject.configure do |c|
+        c.client_id = :set_in_configure
+      end
+
+      subject.client_id.should == :set_in_configure
+    end
+  end
+
+  context '#provider=' do
+    before do
+      subject.provider = :facebook
+    end
+
+    it 'sets provider' do
+      subject.provider.should == :facebook
+    end
+
+    it 'sets provider_string' do
+      subject.provider_string.should == 'facebook'
+    end
+
+    let(:facebook_const) do
+      OpenAuth2::Provider::Facebook
+    end
+
+    it 'sets provider_const' do
+      subject.provider_const.should == facebook_const
+    end
+
+    it 'copies over options from provider' do
+      subject.authorize_url.should == 'https://graph.facebook.com'
+    end
+
+    it 'keeps non-overlapping default options' do
+      subject.response_type.should == 'code'
+    end
+
+    it 'overwrites overlapping default options' do
+      subject.refresh_token_name.should == 'fb_exchange_token'
+    end
+
+    it 'raises UnknownProvider if arg is not in list of providers' do
+      expect do
+        subject.provider = :unknown
+      end.to raise_error(OpenAuth2::UnknownProvider)
+    end
+
+    it 'provides list of known providers with UnknownProvider' do
+      # mimicking beh. of users including their own provider
+      module OpenAuth2::Provider module UserDefined end end
+
+      providers = [:Default, :Facebook, :Google, :UserDefined]
+      error_message = "Known Providers: #{providers}"
+
+      expect do
+        subject.provider = :unknown
+      end.to raise_error(OpenAuth2::UnknownProvider, error_message)
+    end
+  end
+
+  let(:overwrite_response_type) do
+    subject.configure do |c|
+      c.response_type = :overwritten
+    end
+  end
+
+  context '#reset_provider' do
+    it 'resets locally set values' do
+      overwrite_response_type
+      subject.reset_provider
+
+      subject.response_type.should == 'code'
+    end
+
+    let(:set_to_fb_and_reset) do
+      subject.provider = :facebook
+      subject.reset_provider
+    end
+
+    it 'resets provider to default' do
+      set_to_fb_and_reset
+      subject.provider.should == :default
+    end
+
+    it 'resets all config to default values' do
+      set_to_fb_and_reset
+      subject.authorize_url.should == nil
+    end
+  end
+end