right_api_client 1.5.16 → 1.5.17

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG.md
 
+## 1.5.17
+ - \#61 Fix for REST client timeouts changing on redirect.
+ - \#61 Also added rest_client_class initializer parameter so that activity_service can use a different REST client implementation with better logging.
+
 ## 1.5.16
 - \#57 Sapphire added optional support for querying a (detailed) resource with params, example: client.resource(href, :view => 'full')
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    right_api_client (1.5.16)
+    right_api_client (1.5.17)
       json (~> 1.0)
       mime-types (~> 1.0)
       rest-client (~> 1.6)

data/lib/right_api_client/client.rb

@@ -27,7 +27,8 @@ module RightApi
     # permitted parameters for initializing
     AUTH_PARAMS = %w[
       email password_base64 password account_id api_url api_version
-      cookies instance_token access_token timeout open_timeout max_attempts enable_retry
+      cookies instance_token access_token timeout open_timeout max_attempts
+      enable_retry rest_client_class
     ]
 
     attr_reader :cookies, :instance_token, :access_token, :last_request, :timeout, :open_timeout, :max_attempts, :enable_retry
@@ -48,7 +49,9 @@ module RightApi
 
       raise 'This API client is only compatible with the RightScale API 1.5 and upwards.' if (Float(@api_version) < 1.5)
 
-      @rest_client = RestClient::Resource.new(@api_url, :open_timeout => @open_timeout, :timeout => @timeout)
+      # allow a custom resource-style REST client (for special logging, etc.)
+      @rest_client_class ||= ::RestClient::Resource
+      @rest_client = @rest_client_class.new(@api_url, :open_timeout => @open_timeout, :timeout => @timeout)
       @last_request = {}
 
       # There are four options for login:
@@ -110,9 +113,12 @@ module RightApi
     # Given a path returns a RightApiClient::Resource instance.
     #
     def resource(path, params={})
+      r = Resource.process_detailed(self, *do_get(path, params))
 
-      r = Resource.process(self, *do_get(path, params))
-
+      # note that process_detailed will make a best-effort to return an already
+      # detailed resource or array of detailed resources but there may still be
+      # legacy cases where #show is still needed. calling #show on an already
+      # detailed resource is a no-op.
       r.respond_to?(:show) ? r.show : r
     end
 
@@ -459,7 +465,12 @@ module RightApi
       # Update the rest client url if we are redirected to another endpoint
       uri = URI.parse(response.headers[:location])
       @api_url = "#{uri.scheme}://#{uri.host}"
-      @rest_client = RestClient::Resource.new(@api_url, :timeout => -1)
+
+      # note that the legacy code did not use the proper timeout values upon
+      # redirect (i.e. always set :timeout => -1) but that seems like an
+      # oversight; always use configured timeout values regardless of redirect.
+      @rest_client = @rest_client_class.new(
+        @api_url, :open_timeout => @open_timeout, :timeout => @timeout)
     end
   end
 end

data/lib/right_api_client/resource.rb

@@ -20,6 +20,27 @@ module RightApi
       end
     end
 
+    # Data may already be 'detailed' (i.e. has a self-href) so avoid returning
+    # an undetailed resource in that case. this is because calling #show on
+    # the undetailed resource would generate a redundant call to
+    #   client#do_get(...)
+    #
+    # FIX: this logic should probably be the behavior of the Resource.process()
+    # method but we are not willing to change legacy behavior for RightAPI v1.5.
+    # the RightAPI v1.6+ client should only use this logic going forward.
+    def self.process_detailed(client, resource_type, path, data={})
+      if data.kind_of?(Array)
+        process(client, resource_type, path, data)
+      else
+        if obj_href = client.get_href_from_links(data["links"])
+          ResourceDetail.new(client, resource_type, obj_href, data)
+        else
+          # no self-href means make an undetailed resource (legacy behavior).
+          process(client, resource_type, path, data)
+        end
+      end
+    end
+
     def inspect
       "#<#{self.class.name} " +
       "resource_type=\"#{@resource_type}\"" +

data/lib/right_api_client/resources.rb

@@ -51,7 +51,8 @@ module RightApi
     # Any other method other than standard actions (create, index)
     # is simply appended to the href and called with a POST.
     def method_missing(m, *args)
-      client.send(:do_post, [ href, m.to_s ].join('/'), *args)
+      # note that 'href' method is not defined on this class; use 'path' instead.
+      client.send(:do_post, [ path, m.to_s ].join('/'), *args)
     end
   end
 end

data/lib/right_api_client/version.rb

@@ -2,7 +2,7 @@
 module RightApi
   class Client
     API_VERSION = '1.5'
-    CLIENT_VERSION = '16'
+    CLIENT_VERSION = '17'
     VERSION = "#{API_VERSION}.#{CLIENT_VERSION}"
   end
 end

metadata

@@ -1,139 +1,161 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: right_api_client
-version: !ruby/object:Gem::Version
-  version: 1.5.16
+version: !ruby/object:Gem::Version 
+  hash: 33
+  prerelease: 
+  segments: 
+  - 1
+  - 5
+  - 17
+  version: 1.5.17
 platform: ruby
-authors:
+authors: 
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+
+date: 2014-05-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  name: mime-types
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  name: rest-client
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    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
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    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
-    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
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    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
-    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
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    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
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
         version: 0.4.2
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
   type: :development
+  name: bundler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-description: "\nThe right_api_client gem simplifies the use of RightScale's MultiCloud
-  API.\nIt provides a simple object model of the API resources, and handles all of
-  the\nfine details involved in making HTTP calls and translating their responses.\n
-  \ "
-email:
+  requirement: *id008
+description: "\n\
+  The right_api_client gem simplifies the use of RightScale's MultiCloud API.\n\
+  It provides a simple object model of the API resources, and handles all of the\n\
+  fine details involved in making HTTP calls and translating their responses.\n  "
+email: 
 - rubygems@rightscale.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
-- ".rspec"
+
+files: 
+- .gitignore
+- .rspec
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -163,30 +185,39 @@ files:
 - spec/unit/resource_spec.rb
 - spec/unit/resources_spec.rb
 homepage: https://github.com/rightscale/right_api_client
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.15
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: RightScale MultiCloud API HTTP Client
-test_files:
+test_files: 
 - config/login.yml.example
 - spec/functional/audit_entries_spec.rb
 - spec/functional/client_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 2af6588a889b4481d483cab397c80441d8604792
-  data.tar.gz: 33d1712937a923cadcfbf6a5b92e112b85d273a0
-SHA512:
-  metadata.gz: bf2fbd1a63a0a699a1e5a52522088ceb9d31b54eb3bc08a670ab1d89c5ffd4fbcadfc28214284b6ae339c125affb5df05f441e84f5114f9c731bfda5ba090534
-  data.tar.gz: 1175def15b5720a226d0097f9a27517216e5fb597a169e15bfc2e41d56869caef16aeafded911017b38704363607b6379a627dddca5fe0df6e6fce77b7ec2789