right_api_client 1.5.5 → 1.5.6

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = right_api_client - CHANGELOG.rdoc
 
+== 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).
 

data/LICENSE.txt

@@ -1,19 +1,20 @@
-Copyright (c) 2010-2011, RightScale.com
+Copyright (c) 2009-2012 RightScale, Inc.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -194,3 +194,9 @@ Put these special cases in the <tt>RightApi::Helper::RESOURCE_TYPE_SPECIAL_ACTIO
 
 === Resources are not linked together
   - In ResourceDetail, resource_type = Instance, need live_tasks as a method.
+
+= Troubleshooting
+
+== Wrong ruby version
+
+Ruby 1.9 is required. Ruby 1.8 will give undefined results, such as missing attributes.

data/lib/right_api_client/client.rb

@@ -8,6 +8,7 @@ require File.expand_path('../helper', __FILE__)
 require File.expand_path('../resource', __FILE__)
 require File.expand_path('../resource_detail', __FILE__)
 require File.expand_path('../resources', __FILE__)
+require File.expand_path('../exceptions', __FILE__)
 
 # RightApiClient has the generic get/post/delete/put calls that are used by resources
 module RightApi
@@ -132,13 +133,15 @@ module RightApi
             end
 
             [type, response.body]
+          when 404
+            raise Exceptions::UnknownRouteException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           else
-            raise "Unexpected response #{response.code.to_s}, #{response.body}"
+            raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           end
         end
-      #Session cookie is expired or invalid
-      rescue RuntimeError => e
+      rescue Exceptions::ApiException => e
         if re_login?(e)
+          #Session cookie is expired or invalid
           @cookies = login()
           retry
         else
@@ -183,11 +186,13 @@ module RightApi
             else
               response.return!(request, result)
             end
+          when 404
+            raise Exceptions::UnknownRouteException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           else
-            raise "Unexpected response #{response.code.to_s}, #{response.body}"
+            raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           end
         end
-      rescue RuntimeError => e
+      rescue Exceptions::ApiException => e
         if re_login?(e)
           @cookies = login()
           retry
@@ -203,11 +208,13 @@ module RightApi
         @rest_client[path].delete(headers) do |response, request, result|
           case response.code
           when 200, 204
+          when 404
+            raise Exceptions::UnknownRouteException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           else
-            raise "Unexpected response #{response.code.to_s}, #{response.body}"
+            raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           end
         end
-      rescue RuntimeError => e
+      rescue Exceptions::ApiException => e
         if re_login?(e)
           @cookies = login()
           retry
@@ -223,11 +230,13 @@ module RightApi
         @rest_client[path].put(params, headers) do |response, request, result|
           case response.code
           when 204
+          when 404
+            raise Exceptions::UnknownRouteException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           else
-            raise "Unexpected response #{response.code.to_s}, #{response.body}"
+            raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
           end
         end
-      rescue RuntimeError => e
+      rescue Exceptions::ApiException => e
         if re_login?(e)
           @cookies = login()
           retry

data/lib/right_api_client/exceptions.rb

@@ -0,0 +1,15 @@
+module RightApi
+  module Exceptions
+    class ApiException < RuntimeError
+      def initialize(message="")
+        super("Error: #{message}")
+      end
+    end
+
+    class UnknownRouteException < ApiException
+      def initialize(message="")
+        super("Unknown action or route. #{message}")
+      end
+    end
+  end
+end

data/lib/right_api_client/helper.rb

@@ -7,17 +7,6 @@ module RightApi::Helper
     'setting'  => 'multi_cloud_image_setting'
   }
 
