right-scale-api 0.0.3 → 0.0.4

data/README.md

@@ -1,7 +1,9 @@
 RightScale API Gem
 =======================
 
-A client library for the RightScale API.
+A client library for the RightScale API. Still under development, but it has enough written to be useful.
+
+There aren't any tests yet and it doesn't fully cover all the object types RightScale's API supports.
 
 RightScale's [API Docs]("http://support.rightscale.com/15-References/RightScale_API_Reference_Guide")
 
@@ -36,4 +38,19 @@ Usage Examples
     #we do this as an update, because rightscale's api doesn't let you set this on create (as of May 2010)
     server.update :associate_eip_at_launch => true, 
                   :ec2_elastic_ip => ip
-    server.start
+    server.start
+
+#### Create a Deployment
+
+    account.create_deployment :nickname	   => 'foo',
+    			      :description => 'foo bar baz'
+#### Show all Servers
+    account.servers
+#### Show an individual server
+    account.servers.find {|server| server.id ==}
+
+## Contributions Welcome
+
+Fork away.
+
+Needs tests, filling out the object types, etc.

data/Rakefile

@@ -12,7 +12,7 @@ begin
     gem.email = "ndh@baroquebobcat.com"
     gem.homepage = "http://github.com/baroquebobcat/right-scale-api"
     gem.authors = ["Nick Howard"]
-    gem.add_dependency "httparty"
+    gem.add_dependency "httparty", "~> 0.6.0"
     gem.add_dependency "activesupport"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/right-scale-api.rb

@@ -1,10 +1,15 @@
 require 'yaml'
 require 'httparty'
 require 'active_support/core_ext'
+require 'active_support/multibyte'
 
 module RightScaleAPI
   API_VERSION = '1.0'
   BASE_URI = "https://my.rightscale.com/"
+
+  def self.login *args
+    Client.login *args
+  end
 end
 
 require File.dirname(__FILE__) + '/right-scale-api/client'

data/lib/right-scale-api/account.rb

@@ -22,19 +22,49 @@ module RightScaleAPI
                   :ec2_elastic_ips,
                   :ec2_security_groups,
                   :server_templates,
-                  :servers
+                  :servers,
+                  :s3_buckets
 
+    # Creates a Deployment
+    # @param [Hash] opts deployment attributes
+    # @option opts [String] :nickname The nickname of the deployment
+    # @option opts [String] :description The description of the deployment
+    # @option opts [String :default_ec2_availability_zone the default availability zone for the deployment e.g. us-east-1a
+    # @option opts [String] :default_vpc_subnet_href
+    def create_deployment opts
+      Deployment.create opts.merge :account => self
+    end
+    
+    # Creates an EC2 EBS Elastic IP
+    # @param [Hash] opts ip attributes
+    # @option opts [String] :nickname The nickname of the ip
+    # @option opts [Fixnum] :cloud_id the cloud identifier default 1   (1 = us-east; 2 = eu; 3 = us-west, 4 = ap) 
     def create_ec2_elastic_ip opts
       Ec2ElasticIp.create opts.merge :account => self
     end
     
+    # Creates an EC2 EBS Volume
+    # @param [Hash] opts volume attributes
+    # @option opts [String] :nickname The nickname of the volume
+    # @option opts [String] :description
+    # @option opts [Fixnum] :aws_size The size of the volume in gigabytes*
+    # @option opts [String] :ec2_availability_zone name of the availability zone e.g. us-east-1a*
     def create_ec2_ebs_volume opts
       Ec2EbsVolume.create opts.merge :account => self
     end
 
+    # Creates an EC2 Instance
+    # @param [Hash] opts server attributes
+    # @option [RightScaleAPI::ServerTemplate] opts :server_template the server template to use*
+    # @option [[RightScaleAPI::Deployment] opts :deployment 
     def create_server opts
       Server.create opts.merge :account => self
     end
+
+    # Gets an EC2 ssh key.
+    # Currently you can't get a list of ssh keys through the API, so you need to get the id through the web interface.
+    # https://my.rightscale.com/clouds/1/ec2_ssh_keys
+    # @param id the id of the ssh key to get
     def get_ec2_ssh_key id
       Ec2SshKey.new get("/ec2_ssh_keys/#{id}").merge :id => id, :account => self
     end

data/lib/right-scale-api/base.rb

