right-scale-api 0.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+.idea
+*.iml
+*~
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Howard
+
+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 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.md

@@ -0,0 +1,17 @@
+RightScale API Gem
+=======================
+
+A client library for the RightScale API.
+
+RightScale's [API Docs]("http://support.rightscale.com/15-References/RightScale_API_Reference_Guide")
+
+Usage Examples
+----------------------
+
+    RightScaleAPI.login user, pass
+
+    account = RightScaleAPI::Account.get id
+
+    foo_server = account.servers.find {|s| s.nickname == 'foo'}
+
+    foo_server.stop

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "right-scale-api"
+    gem.summary = %Q{A RightScale API gem that doesn't suck.(mostly)}
+    gem.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
+}
+    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 "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
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "right-scale-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

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

@@ -0,0 +1,50 @@
+module RightScaleAPI
+  class Account < Base
+    
+    collection_uri "/api/acct"  
+    
+    def self.sub_resources *resources
+      resources.each do |resource|
+        module_eval %(
+                      def #{resource}
+                        get('/#{resource}.xml')['#{resource}'].map do |attrs|
+                          #{resource.to_s.classify}.new attrs.merge(:account => self)
+                        end
+                      end
+                      ),__FILE__, __LINE__-6
+      end
+    end
+
+    sub_resources :alert_specs,
+                  :deployments,
+                  :ec2_ebs_volumes,
+                  :ec2_elastic_ips,
+                  :ec2_security_groups,
+                  :server_templates,
+                  :servers
+
+    def create_ec2_elastic_ip opts
+      Ec2ElasticIp.create opts.merge :account => self
+    end
+    
+    def create_ec2_ebs_volume opts
+      Ec2EbsVolume.create opts.merge :account => self
+    end
+
+    def create_server opts
+      Server.create opts.merge :account => self
+    end
+    def get_ec2_ssh_key id
+      Ec2SshKey.new get("/ec2_ssh_keys/#{id}").merge :id => id, :account => self
+    end
+
+    class SubResource < Base
+      attr_accessor :account
+
+      def collection_uri
+        account.path + "/" + self.class.api_name.pluralize
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,26 @@
+module RightScaleAPI
+  class AlertSpec < Account::SubResource
+    attributes %w(
+      name
+      file
+      variable
+      condition
+      threshold
+      escalation_name
+      duration
+      description
+    )
+
+    #params
+    # subject -- either a Server or a ServerTemplate
+    def attach_to subject
+      account.post '/alert_specs_subject', :query => {
+        :alert_specs_subject =>{
+          :alert_spec_href => uri,
+          :subject_href => subject.uri,
+          :subject_type => subject.type
+        }
+      }
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+module RightScaleAPI
+  class Base
+    
+    attr_accessor :id, :href
+    
+    #attributes that directly correspond to the api's
+    def self.attributes attrs=nil
+      if attrs
+        @attributes ||= []
+        @attributes += attrs
+        attr_accessor *attrs
+
+        @attributes.each do |attr|
+          if attr =~ /(.+)_href$/
+            relation = $1
+            attr_accessor relation
+          end
+        end
+
+      end
+      @attributes
+    end
+    
+    attributes [:tags, :created_at, :updated_at,:errors]
+
+    def self.get id
+      new :id => id
+    end
+   
+    def self.create opts
+      object = new opts
+      
+      query_opts = opts_to_query_opts opts
+      
+      result = RightScaleAPI::Client.post(object.collection_uri, :body => {api_name => query_opts})
+
+      if result.code.to_i != 201
+        p object.collection_uri
+        p query_opts
+        p result.code
+        p result.headers
+        puts result.inspect
+        raise "create failed"
+      end
+      
+      new opts.merge(result.merge(:href => result.headers['location'].first))
+    end
+
+    def self.api_name
+      name.demodulize.underscore
+    end
+    
+    def initialize attributes
+      attributes.each do |attr,value|
+        send "#{attr}=", value
+      end
+      
+      unless id
+        self.id = id_from_href href if href
+      end
+    end
+    
+    def update attrs
+      put '', :body => {self.class.api_name =>  self.class.opts_to_query_opts(attrs)}
+    end
+    
+    def destroy
+      delete ''
+    end
+
+    def method_missing method,*args
+      if %w(get head post put delete).include? method.to_s
+        args[0] = "#{path}#{args[0]}"
+        RightScaleAPI::Client.send method, *args
+      else
+        super method, *args
+      end
+    end
+    
+    def uri
+      RightScaleAPI::Client.base_uri + path
+    end
+    protected
+    
+    def self.collection_uri uri=nil
+      if uri
+        @collection_uri= uri
+      end
+      @collection_uri
+    end
+    
+    def collection_uri
+      self.class.collection_uri
+    end
+    
+    def path
+      collection_uri + "/" + id
+    end
+    
+    def id_from_href href
+      href.split('/').last
+    end
+    
+    def path_from_href href
+      URI.parse(href).path
+    end
+
+    def self.opts_to_query_opts opts
+      query_opts = opts.dup
+      
+      relations = attributes.select {|a|a.include? '_href'}
+      relations.each do |r|
+        r_name = r.sub('_href','').to_sym
+        if query_opts[r_name]
+          query_opts[r] = query_opts.delete(r_name).href
+        end
+      end
+      query_opts.delete_if {|k,v| ! attributes.include? k.to_s }
+
+      query_opts
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module RightScaleAPI
+  class RightScaleAPI::Client
+    include HTTParty
+    
+    base_uri BASE_URI
+    headers 'X-API-Version' => API_VERSION
+    
+    class <<self
+      alias :login :basic_auth
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RightScaleAPI
+  class Deployment < Account::SubResource
+    attributes %w(
+      nickname
+      description
+      servers
+      parameters
+      default_vpc_subnet_href
+      default_ec2_availability_zone
+      updated_at
+      created_at
+    )
+
+    def start_all
+      post '/start_all'
+    end
+
+    def stop_all
+      post '/stop_all'
+    end
+
+    def duplicate
+      post '/duplicate'
+    end
+
+  end
+end

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

