right_api_client 1.5.9 → 1.5.12

data/spec/spec_helper.rb

@@ -1,42 +1,24 @@
-require 'simplecov'
-SimpleCov.start if ENV["COVERAGE"]
-require File.expand_path('../../lib/right_api_client', __FILE__)
-require 'spec'
+
 require 'pp'
 require 'yaml'
 
-Spec::Runner.configure do |config|
-  config.mock_with :flexmock
-end
+require File.expand_path('../../lib/right_api_client', __FILE__)
 
-module MockSpecHelper
-  def mock_rest_client
-    @api_version = RightApi::Client::API_VERSION
-    @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}
-  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)
-    flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{}'])
-    @client = RightApi::Client.new(:email => 'email', :password => 'password', :account_id => '1')
-  end
+RSpec.configure do |config|
 
-  def given_instance_facing_client
-    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)
-    flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{"links": [
-        {
-          "href": "/api/clouds/1/instances/1",
-          "rel": "self"
-        }]}'])
-    @client = RightApi::Client.new(:instance_token => 'instance_token', :account_id => '1')
+  #
+  # include helpers
+
+  $config = config
+
+  Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |path|
+    require(path)
   end
+
+  #
+  # misc
+
+  config.mock_with :flexmock
 end
+

data/spec/support/mock_spec_helper.rb

@@ -0,0 +1,36 @@
+
+module MockSpecHelper
+
+  def mock_rest_client
+    @api_version = RightApi::Client::API_VERSION
+    @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}
+  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)
+    flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{}'])
+    @client = RightApi::Client.new(:email => 'email', :password => 'password', :account_id => '1')
+  end
+
+  def given_instance_facing_client
+    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)
+    flexmock(@rest_client).should_receive(:get).with(@header, Proc).and_return(['', '{"links": [
+        {
+          "href": "/api/clouds/1/instances/1",
+          "rel": "self"
+        }]}'])
+    @client = RightApi::Client.new(:instance_token => 'instance_token', :account_id => '1')
+  end
+end
+
+$config.include MockSpecHelper
+

data/spec/unit/helper_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path('../../spec_helper', __FILE__)
+include RightApi::Helper
+
+describe RightApi::Helper do
+
+  API_MEDIA_TYPES = %w{audit_entry ip_address process server}
+
+  context "#is_singular?" do
+    API_MEDIA_TYPES.each do |media_type|
+      it "should identify media type #{media_type} as singular" do
+        is_singular?(media_type).should == true
+      end
+    end
+  end
+
+  context "#fix_array_of_hashes" do
+    it "fixes all the keys that have the value as array of hashes" do
+      res = fix_array_of_hashes(
+          'a' => '1',
+          'b' => [1, 2, 3],
+          'c' => {1 => 2, 3 => 4},
+          'd' => [
+              {5 => 6, 7 => 8},
+              {9 => 10, 11 => 12}
+          ]
+      )
+
+      res.should == {
+          'a' => '1',
+          'b' => [1, 2, 3],
+          'c' => {1 => 2, 3 => 4},
+          'd[]' => [
+              {5 => 6, 7 => 8},
+              {9 => 10, 11 => 12}
+          ]
+      }
+
+    end
+
+    it "fixes key that have a top-level array of hashes as value" do
+      res = fix_array_of_hashes(
+          'a' => [
+              {1 => 2},
+              {3 => 4}
+          ]
+      )
+
+      res.should == {
+          'a[]' => [
+              {1 => 2},
+              {3 => 4}
+          ]
+      }
+    end
+
+    it "fixes key that have a nested array of hashes as value" do
+      res = fix_array_of_hashes(
+          'a' => {
+              'b' => [
+                  {1 => 2},
+                  {3 => 4}
+              ]
+          }
+      )
+
+      res.should == {
+          'a' => {
+              'b' => {
+                  '' => [
+                      {1 => 2},
+                      {3 => 4}
+                  ]
+              }
+          }
+      }
+    end
+  end
+end

data/spec/{instance_facing_spec.rb → unit/instance_facing_spec.rb}

@@ -1,25 +1,24 @@
-require File.expand_path('../spec_helper', __FILE__)
-include MockSpecHelper
+require File.expand_path('../../spec_helper', __FILE__)
 
 describe RightApi::Client do
