mojodna-fireeagle 0.8.0.1 → 0.8.99

data/History.txt

@@ -1,3 +1,8 @@
+== 0.9.0
+
+* Switch to happymapper for XML parsing
+* Support for OAuth 1.0a
+
 == 0.8.0.0
 
 * Update recent method

data/lib/fireeagle.rb

@@ -52,15 +52,3 @@ class Hash
     false_count == 0 or false_count == size
   end
 end
-
-# FireEagle addition to the <code>OAuth::Consumer</code> class
-class OAuth::Consumer
-  alias_method :create_http_with_verify, :create_http
-  # Monkey patch to silence the SSL warnings
-  def create_http_without_verify #:nodoc:
-    http_object             = create_http_with_verify
-    http_object.verify_mode = OpenSSL::SSL::VERIFY_NONE if uri.scheme=="https"
-    http_object
-  end
-  alias_method :create_http, :create_http_without_verify
-end

data/lib/fireeagle/client.rb

@@ -1,7 +1,7 @@
 module FireEagle
   class Client
     # TODO add access_token=() and request_token=() methods that check whether the tokens are usable
-    
+
     attr_reader :access_token, :request_token, :consumer, :format
 
     # Initialize a FireEagle Client. Takes an options Hash.
@@ -20,35 +20,71 @@ module FireEagle
     # [<tt>:app_id</tt>]                 Your Mobile Application ID
     # [<tt>:debug</tt>]                  Boolean
     #
-    # User-specific OAuth tokens tie FireEagle users to your application. As such, they are intended to be
-    # distributed (with keys) to that user's mobile device and/or computer running your desktop or mobile client.
-    # For web-based applications User-specific tokens will be retrieved by your web server where they should be
-    # treated as private data. Take care to avoid releasing this data to the public, as the corresponding User's location
-    # information may be inadvertently exposed. User-specific OAuth tokens should be considered the property of
-    # your users.
+    # User-specific OAuth tokens tie Fire Eagle users to your application. As
+    # such, they are intended to be distributed (with keys) to that user's
+    # mobile device and/or computer running your desktop or mobile client. For
+    # web-based applications User-specific tokens will be retrieved by your
+    # web server where they should be treated as private data. Take care to
+    # avoid releasing this data to the public, as the corresponding User's
+    # location information may be inadvertently exposed. User-specific OAuth
+    # tokens should be considered the property of your users.
+    #
+    # General-purpose OAuth tokens are tied to your application and allow you,
+    # as a developer, to make more general (often batch-style) queries against
+    # Fire Eagle. As a result, allowing this token/secret combination loose
+    # has the potential to reveal a much greater amount of personal data. In
+    # an attempt to mitigate this, we will only grant general-purpose tokens
+    # to web applications (contact us with details, if you seek an exception).
+    # In addition, we require developers to provide a restrictive IP range at
+    # registration time in order to further mitigate the risk of
+    # general-purpose tokens being used inappropriately.
+    #
+    # In general, OAuth tokens should be considered sacrosanct in order to
+    # help us respect our users' privacy. Please take this responsibility on
+    # as your own. If your Application Oauth tokens are compromised, Fire
+    # Eagle will turn off your application service until the problem is
+    # resolved.
+    #
+    # If the Client is initialized without an OAuth access token, it's assumed
+    # you're operating a non-web based application.
+    #
+    # == Example web-based authentication flow:
+    #
+    # Initialize a client with your consumer key and consumer secret.
+    #
+    #   >> c = FireEagle::Client.new(:consumer_key => "key", :consumer_secret => "sekret")
+    #   => #<FireEagle::Client:0x1ce2e70 ... >
+    #
+    # Generate a request token with a +callback_url+:
     #
-    # General-purpose OAuth tokens are tied to your application and allow you, as a developer, to make more
-    # general (often batch-style) queries against FireEagle. As a result, allowing this token/secret combination
-    # loose has the potential to reveal a much greater amount of personal data. In an attempt to mitigate this, we will
-    # only grant general-purpose tokens to web applications (contact us with details, if you seek an exception). In
-    # addition, we require developers to provide a restrictive IP range at registration time in order to further mitigate
-    # the risk of general-purpose tokens being used inappropriately.
+    #   >> c.get_request_token("http://example.com/cb")
+    #   => #<OAuth::Token:0x1cdb5bc @token="request_token", @secret="sekret">
     #
-    # In general, OAuth tokens should be considered sacrosanct in order to help us respect our users' privacy. Please
-    # take this responsibility on as your own. If your Application Oauth tokens are compromised, FireEagle will
-    # turn off your application service until the problem is resolved.
+    # Prompt your user to visit your app's authorization url:
     #
