right_api_client 1.5.9 → 1.5.12

data/lib/right_api_client/errors.rb

@@ -0,0 +1,30 @@
+
+module RightApi
+
+  class ApiError < RuntimeError
+
+    def initialize(request, response)
+
+      @request, @response = request, response
+
+      super(
+        prefix +
+        "HTTP Code: #{response.code.to_s}, " +
+        "Response body: #{response.body}")
+    end
+
+    def prefix
+
+      'Error: '
+    end
+  end
+
+  class UnknownRouteError < ApiError
+
+    def prefix
+
+      'Unknown action or route. '
+    end
+  end
+end
+

data/lib/right_api_client/helper.rb

@@ -58,7 +58,9 @@ module RightApi::Helper
             # get the resource_type
             # Special case: calling .data you don't want a resources object back
             # but rather all its details since you cannot do a show
-            return RightApi::ResourceDetail.new(client, *client.do_get(hrefs.first, *args)) if rel == :data
+            return RightApi::ResourceDetail.new(
+              client, *client.send(:do_get, hrefs.first, *args)
+            ) if rel == :data
 
             if is_singular?(rel)
               # Then the href will be: /resource_type/:id
@@ -150,8 +152,19 @@ module RightApi::Helper
 
   # Helper method that checks whether the string is singular
   def is_singular?(str)
-    return true if ['data'].include?(str.to_s)
-    (str.to_s)[-1, 1] != 's' # use legacy syntax for Ruby 1.8.7
+    test_str = str.to_s
+    return true if ['data'].include?(test_str)
+
+    case test_str
+    when "audit_entry"
+      return true
+    when "ip_address"
+      return true
+    when "process"
+      return true
+    else
+      (test_str)[-1, 1] != 's' # use legacy syntax for Ruby 1.8.7
+    end
   end
 
   # Does not modify links
@@ -172,10 +185,58 @@ module RightApi::Helper
     return nil
   end
 
+  # HACK: instead of pulling in activesupport gem, just hardcode some words
+  def simple_singularize(word)
+    case word
+    when "audit_entries"
+      "audit_entry"
+    when "ip_addresses"
+      "ip_address"
+    when "processes"
+      "process"
+    else
+      word.chop
+    end
+  end
+
   # Will not change obj
   def get_singular(obj)
-    str = obj.to_s
-    return 'audit_entry' if str == 'audit_entries'
-    str.chomp('s')
+    simple_singularize(obj.to_s.downcase)
   end
+
+  # rest client does not post params correctly for all the keys whose values are arrays of hashes
+  # @see http://stackoverflow.com/questions/6436110/restclient-strips-out-the-array-of-hashes-parameter-with-just-the-last-hash
+  #
+  def fix_array_of_hashes(args, top_level = true)
+
+    if args.is_a?(Array)
+
+      #recursively fix each element of the array
+      #
+      args.collect{|a| fix_array_of_hashes(a, false)}
+    elsif args.is_a?(Hash)
+
+      args.inject({}) do |res, (k, v)|
+        key = k
+        if v.is_a?(Array) && !v.empty? && v.first.is_a?(Hash)
+          if top_level
+            # signal to Rails that this really is an array
+            key = k.to_s + '[]'
+            value = fix_array_of_hashes(v, false)
+          else
+            # signal to Rails that this really is an array
+            value = {'' => fix_array_of_hashes(v, false)}
+          end
+        else
+          value = fix_array_of_hashes(v, false)
+        end
+        res[key] = value
+        res
+      end
+    else
+
+      args
+    end
+  end
+
 end

data/lib/right_api_client/resource.rb

@@ -40,26 +40,25 @@ module RightApi
       @href = href
 
       # Add destroy method to relevant resources
-      define_instance_method('destroy') do
-        client.do_delete(href)
+      define_instance_method('destroy') do |*args|
+        client.send(:do_delete, href, *args)
       end
 
       # Add update method to relevant resources
       define_instance_method('update') do |*args|
-        client.do_put(href, *args)
+        client.send(:do_put, href, *args)
       end
 
       # Add show method to relevant resources
       define_instance_method('show') do |*args|
-        RightApi::ResourceDetail.new(client, *client.do_get(href, *args))
+        RightApi::ResourceDetail.new(client, *client.send(:do_get, href, *args))
       end
     end
 
-    #Any other method other than standard actions(show,update,destroy) is simply appended to the href and
-    #called with a POST.
+    # Any other method other than standard actions(show,update,destroy)
+    # is simply appended to the href and called with a POST.
     def method_missing(m, *args)
-      action_href = href + "/" + m.to_s
-      client.do_post(action_href, *args)
+      client.send(:do_post, [ href, m.to_s ].join('/'), *args)
     end
   end
 end

data/lib/right_api_client/resource_detail.rb

