OpenAuth2 0.0.2 → 0.0.3

data/Readme.markdown

@@ -19,16 +19,16 @@ client_id     = 'enter in your own value'
 client_secret = 'enter in your own value'
 redirect_uri  = 'enter in your own value'
 
-config = OpenAuth2::Config.new do |c|
+config = OpenAuth2::Config.new do
   # indicate what kind of provider you want to use
   # Accepts: :google, :facebook or :default
-  #
-  c.provider       = :facebook
 
-  c.client_id      = client_id
-  c.client_secret  = client_secret
-  c.redirect_uri   = redirect_uri
-  c.scope          = ['publish_stream']
+  provider       = :facebook
+
+  client_id      = client_id
+  client_secret  = client_secret
+  redirect_uri   = redirect_uri
+  scope          = ['publish_stream']
 end
 ```
 
@@ -37,16 +37,16 @@ end
 Next, initialize a `client` object, which we'll use to make requests and pass in the `config` object we created earlier.
 
 ```ruby
-client = OpenAuth2::Client.new do |c|
-  c.config = config
+client = OpenAuth2::Client.new do
+  config = config
 end
 ```
 
 `Client#configure_connection` takes a block, which can be used to setup middleware like any other Faraday client, i.e:
 
 ```ruby
-client.configure_connection do |c|
-  c.response :logger
+client.configure_connection do
+  response :logger
 end
 ```
 
@@ -72,11 +72,11 @@ Access token is used to sign the request so the server can identify the client s
 access_token  = 'enter in your value'
 refresh_token = 'enter in your value'
 
-client.configure do |c|
-  c.access_token  = access_token
+client.configure do
+  access_token  = access_token
 
   # optional, for fb its same as above
-  c.refresh_token = refresh_token
+  refresh_token = refresh_token
 end
 ```
 
@@ -88,8 +88,8 @@ If you don't have an access token, we'll need to ask the server for it.
 
 ```ruby
 token = client.token
-token.configure_connection do |c|
-  c.response :logger
+token.configure_connection do
+  response :logger
 end
 
 # asks Facebook for access_token
@@ -146,20 +146,22 @@ client.connection.run_request(:get, path, nil, nil)
 
 ## Plugins
 
-OpenAuth2 comes with inbuilt support for Google and Facebook, but its trivial to add new plugins.
+Since various OAuth2 providers differ in their implementation, OpenAuth2 provides a simple plugin system to accomodate the differences, rather than 'one shoe fits all' approach. Facebook and Google plugins are builtin, but it is trivial to add new ones.
 
-There are only three requirements:
+There are three requirements:
 
   1. Should be under right namespace (OpenAuth2::Provider)
-  1. Contains Options hash
-  1. Contains #parse class method
+  1. Contain Options hash
+  1. Contain #parse class method
+
+To use the plugin, call `Config#provider=` with name of the provider. OpenAuth2 upcases and camelizes the name and looks for the constant under OpenAuth2::Provider namespace.
 
