right_api_client 1.5.15 → 1.5.16

checksums.yaml

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

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--format=nested
+--backtrace
+--debugger

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG.md
 
+## 1.5.16
+- \#57 Sapphire added optional support for querying a (detailed) resource with params, example: client.resource(href, :view => 'full')
+
 ## 1.5.15
 - \#50 Ivory 14 02 acu148161 Harden client against spotty networks
 

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+gem 'ruby-debug',
+    :platforms => [:ruby_18]
+gem 'debugger',
+    :platforms => [:ruby_19, :ruby_20, :ruby_21]

data/Gemfile.lock

@@ -1,18 +1,29 @@
 PATH
   remote: .
   specs:
-    right_api_client (1.5.15)
-      json
+    right_api_client (1.5.16)
+      json (~> 1.0)
+      mime-types (~> 1.0)
       rest-client (~> 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    columnize (0.3.6)
+    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)
     flexmock (0.8.7)
     json (1.8.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
     mime-types (1.25.1)
     rake (0.8.7)
+    rbx-require-relative (0.0.9)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.9.0)
@@ -23,6 +34,11 @@ 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.4.2)
       simplecov-html (~> 0.4.4)
     simplecov-html (0.4.5)
@@ -31,9 +47,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (~> 1.0)
+  debugger
   flexmock (= 0.8.7)
   rake (= 0.8.7)
   right_api_client!
   rspec (= 2.9.0)
+  ruby-debug
   simplecov (= 0.4.2)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 RightScale, Inc.
+Copyright (c) 2009-2014 RightScale, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/config/login.yml.example

@@ -6,7 +6,7 @@
 # The account number is at the end of the browser address bar.
 :account_id: my_account_id
 
-# There are four login mechanisms:
+# There are five login mechanisms:
 
 # 0. Use the following parameters to login with your email and base64-encoded password:
 # To encode your plaintext password, use 'base64' command or similar.
@@ -22,9 +22,14 @@
 # User Data box, you will see RS_API_TOKEN = your_account_id:the_instance_token
 :instance_token: my_instance_token
 
-# 3. Use the following parameter to login with pre-authenticated cookies:
+# 3. Use the following parameter to send a pre-authenticated cookie with every request:
 :cookies: my_cookie_string
 