-  context "Given an instance-facing logged in RightScale user" do
+  context "given an instance-facing logged in RightScale user" do
     before(:each) do
       given_instance_facing_client
     end
 
-    it "Should have the required methods for the client" do
+    it "has the required methods for the client" do
       @client.api_methods.sort.collect{|s| s.to_s}.should == ["backups", "get_instance", "live_tasks", "volume_attachments", "volume_snapshots", "volume_types", "volumes"]
     end
 
-    it "Should return an instance of the Resource class when user provides an id" do
+    it "returns an instance of the Resource class when user provides an id" do
       @client.volumes(:id => 1).class.should    == RightApi::Resource
       @client.backups(:id => 1).class.should    == RightApi::Resource
       @client.live_tasks(:id => 1).class.should == RightApi::Resource
     end
 
-    it "Should return an instance of the Resources class when user does not provide an id" do
+    it "returns an instance of the Resources class when user does not provide an id" do
       @client.volumes.class.should == RightApi::Resources
       @client.backups.class.should == RightApi::Resources
     end
   end
-end
+end

data/spec/{resource_detail_spec.rb → unit/resource_detail_spec.rb}

@@ -1,31 +1,30 @@
-require File.expand_path('../spec_helper', __FILE__)
-include MockSpecHelper
+require File.expand_path('../../spec_helper', __FILE__)
 
 describe RightApi::ResourceDetail do
-  context "Given a logged in RightScale user" do
+  context "given a logged in RightScale user" do
     before(:each) do
       given_user_facing_client
     end
 
-    it "Should have the required methods for instances of the ResourceDetail class" do
+    it "has the required methods for instances of the ResourceDetail class" do
       resource = RightApi::ResourceDetail.new(@client, 'deployment', '/api/deployments/1', {})
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["destroy", "links", "show", "update"]
     end
 
-    it "Should have resource-specific methods for instances of the ResourceDetail class" do
+    it "has resource-specific methods for instances of the ResourceDetail class" do
       resource = RightApi::ResourceDetail.new(@client, 'deployment', '/api/deployments/1',
                                               {:attribute1 => 'value1', :attribute2 => 'value2'})
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["attribute1", "attribute2", "destroy", "links", "show", "update"]
     end
 
-    it "Should have the links for instances of the ResourceDetail class" do
+    it "has the links for instances of the ResourceDetail class" do
       resource = RightApi::ResourceDetail.new(@client, 'deployment', '/api/deployments/1',
                                               {'links' => [{'rel' => 'link1', 'href' => 'link1_href'},
                                                            {'rel' => 'link2', 'href' => 'link2_href'}]})
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["destroy", "link1", "link2", "links", "show", "update"]
     end
 
-    it "Should have the actions for instances of the ResourceDetail class" do
+    it "has the actions for instances of the ResourceDetail class" do
       resource = RightApi::ResourceDetail.new(@client, 'deployment', '/api/deployments/1',
                                               {'links' => [{'rel' => 'self', 'href' => 'self'}],
                                                'actions' => [{'rel' => 'action1'}, {'rel' => 'action2'}]})
@@ -35,14 +34,14 @@ describe RightApi::ResourceDetail do
       resource.action1.should == 'ok'
     end
 
-    it "Should have live_tasks for the 'instance' resource" do
+    it "has live_tasks for the 'instance' resource" do
       resource = RightApi::ResourceDetail.new(@client, 'instance', '/api/instances/1', {})
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["destroy", "links", "live_tasks", "show", "update"]
       flexmock(RightApi::Resource).should_receive(:process).with(@client, 'live_task', '/api/instances/1/live/tasks/1').and_return('ok')
       resource.live_tasks(:id => '1').should == 'ok'
     end
 