@@ -41,8 +41,7 @@ module RightApi
         actions << action_name.to_sym
 
         define_instance_method(action_name.to_sym) do |*args|
-          action_href = hash['href'] + "/" + action['rel']
-          client.do_post(action_href, *args)
+          client.send(:do_post, "#{hash['href']}/#{action['rel']}", *args)
         end
       end
 
@@ -91,13 +90,19 @@ module RightApi
       end
 
       # Add destroy method to relevant resources
-      define_instance_method('destroy') do
-        client.do_delete(href)
+      define_instance_method('destroy') do |*args|
+        client.send(:do_delete, href, *args)
       end
 
       # Add update method to relevant resources
       define_instance_method('update') do |*args|
-        client.do_put(href, *args)
+
+        if resource_type == 'account' # HACK: handle child_account update specially
+          update_href = href.sub(/account/, 'child_account')
+          client.send(:do_put, update_href, *args)
+        else
+          client.send(:do_put, href, *args)
+        end
       end
 
       # Add show method to relevant resources
@@ -106,12 +111,11 @@ module RightApi
       end
     end
 
-    #Any other method other than standard actions(show,update,destroy) is simply appended to the href and
-    #called with a POST.
+    # Any other method other than standard actions(show,update,destroy)
+    # is simply appended to the href and called with a POST.
     def method_missing(m, *args)
-      #The method href would have been defined while initializing the object
-      action_href = href + "/" + m.to_s
-      client.do_post(action_href, *args)
+      # the method href would have been defined while initializing the object
+      client.send(:do_post, [ href, m.to_s ].join('/'), *args)
     end
   end
 end

data/lib/right_api_client/resources.rb

@@ -25,16 +25,16 @@ module RightApi
       @resource_type = resource_type
       # Add create methods for the relevant root RightApi::Resources
       self.define_instance_method('create') do |*args|
-        client.do_post(path, *args)
+        client.send(:do_post, path, *args)
       end
 
       # Add in index methods for the relevant root RightApi::Resources
       self.define_instance_method('index') do |*args|
         # Session uses .index like a .show (so need to treat it as a special case)
         if resource_type == 'session'
-          ResourceDetail.new(client, *client.do_get(path, *args))
+          ResourceDetail.new(client, *client.send(:do_get, path, *args))
         else
-          RightApi::Resource.process(client, *client.do_get(path, *args))
+          RightApi::Resource.process(client, *client.send(:do_get, path, *args))
         end
       end
 
@@ -43,16 +43,15 @@ module RightApi
         # Insert_in_path will NOT modify path
         action_path = insert_in_path(path, meth)
         self.define_instance_method(meth) do |*args|
-          client.send action, action_path, *args
+          client.send(action, action_path, *args)
         end
       end if Helper::RESOURCE_SPECIAL_ACTIONS[resource_type]
     end
 
-    #Any other method other than standard actions(create, index) is simply appended to the path and
-    #called with a POST.
+    # Any other method other than standard actions (create, index)
+    # is simply appended to the href and called with a POST.
     def method_missing(m, *args)
-      action_path = path + "/" + m.to_s
-      client.do_post(action_path, *args)
+      client.send(:do_post, [ href, m.to_s ].join('/'), *args)
     end
   end
 end

data/lib/right_api_client/version.rb

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

data/login_to_client_irb.rb

@@ -8,8 +8,7 @@ require 'irb'
 
 begin
   @client = RightApi::Client.new(YAML.load_file(File.expand_path('../config/login.yml', __FILE__)))
-  puts "logged-in to the API, use the '@client' variable to use the client, e.g. '@client.session.index.message' will output:"
-  puts @client.session.index.message
+  puts "logged-in to the API, use the '@client' variable to use the client"
 end
 
 IRB.start

data/right_api_client.gemspec

@@ -1,29 +1,29 @@
 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      = [ 'RightScale, Inc.' ]