-    # If the Client is initialized without an OAuth access token, it's assumed you're operating a non-web based application.
+    #   >> c.authorization_url
+    #   => "http://fireeagle.yahoo.net/oauth/authorize?oauth_token=request_token"
+    #
+    # When the user has completed this step, s/he will be redirected back to
+    # the callback url you configured when obtaining a request token.
+    # +oauth_verifier+ will be present in the callback.
+    #
+    #   >> c.convert_to_access_token(oauth_verifier)
+    #   => #<OAuth::Token:0x1cd3bf0 @token="access_token", @secret="access_token_secret">
     #
     # == Non web-based applications
     #
-    # For non web-based applications, such as a mobile client application, the authentication between the user and
-    # the application is slightly different. The request token is displayed to the user by the client application. The
-    # user then logs into the FireEagle website (using mobile_authorization_url) and enters this code to authorize the application.
-    # When the user finishes the authorization step the client application exchanges the request token for an access token
-    # (using convert_to_access_token). This is a lightweight method for non-web application users to authenticate an application
-    # without entering any identifying information into a potentially insecure application. Request tokens are valid for only
-    # 1 hour after being issued.
+    # For non web-based applications, such as a mobile client application, the
+    # authentication between the user and the application is slightly
+    # different. The request token is displayed to the user by the client
+    # application. The user then logs into the FireEagle website (using
+    # mobile_authorization_url) and enters this code to authorize the
+    # application. When the user finishes the authorization step the client
+    # application exchanges the request token for an access token (using
+    # +convert_to_access_token+). This is a lightweight method for non-web
+    # application users to authenticate an application without entering any
+    # identifying information into a potentially insecure application. Request
+    # tokens are valid for only 1 hour after being issued.
     #
     # == Example mobile-based authentication flow:
     #
@@ -67,9 +103,10 @@ module FireEagle
     #   >> c.mobile_authorization_url
     #   => "http://fireeagle.yahoo.net/oauth/mobile_auth/12345"
     #
-    # Once the user has indicated to you that they've done this, convert their request token to an access token:
+    # Once the user has indicated to you that they've done this (and provided
+    # a verification code), convert their request token to an access token:
     #
-    #   >> c.convert_to_access_token
+    #   >> c.convert_to_access_token(oauth_verifier)
     #   => #<OAuth::Token:0x1cd3bf0 @token="access_token", @secret="access_token_secret">
     #
     # You're done!
@@ -100,10 +137,10 @@ module FireEagle
       end
     end
 
-    # Obtain an <strong>new</strong> unauthorized OAuth Request token
-    def get_request_token(force_token_regeneration = false)
+    # Obtain a <strong>new</strong> unauthorized OAuth Request token
+    def get_request_token(callback_url = "", force_token_regeneration = false)
       if force_token_regeneration || @request_token.nil?
-        @request_token = consumer.get_request_token
+        @request_token = consumer.get_request_token(:oauth_callback => callback_url)
       end
       @request_token
     end
@@ -120,10 +157,10 @@ module FireEagle
       request_token.authorize_url
     end
 
-    #Exchange an authorized OAuth Request token for an access token. For use by desktop-based and mobile applications.
-    def convert_to_access_token
-      raise FireEagle::ArgumentError, "call #get_request_token and have user authorize the token first" if @request_token.nil?
-      @access_token = request_token.get_access_token
+    # Exchange an authorized OAuth Request token for an access token. For use by desktop-based and mobile applications.
+    def convert_to_access_token(oauth_verifier)
+      raise FireEagle::ArgumentError, "call #get_request_token and have the user authorize the token first" if @request_token.nil?
+      @access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
     end
 
     # Disambiguates potential values for update query. Results from lookup can be passed to

data/lib/fireeagle/version.rb

@@ -2,9 +2,8 @@ module FireEagle #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 8
-    TINY  = 0
-    TEENY = 1
+    TINY  = 99
 
-    STRING = [MAJOR, MINOR, TINY, TEENY].join('.')
+    STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

metadata

@@ -1,28 +1,31 @@
 --- !ruby/object:Gem::Specification 
 name: mojodna-fireeagle
 version: !ruby/object:Gem::Version 
-  version: 0.8.0.1
+  version: 0.8.99
 platform: ruby
 authors: 
 - Jesse Newland
+- Seth Fitzsimmons
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 -08:00
+date: 2009-05-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: mojodna-oauth
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.1
+        version: 0.3.4.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: happymapper
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,6 +35,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: GeoRuby
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -41,6 +45,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -48,9 +53,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: Ruby wrapper for Yahoo!'s FireEagle
+description: Ruby wrapper for Yahoo!'s Fire Eagle
 email: 
 - jnewland@gmail.com
+- seth@mojodna.net
 executables: []
 
 extensions: []
@@ -121,6 +127,6 @@ rubyforge_project: fireeagle
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Ruby wrapper for Yahoo!'s FireEagle
+summary: Ruby wrapper for Yahoo!'s Fire Eagle
 test_files: []