rest_connection 1.0.5 → 1.0.6

data/lib/rest_connection/rightscale/multi_cloud_image_cloud_setting_internal.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 0.1
+#
 class MultiCloudImageCloudSettingInternal
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/multi_cloud_image_internal.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 0.1
+#
 class MultiCloudImageInternal
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/permission.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 
 #

data/lib/rest_connection/rightscale/right_script.rb

@@ -22,6 +22,9 @@
 #++
 
 
+#
+# API 1.0
+#
 class RightScript
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/right_script_attachment_internal.rb

@@ -24,6 +24,9 @@
 require 'rest-client'
 RestClient.log = ENV["REST_CONNECTION_LOG"] || "stdout"
 
+#
+# API 0.1
+#
 class RightScriptAttachmentInternal
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/right_script_internal.rb

@@ -21,7 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-
+#
+# API 0.1
+#
 class RightScriptInternal
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/rightscale_api_base.rb

@@ -23,9 +23,15 @@
 
 require 'active_support/inflector'
 
+
 module RightScale
   module Api
+
+    # TODO: move this to McAuditEntry
     DATETIME_FMT = "%Y/%m/%d %H:%M:%S +0000"
+
+    # Every supported AWS cloud must be hardcoded here.
+    # FIXME: Once this list exceeds 10 entries, must also update cloud_id logic elsewhere!
     AWS_CLOUDS = [
       {"cloud_id" => 1, "name" => "AWS US-East"},
       {"cloud_id" => 2, "name" => "AWS EU"},
@@ -38,6 +44,7 @@ module RightScale
     ]
 
     BASE_COOKIE_REFRESH = proc do
+      # Refresh cookie by logging in again
       def refresh_cookie
         # login
         @cookie = nil
@@ -51,7 +58,7 @@ module RightScale
     end
 
     # Pass no arguments to reset to the default configuration,
-    # pass a hash to update the settings for all API Versions
+    # pass a hash to update the settings for all API versions
     def self.update_connection_settings(*settings)
       if settings.size > 1
         raise ArgumentError.new("wrong number of arguments (#{settings.size} for 1)")
@@ -68,7 +75,12 @@ module RightScale
       true
     end
 
-    # Check for API 0.1 Access
+    # Active API version probing
+    # TODO: probe passively instead
+    # TODO: move this logic to a separate file
+
+    # Checks for API 0.1 access
+    # Requires an account with internal API access on a legacy cluster
     def self.api0_1?
       if class_variable_defined?("@@api0_1")
         return @@api0_1 unless @@api0_1.nil?
@@ -77,9 +89,12 @@ module RightScale
       @@api0_1 = true
     rescue RestConnection::Errors::Forbidden
       @@api0_1 = false
+    rescue RestConnection::Errors::UnprocessableEntity
+      @@api0_1 = false
     end
 
-    # Check for API 1.0 Access
+    # Checks for API 1.0 access
+    # Should always succeed
     def self.api1_0?
       if class_variable_defined?("@@api1_0")
         return @@api1_0 unless @@api1_0.nil?
@@ -90,7 +105,8 @@ module RightScale
       @@api1_0 = false
     end
 
-    # Check for API 1.5 Beta Access
+    # Check for API 1.5 access
+    # Should always succeed
     def self.api1_5?
       if class_variable_defined?("@@api1_5")
         return @@api1_5 unless @@api1_5.nil?
@@ -102,6 +118,8 @@ module RightScale
     end
 
     module BaseConnection
+
+      # Config for API 1.0
       def connection(*opts)
         @@connection ||= RestConnection::Connection.new(*opts)
         settings = @@connection.settings
@@ -128,6 +146,7 @@ module RightScale
       def resource_singular_name
         self.to_s.underscore
       end
+
       # matches using result of block match expression
       # ex: Server.find_by(:nickname) { |n| n =~ /production/ }
       def find_by(attrib, &block)
@@ -161,10 +180,11 @@ module RightScale
         self.find_by(:nickname) { |n| n == nickname }
       end
 