-  s.email        = [ 'rubygems@rightscale.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.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          = [ 'RightScale, Inc.' ]
+  s.email            = [ 'rubygems@rightscale.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.files            = `git ls-files`.split(' ')
+  s.test_files       = `git ls-files spec config`.split(' ')
   s.rubygems_version = '1.8.17'
 
   s.add_runtime_dependency 'json'
-  s.add_runtime_dependency 'rest-client',      '1.6.7'
+  s.add_runtime_dependency 'rest-client',      '~> 1.6'
 
   s.add_development_dependency 'rake',         '0.8.7'
-  s.add_development_dependency 'rspec',        '1.3.0'
+  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'

data/right_api_client.rconf

@@ -1,5 +1,5 @@
 ruby do
-  version  'ree-1.8.7-2011.02'
+  version  'ree-1.8.7-2012.02'
   rubygems '1.8.17'
   gemset   'right_api_client'
 end

data/spec/{audit_entries_spec.rb → functional/audit_entries_spec.rb}

@@ -1,12 +1,10 @@
-
-require 'spec_helper'
-
+require File.expand_path('../../spec_helper', __FILE__)
 
 describe RightApi::Client do
 
   before(:all) do
 
-    creds = File.expand_path('../../config/login.yml', __FILE__)
+    creds = File.expand_path('../../../config/login.yml', __FILE__)
 
     begin
       @client = RightApi::Client.new(YAML.load_file(creds))

data/spec/{client_spec.rb → functional/client_spec.rb}

@@ -1,31 +1,33 @@
-require File.expand_path('../spec_helper', __FILE__)
-require 'yaml'
+require File.expand_path('../../spec_helper', __FILE__)
 
 describe RightApi::Client do
-  context "Given a valid set of credentials in the config/login.yml file" do
+
+  context "given a valid set of credentials in the config/login.yml file" do
+
     before(:all) do
-      @creds = '../../config/login.yml'
+      @creds = '../../../config/login.yml'
       begin
         @client = RightApi::Client.new(YAML.load_file(File.expand_path(@creds, __FILE__)))
-      rescue Exception => e
+      rescue => 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
+        puts e.backtrace
       end
     end
 
-    it "Should login" do
-      @client.headers[:cookies].should_not be_nil
+    it "logs in" do
+      @client.send(:headers)[:cookies].should_not be_nil
       @client.session.index.message.should == 'You have successfully logged into the RightScale API.'
     end
 
-    it "Should return valid cookies" do
+    it "returns valid cookies" do
       @client.cookies.class.should == Hash
       @client.cookies['_session_id'].should_not be_nil
       @client.cookies['domain'].should match /rightscale.com$/
       @client.cookies.keys.sort.last.should match /^rs_gbl/ # HACK: not quite sane sanity check
     end
 
-    it "Should accept a cookie argument when creating a new client" do
+    it "accepts a cookie 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)
@@ -35,12 +37,27 @@ describe RightApi::Client do
       client1.cookies.should == @client.cookies
     end
 
-    it "Should accept a YAML argument when creating a new client" do
+    it "timestamps cookies" do
+
+      @client.cookies.timestamp.should_not == nil
+    end
+
+    it "keeps track of the cookies all the time" do
+
+      t0 = @client.cookies.timestamp
+
+      @client.deployments.index
+      t1 = @client.cookies.timestamp
+
+      t0.to_f.should < t1.to_f
+    end
+
+    it "accepts a YAML argument when creating a new client" do
       client2 = RightApi::Client.new(YAML.load_file(File.expand_path(@creds, __FILE__)))
       client2.cookies.should_not == @client.cookies
     end
 
-    it "Should send post/get/put/delete requests to the server correctly" do
+    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'})
       new_deployment.class.should     == RightApi::Resource
@@ -55,7 +72,7 @@ describe RightApi::Client do
       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 == ""
+      @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}")
       tags.class.should == Array
       tags.first.class.should == RightApi::ResourceDetail
@@ -65,5 +82,61 @@ describe RightApi::Client do
       deployment.destroy.should be_nil
       new_deployment2.destroy.should be_nil
     end
+
+    it "singularizes resource_types correctly" do
+      @client.get_singular('servers').should == 'server'
+      @client.get_singular('deployments').should == 'deployment'
+      @client.get_singular('audit_entries').should == 'audit_entry'
+      @client.get_singular('processes').should == 'process'
+      @client.get_singular('ip_addresses').should == 'ip_address'
+    end
+
+    it "returns the resource when calling #resource(href)" do
+
+      d0 = @client.deployments.index.first
+
+      d1 = @client.resource(d0.href)
+
+      d1.href.should == d0.href
+    end
+
+    it "raises meaningful errors" do
+
+      err = begin
+        @client.resource('/api/nada')
+      rescue => e
+        e
+      end
+
+      err.class.should ==
+        RightApi::UnknownRouteError
+      err.message.should ==
+        "Unknown action or route. HTTP Code: 404, Response body: " +
+        "NotFound: No route matches \"/api/nada\" with {:method=>:get}"
+    end
+
+    it "wraps errors with _details" do
+
+      err = begin
+        @client.deployments(:id => 'nada').show
+      rescue => e
+        e
+      end
+
+      #p err
+      #puts err.backtrace
+
+      err._details.method.should == :get
+      err._details.path.should == '/api/deployments/nada'
+      err._details.params.should == {}
+
+      err._details.request.class.should == RestClient::Request
+
+      err._details.response.code.should == 422
+      err._details.response.class.should == String
+      err._details.response.should == "ResourceNotFound: Couldn't find Deployment with ID=nada "
+
+      err._details.code.should == 422
+    end
   end
 end