-### Foursquare Example
+### Plugin Example
 
 ```ruby
 module OpenAuth2
   module Provider
-    module Facebook
+    module YourApi
 
       # Provider::Base contains keys of various accepted
       # Options, while Provider::Default contains the default options and
@@ -171,6 +173,9 @@ module OpenAuth2
         :refresh_token_grant_name => '',
       }
 
+      # Called after AccessToken#get and #refresh response are received
+      # from provider.
+      #
       def self.parse(config, response_body)
         # parse the response body
         access_token            = response_body.gsub('access_token=', '')
@@ -193,17 +198,17 @@ require 'json'
 access_token  = 'enter in your own value'
 refresh_token = 'enter in your own value'
 
-config = OpenAuth2::Config.new do |c|
-  c.provider       = :google
-  c.access_token   = access_token
-  c.refresh_token  = refresh_token
-  c.scope          = ['https://www.googleapis.com/auth/calendar']
-  c.redirect_uri   = 'http://localhost:9393/google/callback'
-  c.path_prefix    = '/calendar/v3'
+config = OpenAuth2::Config.new do
+  provider       = :google
+  access_token   = access_token
+  refresh_token  = refresh_token
+  scope          = ['https://www.googleapis.com/auth/calendar']
+  redirect_uri   = 'http://localhost:9393/google/callback'
+  path_prefix    = '/calendar/v3'
 end
 
-client = OpenAuth2::Client.new do |c|
-  c.config = config
+client = OpenAuth2::Client.new do
+  config = config
 end
 
 # get request

data/examples/fb.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/open_auth2'
 
-@config = OpenAuth2::Config.new do |c|
-  c.provider = :facebook
+@config = OpenAuth2::Config.new do
+  provider = :facebook
 end
 
 @client = OpenAuth2::Client.new(@config)

data/examples/google.rb

@@ -8,18 +8,18 @@ AccessToken  = nil
 RefreshToken = nil
 PostEmail    = nil
 
-@config = OpenAuth2::Config.new do |c|
-  c.provider       = :google
-  c.code           = Code
-  c.client_id      = ClientId
-  c.client_secret  = ClientSecret
-  c.scope          = ['https://www.googleapis.com/auth/calendar']
-  c.redirect_uri   = 'http://localhost:9393/google/callback'
-  c.path_prefix    = '/calendar/v3'
+@config = OpenAuth2::Config.new do
+  provider       = :google
+  code           = Code
+  client_id      = ClientId
+  client_secret  = ClientSecret
+  scope          = ['https://www.googleapis.com/auth/calendar']
+  redirect_uri   = 'http://localhost:9393/google/callback'
+  path_prefix    = '/calendar/v3'
 end
 
-@client = OpenAuth2::Client.new do |c|
-  c.config = @config
+@client = OpenAuth2::Client.new do
+  config = @config
 end
 
 @token = @client.token

data/lib/open_auth2.rb

@@ -19,15 +19,5 @@ require_relative 'open_auth2/client'
 require_relative 'open_auth2/version'
 
 module OpenAuth2
-
-  # Raised in Config#provider= when user sets to provider not in
-  # 'lib/open_auth2/provider/' or included by them manually.
-  #
   class UnknownProvider < StandardError; end
-
-  # Raised in Client#new unless @config is set.
-  class NoConfigObject < StandardError; end
-
-  # Raised in Client#new unless @config is set to OpenAuth2::Config.
-  class UnknownConfigObject < StandardError; end
 end

data/lib/open_auth2/client.rb

@@ -5,11 +5,7 @@ module OpenAuth2
     extend DelegateToConfig
     include Connection
 
-    # Use it to set @config. Will raise error if no @config or wrong
-    # @config. We rely on Config for all Options info, so its important
-    # it is set right.
-    #
-    # Yields: self.
+    # Use to set config.
     #
     # Accepts:
     #   config: (optional) OpenAuth2::Config object
@@ -20,46 +16,33 @@ module OpenAuth2
     #   end
     #
     #   # set via block
-    #   OpenAuth2::Client.new do |c|
-    #     c.config = config
+    #   OpenAuth2::Client.new do
+    #     config = config
     #   end
     #
     #   # or pass it as an argument
     #   OpenAuth2::Client.new(config)
     #
-    # Returns: self.
-    #
-    def initialize(config=nil)
+    def initialize(config=nil, &blk)
       @config = config
-
-      yield self if block_given?
-      raise_config_setter_errors
-
-      # endpoint is where the api requests are made
+      instance_eval(&blk) if block_given?
       @faraday_url = endpoint
-
-      self
     end
 
-    # Yields: self, use it to set/change config after #initialize.
-    # Mainly for setting access_token and refresh_token. Will raise
-    # Config related errors same as #initialize.
+    # Use to set/change config after #initialize.
     #
     # Examples:
     #   client = OpenAuth2::Client.new
     #
-    #   client.configure do |c|
-    #     c.access_token  = :access_token
-    #     c.refresh_token = :refresh_token
+    #   client.configure do
+    #     access_token  = :access_token
+    #     refresh_token = :refresh_token
     #   end
     #
     # Returns: self.
     #
-    def configure
-      yield self
-      raise_config_setter_errors
-
-      self
+    def configure(&blk)
+      instance_eval(&blk) if block_given?
     end
 
     # We use this to get & refresh access/refresh tokens.
@@ -171,12 +154,5 @@ module OpenAuth2
       connection.run_request(hash[:verb], hash[:path], hash[:body],
                              hash[:header])
     end
-
-    private
-
-    def raise_config_setter_errors
-      raise NoConfigObject      unless config
-      raise UnknownConfigObject unless config.is_a?(OpenAuth2::Config)
-    end
   end
 end

data/lib/open_auth2/config.rb

@@ -5,39 +5,34 @@ module OpenAuth2
     attr_accessor *Provider::Base::Keys
     attr_reader :provider, :provider_const, :provider_string
 
-    # Sets provider to default.
-    #
-    # Yields: self, use it to set config.
+    # Use to set config info.
     #
     # Examples:
-    #   OpenAuth2::Config.new do |c|
-    #     c.provider = :default
+    #   OpenAuth2::Config.new do
+    #     provider = :default
     #   end
     #
-    # Returns: self.
-    #
-    def initialize
+    def initialize(&blk)
       set_default_as_provider
-
-      yield self if block_given?
+      instance_eval(&blk) if block_given?
     end
 
-    # Yields: self, use it to set/change config after #initialize.
+    # Use to set config info.
     #
     # Examples:
     #   config = OpenAuth2::Config.new
     #
-    #   config.configure do |c|
-    #     c.provider = :google
+    #   config.configure do
+    #     provider = :google
     #   end
     #
     # Returns: self.
     #
-    def configure
-      yield self if block_given?
+    def configure(&blk)
+      instance_eval(&blk) if block_given?
     end
 
-    # Finds provider's module & copies its Options key/values to here.
+    # Finds provider's module & copies its Options key/value pairs.
     #
     # Accepts:
     #   name - String/Symbol/Constant.
@@ -47,7 +42,7 @@ module OpenAuth2
       copy_provider_keys
     end
 
-    # Removes all overwritten config & resets provider to default.
+    # Removes all overwritten config & reset to default.
     def reset_provider
       remove_instance_vars
       set_default_as_provider

data/lib/open_auth2/connection.rb

@@ -18,20 +18,19 @@ module OpenAuth2
     #   config = OpenAuth2::Config.new
     #   client = OpenAuth2::Client.new(config)
     #
-    #   client.connection do |c|
-    #     c.response :logger
+    #   client.connection do
+    #     response :logger
     #   end
     #
     # Returns: Faraday object.
     #
-    def connection
+    def connection(&blk)
       @connection ||= Faraday.new(:url => @faraday_url) do |builder|
         builder.request :url_encoded
         builder.adapter :net_http
+        builder.instance_eval(&blk) if block_given?
       end
 
-      yield @connection if block_given?
-
       @connection
     end
   end

data/lib/open_auth2/provider/base.rb

@@ -1,8 +1,8 @@
 module OpenAuth2
   module Provider
 
-    # Contains all possible Options keys. Config allows only the ones
-    # specified here.
+    # Contains all possible Options keys. Config uses this to define
+    # methods.
     #
     module Base
       Keys = [

data/lib/open_auth2/token.rb

@@ -5,24 +5,14 @@ module OpenAuth2
     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.
-    #
+    # Called internally from Client#token only.
     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.
+    # Packages info from config & passed in arguments into an url that
+    # user can to visit to authorize this app.
     #
     # Examples:
     #   token.build_code_url
@@ -32,8 +22,7 @@ module OpenAuth2
     #   token.build_code_url(:scope => 'publish_stream')
     #
     # Accepts:
-    #   params: (optional) Hash of additional config to be bundled into
-    #           the url.
+    #   params: (optional) Hash of additional config.
     #
     # Returns: String (url).
     #
@@ -46,7 +35,7 @@ module OpenAuth2
     end
 
     # Make request to OAuth server for access token & ask @config to
-    # parse it. @config delegates that to the appropriate provider.
+    # parse it. @config delegates to the appropriate provider.
     #
     # We ask @config since the format of response differs between
     # OAuth servers widely.
@@ -131,7 +120,7 @@ module OpenAuth2
        }.merge(params)
     end
 
-    # Makes the actual request. connection is the Faraday object.
+    # Makes the actual request. `connection` is a Faraday object.
     def post(body)
       connection.post do |conn|
         conn.headers["Content-Type"] = "application/x-www-form-urlencoded"

data/lib/open_auth2/version.rb

@@ -1,3 +1,3 @@
 module OpenAuth2
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/open_auth2.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
 
   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 'vcr',     '1.11.3'
   s.add_development_dependency 'fakeweb', '~> 1.3'
   s.add_development_dependency 'timecop', '~> 0.3'
 

data/spec/client_spec.rb

@@ -3,65 +3,45 @@ require 'spec_helper'
 
 describe OpenAuth2::Client do
   let(:config) do
-    OpenAuth2::Config.new do |c|
-      c.provider     = :facebook
-      c.access_token = :access_token
+    OpenAuth2::Config.new do
+      self.provider     = :facebook
+      self.access_token = :access_token
     end
   end
 
+  subject do
+    described_class.new(config)
+  end
+
   context '#initialize' do
-    it 'accepts config as argument' do
-      subject = described_class.new(config)
+    it 'accepts config as an argument' do
       subject.config.should == config
     end
 
     it 'accepts config via block' do
-      subject = described_class.new do |c|
-        c.config = config
+      rspec = self
+      subject = described_class.new do
+        self.config = rspec.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)
+      subject.config.should == config
     end
 
-    it 'sets @faraday_url' do
+    it 'sets endpoint to make requests' 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
+      subject.configure do
+        self.access_token  = :access_token
+        self.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
@@ -97,14 +77,17 @@ describe OpenAuth2::Client do
   end
 
   context OpenAuth2::Connection do
-    it 'returns Faraday::Connection object' do
+    it 'returns Faraday object' do
       subject.connection.should be_a(Faraday::Connection)
     end
 
-    it 'yields Faraday::Connection object' do
-      subject.connection do |f|
-        f.response :logger
+    it 'allows adding custom middleware to Faraday' do
+      subject.connection do
+        response :logger
       end
+
+      subject.connection.builder.handlers.should 
+        include(Faraday::Response::Logger)
     end
   end
 end

data/spec/config_spec.rb

@@ -11,8 +11,8 @@ describe OpenAuth2::Config do
 
   context '#initialize' do
     subject do
-      described_class.new do |c|
-        c.client_id = :set_in_new
+      described_class.new do
+        self.client_id = :set_in_new
       end
     end
 
@@ -27,8 +27,8 @@ describe OpenAuth2::Config do
 
   context '#configure' do
     it 'accepts a block to set/overwrite config' do
-      subject.configure do |c|
-        c.client_id = :set_in_configure
+      subject.configure do
+        self.client_id = :set_in_configure
       end
 
       subject.client_id.should == :set_in_configure
@@ -85,8 +85,8 @@ describe OpenAuth2::Config do
   end
 
   let(:overwrite_response_type) do
-    subject.configure do |c|
-      c.response_type = :overwritten
+    subject.configure do
+      self.response_type = :overwritten
     end
   end
 

data/spec/google/client_spec.rb

@@ -3,12 +3,12 @@ require 'spec_helper'
 
 describe 'Google Client' do
   let(:config) do
-    OpenAuth2::Config.new do |c|
-      c.provider       = :google
-      c.access_token   = Creds::Google::AccessToken
-      c.refresh_token  = Creds::Google::RefreshToken
-      c.redirect_uri   = 'http://localhost:9393/google/callback'
-      c.path_prefix    = '/calendar/v3'
+    OpenAuth2::Config.new do
+      self.provider       = :google
+      self.access_token   = Creds::Google::AccessToken
+      self.refresh_token  = Creds::Google::RefreshToken
+      self.redirect_uri   = 'http://localhost:9393/google/callback'
+      self.path_prefix    = '/calendar/v3'
     end
   end
 

data/spec/google/token_spec.rb

@@ -3,13 +3,13 @@ require 'spec_helper'
 
 describe 'Google Token' do
   let(:config) do
-    OpenAuth2::Config.new do |c|
-      c.provider       = :google
-      c.client_id      = Creds::Google::ClientId
-      c.client_secret  = Creds::Google::ClientSecret
-      c.code           = Creds::Google::Code
-      c.redirect_uri   = 'http://localhost:9393/google/callback'
-      c.scope          = ['https://www.googleapis.com/auth/calendar']
+    OpenAuth2::Config.new do
+      self.provider       = :google
+      self.client_id      = Creds::Google::ClientId
+      self.client_secret  = Creds::Google::ClientSecret
+      self.code           = Creds::Google::Code
+      self.redirect_uri   = 'http://localhost:9393/google/callback'
+      self.scope          = ['https://www.googleapis.com/auth/calendar']
     end
   end
 

data/spec/token_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 
 describe OpenAuth2::Token do
   let(:config) do
-    OpenAuth2::Config.new do |c|
-      c.provider = :facebook
+    OpenAuth2::Config.new do
+      self.provider = :facebook
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: OpenAuth2
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-20 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70136571467600 !ruby/object:Gem::Requirement
+  requirement: &70097461613900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70136571467600
+  version_requirements: *70097461613900
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70136571467080 !ruby/object:Gem::Requirement
+  requirement: &70097461612320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70136571467080
+  version_requirements: *70097461612320
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70136571466700 !ruby/object:Gem::Requirement
+  requirement: &70097461607360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70136571466700
+  version_requirements: *70097461607360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70136571466140 !ruby/object:Gem::Requirement
+  requirement: &70097461606500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70136571466140
+  version_requirements: *70097461606500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70136571465600 !ruby/object:Gem::Requirement
+  requirement: &70097461605800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,21 +65,21 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70136571465600
+  version_requirements: *70097461605800
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70136571465120 !ruby/object:Gem::Requirement
+  requirement: &70097461605280 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - =
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.11.3
   type: :development
   prerelease: false
-  version_requirements: *70136571465120
+  version_requirements: *70097461605280
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70136571464540 !ruby/object:Gem::Requirement
+  requirement: &70097461603840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70136571464540
+  version_requirements: *70097461603840
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70136571463920 !ruby/object:Gem::Requirement
+  requirement: &70097461602600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70136571463920
+  version_requirements: *70097461602600
 description: OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby.
 email:
 - senthil196@gmail.com
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: OpenAuth2
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby. The
@@ -188,3 +188,4 @@ test_files:
 - spec/google/token_spec.rb
 - spec/spec_helper.rb
 - spec/token_spec.rb
+has_rdoc: