right_api_client 1.5.1

data/right_api_client.gemspec

@@ -0,0 +1,31 @@
+require File.expand_path('../lib/right_api_client/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'right_api_client'
+  s.version      = RightApi::Client::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.date         = Time.now.utc.strftime("%Y-%m-%d")
+  s.require_path = 'lib'
+  s.authors      = [ 'Ali Khajeh-Hosseini' ]
+  s.email        = [ 'alikhajeh1@gmail.com' ]
+  s.homepage     = 'https://github.com/rightscale/right_api_client'
+  s.summary      = 'RightScale MultiCloud API HTTP Client'
+  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 fine details involved
+in making HTTP calls and translating their responses.
+  }
+  s.files = `git ls-files`.split(' ')
+  s.test_files = `git ls-files spec config`.split(' ')
+  s.rubygems_version = '1.6.2'
+
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'rest-client',      '1.6.3'
+
+  s.add_development_dependency 'rake',         '0.8.7'
+  s.add_development_dependency 'rspec',        '1.3.0'
+  s.add_development_dependency 'flexmock',     '0.8.7'
+  s.add_development_dependency 'ruby-debug19', '0.11.6'
+  s.add_development_dependency 'simplecov',    '0.4.2'
+  s.add_development_dependency 'bundler'
+end

data/right_api_client.rconf

@@ -0,0 +1,10 @@
+ruby do
+  version  'ruby-1.9.2-p180'
+  rubygems '1.6.2'
+  gemset   'right_api_client'
+end
+bundler do
+  version     '1.0.10'
+  exclusions  'deployment'
+  bundle_path File.join(ENV["HOME"], '.rightscale', 'right_api_client')
+end

data/spec/client_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe RightApi::Client do
+  context "Given a valid set of credentials in the config/login.yml file" do
+    before(:all) do
+      @creds = '../../config/login.yml'
+      begin
+        @client = RightApi::Client.new(YAML.load_file(File.expand_path(@creds, __FILE__)))
+      rescue Exception => e
+        puts "WARNING: The following specs need a valid set of credentials as they are integration tests that can only be done by calling the API server"
+        puts e.message
+      end
+    end
+
+    it "Should login" do
+      @client.headers[:cookies].should_not be_nil
+      @client.session.index.message.should == 'You have successfully logged into the RightScale API.'
+    end
+
+    it "Should return a cookies Hash with a 'domain' and a '_session_id'" do
+      @client.cookies.class.should     == Hash
+      @client.cookies.keys.sort.should == %w[ _session_id domain rs_gbl ]
+    end
+
+    it "Should accept a cookie argument when creating a new client" do
+      client1 = RightApi::Client.new(:cookies => @client.cookies)
+      client2 = RightApi::Client.new(YAML.load_file(File.expand_path(@creds, __FILE__)))
+
+      client1.cookies.should     == @client.cookies
+      client2.cookies.should_not == @client.cookies
+    end
+
+    it "Should send 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'})
+      new_deployment.class.should     == RightApi::Resource
+      new_deployment.show.name.should == 'test'
+
+      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'
+
+      # 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 == ""
+      tags = @client.tags.by_resource("resource_hrefs[]=#{deployment.show.href}&resource_hrefs[]=#{new_deployment2.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'
+
+      deployment.destroy.should be_nil
+      new_deployment2.destroy.should be_nil
+    end
+  end
+end

data/spec/instance_facing_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../spec_helper', __FILE__)
+include MockSpecHelper
+
+describe RightApi::Client 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
+      @client.api_methods.sort.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
+      @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
+      @client.volumes.class.should == RightApi::Resources
+      @client.backups.class.should == RightApi::Resources
+    end
+  end
+end

data/spec/resource_detail_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../spec_helper', __FILE__)
+include MockSpecHelper
+
+describe RightApi::ResourceDetail 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
+      resource = RightApi::ResourceDetail.new(@client, 'deployment', '/api/deployments/1', {})
+      resource.api_methods.sort.should == [:destroy, :links, :show, :update]
+    end
+
+    it "Should not have destroy/show/update for instances of the ResourceDetail class that do not support them" do
+      resource = RightApi::ResourceDetail.new(@client, 'session', '/api/session', {})
+      resource.api_methods.sort.should == [:links]
+    end
+
+    it "Should have 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.should == [:attribute1, :attribute2, :destroy, :links, :show, :update]
+    end
+
+    it "Should have 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.should == [:destroy, :link1, :link2, :links, :show, :update]
+    end
+
+    it "Should have 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'}]})
+      resource.api_methods.sort.should == [:action1, :action2, :destroy, :href, :links, :show, :update]
+
+      flexmock(@rest_client).should_receive(:post).with({}, @header, Proc).and_return('ok')
+      resource.action1.should == 'ok'
+    end
+
+    it "Should have live_tasks for the 'instance' resource" do
+      resource = RightApi::ResourceDetail.new(@client, 'instance', '/api/instances/1', {})
+      resource.api_methods.sort.should == [: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
+      resource = RightApi::ResourceDetail.new(@client, 'server', '/api/servers/1', {
+          'links' => [
+              {'href' => '/api/servers/1', 'rel' => 'self'},
+              {'href' => '/api/clouds/1/instances/1', 'rel' => 'current_instance'}],
+          'current_instance' => {'links' => [{'href' => '/api/clouds/1/instances/1', 'rel' => 'self'}]}})
+      resource.api_methods.sort.should == [:current_instance, :destroy, :href, :links, :show, :update]
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../spec_helper', __FILE__)
+include MockSpecHelper
+
+describe RightApi::Resource 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 Resource class" do
+      resource = RightApi::Resource.process(@client, 'deployment', '/api/deployments/1')
+      resource.api_methods.sort.should == [:destroy, :show, :update]
+    end
+
+    it "Should not have destroy/show/update for instances of the Resource class that do not support them" do
+      resource = RightApi::Resource.process(@client, 'session', '/api/session')
+      resource.api_methods.sort.should == []
+    end
+
+    it "Should have 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/resources_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../spec_helper', __FILE__)
+include MockSpecHelper
+
+describe RightApi::Resources 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 Resources class" do
+      resource = RightApi::Resources.new(@client, '/api/deployments', 'deployments')
+      resource.api_methods.sort.should == [:create, :index]
+    end
+
+    it "Should not have index for instances of the Resources class that do not support it" do
+      resource = RightApi::Resources.new(@client, '/api/tags', 'tags')
+      resource.api_methods.sort.should == [:by_resource, :by_tag, :multi_add, :multi_delete]
+    end
+
+    it "Should have resource-specific methods for instances of the Resources class" do
+      resource = RightApi::Resources.new(@client, '/api/backups', 'backups')
+      resource.api_methods.sort.should == [:cleanup, :create, :index]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'simplecov'
+SimpleCov.start if ENV["COVERAGE"]
+require File.expand_path('../../lib/right_api_client', __FILE__)
+require 'spec'
+require 'rest_client'
+
+Spec::Runner.configure do |config|
+  config.mock_with :flexmock
+end
+
+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

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: right_api_client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.5.1
+platform: ruby
+authors: 
+- Ali Khajeh-Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+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  "
+email: 
+- alikhajeh1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- config/login.yml.example
+- lib/right_api_client.rb
+- lib/right_api_client/client.rb
+- lib/right_api_client/helper.rb
+- lib/right_api_client/resource.rb
+- lib/right_api_client/resource_detail.rb
+- lib/right_api_client/resources.rb
+- lib/right_api_client/version.rb
+- login_to_client_irb.rb
+- right_api_client.gemspec
+- right_api_client.rconf
+- spec/client_spec.rb
+- spec/instance_facing_spec.rb
+- spec/resource_detail_spec.rb
+- spec/resource_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/rightscale/right_api_client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2710163890528289054
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2710163890528289054
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: RightScale MultiCloud API HTTP Client
+test_files: 
+- config/login.yml.example
+- spec/client_spec.rb
+- spec/instance_facing_spec.rb
+- spec/resource_detail_spec.rb
+- spec/resource_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb