right_api_client 1.5.26 → 1.5.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eeab13e482a55de8488498410a7d7f2c4c37d7e
-  data.tar.gz: 11bc227243c77b8fd1441b7d14d58cf93f34e5d4
+  metadata.gz: 94b49a3bb3d9527ab20246b6fb3207c45adf2c1c
+  data.tar.gz: 371e6f5e1cd65d28be220d7b5cb227a3ae83abaf
 SHA512:
-  metadata.gz: 939995fa3c0e80733933154736695249d56d713b4017a929fe14a8f5701e4f487ed9f95aa6a44d050d9eea66c5019433c5035a4ff6a678bef8a3f549ce77a160
-  data.tar.gz: 68358b59c102309ff9c2a9af59b0e5a73cea3a3f10435acac5343586971291ef1d8b037b50b1f7a82978fdb77c8d086e2fdfdb9b5a4ef3dd8743f03366aece09
+  metadata.gz: 875e0cf8a86df6b4f867357a062240c31043220d3c67352abc786862485e17163264e6eb06a95b0291fc6a92a5152a0e9bfde01a9d23e97b7098883f10ad08f1
+  data.tar.gz: cb772ee333b0366ef18dc010e9c1d464f09c653b53f9be48c67529dd76b935c8936ceabf2ef8c017ec984b78f9f201a8fb6506b01933c765ab6df1c3cfaac1cc

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 ## Next
  - Your info here
 
+## 1.5.27
+ - \#96 Set default timeout to 6 minutes since the RightScale API has a timeout of 5 minutes for calls
+ - \#94 Updating the README and config/login.yml.example with oauth info
+ - \#93 Work around getting ASCII-8BIT for audit entry detail.
+ - \#91 Fix for issue #83 instance facing client should support tags
+ - \#90 Allow GET /api/right_scripts/:id/source to work since it comes back as text/plain
+ - \#88 Update maintainer info, and add description to bypass the timeout warning
+
 ## 1.5.26
  - \#87 Use the actual response code to determine if re-login is appropriate
 

data/Gemfile

@@ -11,6 +11,7 @@ group :development do
   gem 'rspec', '2.9.0'
   gem 'flexmock', '0.8.7'
   gem 'coveralls', :require => false
+  gem 'pry'
 end
 
 # Gems used during test and development that should be OMITTED from the gemspec

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     addressable (2.3.6)
     builder (3.2.2)
+    coderay (1.1.0)
     columnize (0.3.6)
     coveralls (0.7.1)
       multi_json (~> 1.3)
@@ -45,6 +46,7 @@ GEM
       multi_json (>= 1.5)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
+    method_source (0.8.2)
     mime-types (1.25.1)
     multi_json (1.10.1)
     multi_xml (0.5.5)
@@ -56,6 +58,10 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rack (1.5.2)
     rake (0.8.7)
     rbx-require-relative (0.0.9)
