right_api_client 1.5.28 → 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 304eb8dc7fffc201f86fd38ea6af1aa114e47a6d
+  data.tar.gz: c15da2ef2793b2a8c90488f41cf7e4310ce073e6
+SHA512:
+  metadata.gz: 11d74155efd40389bf64cde1b1e97c34f3e1610ff3da7f563de386cb63c70b24d2e61b4e8e80cf09f5832af4752a3aa689295b241b2f6aa5bf0720466c45715b
+  data.tar.gz: 272edd8cfecd3e92bd32b61295b03fa364ac5faca26035f20c403ab846f94f93c1ff1ec493c543c6092654ad325068dfacf00ed8af1043269aa2c0d937e65cbf

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
+sudo: false
 rvm:
-  - 1.8.7
-  - 1.9.3
   - 2.0.0
   - 2.1.0
 script: 

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Next
  - Your info here
 
+## 1.6
+ - \#101 Deprecate support for ruby 1.x
+ - \#100 Add support for using local proxy with RightLink10
+
 ## 1.5.28
  - \#98 Update do_put to add text/plain Content-type
  - \#97 Added put action for the runnable_binding resource

data/Gemfile

@@ -16,9 +16,7 @@ end
 
 # Gems used during test and development that should be OMITTED from the gemspec
 group :test do
-  gem 'ruby-debug',
-      :platforms => [:ruby_18]
-  gem 'debugger',
-      :platforms => [:ruby_19, :ruby_20, :ruby_21]
+  gem 'byebug',
+      :platforms => [:ruby_20, :ruby_21]
   gem 'jeweler', '~> 2.0'
 end

data/Gemfile.lock

@@ -3,20 +3,14 @@ GEM
   specs:
     addressable (2.3.6)
     builder (3.2.2)
+    byebug (6.0.2)
     coderay (1.1.0)
-    columnize (0.3.6)
     coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    debugger (1.6.6)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.2)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.2)
     diff-lcs (1.1.3)
     docile (1.1.5)
     faraday (0.8.9)
@@ -44,8 +38,6 @@ GEM
     json (1.8.1)
     jwt (0.1.11)
       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)
@@ -64,7 +56,6 @@ GEM
       slop (~> 3.4)
     rack (1.5.2)
     rake (0.8.7)
-    rbx-require-relative (0.0.9)
     rdoc (4.1.1)
       json (~> 1.4)
     rest-client (1.6.8)
@@ -78,11 +69,6 @@ GEM
     rspec-expectations (2.9.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.9.0)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
     simplecov (0.9.0)
       docile (~> 1.1.0)
       multi_json
@@ -98,8 +84,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   coveralls
-  debugger
   flexmock (= 0.8.7)
   jeweler (~> 2.0)
   json (~> 1.0)
@@ -108,4 +94,6 @@ DEPENDENCIES
   rake (= 0.8.7)
   rest-client (~> 1.6)
   rspec (= 2.9.0)
-  ruby-debug
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -13,14 +13,14 @@ It is assumed that users are already familiar with the RightScale API:
 Maintained by the RightScale QA ServerTemplate and Ivory Automation Team
 
 ## Installation
-Ruby 1.8.7 or higher is required.
+Ruby 2.0 or higher is required as of version 1.6
 
     gem install right_api_client
 
 ## Versioning
 The right\_api\_client gem is versioned using the usual X.Y.Z notation, where X.Y is the
 RightScale API version, and Z is the client version. For example, if you want to use
-RightScale API 1.5, you should use the latest version of the 1.5 gem. This will ensure
+RightScale API 1.5, you should use the latest version of the 1.6 gem. This will ensure
 that you get the latest bug fixes for the client that is compatible with that API version.
 
 ## Usage Instructions
@@ -33,7 +33,7 @@ navigate to the Settings > Account Settings page. The account is is at the end o
     puts "Available methods: #{@client.api_methods}"
 
 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
+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, for example, oauth authentication.**
 
@@ -162,7 +162,7 @@ Launch the newly created server. Inputs are a bit tricky so they have to be set
     inputs = "inputs[][name]=NAME1&inputs[][value]=text:VALUE1&inputs[][name]=NAME2&inputs[][value]=text:VALUE2"
     new_server.show.launch(inputs)
 
-Run a script on the server. The API does not currently expose right_scripts, hence, the script href has
+Run a script on the server. The API does not currently expose right\_scripts, hence, the script href has
 to be retrieved from the dashboard and put in the following href format.
 
     script_href = "right_script_href=/api/right_scripts/382371"
@@ -174,7 +174,7 @@ Update the server's name
     params = { :server => {:name => 'New Server Name'}}
     @client.servers(:id => 'my_server_id').update(params)
 
-Terminate the server (i.e. shutdown its current_instance)
+Terminate the server (i.e. shutdown its current\_instance)
 
     @client.servers(:id => 'my_server_id').show.terminate
 