@@ -0,0 +1,9 @@
+module RightScaleAPI
+ class Ec2EbsSnapshot < Account::SubResource
+   attributes %w(
+      description
+      ec2_ebs_volume_id
+      commit_state
+   )
+ end
+end

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

@@ -0,0 +1,31 @@
+module RightScaleAPI
+class Ec2EbsVolume < Account::SubResource
+
+   attributes %w(
+      description
+      ec2_availability_zone
+      aws_attached_at
+      aws_attachment_status
+      aws_device
+      aws_id
+      aws_size
+      aws_status
+      created_at
+   )
+
+   def attach_to_server server, device, mount
+     account.post '/component_ec2_ebs_volumes', :body => {
+       :component_ec2_ebs_volumes => {
+         :ec2_ebs_volume_href => uri,
+         :component_href => server.href,
+         :device => device,
+         :mount => mount
+       }
+     }
+   end
+
+   def collection_uri
+     account.path + "/ec2_ebs_volumes"
+   end
+ end
+end

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

@@ -0,0 +1,10 @@
+module RightScaleAPI
+  class Ec2ElasticIp < Account::SubResource
+    attributes %w(
+      ec2_instance_id
+      public_ip
+      cloud_id
+      server_href
+      )
+  end 
+end

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

@@ -0,0 +1,14 @@
+module RightScaleAPI
+  class Ec2SecurityGroup <  Account::SubResource
+    attributes %w(
+      aws_description
+      aws_group_name
+      aws_perms
+      owner
+      group
+      cidr_ips
+      protocol
+      from_port
+      to_port)
+  end
+end

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