@@ -82,6 +88,7 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    slop (3.6.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
@@ -97,6 +104,7 @@ DEPENDENCIES
   jeweler (~> 2.0)
   json (~> 1.0)
   mime-types (~> 1.0)
+  pry
   rake (= 0.8.7)
   rest-client (~> 1.6)
   rspec (= 2.9.0)

data/README.md

@@ -10,7 +10,7 @@ It is assumed that users are already familiar with the RightScale API:
   - API Documentation: http://support.rightscale.com/12-Guides/RightScale_API_1.5
   - API Reference Docs: http://reference.rightscale.com/api1.5/index.html
 
-Maintained by the RightScale Salmon team
+Maintained by the RightScale QA ServerTemplate and Ivory Automation Team
 
 ## Installation
 Ruby 1.8.7 or higher is required.
@@ -34,8 +34,8 @@ navigate to the Settings > Account Settings page. The account is is at the end o
 
 The client makes working with and getting to know the API much easier. It spiders the API dynamically to
 discover its resources on the fly. At every step, the user has the ability to query api_methods(), which
-indicates the potential methods that can be called. The ```config/login.yml.example``` file provides
-details of different login parameters.
+indicates the potential methods that can be called. **The ```config/login.yml.example``` file provides
+details of different login parameters, for example, oauth authentication.**
 
 ### Making API calls
 Essentially, just follow the RightScale API documentation (available from http://support.rightscale.com)
@@ -60,6 +60,9 @@ Examples:
    
     # A non-CRUD action: POST /api/servers/:server_id/launch
     @client.servers(:id => 4).show.launch
+    
+    # Get an resource by it's href
+    @client.resource('/api/clouds/1/volumes/bfd53dbc005f').show
 
 As seen above, whenever you need to chain methods, you must call .show before specifying the next method.
 
@@ -296,3 +299,17 @@ bundle exec rspec spec/functional
 ## Wrong ruby version
 
 Ruby 1.8.7 or higher is required.
+
+## Warning message: To disable read timeouts, please set timeout to nil instead of -1
+
+To avoid this message you can set ```:timeout```  when creating your RightAp::Client object.  You will need
+to use a different value depending on which version of rest-client is being used.
+
+### rest-client 1.6.x supports ruby 1.8.x
+* ```:timeout => nil```, 60 second timeout (default of Net::HTTP)
+* ```:timeout => -1```, infinite timeout.
+
+### rest-client 1.7.x supports ruby >= 1.9.x
+* **```:timeout => nil```, infinite timeout - no warning message.**
+* ```:timeout => -1```, infinite timeout - plus the error message above being displayed.
+

data/VERSION

@@ -1 +1 @@
-1.5.26
+1.5.27

data/lib/right_api_client/client.rb

@@ -55,7 +55,7 @@ module RightApi
     include Helper
 
     DEFAULT_OPEN_TIMEOUT = nil
-    DEFAULT_TIMEOUT = -1
+    DEFAULT_TIMEOUT = 6 * 60
     DEFAULT_MAX_ATTEMPTS = 5
 
     DEFAULT_SSL_VERSION = 'TLSv1'
@@ -163,6 +163,7 @@ module RightApi
             # Following are special cases that need to over-ride the obj_path
             obj_path = '/api/backups'                if meth == :backups
             obj_path = instance_href + '/live/tasks' if meth == :live_tasks
+            obj_path = '/api/tags'                   if meth == :tags
             if has_id(*args)
               obj_path = add_id_and_params_to_path(obj_path, *args)
               RightApi::Resource.process(self, get_singular(meth), obj_path)
@@ -347,10 +348,18 @@ module RightApi
               # will be used later to add relevant methods to relevant resources
               type = if result.content_type.index('rightscale')
                 get_resource_type(result.content_type)
+              elsif result.content_type.index('text/plain')
+                'text'
               else
                 ''
               end
 
+              # work around getting ASCII-8BIT from some resources like audit entry detail
+              charset = get_charset(response.headers)
+              if charset && response.body.encoding != charset
+                response.body.force_encoding(charset)
+              end
+
               [type, response.body]
             when 301, 302
               update_api_url(response)
@@ -546,6 +555,14 @@ module RightApi
       content_type.scan(/\.rightscale\.(.*)\+json/)[0][0]
     end
 
+    # @param [Hash{Symbol => String}] headers the HTTP headers
+    def get_charset(headers)
+      charset = headers[:content_type].split(';').map(&:strip).detect { |item| item =~ /^charset=/i }
+      if charset
+        Encoding.find(charset.gsub(/^charset=/i, ''))
+      end
+    end
+
     # Makes sure the @cookies have a timestamp.
     #
     def timestamp_cookies

data/lib/right_api_client/helper.rb

@@ -17,7 +17,7 @@ module RightApi::Helper
   }
 
   # List of resources that are available as instance-facing calls
-  INSTANCE_FACING_RESOURCES = [:backups, :live_tasks, :volumes, :volume_attachments, :volume_snapshots, :volume_types]
+  INSTANCE_FACING_RESOURCES = [:backups, :live_tasks, :volumes, :volume_attachments, :volume_snapshots, :volume_types, :tags]
 
   # Helper used to add methods to classes dynamically
   def define_instance_method(meth, &blk)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: right_api_client
 version: !ruby/object:Gem::Version
-  version: 1.5.26
+  version: 1.5.27
 platform: ruby
 authors:
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
 
   The right_api_client gem simplifies the use of RightScale's MultiCloud API.