@@ -3,7 +3,8 @@ module RightScaleAPI
     
     attr_accessor :id, :href
     
-    #attributes that directly correspond to the api's
+    # attributes that directly correspond to the api's
+    # @param [Array<Symbol>] attrs a list of attributes an object type has
     def self.attributes attrs=nil
       if attrs
         @attributes ||= Base.attributes
@@ -24,10 +25,14 @@ module RightScaleAPI
     
     attributes [:tags, :created_at, :updated_at,:errors, :nickname]
 
+    # gets an object by id
+    # @param id [Fixnum]
     def self.get id
       new :id => id
     end
    
+    # creates a new object on RightScale
+    # @param opts [Hash] attributes of the created object
     def self.create opts
       object = new opts
       
@@ -43,10 +48,11 @@ module RightScaleAPI
         puts result.inspect
         raise "create failed"
       end
-      
-      new opts.merge(result.merge(:href => result.headers['location'].first))
+
+      new opts.merge(result.merge(:href =>  result.headers['location']))
     end
 
+    # The RightScale API name for the class
     def self.api_name
       name.demodulize.underscore
     end
@@ -61,10 +67,13 @@ module RightScaleAPI
       end
     end
     
+    # Updates the object with the passed attributes
+    # @param [Hash] attrs the updated attributes
     def update attrs
       put '', :body => {self.class.api_name =>  self.class.opts_to_query_opts(attrs)}
     end
     
+    # tells the API to delete the object
     def destroy
       delete ''
     end
@@ -94,10 +103,12 @@ module RightScaleAPI
       send_request :delete, *args
     end
     
+    # the objects uri on rightscale
     def uri
       RightScaleAPI::Client.base_uri + path
     end
 
+    # Reload the attributes of the object
     def reload!
       get('')[self.class.api_name].each do |attr, value|
         self.send :"#{attr}=",value

data/lib/right-scale-api/ec2_ebs_volume.rb

@@ -1,7 +1,9 @@
 module RightScaleAPI
-class Ec2EbsVolume < Account::SubResource
+  # EC2 EBS Volume
+  # See http://support.rightscale.com/15-References/RightScale_API_Reference_Guide/02-Management/05-EC2_EBS_Volumes
+  class Ec2EbsVolume < Account::SubResource
 
-   attributes %w(
+    attributes %w(
       description
       ec2_availability_zone
       aws_attached_at
@@ -11,21 +13,25 @@ class Ec2EbsVolume < Account::SubResource
       aws_size
       aws_status
       created_at
-   )
+    )
 
-   def attach_to_server server, device, mount
-     account.post '/component_ec2_ebs_volumes', :body => {
-       :component_ec2_ebs_volume => {
-         :ec2_ebs_volume_href => uri,
-         :component_href => server.href,
-         :device => device,
-         :mount => mount
-       }
-     }
-   end
+    # Attaches the volume to a server
+    # @param [RightScaleAPI::Server] server the server to attach the volume to
+    # @param [String] device the device to mount the volume as e.g. /dev/sdk
+    # @param [String] mount when to mount the device. Usually 'boot'
+    def attach_to_server server, device, mount
+      account.post '/component_ec2_ebs_volumes', :body => {
+        :component_ec2_ebs_volume => {
+          :ec2_ebs_volume_href => uri,
+          :component_href => server.href,
+          :device => device,
+          :mount => mount
+        }
+      }
+    end
 
-   def collection_uri
-     account.path + "/ec2_ebs_volumes"
-   end
- end
+    def collection_uri
+      account.path + "/ec2_ebs_volumes"
+    end
+  end
 end

data/lib/right-scale-api/ec2_ssh_key.rb

@@ -1,4 +1,6 @@
 module RightScaleAPI
+  # EC2 SSH key
+  # http://support.rightscale.com/15-References/RightScale_API_Reference_Guide/02-Management/08-EC2_SSH_Keys
   class Ec2SshKey <  Account::SubResource
     attributes %w(
       aws_key_name

data/lib/right-scale-api/s3_bucket.rb

@@ -0,0 +1,5 @@
+module RightScaleAPI
+  class S3Bucket < Account::SubResource
+    attributes %w(location)
+  end
+end

data/lib/right-scale-api/server.rb

@@ -22,27 +22,39 @@ module RightScaleAPI
       type
       vpc_subnet_href
     )
-        
+    
+    # Starts the server
     def start
       post '/start'
     end
     
