oa-oauth 0.1.4 → 0.1.5

data/lib/omniauth/oauth.rb

@@ -13,5 +13,7 @@ module OmniAuth
     autoload :Foursquare,         'omniauth/strategies/foursquare'
     autoload :Gowalla,            'omniauth/strategies/gowalla'
     autoload :Identica,           'omniauth/strategies/identica'
+    autoload :TripIt,             'omniauth/strategies/trip_it'
+    autoload :Dopplr,             'omniauth/strategies/dopplr'
   end
 end

data/lib/omniauth/strategies/dopplr.rb

@@ -0,0 +1,22 @@
+require 'omniauth/oauth'
+
+module OmniAuth
+  module Strategies
+    #
+    # Authenticate to Dopplr via OAuth and retrieve an access token for API usage
+    #
+    # Usage:
+    #
+    #    use OmniAuth::Strategies::Dopplr, 'consumerkey', 'consumersecret'
+    #
+    class Dopplr < OmniAuth::Strategies::OAuth
+      def initialize(app, consumer_key, consumer_secret)
+        super(app, :dopplr, consumer_key, consumer_secret,
+                :site => 'https://www.dopplr.com',
+                :request_token_path => "/oauth/request_token",
+                :access_token_path  => "/oauth/access_token",
+                :authorize_path    => "/oauth/authorize")
+      end     
+    end
+  end
+end

data/lib/omniauth/strategies/facebook.rb

@@ -3,25 +3,23 @@ require 'multi_json'
 
 module OmniAuth
   module Strategies
-    #
     # Authenticate to Facebook utilizing OAuth 2.0 and retrieve
     # basic user information.
     #
-    # Usage:
-    #
-    #    use OmniAuth::Strategies::Facebook, 'app_id', 'app_secret'
-    #
-    # Options:
-    #
-    # <tt>:scope</tt> :: Extended permissions such as <tt>email</tt> and <tt>offline_access</tt> (which are the defaults).
+    # @example Basic Usage
+    #   use OmniAuth::Strategies::Facebook, 'app_id', 'app_secret'
     class Facebook < OAuth2
+      # @param [Rack Application] app standard middleware application parameter
+      # @param [String] app_id the application id as [registered on Facebook](http://www.facebook.com/developers/)
+      # @param [String] app_secret the application secret as registered on Facebook
+      # @option options [String] :scope ('email,offline_access') comma-separated extended permissions such as `email` and `manage_pages`
       def initialize(app, app_id, app_secret, options = {})
         options[:site] = 'https://graph.facebook.com/'
         super(app, :facebook, app_id, app_secret, options)
       end
       
       def user_data
-        @data ||= MultiJson.decode(@access_token.get('/me'))
+        @data ||= MultiJson.decode(@access_token.get('/me', {}, { "Accept-Language" => "en-us,en;"}))
       end
       
       def request_phase
@@ -51,4 +49,4 @@ module OmniAuth
       end
     end
   end
-end
+end

data/lib/omniauth/strategies/github.rb

@@ -3,7 +3,13 @@ require 'multi_json'
 
 module OmniAuth
   module Strategies
+    # OAuth 2.0 based authentication with GitHub. In order to 
+    # sign up for an application, you need to [register an application](http://github.com/account/applications/new)
+    # and provide the proper credentials to this middleware.
     class GitHub < OAuth2
+      # @param [Rack Application] app standard middleware application argument
+      # @param [String] app_id the application ID for your client
+      # @param [String] app_secret the application secret
       def initialize(app, app_id, app_secret, options = {})
         options[:site] = 'https://github.com/'
         options[:authorize_path] = '/login/oauth/authorize'
@@ -11,6 +17,8 @@ module OmniAuth
         super(app, :github, app_id, app_secret, options)
       end
       
+      protected
+      
       def user_data
         @data ||= MultiJson.decode(@access_token.get('/api/v2/json/user/show'))['user']
       end

data/lib/omniauth/strategies/google_apps_market.rb

@@ -0,0 +1,3 @@
+module OmniAuth
+  module Strategies
+    class GoogleAppsMarket

data/lib/omniauth/strategies/gowalla.rb

@@ -7,14 +7,13 @@ module OmniAuth
     # Authenticate to Gowalla utilizing OAuth 2.0 and retrieve
     # basic user information.
     #
-    # Usage:
-    #
-    #    use OmniAuth::Strategies::Gowalla, 'API Key', 'Secret Key'
-    #
-    # Options:
-    #
-    # <tt>:scope</tt> :: Extended permissions such as <tt>email</tt> and <tt>offline_access</tt> (which are the defaults).
+    # @example Basic Usage
+    #     use OmniAuth::Strategies::Gowalla, 'API Key', 'Secret Key'
     class Gowalla < OAuth2
+      # @param [Rack Application] app standard middleware application parameter
+      # @param [String] api_key the application id as [registered on Gowalla](http://gowalla.com/api/keys)
+      # @param [String] secret_key the application secret as [registered on Gowalla](http://gowalla.com/api/keys)
+      # @option options ['read','read-write'] :scope ('read') the scope of your authorization request; must be `read` or `read-write`
       def initialize(app, api_key, secret_key, options = {})
         options[:site] = 'https://api.gowalla.com/api/oauth'
         options[:authorize_url] = 'https://gowalla.com/api/oauth/new'