-  # TODO: add this information to the API instead
-  # The API does not provide information about the basic actions that can be
-  # performed on a resource so define them here:
-  RESOURCE_ACTIONS = {
-    :create   => ['deployments', 'server_arrays', 'servers', 'ssh_keys', 'volumes', 'volume_snapshots', 'volume_attachments', 'backups', 'audit_entries'],
-    :destroy  => ['deployment', 'server_array', 'server', 'ssh_key', 'volume', 'volume_snapshot', 'volume_attachment', 'backup'],
-    :update   => ['deployment', 'instance', 'server_array', 'server', 'backup', 'audit_entries'],
-    :no_index => ['tags', 'tasks', 'monitoring_metric_data'], # Easier to specify those that don't need an index call
-    :no_show  => ['input', 'session', 'resource_tag']  # Once again, easier to define those that don't have a show call
-  }
-
   # Some RightApi::Resources have methods that operate on the resource type itself
   # and not on a particular one (ie: without specifying an id). Place these here:
   RESOURCE_SPECIAL_ACTIONS = {

data/lib/right_api_client/resource.rb

@@ -3,6 +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
 
     # Will create a (or an array of) new Resource object(s)
     # All parameters are treated as read only
@@ -33,29 +34,32 @@ module RightApi
         resource_type = INCONSISTENT_RESOURCE_TYPES[resource_type]
       end
       # For the inspect function:
+      @client = client
       @resource_type = resource_type
       @hash = hash
+      @href = href
 
       # Add destroy method to relevant resources
-      if Helper::RESOURCE_ACTIONS[:destroy].include?(resource_type)
-        define_instance_method('destroy') do
-          client.do_delete(href)
-        end
+      define_instance_method('destroy') do
+        client.do_delete(href)
       end
 
       # Add update method to relevant resources
-      if Helper::RESOURCE_ACTIONS[:update].include?(resource_type)
-        define_instance_method('update') do |*args|
-          client.do_put(href, *args)
-        end
+      define_instance_method('update') do |*args|
+        client.do_put(href, *args)
       end
 
       # Add show method to relevant resources
-      if !Helper::RESOURCE_ACTIONS[:no_show].include?(resource_type)
-        define_instance_method('show') do |*args|
-          RightApi::ResourceDetail.new(client, *client.do_get(href, *args))
-        end
+      define_instance_method('show') do |*args|
+        RightApi::ResourceDetail.new(client, *client.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.
+    def method_missing(m, *args)
+      action_href = href + "/" + m.to_s
+      client.do_post(action_href, *args)
+    end
   end
 end

data/lib/right_api_client/resource_detail.rb

@@ -91,25 +91,27 @@ module RightApi
       end
 
       # Add destroy method to relevant resources
-      if Helper::RESOURCE_ACTIONS[:destroy].include?(resource_type)
-        define_instance_method('destroy') do
-          client.do_delete(href)
-        end
+      define_instance_method('destroy') do
+        client.do_delete(href)
       end
 
       # Add update method to relevant resources
-      if Helper::RESOURCE_ACTIONS[:update].include?(resource_type)
-        define_instance_method('update') do |*args|
-          client.do_put(href, *args)
-        end
+      define_instance_method('update') do |*args|
+        client.do_put(href, *args)
       end
 
       # Add show method to relevant resources
-      if !Helper::RESOURCE_ACTIONS[:no_show].include?(resource_type)
-        define_instance_method('show') do |*args|
-          self
-        end
+      define_instance_method('show') do |*args|
+        self
       end
     end
+
+    #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)
+    end
   end
 end

data/lib/right_api_client/resources.rb

@@ -6,6 +6,7 @@ module RightApi
   class Resources
     include Helper
 
+    attr_reader :client, :path
     def inspect
       "#<#{self.class.name} " +
       "resource_type=\"#{@resource_type}\">"
@@ -15,26 +16,25 @@ module RightApi
     # Resource_type should always be plural.
     # All parameters are treated as read only
     def initialize(client, path, resource_type)
+      @client = client
+      @path   = path
+
       if INCONSISTENT_RESOURCE_TYPES.has_key?(get_singular(resource_type))
         resource_type = INCONSISTENT_RESOURCE_TYPES[get_singular(resource_type)] + 's'
       end
       @resource_type = resource_type
       # Add create methods for the relevant root RightApi::Resources
-      if Helper::RESOURCE_ACTIONS[:create].include?(resource_type)
-        self.define_instance_method('create') do |*args|
-          client.do_post(path, *args)
-        end
+      self.define_instance_method('create') do |*args|
+        client.do_post(path, *args)
       end
 
       # Add in index methods for the relevant root RightApi::Resources
-      if !Helper::RESOURCE_ACTIONS[:no_index].include?(resource_type)
-        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))
-          else
-            RightApi::Resource.process(client, *client.do_get(path, *args))
-          end
+      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))
+        else
+          RightApi::Resource.process(client, *client.do_get(path, *args))
         end
       end
 