@@ -0,0 +1,13 @@
+module RightScaleAPI
+  class Ec2SshKey <  Account::SubResource
+    attributes %w(
+      aws_key_name
+      aws_fingerprint
+      aws_material
+      ec2_ssh_key)
+    
+    def href
+      uri
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module RightScaleAPI
+  class Server < Account::SubResource
+    attributes %w(
+      aki_image_href
+      ari_image_href
+      associate_eip_at_launch
+      cloud_id
+      current_instance_href
+      deployment_href
+      ec2_availability_zone
+      ec2_elastic_ip_href
+      ec2_image_href
+      ec2_security_groups_href
+      ec2_ssh_key_href
+      ec2_user_data
+      instance_type
+      nickname
+      parameters
+      server_template_href
+      server_type
+      state
+      type
+      vpc_subnet_href
+    )
+        
+    def start
+      post '/start'
+    end
+    
+    def stop
+      post '/stop'
+    end
+    
+    def reboot
+      post '/reboot'
+    end
+    
+    def settings
+      get('/settings')['settings']
+    end
+
+    def attach_volume volume, device
+      if running?
+        post '/attach_volume', :query => {
+          :server => {
+            :ec2_ebs_volume_href => volume.uri,
+            :device => device
+          }
+        }
+      else
+        volume.attach_to_server self, device, 'boot'
+      end
+    end
+
+    # Account#create_ec2_ebs_volume's opts +
+    # :device -- device mount point, eg /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
+      volume = account.create_ec2_ebs_volume opts
+      attach_volume volume, device
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module RightScaleAPI
+  class ServerTemplate <  Account::SubResource
+    attributes %w(
+      name
+      description
+      multi_cloud_image_href
+      parameters
+      is_head_version
+      version)
+  end
+end

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

@@ -0,0 +1,13 @@
+module RightScaleAPI
+# currently this resource has no index method
+  class Status <  Account::SubResource
+    attributes %w(
+      description
+      started_at
+      ended_at
+      state
+    )
+#show only
+#account.get '/statuses/-id-'
+  end
+end

data/lib/right-scale-api.rb

@@ -0,0 +1,16 @@
+require 'yaml'
+require 'httparty'
+require 'active_support/core_ext'
+
+module RightScaleAPI
+  API_VERSION = '1.0'
+  BASE_URI = "https://my.rightscale.com/"
+end
+
+require File.dirname(__FILE__) + '/right-scale-api/client'
+require File.dirname(__FILE__) + '/right-scale-api/base'
+require File.dirname(__FILE__) + '/right-scale-api/account'
+
+Dir[File.dirname(__FILE__) + "/right-scale-api/*.rb"].each do |src|
+  require src
+end

data/right-scale-api.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{right-scale-api}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Howard"]
+  s.date = %q{2010-05-01}
+  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
+}
+  s.email = %q{ndh@baroquebobcat.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/right-scale-api.rb",
+     "lib/right-scale-api/account.rb",
+     "lib/right-scale-api/alert_spec.rb",
+     "lib/right-scale-api/base.rb",
+     "lib/right-scale-api/client.rb",
+     "lib/right-scale-api/deployment.rb",
+     "lib/right-scale-api/ec2_ebs_snapshot.rb",
+     "lib/right-scale-api/ec2_ebs_volume.rb",
+     "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/server.rb",
+     "lib/right-scale-api/server_template.rb",
+     "lib/right-scale-api/status.rb",
+     "right-scale-api.gemspec",
+     "spec/right-scale-api_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  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.summary = %q{A RightScale API gem that doesn't suck.(mostly)}
+  s.test_files = [
+    "spec/right-scale-api_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    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"])
+      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<activesupport>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/right-scale-api_spec.rb

@@ -0,0 +1,7 @@
+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"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'right-scale-api'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: right-scale-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Nick Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-01 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: |
+  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
+
+email: ndh@baroquebobcat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/right-scale-api.rb
+- lib/right-scale-api/account.rb
+- lib/right-scale-api/alert_spec.rb
+- lib/right-scale-api/base.rb
+- lib/right-scale-api/client.rb
+- lib/right-scale-api/deployment.rb
+- lib/right-scale-api/ec2_ebs_snapshot.rb
+- lib/right-scale-api/ec2_ebs_volume.rb
+- 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/server.rb
+- lib/right-scale-api/server_template.rb
+- lib/right-scale-api/status.rb
+- right-scale-api.gemspec
+- spec/right-scale-api_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/baroquebobcat/right-scale-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A RightScale API gem that doesn't suck.(mostly)
+test_files: 
+- spec/right-scale-api_spec.rb
+- spec/spec_helper.rb