OpenAuth2 0.0.4 → 0.0.6

data/Readme.markdown

@@ -1,11 +1,10 @@
-# OpenAuth2 [![Build Status](https://secure.travis-ci.org/senthilnambi/OpenAuth2.png?branch=master)][travis]
+# OpenAuth2 [![Build Status](https://secure.travis-ci.org/sent-hil/OpenAuth2.png?branch=master)][travis]
 
-[travis]: http://travis-ci.org/senthilnambi/OpenAuth2
+[travis]: http://travis-ci.org/sent-hil/OpenAuth2
 
 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.
 
 * This software is alpha, you're either very brave or very foolish to use this in production of rockets or anything else.
-* This Readme is best viewed in [DocumentUp](http://documentup.com/senthilnambi/OpenAuth2).
 
 ## Config
 
@@ -42,11 +41,11 @@ client = OpenAuth2::Client.new do |c|
 end
 ```
 
-`Client#configure_connection` takes a block, which can be used to setup middleware like any other Faraday client, i.e:
+`Client#connection` returns a `Faraday::Connection` object, which can be used to setup middleware.
 
 ```ruby
-client.configure_connection do |c|
-  c.response :logger
+client.connection do
+  response :logger
 end
 ```
 
@@ -72,11 +71,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
-  access_token  = access_token
+client.configure do |c|
+  c.access_token  = access_token
 
   # optional, for fb its same as above
-  refresh_token = refresh_token
+  c.refresh_token = refresh_token
 end
 ```
 
@@ -84,11 +83,11 @@ end
 
 If you don't have an access token, we'll need to ask the server for it.
 
-`token#configure_connection` takes an block, just like `client#configure_connection`, which can be used to setup middleware like any other Faraday client.
+`token#configure` is similar to `client#connection`.
 
 ```ruby
 token = client.token
-token.configure_connection do
+token.configure do
   response :logger
 end
 
@@ -148,11 +147,11 @@ client.connection.run_request(:get, path, nil, nil)
 
 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 three requirements:
+There are only three requirements:
 
   1. Should be under right namespace (OpenAuth2::Provider)
-  1. Contain Options hash
-  1. Contain #parse class method
+  1. Should contain #options method
+  1. Should contain #parse 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.
 
@@ -161,22 +160,26 @@ To use the plugin, call `Config#provider=` with name of the provider. OpenAuth2
 ```ruby
 module OpenAuth2
   module Provider
-    module YourApi
+    class Default
 
-      # Provider::Base contains keys of various accepted
-      # Options, while Provider::Default contains the default options and
+      # Provider::Base contains keys of various accepted Options,
+      # while Provider::Default contains the default options and
       # their values. You can however override them here.
       #
-      Options = {
-        :authorize_url            => '',
-        :code_url                 => '',
-        :refresh_token_grant_name => '',
-      }
+      def options
+        {
+        :response_type            => 'code',
+        :access_token_grant_name  => 'authorization_code',
+        :refresh_token_grant_name => 'refresh_token',
+        :refresh_token_name       => :refresh_token,
+        :scope                    => [],
+        }
+      end
 
       # Called after AccessToken#get and #refresh response are received
       # from provider.
       #
-      def self.parse(config, response_body)
+      def parse(config, response_body)
         # parse the response body
         access_token            = response_body.gsub('access_token=', '')
 
@@ -189,53 +192,9 @@ module OpenAuth2
 end
 ```
 
-## Google example
-
-```ruby
-require 'open_auth2'
-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'
-end
+## Examples
 
-client = OpenAuth2::Client.new do |c|
-  c.config = config
-end
-
-# get request
-client.get(:path => '/users/me/calendarList')
-
-post_url = '/calendar/v3/calendars/openauth2@gmail.com/events'
-body     = {
-  "summary" => "From OpenAuth2",
-  "start"   => {"dateTime"=>"2012-01-20T10:00:00.000-07:00"},
-  "end"     => {"dateTime"=>"2012-01-20T10:25:00.000-07:00"}
-}
-body = JSON.dump(body)
-
-# post request
-client.post(:path         => post_url,
-            :body         => body,
-            :content_type => content_type)
-
-header   = {"Content-Type" => "application/json"}
-full_url = "#{post_url}?access_token=#{access_token}"
-
-# post request via #run_request
-client.run_request(:verb   => :post,
-                   :path   => full_url,
-                   :body   => body,
-                   :header => header)
-```
+See examples/ for more ... (its a surprise).
 
 ## Requirements
 

data/examples/fb.rb

@@ -1,9 +1,20 @@
 require_relative '../lib/open_auth2'
 
+ClientId = '216091171753850'
+ClientSecret = '56f751bef00d6d21e858566b873ac8f8'
+Code = ''
+AccessToken = ''
+
 @config = OpenAuth2::Config.new do |c|
-  c.provider = :facebook
+  c.provider       = :facebook
+  c.client_id      = ClientId
+  c.client_secret  = ClientSecret
+  c.code           = Code
+  c.access_token   = AccessToken
+  c.redirect_uri   = 'http://localhost:9393/'
+  c.scope          = ['manage_pages', 'read_insights']
 end
 
 @client = OpenAuth2::Client.new(@config)
-
-@coke = @client.get(:path => '/cocacola')
+@url    = @client.build_code_url
+@token  = @client.token

data/examples/google.rb

@@ -1,18 +1,20 @@
 require_relative '../lib/open_auth2'
 require 'json'
 
-ClientId     = nil
-ClientSecret = nil
+ClientId     = '948773240950.apps.googleusercontent.com'
+ClientSecret = 'MTkeuqOhFTbfRbd27BcEROTl'
 Code         = nil
-AccessToken  = nil
-RefreshToken = nil
-PostEmail    = nil
+AccessToken  = 'ya29.AHES6ZRL6dKYn5HvssNQvH15KXTc76jCd9KC6Wfsir74whQ'
+RefreshToken = '1/2hTXHN9FULj7v_hVOIoyHn6BpOQS6uDOw-xllInXnTU'
+PostEmail    = 'senthil196@gmail.com'
 
 @config = OpenAuth2::Config.new do |c|
   c.provider       = :google
   c.code           = Code
   c.client_id      = ClientId
   c.client_secret  = ClientSecret
+  c.access_token   = AccessToken
+  c.refresh_token  = RefreshToken
   c.scope          = ['https://www.googleapis.com/auth/calendar']
   c.redirect_uri   = 'http://localhost:9393/google/callback'
   c.path_prefix    = '/calendar/v3'
@@ -22,32 +24,34 @@ end
   c.config = @config
 end
 
-@token = @client.token
+#@token = @client.token
 
-params = {:approval_prompt => 'force', :access_type => 'offline'}
-@url  = @token.build_code_url(params)
+#params = {:approval_prompt => 'force', :access_type => 'offline'}
+#@url  = @token.build_code_url(params)
 
 # get request
 @list = @client.get(:path => '/users/me/calendarList')
 
-post_url = "/calendar/v3/calendars/#{PostEmail}/events"
-body     = {
+@post_url = "/calendar/v3/calendars/#{PostEmail}/events"
+@body     = {
   "summary" => "From OpenAuth2",
-  "start"   => {"dateTime"=>"2012-03-03T10:00:00.000-07:00"},
-  "end"     => {"dateTime"=>"2012-03-03T10:25:00.000-07:00"}
+  "start"   => {"dateTime"=>"2012-10-03T10:00:00.000-07:00"},
+  "end"     => {"dateTime"=>"2012-10-03T10:25:00.000-07:00"}
 }
-body = JSON.dump(body)
+@body = JSON.dump(@body)
 
 # post request
-@client.post(:path         => post_url,
-             :body         => body,
-             :content_type => "application/json")
+def make_request
+  @response  = @client.post(:path         => @post_url,
+                            :body         => @body,
+                            :content_type => "application/json")
+end
 
-header   = {"Content-Type" => "application/json"}
-full_url = "#{post_url}?access_token=#{AccessToken}"
+#header   = {"Content-Type" => "application/json"}
+#full_url = "#{post_url}?access_token=#{AccessToken}"
 
 # post request via #run_request
-@client.run_request(:verb   => :post,
-                    :path   => full_url,
-                    :body   => body,
-                    :header => header)
+#@client.run_request(:verb   => :post,
+                    #:path   => full_url,
+                    #:body   => body,
+                    #:header => header)

data/lib/open_auth2/client.rb

@@ -1,6 +1,6 @@
 module OpenAuth2
 
-  # Used to make GET/POST requests to OAuth server.
+  # Makes GET/POST requests to OAuth server.
   class Client
     extend DelegateToConfig
     include Connection
@@ -8,7 +8,7 @@ module OpenAuth2
     # Use to set config.
     #
     # Accepts:
-    #   config: (optional) OpenAuth2::Config object
+    #   config - (optional) OpenAuth2::Config object.
     #
     # Examples:
     #   config = OpenAuth2::Config.new do |c|
@@ -45,7 +45,7 @@ module OpenAuth2
       yield self if block_given?
     end
 
-    # We use this to get & refresh access/refresh tokens.
+    # Use this to get & refresh access/refresh tokens.
     #
     # Returns: Token object.
     #
@@ -61,8 +61,8 @@ module OpenAuth2
     #   client.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 to be bundled into
+    #                       the url.
     #
     # Returns: String (url).
     #
@@ -70,8 +70,8 @@ module OpenAuth2
       token.build_code_url(params)
     end
 
-    # Makes GET request to OAuth server via Faraday. If access_token
-    # is available, we pass that along to identify ourselves.
+    # Makes GET request to OAuth server. If access_token is available
+    # we pass that along to identify ourselves.
     #
     # Accepts:
     #   hash
@@ -97,7 +97,7 @@ module OpenAuth2
       end
     end
 
-    # Makes POST request to OAuth server via Faraday.
+    # Makes POST request to OAuth server.
     #
     # Accepts:
     #   hash
@@ -142,11 +142,13 @@ module OpenAuth2
     # Examples:
     #   # public GET request
     #   path = "https://graph.facebook.com/cocacola"
-    #   client.run_request(verb: :get, path: path, body: nil, header: nil)
+    #   client.run_request(verb: :get, path: path, body: nil,
+    #                      header: nil)
     #
     #   # private GET request
     #   path = "/me/likes?access_token=..."
-    #   client.run_request(verb: :get, path: path, body: nil, header: nil)
+    #   client.run_request(verb: :get, path: path, body: nil,
+    #                      header: nil)
     #
     # Returns: Faraday response object.
     #

data/lib/open_auth2/config.rb

@@ -49,7 +49,7 @@ module OpenAuth2
     end
 
     def parse(response_body)
-      @provider_const.parse(self, response_body)
+      @provider_const.new.parse(self, response_body)
     end
 
     private
@@ -69,10 +69,8 @@ module OpenAuth2
       full_string     = "OpenAuth2::Provider::#{provider_string}"
 
       @provider_const = full_string.constantize
-    rescue NameError => error
-      if error.to_s =~ /uninitialized constant/
-        raise UnknownProvider, "Known Providers: #{known_providers}"
-      end
+    rescue NameError
+      raise UnknownProvider, "Known Providers: #{known_providers}"
     end
 
     def known_providers
@@ -83,7 +81,7 @@ module OpenAuth2
     end
 
     def copy_provider_keys
-      @provider_const::Options.each do |key,value|
+      @provider_const::new.options.each do |key,value|
         instance_variable_set("@#{key}", value)
       end
     end

data/lib/open_auth2/provider/default.rb

@@ -5,14 +5,20 @@ module OpenAuth2
     # #initialize. We can then choose another provider or overwrite
     # them individually.
     #
-    module Default
-      Options = {
+    class Default
+      def options
+        {
         :response_type            => 'code',
         :access_token_grant_name  => 'authorization_code',
         :refresh_token_grant_name => 'refresh_token',
         :refresh_token_name       => :refresh_token,
         :scope                    => [],
-      }
+        }
+      end
+
+      def parse(config, response_body)
+        response_body
+      end
     end
   end
 end

data/lib/open_auth2/provider/facebook.rb

@@ -1,17 +1,19 @@
 module OpenAuth2
   module Provider
-    module Facebook
-      Options = {
-        :authorize_url            => 'https://graph.facebook.com',
-        :code_url                 => 'https://www.facebook.com',
-        :refresh_token_grant_name => 'fb_exchange_token',
-        :refresh_token_name       => 'fb_exchange_token',
-        :authorize_path           => '/dialog/oauth',
-        :token_path               => 'oauth/access_token',
-        :endpoint                 => 'https://graph.facebook.com'
-      }
+    class Facebook
+      def options
+        {
+          :authorize_url            => 'https://graph.facebook.com',
+          :code_url                 => 'https://www.facebook.com',
+          :refresh_token_grant_name => 'fb_exchange_token',
+          :refresh_token_name       => 'fb_exchange_token',
+          :authorize_path           => '/dialog/oauth',
+          :token_path               => 'oauth/access_token',
+          :endpoint                 => 'https://graph.facebook.com'
+        }
+      end
 
-      def self.parse(config, response_body)
+      def parse(config, response_body)
         access_token            = response_body.gsub('access_token=', '')
         config.access_token     = access_token
         config.refresh_token    = access_token

data/lib/open_auth2/provider/google.rb

@@ -1,16 +1,18 @@
 module OpenAuth2
   module Provider
-    module Google
-      Options = {
+    class Google
+      def 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'
-      }
+        }
+      end
 
-      def self.parse(config, body)
+      def parse(config, body)
         json                    = JSON.parse(body)
 
         config.access_token     = json['access_token']

data/lib/open_auth2/token.rb

@@ -1,11 +1,10 @@
 module OpenAuth2
 
-  # Used to get Access/Refresh tokens from OAuth server.
+  # Gets Access/Refresh tokens from OAuth server.
   class Token
     extend DelegateToConfig
     include Connection
 
-    # Called internally from Client#token only.
     def initialize(config)
       @config      = config
       @faraday_url = authorize_url
@@ -22,7 +21,7 @@ module OpenAuth2
     #   token.build_code_url(:scope => 'publish_stream')
     #
     # Accepts:
-    #   params: (optional) Hash of additional config.
+    #   params - (optional) Hash of additional config.
     #
     # Returns: String (url).
     #
@@ -30,21 +29,15 @@ module OpenAuth2
       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 to the appropriate provider.
-    #
-    # We ask @config since the format of response differs between
-    # OAuth servers widely.
+    # Makes request to OAuth server for access token & parses it by
+    # delegating to the appropriate provider.
     #
     # Accepts:
-    #   params: (optional) Hash of additional config to be sent with
-    #           request.
-    #
-    # Returns: ?.
+    #   params - (optional) Hash of additional config to be sent with
+    #                       request.
     #
     def get(params={})
       body        = get_body_hash(params)
@@ -53,14 +46,11 @@ module OpenAuth2
       parse(raw_request)
     end
 
-    # Make request to OAuth server to refresh the access token &
-    # ask @config to parse it.
+    # Makes request to OAuth server to refresh the access token.
     #
     # Accepts:
-    #   params: (optional) Hash of additional config to be sent with
-    #           request.
-    #
-    # Returns: ?.
+    #   params - (optional) Hash of additional config to be sent with
+    #                       request.
     #
     def refresh(params={})
       body        = refresh_body_hash(params)
@@ -82,7 +72,6 @@ module OpenAuth2
       URI.parse(code_url).host
     end
 
-    # Make travel safe.
     def encoded_body(params)
       URI.encode_www_form(url_body_hash(params))
     end

data/lib/open_auth2/version.rb

@@ -1,3 +1,3 @@
 module OpenAuth2
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

data/open_auth2.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths     = ["lib"]
 
   s.add_dependency 'faraday',             '~> 0.7'
-  s.add_dependency 'activesupport',       '~> 3.2'
+  s.add_dependency 'activesupport',       '~> 3.1'
   s.add_dependency 'json'
 
   if RUBY_PLATFORM == 'java'

data/spec/client_spec.rb

@@ -85,7 +85,7 @@ describe OpenAuth2::Client do
         response :logger
       end
 
-      subject.connection.builder.handlers.should 
+      subject.connection.builder.handlers.should
         include(Faraday::Response::Logger)
     end
   end

data/spec/facebook/client_spec.rb

@@ -69,7 +69,7 @@ describe 'Facebook Client' do
       "{\"message\":\"From OpenAuth2\"}"
     end
 
-    it 'makes request' do
+    xit 'makes request' do
       VCR.use_cassette('fb/post') do
         content_type = 'application/json'
         request = subject.post(:path         => post_url,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: OpenAuth2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70354480374180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,31 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70354480374180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70354480372100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70354480372100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70354480364500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70354480364500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70354480363640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70354480363640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70354480363000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,21 +85,31 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70354480363000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70354480362360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.11.3
   type: :development
   prerelease: false
-  version_requirements: *70354480362360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.3
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70354480361000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +117,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70354480361000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70354480359720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +133,12 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70354480359720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby.
 email:
 - senthil196@gmail.com
@@ -156,15 +196,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2189498827599968042
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2189498827599968042
 requirements: []
 rubyforge_project: OpenAuth2
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: OpenAuth2 is a thin OAuth2 wrapper written on top of Faraday in Ruby. The
@@ -188,4 +234,3 @@ test_files:
 - spec/google/token_spec.rb
 - spec/spec_helper.rb
 - spec/token_spec.rb
-has_rdoc: