right_api_client 1.5.24 → 1.5.25

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # CHANGELOG.md
 
 ## Next
+ - Your info here
+
+## 1.5.25
+ - \#85 Fix bug causing useless and malformed login if client is passed an access token with no expiry timestamp
 
 ## 1.5.24
  - \#81 Pass ssl_version option of TLSv1 to rest-client

data/README.md

@@ -96,6 +96,11 @@ Log to STDOUT:
 
     @client.log(STDOUT)
 
+### Retrying HTTP Requests
+HTTP calls can sometimes fail. To enable retrying idempotent requests automatically, enable the `:enable_retry` flag. By default, this value is `false`
+
+    @client = RightApi::Client.new(:email => 'my@email.com', :password => 'my_password', :account_id => 'my_account_id', :enable_retry => true)
+
 ### Managing multiple accounts
 Multiple accounts can be managed by using the api\_url and account\_id attributes on the client.
 

data/VERSION

@@ -1 +1 @@
-1.5.24
+1.5.25

data/lib/right_api_client/client.rb

@@ -112,7 +112,7 @@ module RightApi
     # @return [Boolean] whether to retry idempotent requests that fail
     attr_reader :enable_retry
 
-    # Instantiate a new Client.
+    # Instantiate a new Client, then login if necessary.
     def initialize(args)
       raise 'This API client is only compatible with Ruby 1.8.7 and upwards.' if (RUBY_VERSION < '1.8.7')
 
@@ -142,7 +142,7 @@ module RightApi
       #
       # The latter two options are not really login; they imply that the user logged in out of band.
       # See config/login.yml.example for more info.
-      login() unless @cookies || @access_token
+      login() if need_login?
 
       timestamp_cookies
 
@@ -499,13 +499,28 @@ module RightApi
       end
     end
 
-    # Determine whether the client needs a fresh round of authentication based on state of
-    # cookies/tokens and their expiration timestamps.
+    # Determine whether the client should login based on known state of cookies/tokens and their
+    # expiration timestamps.
     #
-    # @return [Boolean] true if re-login is suggested
+    # If the method returns true, then the client MUST login based on known state.
+    #
+    # If the method returns false, login MAY still be required; we simply cannot determine with
+    # confidence that login is required. This can happen in the following cases:
+    #   - cookie jar has cookies, but they are expired, corrupted or unrelated to auth
+    #   - #initialize method received an access_token but no access_token_expires_at
+    #
+    # @return [Boolean] true if re-login is known to be required
     def need_login?
-      (@refresh_token && @refresh_token_expires_at && @refresh_token_expires_at - Time.now < 900) ||
-      (@cookies.respond_to?(:empty?) && @cookies.empty?)
+      if @access_token
+        # If our access token is expired and we know it...
+        @access_token_expires_at && @access_token_expires_at - Time.now < 900
+      elsif @cookies
+        # Or if we have a cookie jar and it's empty
+        @cookies.respond_to?(:empty?) && @cookies.empty?
+      else
+        # Or if we have neither cookies nor an access token (because how else can a man auth?)
+        true
+      end
     end
 
     # Determine whether an exception can be fixed by logging in again.
@@ -513,7 +528,7 @@ module RightApi
     # @return [Boolean] true if re-login is appropriate
     def re_login?(e)
       auth_error =
-        (e.message.index('403') && e.message =~ %r(.*Session cookie is expired or invalid)) ||
+        (e.message.index('403') && e.message =~ %r(.*cookie is expired or invalid)) ||
         e.message.index('401')
 
       renewable_creds =

metadata

@@ -1,144 +1,144 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: right_api_client
-version: !ruby/object:Gem::Version
-  version: 1.5.24
+version: !ruby/object:Gem::Version 
+  hash: 49
   prerelease: 
+  segments: 
+  - 1
+  - 5
+  - 25
+  version: 1.5.25
 platform: ruby
-authors:
+authors: 
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-12-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   name: mime-types
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
         version: 2.9.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.9.0
-- !ruby/object:Gem::Dependency
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: flexmock
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! '
-
-  The right_api_client gem simplifies the use of RightScale''s MultiCloud API.
-
+  requirement: *id007
+description: |
+  
+  The right_api_client gem simplifies the use of RightScale's MultiCloud API.
   It provides a simple object model of the API resources, and handles all of the
-
   fine details involved in making HTTP calls and translating their responses.
 
-'
 email: rubygems@rightscale.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.md
-files:
+files: 
 - .coveralls.yml
 - .travis.yml
 - CHANGELOG.md
@@ -160,31 +160,37 @@ files:
 - login_to_client_irb.rb
 - right_api_client.rconf
 homepage: https://github.com/rightscale/right_api_client
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2833104221795664035
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: RightScale MultiCloud API HTTP Client
 test_files: []
+