right_api_client 1.5.12 → 1.5.13

data/.gitignore

@@ -7,6 +7,7 @@ nbproject
 .bundle
 .idea
 .idea/*
+.ruby-version
 coverage/*
 doc/*
 *~

data/CHANGELOG.md

@@ -1,43 +1,52 @@
-= right_api_client - CHANGELOG.md
-
-== right_api_client - 1.5.11
-#33 fix specs and readme
-#32 fix nested array of hashes params
-#30 README markdown formatting
-#29 rename read me and add mandatory ownership string
-
-== right_api_client - 1.5.10
-#28 Preserve the last request made and make it accessible
-#26 Fix specs. Separate out unit tests and functional tests.
-#25 Add support for other RightScale endpoints.
-#23 Fix child_account update href.
-#20 Always store the latest cookies. Also includes a jump from rspec 1.3.0 to 2.9.0 and spec infrastructure reorganization.
-
-== right_api_client - 1.5.9
-Downgrade even further to Ruby 1.8.7. Should still work in Ruby 1.9.x.
-
-== right_api_client - 1.5.8
-Fix invalid gemspec by downgrading to Ruby 1.9.2 when building gem.
-
-== right_api_client - 1.5.7
-Enforce Ruby 1.9 interpreter.
-Remove the default 60 second timeout on requests.
-
-== right_api_client - 1.5.6
-Remove unused constant. Fix license and read me.
-Refs #11682 - allow all methods on resource classes and post them to rightapi.
-
-== right_api_client - 1.5.5
-Fix crash on audit_entry.detail.show (text and not JSON).
-
-== right_api_client - 1.5.4
-Fix singular for audit_entries resources. Update rest-client gem version to 1.6.7.
-
-== right_api_client - 1.5.3
-Add support for audit_entries resources. Update RConf ruby version to ruby-1.9.2-p290.
-
-== right_api_client - 1.5.2
-Fix issues with client when using Ruby 1.8.7 (note that right_api_client has not been fully tested with 1.8.7 yet).
-
-== right_api_client - 1.5.1
-Initial public release, supports all of the calls in RightScale API 1.5.
+# CHANGELOG.md
+## 1.5.13
+- \#44 Charcoal 13 18 account id in header acu103549
+- \#42 Salmon 13 17 acu135785 add current url
+- \#41 Add '/index.html' to the api ref url due to 404
+- \#39 acu119168 fix markup
+- \#37 acu111022 fix readme ownership string
+
+## 1.5.12
+- \#35 acu104862 remove activesupport dependency and replace inflector
+
+## 1.5.11
+- \#33 fix specs and readme
+- \#32 fix nested array of hashes params
+- \#30 README markdown formatting
+- \#29 rename read me and add mandatory ownership string
+
+## 1.5.10
+- \#28 Preserve the last request made and make it accessible
+- \#26 Fix specs. Separate out unit tests and functional tests.
+- \#25 Add support for other RightScale endpoints.
+- \#23 Fix child_account update href.
+- \#20 Always store the latest cookies. Also includes a jump from rspec 1.3.0 to 2.9.0 and spec infrastructure reorganization.
+
+## 1.5.9
+- Downgrade even further to Ruby 1.8.7. Should still work in Ruby 1.9.x.
+
+## 1.5.8
+- Fix invalid gemspec by downgrading to Ruby 1.9.2 when building gem.
+
+## 1.5.7
+- Enforce Ruby 1.9 interpreter.
+- Remove the default 60 second timeout on requests.
+
+## 1.5.6
+- Remove unused constant. Fix license and read me.
+- Refs #11682 - allow all methods on resource classes and post them to rightapi.
+
+## 1.5.5
+- Fix crash on audit_entry.detail.show (text and not JSON).
+
+## 1.5.4
+- Fix singular for audit_entries resources. Update rest-client gem version to 1.6.7.
+
+## 1.5.3
+- Add support for audit_entries resources. Update RConf ruby version to ruby-1.9.2-p290.
+
+## 1.5.2
+- Fix issues with client when using Ruby 1.8.7 (note that right_api_client has not been fully tested with 1.8.7 yet).
+
+## 1.5.1
+- Initial public release, supports all of the calls in RightScale API 1.5.

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    right_api_client (1.5.13)
+      json
+      rest-client (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    flexmock (0.8.7)
+    json (1.8.1)
+    mime-types (1.24)
+    rake (0.8.7)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  flexmock (= 0.8.7)
+  rake (= 0.8.7)
+  right_api_client!
+  rspec (= 2.9.0)
+  simplecov (= 0.4.2)

data/README.md

@@ -6,9 +6,9 @@ in making HTTP calls and translating their responses.
 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
+  - API Reference Docs: http://reference.rightscale.com/api1.5/index.html
 
-Maintained by the RightScale "Yellow_team" 
+Maintained by the RightScale Salmon team
 
 ## Installation
 Ruby 1.8.7 or higher is required.
@@ -41,15 +41,41 @@ and treat every resource in the paths as objects that can call other objects usi
 
 Examples:
 
-   - Index:     /api/clouds/:cloud_id/datacenters             =>  @client.clouds(:id => :cloud_id).show.datacenters.index
-   - Show:      /api/clouds/:cloud_id/datacenters/:id         =>  @client.clouds(:id => :cloud_id).show.datacenters(:id => :datacenter_id).show
-   - Create:    /api/deployments/:deployment_id/servers       =>  @client.deployments(:id => :deployment_id).show.servers.create
-   - Update:    /api/deployments/:deployment_id/servers/:id   =>  @client.deployments(:id => :deployment_id).show.servers(:id => :server_id).update
-   - Destroy:   /api/deployments/:deployment_id/servers/:id   =>  @client.deployments(:id => :deployment_id).show.servers(:id => :server_id).destroy
-   - An action: /api/servers/:server_id/launch                =>  @client.servers(:id => :server_id).show.launch
+    # Index datacenters: GET /api/clouds/:cloud_id/datacenters
+    @client.clouds(:id => 1).show.datacenters.index
+   
+    # Show server: GET /api/clouds/:cloud_id/datacenters/:id
+    @client.clouds(:id => 1).show.datacenters(:id => 2).show
+   
+    # Create server: POST /api/deployments/:deployment_id/servers
+    @client.deployments(:id => 3).show.servers.create
+   
+    # Update server: PUT /api/deployments/:deployment_id/servers/:id
+    @client.deployments(:id => 3).show.servers(:id => 4).update
+   
+    # Destroy server: DELETE /api/deployments/:deployment_id/servers/:id
+    @client.deployments(:id => 3).show.servers(:id => 4).destroy
+   
+    # A non-CRUD action: POST /api/servers/:server_id/launch
+    @client.servers(:id => 4).show.launch
 
 As seen above, whenever you need to chain methods, you must call .show before specifying the next method.
 
+### Last HTTP Request
+
+You can inspect all the information about the last HTTP request, including its response.
+For more info: https://github.com/rest-client/rest-client
+
+Examples:
+
+    deployments = @client.deployments.index
+    last_request = @client.last_request[:request]
+    last_url = last_request.url
+    last_method = last_request.method
+    last_response = @client.last_request[:response]
+    last_code = last_response.code
+    last_headers = last_request.headers
+
 ### Parameters
 Pass-in parameters to the method that they belong to. Lets say you want to filter on the index for deployments:
 
@@ -58,15 +84,39 @@ Pass-in parameters to the method that they belong to. Lets say you want to filte
 The filter is the parameter for the index call and not the deployment call.
 
 ### Logging HTTP Requests
-The HTTP calls made by right\_api\_client can be logged in two ways:
-1. Log to a file
+The HTTP calls made by right\_api\_client can be logged in two ways.
+
+Log to a file:
 
     @client.log('~/right_api_client.log')
 
-2. Log to STDOUT
+Log to STDOUT:
 
     @client.log(STDOUT)
 
+### Managing multiple accounts
+Multiple accounts can be managed by using the api\_url and account\_id attributes on the client.
+
+The api\_url attribute allows users to modify the shard which the client is being used to connect to.
+This should not be required as the client will find the correct shard using the account id but is
+included for completeness.
+
+Example:
+
+    @client.api_url # https://my.rightscale.com
+    @client.api_url = 'https://us-3.rightscale.com' # Update the client to make requests to shard 3
+
+The account\_id switches which account is being managed by the client. This allows a user with
+multiple accounts to perform actions whilst only having to authenticate once. This defaults to the
+account which was used to create the client.
+
+Example:
+
+    @client.account_id = 1
+    @client.users.index.count # The number of users in account with id 1
+    @client.account_id = 2
+    @client.users.index.count # The number of users in account with id 2
+
 ## Examples
 Get a list of all servers (aka doing an Index call)
 

data/lib/right_api_client/client.rb

@@ -27,6 +27,7 @@ module RightApi
     ]
 
     attr_reader :cookies, :instance_token, :last_request
+    attr_accessor :account_id, :api_url
 
     def initialize(args)
 
@@ -141,7 +142,7 @@ module RightApi
 
     # Returns the request headers
     def headers
-      {'X_API_VERSION' => @api_version, :cookies => @cookies, :accept => :json}
+      {'X_API_VERSION' => @api_version, 'X_ACCOUNT' => @account_id, :cookies => @cookies, :accept => :json}
     end
 
     def update_last_request(request, response)
@@ -244,6 +245,9 @@ module RightApi
             else
               response.return!(request, result)
             end
+          when 301, 302
+            update_api_url(response)
+            do_post(path, params)
           when 404
             raise UnknownRouteError.new(request, response)
           else
@@ -280,6 +284,9 @@ module RightApi
           when 200
           when 204
             nil
+          when 301, 302
+            update_api_url(response)
+            do_delete(path, params)
           when 404
             raise UnknownRouteError.new(request, response)
           else
@@ -313,6 +320,9 @@ module RightApi
           case response.code
           when 204
             nil
+          when 301, 302
+            update_api_url(response)
+            do_put(path, params)
           when 404
             raise UnknownRouteError.new(request, response)
           else

data/lib/right_api_client/version.rb

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

data/right_api_client.rconf

@@ -1,10 +1,9 @@
 ruby do
   version  'ree-1.8.7-2012.02'
-  rubygems '1.8.17'
   gemset   'right_api_client'
 end
 bundler do
-  version     '1.0.21'
+  version     '1.3.5'
   exclusions  'deployment'
   bundle_path File.join(ENV["HOME"], '.rightscale_bundle', 'right_api_client')
 end

data/spec/functional/client_spec.rb

@@ -58,29 +58,45 @@ describe RightApi::Client do
     end
 
     it "sends post/get/put/delete requests to the server correctly" do
-      new_deployment = @client.deployments.create(:deployment => {:name => 'test'})
-      new_deployment2 = @client.deployments.create(:deployment => {:name => 'test2'})
+      deployment_name = "right_api_client functional test #{Time.now.to_s}"
+      # create a new deployment
+      new_deployment = @client.deployments.create(:deployment => {:name => deployment_name})
       new_deployment.class.should     == RightApi::Resource
-      new_deployment.show.name.should == 'test'
+      new_deployment.show.name.should == deployment_name
 
+      # verify new deployment
       deployment = @client.deployments(:id => new_deployment.show.href.split('/').last)
       deployment.class.should      == RightApi::Resource
       deployment.show.class.should == RightApi::ResourceDetail
       deployment.show.href.should  == new_deployment.show.href
 
-      deployment.update(:deployment => {:name => 'test2'}).should be_nil
-      deployment.show.name.should == 'test2'
+      # update deployment
+      deployment.update(:deployment => {:name => "#{deployment_name} updated"}).should be_nil
+      deployment.show.name.should == "#{deployment_name} updated"
 
-      # Tags are a bit special as they use POST and return content type so they need specific tests
-      @client.tags.multi_add("resource_hrefs[]=#{deployment.show.href}&resource_hrefs[]=#{new_deployment2.show.href}&tags[]=tag1").should == nil
-      tags = @client.tags.by_resource("resource_hrefs[]=#{deployment.show.href}&resource_hrefs[]=#{new_deployment2.show.href}")
+      # delete deployment
+      deployment.destroy.should be_nil
+    end
+
+    # Tags are a bit special as they use POST and return content type so they need specific tests
+    it "adds tag to deployment" do
+      deployment_name = "right_api_client functional test #{Time.now.to_s}"
+
+      # create a new deployment
+      new_deployment = @client.deployments.create(:deployment => {:name => deployment_name})
+
+      # add a tag to deployment
+      @client.tags.multi_add("resource_hrefs[]=#{new_deployment.show.href}&tags[]=tag1").should == nil
+
+      # verify tag
+      tags = @client.tags.by_resource("resource_hrefs[]=#{new_deployment.show.href}")
       tags.class.should == Array
       tags.first.class.should == RightApi::ResourceDetail
       tags.first.tags.first.should == {"name" => "tag1"}
-      tags.first.resource.first.show.name.should == 'test2'
+      tags.first.resource.show.name.should == deployment_name
 
-      deployment.destroy.should be_nil
-      new_deployment2.destroy.should be_nil
+      # delete deployment
+      new_deployment.destroy.should be_nil
     end
 
     it "singularizes resource_types correctly" do

data/spec/support/mock_spec_helper.rb

@@ -1,12 +1,12 @@
-
 module MockSpecHelper
 
   def mock_rest_client
     @api_version = RightApi::Client::API_VERSION
+    @test_account_id = '1'
     @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, :cookies => {}, :accept => :json}
+    @header = {'X_API_VERSION' => @api_version, 'X_ACCOUNT' => @test_account_id, :cookies => {}, :accept => :json}
   end
 
   def given_user_facing_client
@@ -15,7 +15,7 @@ module MockSpecHelper
         {'email' => 'email', 'password' => 'password', 'account_href' => '/api/accounts/1'},
         {'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 => '1')
+    @client = RightApi::Client.new(:email => 'email', :password => 'password', :account_id => @test_account_id)
   end
 
   def given_instance_facing_client
@@ -28,7 +28,7 @@ module MockSpecHelper
           "href": "/api/clouds/1/instances/1",
           "rel": "self"
         }]}'])
-    @client = RightApi::Client.new(:instance_token => 'instance_token', :account_id => '1')
+    @client = RightApi::Client.new(:instance_token => 'instance_token', :account_id => @test_account_id)
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_api_client
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 5
-  - 12
-  version: 1.5.12
+  - 13
+  version: 1.5.13
 platform: ruby
 authors: 
 - RightScale, Inc.
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-09 00:00:00 -04:00
-default_executable: 
+date: 2013-12-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
-  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +28,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :runtime
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: rest-client
-  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +43,11 @@ dependencies:
         - 1
         - 6
         version: "1.6"
+  prerelease: false
   type: :runtime
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,11 +59,11 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
+  prerelease: false
   type: :development
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -77,11 +75,11 @@ dependencies:
         - 9
         - 0
         version: 2.9.0
+  prerelease: false
   type: :development
   requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: flexmock
-  prerelease: false
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -93,11 +91,11 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
+  prerelease: false
   type: :development
   requirement: *id005
 - !ruby/object:Gem::Dependency 
   name: simplecov
-  prerelease: false
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -109,11 +107,11 @@ dependencies:
         - 4
         - 2
         version: 0.4.2
+  prerelease: false
   type: :development
   requirement: *id006
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -123,6 +121,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :development
   requirement: *id007
 description: "\n\
@@ -141,6 +140,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -165,7 +165,6 @@ files:
 - spec/unit/resource_detail_spec.rb
 - spec/unit/resource_spec.rb
 - spec/unit/resources_spec.rb
-has_rdoc: true
 homepage: https://github.com/rightscale/right_api_client
 licenses: []
 
@@ -195,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.28
 signing_key: 
 specification_version: 3
 summary: RightScale MultiCloud API HTTP Client