+# 4. Use the following parameter to send an existing OAuth access token with every request:
+# To learn more about OAuth and how to obtain an access token, see
+# http://support.rightscale.com/12-Guides/03-Rightscale_API/OAuth
+:access_token: my_token_string
+
 # The following are optional parameters:
 :api_url: (this defaults to https://my.rightscale.com)
 :api_version: (this defaults to 1.5)

data/lib/right_api_client/client.rb

@@ -27,10 +27,10 @@ module RightApi
     # permitted parameters for initializing
     AUTH_PARAMS = %w[
       email password_base64 password account_id api_url api_version
-      cookies instance_token timeout open_timeout max_attempts enable_retry
+      cookies instance_token access_token timeout open_timeout max_attempts enable_retry
     ]
 
-    attr_reader :cookies, :instance_token, :last_request, :timeout, :open_timeout, :max_attempts, :enable_retry
+    attr_reader :cookies, :instance_token, :access_token, :last_request, :timeout, :open_timeout, :max_attempts, :enable_retry
     attr_accessor :account_id, :api_url
 
     def initialize(args)
@@ -51,10 +51,15 @@ module RightApi
       @rest_client = RestClient::Resource.new(@api_url, :open_timeout => @open_timeout, :timeout => @timeout)
       @last_request = {}
 
-      # There are three options for login: credentials, instance token,
-      # or if the user already has the cookies they can just use those.
+      # There are four options for login:
+      #  - credentials
+      #  - instance API token
+      #  - existing user-supplied cookies
+      #  - existing user-supplied OAuth access token
+      #
+      # 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
+      login() unless @cookies || @access_token
 
       timestamp_cookies
 
@@ -104,9 +109,9 @@ module RightApi
 
     # Given a path returns a RightApiClient::Resource instance.
     #
-    def resource(path)
+    def resource(path, params={})
 
-      r = Resource.process(self, *do_get(path))
+      r = Resource.process(self, *do_get(path, params))
 
       r.respond_to?(:show) ? r.show : r
     end
@@ -175,7 +180,7 @@ module RightApi
       response = nil
       attempts = 0
       begin
-        response = @rest_client[path].post(params, 'X_API_VERSION' => @api_version) do |response, request, result, &block|
+        response = @rest_client[path].post(params, 'X-Api-Version' => @api_version) do |response, request, result, &block|
           if response.code == 302
             update_api_url(response)
             response.follow_redirection(request, result, &block)
@@ -195,7 +200,19 @@ module RightApi
 
     # Returns the request headers
     def headers
-      {'X_API_VERSION' => @api_version, 'X_ACCOUNT' => @account_id, :cookies => @cookies, :accept => :json}
+      h = {
+        'X-Api-Version' => @api_version,
+        'X-Account' => @account_id,
+        :accept => :json,
+      }
+
+      if @access_token
+        h['Authorization'] = "Bearer #{@access_token}"
+      elsif @cookies
+        h[:cookies] = @cookies
+      end
+
+      h
     end
 
     def update_last_request(request, response)
@@ -373,6 +390,9 @@ module RightApi
     end
 
     def re_login?(e)
+      # cannot successfully re-login with only an access token; we want the
+      # expiration error to be raised.
+      return false if @access_token
       e.message.index('403') && e.message =~ %r(.*Session cookie is expired or invalid)
     end
 

data/lib/right_api_client/resource.rb

@@ -3,7 +3,7 @@ module RightApi
   # This class dynamically adds methods and properties to instances depending on what type of resource they are.
   class Resource
     include Helper
-    attr_reader :client, :href
+    attr_reader :client, :href, :resource_type
 
     # Will create a (or an array of) new Resource object(s)
     # All parameters are treated as read only

data/lib/right_api_client/resource_detail.rb

@@ -77,7 +77,10 @@ module RightApi
                 # future we might like to extract resource_type from child_href
                 # and not hard-code it.
                 if child_href.index('instance')
-                  define_instance_method(k) { RightApi::Resource.process(client, 'instance', child_href, v) }
+                  define_instance_method(k) do |*args|
+                    path = add_id_and_params_to_path(child_href, *args)
+                    RightApi::Resource.process(client, 'instance', path, v)
+                  end
                 end
               end
             end

data/lib/right_api_client/resources.rb

@@ -6,7 +6,7 @@ module RightApi
   class Resources
     include Helper
 
-    attr_reader :client, :path
+    attr_reader :client, :path, :resource_type
     def inspect
       "#<#{self.class.name} " +
       "resource_type=\"#{@resource_type}\">"

data/lib/right_api_client/version.rb

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

data/right_api_client.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.email            = [ 'rubygems@rightscale.com' ]
   s.homepage         = 'https://github.com/rightscale/right_api_client'
   s.summary          = 'RightScale MultiCloud API HTTP Client'
+  s.license          = 'MIT'
   s.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
@@ -19,12 +20,13 @@ fine details involved in making HTTP calls and translating their responses.
   s.test_files       = `git ls-files spec config`.split(' ')
   s.rubygems_version = '1.3.7'
 
-  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'json',             '~> 1.0'
+  s.add_runtime_dependency 'mime-types',       '~> 1.0'
   s.add_runtime_dependency 'rest-client',      '~> 1.6'
 
   s.add_development_dependency 'rake',         '0.8.7'
   s.add_development_dependency 'rspec',        '2.9.0'
   s.add_development_dependency 'flexmock',     '0.8.7'
   s.add_development_dependency 'simplecov',    '0.4.2'
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'bundler',      '~> 1.0'
 end

data/right_api_client.rconf

@@ -3,7 +3,7 @@ ruby do
   gemset   'right_api_client'
 end
 bundler do
-  version     '1.3.5'
+  version     '1.5.3'
   exclusions  'deployment'
   bundle_path File.join(ENV["HOME"], '.rightscale_bundle', 'right_api_client')
 end

data/spec/functional/client_spec.rb

@@ -13,6 +13,9 @@ describe RightApi::Client do
         puts e.message
         puts e.backtrace
       end
+
+      # Don't bother to run tests if the client didn't initialize
+      @client.should_not be_nil
     end
 
     it "logs in" do
@@ -37,6 +40,20 @@ describe RightApi::Client do
       client1.cookies.should == @client.cookies
     end
 
+    it "accepts an access_token argument when creating a new client" do
+      my_hash = YAML.load_file(File.expand_path(@creds, __FILE__))
+      my_hash.delete(:email)
+      my_hash.delete(:password)
+      my_hash.delete(:cookies)
+
+      access_token = @client.cookies.detect { |k, _| k =~ /^rs_gbl/ }.last
+      access_token.should_not be_nil
+      my_hash[:access_token] = access_token
+
+      client1 = RightApi::Client.new(my_hash)
+      client1.access_token.should == access_token
+    end
+
     it "timestamps cookies" do
 
       @client.cookies.timestamp.should_not == nil

data/spec/support/mock_spec_helper.rb

@@ -6,14 +6,14 @@ module MockSpecHelper
     @rest_client = RestClient::Resource.new(RightApi::Client::DEFAULT_API_URL)
     flexmock(RestClient::Resource).should_receive(:new).and_return(@rest_client)
     @session = flexmock(:cookies => {})
-    @header = {'X_API_VERSION' => @api_version, 'X_ACCOUNT' => @test_account_id, :cookies => {}, :accept => :json}
+    @header = {'X-Api-Version' => @api_version, 'X-Account' => @test_account_id, :cookies => {}, :accept => :json}
   end
 
   def given_user_facing_client
     mock_rest_client
     flexmock(@rest_client).should_receive(:post).with(
         {'email' => 'email', 'password' => 'password', 'account_href' => '/api/accounts/1'},
-        {'X_API_VERSION' => @api_version}, Proc).and_return(@session)
+        {'X-Api-Version' => @api_version}, Proc).and_return(@session)
     flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{}'])
     @client = RightApi::Client.new(:email => 'email', :password => 'password', :account_id => @test_account_id)
   end