@@ -47,5 +47,12 @@ module RightApi
         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.
+    def method_missing(m, *args)
+      action_path = path + "/" + m.to_s
+      client.do_post(action_path, *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 = '5'
+    CLIENT_VERSION = '6'
     VERSION = "#{API_VERSION}.#{CLIENT_VERSION}"
   end
 end

data/right_api_client.rconf

@@ -1,10 +1,10 @@
 ruby do
-  version  'ruby-1.9.2-p290'
-  rubygems '1.6.2'
+  version  'ruby-1.9.3-p125'
+  rubygems '1.8.11'
   gemset   'right_api_client'
 end
 bundler do
-  version     '1.0.10'
+  version     '1.0.21'
   exclusions  'deployment'
   bundle_path File.join(ENV["HOME"], '.rightscale_bundle', 'right_api_client')
 end

data/spec/resource_detail_spec.rb

@@ -12,11 +12,6 @@ describe RightApi::ResourceDetail do
       resource.api_methods.sort.collect{|s| s.to_s}.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.collect{|s| s.to_s}.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'})
@@ -42,7 +37,7 @@ describe RightApi::ResourceDetail do
 
     it "Should have 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 == ["links", "live_tasks", "show", "update"]
+      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
@@ -56,4 +51,4 @@ describe RightApi::ResourceDetail do
       resource.api_methods.collect{|s| s.to_s}.sort.should == ["current_instance", "destroy", "href", "links", "show", "update"]
     end
   end
-end
+end

data/spec/resource_spec.rb

@@ -12,9 +12,9 @@ describe RightApi::Resource do
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["destroy", "show", "update"]
     end
 
-    it "Should not have destroy/show/update for instances of the Resource class that do not support them" do
+    it "Should have destroy/show/update for all instances of the Resource class" do
       resource = RightApi::Resource.process(@client, 'session', '/api/session')
-      resource.api_methods.sort.should == []
+      resource.api_methods.sort.should == [:destroy, :show, :update]
     end
 
     it "Should have an array of ResourceDetail instances for index calls" do
@@ -22,4 +22,4 @@ describe RightApi::Resource do
       resources.first.class.should == RightApi::ResourceDetail
     end
   end
-end
+end

data/spec/resources_spec.rb

@@ -12,9 +12,9 @@ describe RightApi::Resources do
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["create", "index"]
     end
 
-    it "Should not have index for instances of the Resources class that do not support it" do
+    it "Should have 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{|s| s.to_s}.should == ["by_resource", "by_tag", "multi_add", "multi_delete"]
+      resource.api_methods.sort.collect{|s| s.to_s}.should == ["by_resource", "by_tag", "create", "index", "multi_add", "multi_delete"]
     end
 
     it "Should have resource-specific methods for instances of the Resources class" do
@@ -22,4 +22,4 @@ describe RightApi::Resources do
       resource.api_methods.sort.collect{|s| s.to_s}.should == ["cleanup", "create", "index"]
     end
   end
-end
+end

metadata

@@ -1,108 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: right_api_client
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.5.6
   prerelease: 
-  version: 1.5.5
 platform: ruby
-authors: 
+authors:
 - RightScale, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-20 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70331231890480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231890480
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70331231889980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231889980
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70331231889480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231889480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70331231889020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: flexmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231889020
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: &70331231888560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231888560
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70331231888100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.4.2
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70331231888100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70331231887720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *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  "
-email: 
+  prerelease: false
+  version_requirements: *70331231887720
+description: ! "\nThe right_api_client gem simplifies the use of RightScale's MultiCloud
+  API. It provides\na simple object model of the API resources, and handles all of
+  the fine details involved\nin making HTTP calls and translating their responses.\n
+  \ "
+email:
 - rubygems@rightscale.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.rdoc
 - Gemfile
@@ -112,6 +107,7 @@ files:
 - 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/helper.rb
 - lib/right_api_client/resource.rb
 - lib/right_api_client/resource_detail.rb
@@ -127,35 +123,31 @@ files:
 - 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: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: RightScale MultiCloud API HTTP Client
-test_files: 
+test_files:
 - config/login.yml.example
 - spec/audit_entries_spec.rb
 - spec/client_spec.rb