@@ -238,6 +238,17 @@ Due to the limiting scope of the instance-facing calls, only a subset of these m
 (see the API Reference Docs for valid methods). If you call a method that instance's are not authorized to access,
 you will get a 403 Permission Denied error.
 
+## RightLink10 and Instance Facing Calls:
+Having RightLink10 installed on an instance allows 'instance facing calls' via a local
+[reverse proxy](http://docs.rightscale.com/rl10/reference/rl10_local_and_proxied_http_requests.html).  To use
+the reverse proxy on the instance, you will only need to provide the following parameter:
+
+- ```:rl10``` Set this to ```true```
+
+Setting this parameter to `true` will use the information in the proxy authentication file to create the client.
+
+### Example
+    @instance_client = RightApi::Client.new(:rl10 => true)
 
 # Design Decisions
 In the code, we only hard-code CRUD operations for resources. We use the .show and .index methods to make the client
@@ -296,20 +307,23 @@ bundle exec rspec spec/functional
 
 # Troubleshooting
 
+## Known issues:
+ * Cookies are lost on follow redirect.  This is a bug introduced in rest-client. 
+[Github issue #406](https://github.com/rest-client/rest-client/issues/406)
+has already been filed for this.  To work around this, please lock the rest-client version 
+to 1.7 until the issue is fixed.
+
+
 ## Wrong ruby version
 
-Ruby 1.8.7 or higher is required.
+* As of right\_api\_client gem version 1.6, only Ruby 2.0 or higher is supported.
+* right\_api\_client version 1.5.28 was tested with ruby 1.9, but it no longer supported.
 
 ## 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.28
+1.6.0

data/lib/right_api_client/client.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'set'
 require 'cgi'
 require 'base64'
+require 'rbconfig'
 
 require File.expand_path('../version', __FILE__) unless defined?(RightApi::Client::VERSION)
 require File.expand_path('../helper', __FILE__)
@@ -74,6 +75,7 @@ module RightApi
       account_id api_url api_version
       timeout open_timeout max_attempts
       enable_retry rest_client_class
+      rl10
     ]
 
     # @return [String] OAuth 2.0 refresh token if provided
@@ -128,6 +130,19 @@ module RightApi
 
       raise 'This API client is only compatible with the RightScale API 1.5 and upwards.' if (Float(@api_version) < 1.5)
 
+      # If rl10 parameter was passed true, read secrets file to set @local_token, and @api_url
+      if @rl10
+        case RbConfig::CONFIG['host_os']
+        when /mswin|mingw|cygwin/
+          local_secret_file = File.join(ENV['ProgramData'] || 'C:/ProgramData', 'RightScale/RightLink/secret')
+        else
+          local_secret_file = '/var/run/rightlink/secret'
+        end
+        local_auth_info = Hash[File.readlines(local_secret_file).map{ |line| line.chomp.split('=', 2) }]
+        @local_token = local_auth_info['RS_RLL_SECRET']
+        @api_url = "http://localhost:#{local_auth_info['RS_RLL_PORT']}"
+      end
+
       # 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, :ssl_version => @ssl_version)
@@ -147,7 +162,7 @@ module RightApi
       timestamp_cookies
 
       # Add the top level links for instance_facing_calls
-      if @instance_token
+      if @instance_token || @local_token
         resource_type, path, data = self.do_get(ROOT_INSTANCE_RESOURCE)
         instance_href = get_href_from_links(data['links'])
         cloud_href = instance_href.split('/instances')[0]
@@ -316,6 +331,10 @@ module RightApi
         h[:cookies] = @cookies
       end
 
+      if @local_token
+        h['X-RLL-Secret'] = @local_token
+      end
+
       h
     end
 
@@ -523,7 +542,11 @@ module RightApi
     #
     # @return [Boolean] true if re-login is known to be required
     def need_login?
-      if @access_token
+      # @local_token is the key to use the local proxy.  Connecting using this key
+      # and the local proxy does not require login.
+      if @local_token
+        false
+      elsif @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

metadata

@@ -1,113 +1,132 @@
 --- !ruby/object:Gem::Specification
 name: right_api_client
 version: !ruby/object:Gem::Version
-  version: 1.5.28
-  prerelease: 
+  version: 1.6.0
 platform: ruby
 authors:
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &15775520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *15775520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &15774740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *15774740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &15774060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *15774060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15773220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *15773220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15772120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *15772120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &15787100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *15787100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: &15786180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15786180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &15785100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15785100
-description: ! '
-
-  The right_api_client gem simplifies the use of RightScale''s MultiCloud API.
+  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.
   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: []
@@ -138,29 +157,25 @@ files:
 homepage: https://github.com/rightscale/right_api_client
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -65157902423218437
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RightScale MultiCloud API HTTP Client
 test_files: []