@@ -22,7 +22,7 @@ module MockSpecHelper
     mock_rest_client
     flexmock(@rest_client).should_receive(:post).with(
         {'instance_token' => 'instance_token', 'account_href' => '/api/accounts/1'},
-        {'X_API_VERSION' => @api_version}, Proc).and_return(@session)
+        {'X-Api-Version' => @api_version}, Proc).and_return(@session)
     flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{"links": [
         {
           "href": "/api/clouds/1/instances/1",

metadata

@@ -1,143 +1,139 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: right_api_client
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 1
-  - 5
-  - 15
-  version: 1.5.15
+version: !ruby/object:Gem::Version
+  version: 1.5.16
 platform: ruby
-authors: 
+authors:
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-01-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  version_requirements: *id001
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
+  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'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: rest-client
-  version_requirements: *id002
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  name: rake
-  version_requirements: *id003
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  name: rspec
-  version_requirements: *id004
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  name: flexmock
-  version_requirements: *id005
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 4
-        - 2
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.4.2
   type: :development
-  name: simplecov
-  version_requirements: *id006
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: *id007
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
   prerelease: false
-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: 
+  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:
 - rubygems@rightscale.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -167,39 +163,30 @@ 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 
-  none: false
-  requirements: 
+required_ruby_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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.28
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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