-      # the argument can be
-      # 1) takes href (URI),
-      # 2) or id (Integer)
-      # 3) or symbol :all, :first, :last
+      # Retrieves one or more resources of the same type.
+      #
+      # @param [Integer|Symbol|String] href should be one of the following: resource id, :all, :first, :last, resource href
+      # @param [Hash] additional_params if href is an integer, will be part of retrieve request
+      # @param [Block] block if href is a symbol, will be used inside select block to refine results
       def find(href, additional_params={}, &block)
         if href.is_a?(Integer)
           return self.new(connection.get(self.resource_plural_name + "/#{href}", additional_params))

data/lib/rest_connection/rightscale/rightscale_api_gateway.rb

@@ -21,8 +21,16 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.5
+#
+
 module RightScale
   module Api
+
+    #
+    # Refresh cookie by logging in again
+    #
     GATEWAY_COOKIE_REFRESH = proc do
       def refresh_cookie
         # login
@@ -48,6 +56,10 @@ module RightScale
     end
 
     module GatewayConnection
+
+      #
+      # Config for API 1.5
+      #
       def connection(*opts)
         @@gateway_connection ||= RestConnection::Connection.new(*opts)
         settings = @@gateway_connection.settings

data/lib/rest_connection/rightscale/rightscale_api_internal.rb

@@ -21,9 +21,17 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 0.1
+#
 module RightScale
   module Api
     module InternalConnection
+
+      #
+      # Config for API 0.1
+      # Only works for legacy clusters
+      #
       def connection(*opts)
         @@little_brother_connection ||= RestConnection::Connection.new(*opts)
         settings = @@little_brother_connection.settings

data/lib/rest_connection/rightscale/rightscale_api_mc_input.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 module RightScale
   module Api

data/lib/rest_connection/rightscale/rightscale_api_mc_taggable.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 module RightScale
   module Api

data/lib/rest_connection/rightscale/rightscale_api_resources.rb

@@ -73,7 +73,6 @@ require 'rest_connection/rightscale/right_script'
 require 'rest_connection/rightscale/multi_cloud_image_cloud_setting_internal'
 require 'rest_connection/rightscale/multi_cloud_image_internal'
 require 'rest_connection/rightscale/multi_cloud_image'
-require 'rest_connection/rightscale/ec2_server_array_internal'
 require 'rest_connection/rightscale/ec2_server_array'
 require 'rest_connection/rightscale/mc_server_array'
 require 'rest_connection/rightscale/security_group_rule'

data/lib/rest_connection/rightscale/rs_internal.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have special API access to use these internal API calls.
+# API 0.1
 #
 class RsInternal
   include RightScale::Api::Base

data/lib/rest_connection/rightscale/s3_bucket.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class S3Bucket
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/security_group_rule.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 class SecurityGroupRule
   include RightScale::Api::Gateway

data/lib/rest_connection/rightscale/server.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class Server
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/server_ec2_ebs_volume.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class ServerEc2EbsVolume
   include  RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/server_internal.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have special API access to use these internal API calls.
+# API 0.1
 #
 class ServerInternal
   include RightScale::Api::Base

data/lib/rest_connection/rightscale/server_template.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class ServerTemplate
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/server_template_internal.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 0.1
+#
 class ServerTemplateInternal
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/session.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 class Session
   include RightScale::Api::Gateway

data/lib/rest_connection/rightscale/sqs_queue.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class SqsQueue
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/status.rb

@@ -26,6 +26,9 @@
 
 #This is the v4 image only work status api.
 # was used by Server#run_script (depricating..)
+#
+# API 1.0
+#
 class Status
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/tag.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class Tag
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/rightscale/task.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 class Task
   include RightScale::Api::Gateway

data/lib/rest_connection/rightscale/user.rb

@@ -22,7 +22,7 @@
 #++
 
 #
-# You must have Beta v1.5 API access to use these internal API calls.
+# API 1.5
 #
 
 #

data/lib/rest_connection/rightscale/vpc_dhcp_option.rb

@@ -21,6 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+#
+# API 1.0
+#
 class VpcDhcpOption
   include RightScale::Api::Base
   extend RightScale::Api::BaseExtend

data/lib/rest_connection/ssh_hax.rb