@@ -22,12 +21,14 @@ module OmniAuth
         super(app, :gowalla, api_key, secret_key, options)
       end
       
+      protected
+      
       def user_data
         @data ||= MultiJson.decode(@access_token.get("/users/me.json"))
       end
       
       def request_phase
-        options[:scope] ||= "email,offline_access"
+        options[:scope] ||= "read"
         super
       end
       

data/lib/omniauth/strategies/oauth2.rb

@@ -5,11 +5,21 @@ require 'omniauth/oauth'
 
 module OmniAuth
   module Strategies
+    # Authentication strategy for connecting with APIs constructed using
+    # the [OAuth 2.0 Specification](http://tools.ietf.org/html/draft-ietf-oauth-v2-10).
+    # You must generally register your application with the provider and
+    # utilize an application id and secret in order to authenticate using
+    # OAuth 2.0.
     class OAuth2
       include OmniAuth::Strategy
       
-      attr_accessor :options, :client
+      # The options passed in to the strategy.
+      attr_accessor :options
+      # The `OAuth2::Client` for this strategy.
+      attr_accessor :client
       
+      # An error that is indicated in the OAuth 2.0 callback.
+      # This could be a `redirect_uri_mismatch` or other 
       class CallbackError < StandardError
         attr_accessor :error, :error_reason, :error_uri
         
@@ -20,6 +30,13 @@ module OmniAuth
         end
       end
       
+      # Initialize a new OAuth 2.0 authentication provider.
+      
+      # @param [Rack Application] app standard middleware application argument
+      # @param [String] name the name for this provider to be used in its URL, e.g. `/auth/name`
+      # @param [String] client_id the client/application ID of this provider
+      # @param [String] client_secret the client/application secret of this provider
+      # @param [Hash] options that will be passed through to the OAuth2::Client (see [oauth2 docs](http://rubydoc.info/gems/oauth2))
       def initialize(app, name, client_id, client_secret, options = {})
         super(app, name)
         self.options = options
@@ -33,7 +50,7 @@ module OmniAuth
       end
       
       def callback_phase
-        if request.params['error']
+        if request.params['error'] || request.params['error_reason']
           raise CallbackError.new(request.params['error'], request.params['error_description'] || request.params['error_reason'], request.params['error_uri'])
         end
         

data/lib/omniauth/strategies/trip_it.rb

@@ -0,0 +1,35 @@
+require 'omniauth/oauth'
+
+module OmniAuth
+  module Strategies
+    #
+    # Authenticate to TripIt via OAuth and retrieve an access token for API usage
+    #
+    # Usage:
+    #
+    #    use OmniAuth::Strategies::TripIt, 'consumerkey', 'consumersecret'
+    #
+    class TripIt < OmniAuth::Strategies::OAuth
+      def initialize(app, consumer_key, consumer_secret)
+        super(app, :tripit, consumer_key, consumer_secret,
+                :site => 'https://api.tripit.com',
+                :request_token_path => "/oauth/request_token",
+                :access_token_path  => "/oauth/access_token",
+                :authorize_url     => "https://www.tripit.com/oauth/authorize")
+      end
+      
+      def request_phase
+        request_token = consumer.get_request_token(:oauth_callback => callback_url)
+        (session[:oauth]||={})[name.to_sym] = {:callback_confirmed => request_token.callback_confirmed?, :request_token => request_token.token, :request_secret => request_token.secret}
+        r = Rack::Response.new
+        # For some reason, TripIt NEEDS the &oauth_callback query param or the user receives an error.
+        r.redirect request_token.authorize_url + "&oauth_callback=" + urlencode(callback_url)
+        r.finish
+      end
+      
+      def urlencode(str)
+        str.gsub(/[^a-zA-Z0-9_\.\-]/n) {|s| sprintf('%%%02x', s[0]) }
+      end      
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oa-oauth
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 -05:00
+date: 2010-10-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,12 +24,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 17
         segments: 
         - 0
         - 1
-        - 4
-        version: 0.1.4
+        - 5
+        version: 0.1.5
   requirement: *id001
   name: oa-core
   prerelease: false
@@ -202,15 +202,18 @@ extra_rdoc_files: []
 
 files: 
 - lib/omniauth/oauth.rb
+- lib/omniauth/strategies/dopplr.rb
 - lib/omniauth/strategies/facebook.rb
 - lib/omniauth/strategies/foursquare.rb
 - lib/omniauth/strategies/github.rb
+- lib/omniauth/strategies/google_apps_market.rb
 - lib/omniauth/strategies/gowalla.rb
 - lib/omniauth/strategies/identica.rb
 - lib/omniauth/strategies/linked_in.rb
 - lib/omniauth/strategies/oauth.rb
 - lib/omniauth/strategies/oauth2.rb
 - lib/omniauth/strategies/thirty_seven_signals.rb
+- lib/omniauth/strategies/trip_it.rb
 - lib/omniauth/strategies/twitter.rb
 - README.rdoc
 - LICENSE.rdoc