+    # Stops the server
     def stop
       post '/stop'
     end
     
+    # Reboots the server
     def reboot
       post '/reboot'
     end
     
+    # Server Settings
+    # for info: under Sub-resources on
+    # http://support.rightscale.com/15-References/RightScale_API_Reference_Guide/02-Management/02-Servers
     def settings
       get('/settings')['settings']
     end
 
-    def running?
+    # Is the server operational
+    def operational?
       state == 'operational'
     end
+    
+    alias :running? :operational?
 
+    # Attach a volume to the server
+    # @param [RightScaleAPI::Ec2EbsVolume] volume the volume to attach
+    # @param [String] device the device to attach it as e.g. /dev/sdk
     def attach_volume volume, device
       if running?
         post '/attach_volume', :query => {
@@ -56,8 +68,9 @@ module RightScaleAPI
       end
     end
 
-    # Account#create_ec2_ebs_volume's opts +
-    # :device -- device mount point, eg /dev/sdk
+    # creates a blank volume and attaches it to the server
+    # @param [Hash] opts Account#create_ec2_ebs_volume's opts +
+    # @option [String] :device device mount point, e.g. /dev/sdk
     def attach_blank_volume opts
       device = opts.delete :device
       opts = {:ec2_availability_zone => 'us-east-1a'}.merge opts #default to the server's avail zone

data/right-scale-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{right-scale-api}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Howard"]
-  s.date = %q{2010-05-21}
+  s.date = %q{2010-09-14}
   s.description = %q{A client for the RightScale API that hides some of the complexity of the API
 (It doesn't require passing around hrefs as much). Based on HTTParty
 }
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "lib/right-scale-api/ec2_elastic_ip.rb",
      "lib/right-scale-api/ec2_security_group.rb",
      "lib/right-scale-api/ec2_ssh_key.rb",
+     "lib/right-scale-api/s3_bucket.rb",
      "lib/right-scale-api/server.rb",
      "lib/right-scale-api/server_template.rb",
      "lib/right-scale-api/status.rb",
@@ -46,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/baroquebobcat/right-scale-api}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A RightScale API gem that doesn't suck.(mostly)}
   s.test_files = [
     "spec/right-scale-api_spec.rb",
@@ -57,17 +58,17 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.6.0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
-      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<httparty>, ["~> 0.6.0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
-    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<httparty>, ["~> 0.6.0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end

data/spec/right-scale-api_spec.rb

@@ -1,7 +1,31 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "RightScaleApi" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe RightScaleAPI do
+  it { should respond_to(:login) }
+  
+  describe RightScaleAPI::Base do
+    subject { Class.new RightScaleAPI::Base }
+
+    it { should respond_to(:collection_uri) }
+
+    describe 'instance' do
+      subject {  Class.new(RightScaleAPI::Base).new({}) }
+      it { subject.should respond_to(:href) }
+    end
+  end
+
+  describe RightScaleAPI::Account do
+    #
+    describe "#create_ec2_ebs_volume" do
+      #when receive a 422
+      #do stuff with error
+      #missing ec2_avaliability_zone 
+      # Error:Unknown availability zone '' for the cloud AWS US-East
+      #missing aws_size
+      #  Error:MissingParameter: The request must contain the parameter size/snapshot
+    end
+    describe "#create_server" do
+      #@parsed_response={"errors"=>{"error"=>["Server template can't be blank", "Deployment can't be blank"]}}
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
+#$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'right-scale-api'
+require 'fakeweb'
 require 'spec'
 require 'spec/autorun'
 
 Spec::Runner.configure do |config|
-  
+  FakeWeb.allow_net_connect = false
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right-scale-api
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Nick Howard
@@ -14,28 +15,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 -06:00
+date: 2010-09-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 0
-        version: "0"
+        - 6
+        - 0
+        version: 0.6.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +52,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -84,6 +93,7 @@ files:
 - lib/right-scale-api/ec2_elastic_ip.rb
 - lib/right-scale-api/ec2_security_group.rb
 - lib/right-scale-api/ec2_ssh_key.rb
+- lib/right-scale-api/s3_bucket.rb
 - lib/right-scale-api/server.rb
 - lib/right-scale-api/server_template.rb
 - lib/right-scale-api/status.rb
@@ -101,23 +111,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A RightScale API gem that doesn't suck.(mostly)