-    it "Should add methods for child resources from detailed views" do
+    it "adds methods for child resources from detailed views" do
       resource = RightApi::ResourceDetail.new(@client, 'server', '/api/servers/1', {
           'links' => [
               {'href' => '/api/servers/1', 'rel' => 'self'},

data/spec/unit/resource_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe RightApi::Resource do
+  context "given a logged in RightScale user" do
+    before(:each) do
+      given_user_facing_client
+    end
+
+    it "has the required methods for instances of the Resource class" do
+      resource = RightApi::Resource.process(@client, 'deployment', '/api/deployments/1')
+      resource.api_methods.sort.map(&:to_s).should == %w[ destroy show update ]
+    end
+
+    it "has destroy/show/update for all instances of the Resource class" do
+      resource = RightApi::Resource.process(@client, 'session', '/api/session')
+      resource.api_methods.sort.map(&:to_s).should == %w[ destroy show update ]
+    end
+
+    it "has an array of ResourceDetail instances for index calls" do
+      resources = RightApi::Resource.process(@client, 'deployment', '/api/deployments', [{}])
+      resources.first.class.should == RightApi::ResourceDetail
+    end
+  end
+end

data/spec/unit/resources_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe RightApi::Resources do
+  context "given a logged in RightScale user" do
+    before(:each) do
+      given_user_facing_client
+    end
+
+    it "has the required methods for instances of the Resources class" do
+      resource = RightApi::Resources.new(@client, '/api/deployments', 'deployments')
+      resource.api_methods.sort.collect(&:to_s).should == %w[
+        create index ]
+    end
+
+    it "has index even for instances of the Resources class that do not support it" do
+      resource = RightApi::Resources.new(@client, '/api/tags', 'tags')
+      resource.api_methods.sort.collect(&:to_s).should == %w[
+        by_resource by_tag create index multi_add multi_delete ]
+    end
+
+    it "has resource-specific methods for instances of the Resources class" do
+      resource = RightApi::Resources.new(@client, '/api/backups', 'backups')
+      resource.api_methods.sort.collect(&:to_s).should == %w[
+        cleanup create index ]
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_api_client
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 1
   - 5
-  - 9
-  version: 1.5.9
+  - 12
+  version: 1.5.12
 platform: ruby
 authors: 
 - RightScale, Inc.
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-09 00:00:00 -08:00
+date: 2013-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,27 +31,26 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
         - 1
         - 6
-        - 7
-        version: 1.6.7
+        version: "1.6"
   type: :runtime
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -63,27 +62,27 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 43
         segments: 
-        - 1
-        - 3
+        - 2
+        - 9
         - 0
-        version: 1.3.0
+        version: 2.9.0
   type: :development
-  version_requirements: *id004
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: flexmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -95,11 +94,11 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  version_requirements: *id005
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   name: simplecov
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -111,11 +110,11 @@ dependencies:
         - 2
         version: 0.4.2
   type: :development
-  version_requirements: *id006
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -125,11 +124,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id007
+  requirement: *id007
 description: "\n\
-  The right_api_client gem simplifies the use of RightScale's MultiCloud API. It provides\n\
-  a simple object model of the API resources, and handles all of the fine details involved\n\
-  in making HTTP calls and translating their responses.\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: []
@@ -140,15 +139,15 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - config/login.yml.example
 - lib/right_api_client.rb
 - lib/right_api_client/client.rb
-- lib/right_api_client/exceptions.rb
+- lib/right_api_client/errors.rb
 - lib/right_api_client/helper.rb
 - lib/right_api_client/resource.rb
 - lib/right_api_client/resource_detail.rb
@@ -157,13 +156,15 @@ files:
 - login_to_client_irb.rb
 - right_api_client.gemspec
 - right_api_client.rconf
-- spec/audit_entries_spec.rb
-- spec/client_spec.rb
-- spec/instance_facing_spec.rb
-- spec/resource_detail_spec.rb
-- spec/resource_spec.rb
-- spec/resources_spec.rb
+- spec/functional/audit_entries_spec.rb
+- spec/functional/client_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_spec_helper.rb
+- spec/unit/helper_spec.rb
+- spec/unit/instance_facing_spec.rb
+- 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: []
@@ -194,16 +195,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: RightScale MultiCloud API HTTP Client
 test_files: 
 - config/login.yml.example
-- spec/audit_entries_spec.rb
-- spec/client_spec.rb
-- spec/instance_facing_spec.rb
-- spec/resource_detail_spec.rb
-- spec/resource_spec.rb
-- spec/resources_spec.rb
+- spec/functional/audit_entries_spec.rb
+- spec/functional/client_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_spec_helper.rb
+- spec/unit/helper_spec.rb
+- spec/unit/instance_facing_spec.rb
+- spec/unit/resource_detail_spec.rb
+- spec/unit/resource_spec.rb
+- spec/unit/resources_spec.rb