@@ -78,7 +78,7 @@ module SshHax
         # Test for ability to connect; Net::SSH.start sometimes hangs under certain server-side sshd configs
         test_ssh = ""
         [5, 15, 60].each { |timeout_max|
-          test_ssh = `ssh -o \"BatchMode=yes\" -o \"StrictHostKeyChecking=no\" -o \"ConnectTimeout #{timeout_max}\" rightscale@#{host_dns} -C \"exit\" 2>&1`.chomp
+          test_ssh = `ssh -ttq -o \"BatchMode=yes\" -o \"StrictHostKeyChecking=no\" -o \"ConnectTimeout #{timeout_max}\" rightscale@#{host_dns} -C \"exit\" 2>&1`.chomp
           break if test_ssh =~ /permission denied/i or test_ssh.empty?
         }
         raise test_ssh unless test_ssh =~ /permission denied/i or test_ssh.empty?

data/lib/rest_connection/version.rb

@@ -1,4 +1,4 @@
 # This gem is versioned with the usual X.Y.Z notation
 module RestConnection
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/rest_connection.rb

@@ -32,6 +32,10 @@ require 'logger'
 require 'highline/import'
 require 'nokogiri'
 
+#
+# REST connection config and error definitions.
+#
+
 module RestConnection
   class Connection
     # Settings is a hash of options for customizing the connection.
@@ -250,6 +254,8 @@ module RestConnection
       end
     end
 
+    # Logs a message at info level to stdout or log file
+    # FIXME: don't lazy initialize
     def logger(message)
       init_message = "Initializing Logging using "
       if @@logger.nil?

data/rest_connection.gemspec

@@ -18,8 +18,8 @@ It currently has support for RightScale API 1.0 and 1.5.
   s.test_files = `git ls-files spec config`.split(' ')
   s.rubygems_version = '1.8.24'
 
-  s.add_runtime_dependency 'activesupport',    '2.3.10'
-  s.add_runtime_dependency 'net-ssh',          '2.1.4'
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'net-ssh'
   s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'highline'
   s.add_runtime_dependency 'rest-client'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rest_connection
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
   - 0
-  - 5
-  version: 1.0.5
+  - 6
+  version: 1.0.6
 platform: ruby
 authors: 
 - RightScale, Inc.
@@ -15,42 +15,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-03 00:00:00 Z
+date: 2013-04-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 3
         segments: 
-        - 2
-        - 3
-        - 10
-        version: 2.3.10
-  type: :runtime
+        - 0
+        version: "0"
   requirement: *id001
-  prerelease: false
+  name: activesupport
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: net-ssh
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
-        - 2
-        - 1
-        - 4
-        version: 2.1.4
-  type: :runtime
+        - 0
+        version: "0"
   requirement: *id002
-  prerelease: false
+  name: net-ssh
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: json
+  prerelease: false
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,11 +56,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id003
-  prerelease: false
+  name: json
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: highline
+  prerelease: false
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,11 +70,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id004
-  prerelease: false
+  name: highline
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  prerelease: false
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -88,11 +84,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id005
-  prerelease: false
+  name: rest-client
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  prerelease: false
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -102,11 +98,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id006
-  prerelease: false
+  name: nokogiri
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: rake
+  prerelease: false
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -118,11 +114,11 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  type: :development
   requirement: *id007
-  prerelease: false
+  name: rake
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  prerelease: false
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -132,11 +128,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   requirement: *id008
-  prerelease: false
+  name: bundler
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  prerelease: false
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -148,11 +144,11 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  type: :development
   requirement: *id009
-  prerelease: false
+  name: rspec
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug
+  prerelease: false
   version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -162,9 +158,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   requirement: *id010
-  prerelease: false
+  name: ruby-debug
+  type: :development
 description: "\n\
   The rest_connection gem simplifies the use of RESTful APIs.\n\
   It currently has support for RightScale API 1.0 and 1.5.\n  "
@@ -179,9 +175,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - config/rest_api_config.yaml.sample
 - examples/README.txt
@@ -211,7 +206,6 @@ files:
 - lib/rest_connection/rightscale/ec2_elastic_ip.rb
 - lib/rest_connection/rightscale/ec2_security_group.rb
 - lib/rest_connection/rightscale/ec2_server_array.rb
-- lib/rest_connection/rightscale/ec2_server_array_internal.rb
 - lib/rest_connection/rightscale/ec2_ssh_key.rb
 - lib/rest_connection/rightscale/ec2_ssh_key_internal.rb
 - lib/rest_connection/rightscale/executable.rb
@@ -316,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A Modular RESTful API library.