rightresource 0.2.8 → 0.2.9

data/README.rdoc

@@ -10,7 +10,4 @@ License::   The MIT License
     rest_client
     crack
 
-== install
-    sudo gem install json rest-client crack
-
 == example

data/lib/right_resource/alert_spec.rb

@@ -1,7 +1,10 @@
 class AlertSpec < RightResource::Base
   class << self
     def alert_specs_subject(id, params={})
-      connection.post(element_path(id, :alert_specs_subject, params))
+      pair = URI.decode({:alert_specs_subject => params}.to_params).split('&').map {|l| l.split('=')}
+      h = Hash[*pair.flatten]
+      path = "alert_specs_subject"
+      action(:post, path, h)
     end
   end
 end

data/lib/right_resource/base.rb

@@ -20,7 +20,7 @@ module RightResource
 
       # Set RESTFul client with login authentication for HTTP Methods(Low level)
       # === Examples
-      #   conn = Connection.new do |c|
+      #   conn = RightResource::Connection.new do |c|
       #     c.login(:username => "user", :password => "pass", :account => "1")
       #   end
       #   Deployment.connection = conn
@@ -83,6 +83,27 @@ module RightResource
         connection.resource_id || nil
       end
 
+      # RestFul Method
+      def action(method, path, params={})
+        case method
+        when :get
+          connection.get(path, params)
+        when :post
+          connection.post(path, params)
+        when :put
+          connection.put(path, params)
+        when :delete
+          connection.delete(path, params)
+        end
+      rescue RestClient::ResourceNotFound
+        nil
+      rescue => e
+        logger.error("#{e.class}: #{e.pretty_inspect}")
+        logger.debug {"Backtrace:\n#{e.backtrace.pretty_inspect}"}
+      ensure
+        logger.debug {"#{__FILE__} #{__LINE__}: #{self.class}\n#{self.pretty_inspect}\n"}
+      end
+
       # Get resources by index method
       # same resources support criteria like filtering.
       #
@@ -150,14 +171,30 @@ module RightResource
       end
 
       # Create new resource
-      # Example:
+      # ==== Parameters
+      #
+      # * +params+ - see Examples
+      #
+      # === Examples
       #   params = {
-      #     :nickname => "dev",
-      #     :deployment_href => "https://my.rightscale.com/api/acct/22329/deployments/59855",
-      #     :server_template_href => "https://my.rightscale.com/api/acct/22329/server_templates/76610",
-      #     :ec2_availability_zone => "ap-northeast-1a"
+      #     :cloud_id => 4, # {1 = us-east; 2 = eu; 3 = us-west, 4 = ap}
+      #     :ec2_image_href => "https://my.rightscale.com/api/acct/22329/multi_cloud_images/40840", # AMI image or MultiCloud image
+      #     :nickname =>"dev703", # Instance rightscale nickname
+      #     :instance_type => 'm1.xlarge',
+      #     :assoicate_eip_at_launch => '0',
+      #     :deployment_href => "https://my.rightscale.com/api/acct/22329/deployments/63387",
+      #     :ec2_availability_zone=>"ap-southeast-1b",  # (ex: 'us-east-1a', 'any')
+      #     :ec2_ssh_key_href => "https://my.rightscale.com/api/acct/22329/ec2_ssh_keys/240662",
+      #     :ec2_security_group =>
+      #       ["https://my.rightscale.com/api/acct/22329/ec2_security_groups/170342",
+      #       "https://my.rightscale.com/api/acct/22329/ec2_security_groups/170344",
+      #       "https://my.rightscale.com/api/acct/22329/ec2_security_groups/170353"],
+      #     :server_template_href => "https://my.rightscale.com/api/acct/22329/ec2_server_templates/82665"  # rightscale servertemplate
       #   }
-      #   Server.create(params)
+      #   server_id = Server.create(params).id
+      #   settings = Server.settings(server_id)
+      #   p settings
+      #
       def create(params={})
         #TODO: refactor
         self.new(params).tap do |resource|
@@ -187,12 +224,12 @@ module RightResource
 
       # Get single resource
       def element_path(id, prefix_options = nil, query_options = nil)
-        "#{resource_name}s/#{id}#{prefix(prefix_options)}.#{format.extension}#{query_string(query_options)}"
+        "#{resource_name}s/#{id}#{prefix(prefix_options)}#{query_string(query_options)}"
       end
 
       # Get resource collections
       def collection_path(prefix_options = nil, query_options = nil)
-        "#{resource_name}s#{prefix(prefix_options)}.#{format.extension}#{query_string(query_options)}"
+        "#{resource_name}s#{prefix(prefix_options)}#{query_string(query_options)}"
       end
 
       # Get resource name(equals plural of classname)
@@ -233,7 +270,7 @@ module RightResource
               raise ArgumentError, "expected an Hash, String or Symbol, got #{options.pretty_inspect}"
             end
           end
-          default
+          "#{default}.#{format.extension}"
         end
 
         # create querystring by crack to_params method
@@ -271,7 +308,7 @@ module RightResource
 
     def loads(attributes)
       raise ArgumentError, "expected an attributes Hash, got #{attributes.pretty_inspect}" unless attributes.is_a?(Hash)
-      attributes.each_pair {|key,value| @attributes[key.to_s.gsub('-', '_').to_sym] = value}
+      @attributes = attributes.generate_attributes
       self
     end
 
@@ -316,18 +353,18 @@ module RightResource
         #TODO: refactor hard coding
         attrs = self.attributes.reject {|key,value| key.to_s == "cloud_id"}
         pair = URI.decode({resource_name.to_sym => attrs}.to_params).split('&').map {|l| l.split('=')}
-        headers = Hash[*pair.flatten]
-        headers["cloud_id"] = self.attributes[:cloud_id] if self.attributes.has_key?(:cloud_id)
-        connection.put(element_path, headers)
+        h = Hash[*pair.flatten]
+        h["cloud_id"] = self.attributes[:cloud_id] if self.attributes.has_key?(:cloud_id)
+        connection.put(element_path, h)
       end
 
       def create
         #TODO: refactor hard coding
         attrs = self.attributes.reject {|key,value| key.to_s == "cloud_id"}
         pair = URI.decode({resource_name.to_sym => attrs}.to_params).split('&').map {|l| l.split('=')}
-        headers = Hash[*pair.flatten]
-        headers["cloud_id"] = self.attributes[:cloud_id] if self.attributes.has_key?(:cloud_id)
-        connection.post(collection_path, headers)
+        h= Hash[*pair.flatten]
+        h["cloud_id"] = self.attributes[:cloud_id] if self.attributes.has_key?(:cloud_id)
+        connection.post(collection_path, h)
         self.id = self.class.resource_id
       end
 

data/lib/right_resource/core_ext/hash/generate_attributes.rb

@@ -0,0 +1,11 @@
+class Hash
+  def generate_attributes
+    attrs = {}
+    self.each_pair {|key,value| attrs[key.to_s.gsub('-', '_').to_sym] = value}
+    if attrs
+      self.clear
+      self.merge!(attrs)
+    end
+    self
+  end
+end

data/lib/right_resource/core_ext/hash.rb

@@ -0,0 +1 @@
+require 'right_resource/core_ext/hash/generate_attributes'

data/lib/right_resource/core_ext/object.rb

@@ -1,3 +1,3 @@
 if RUBY_VERSION < "1.9.0"
-  require 'right_resource/core_ext/object/tap.rb'
+  require 'right_resource/core_ext/object/tap'
 end

data/lib/right_resource/deployment.rb

@@ -1,15 +1,14 @@
+# == Define methods
+# deployment actions (start_all, stop_all, duplicate)
+# ==== Parameters
+# * +id+ - RightScale deployment resource id(https://my.rightscale.com/deployments/{id})
 class Deployment < RightResource::Base
   class << self
-    def start_all(id)
-      connection.post(element_path(id, :start_all))
-    end
-
-    def stop_all(id)
-      connection.post(element_path(id, :stop_all))
-    end
-
-    def duplicate(id)
-      connection.post(element_path(id, :duplicate))
+    [:start_all, :stop_all, :duplicate].each do |act_method|
+      define_method(act_method) do |id|
+        path = element_path(id, act_method).sub(/\.#{format.extension}$/, '')
+        action(:post, path)
+      end
     end
   end
 end

data/lib/right_resource/ec2_ebs_volume.rb

@@ -1,8 +1,16 @@
+# == alias_method
+# * _attach_to_server_ - component_ec2_ebs_volumes
 class Ec2EbsVolume < RightResource::Base
   class << self
-    def attach_to_server
-      name = "component_ec2_ebs_volumes"
-      raise NotImplementedError
+    # Eb2Volume attach to server
+    # === Parameters
+    # * +params+ - Hash (keys = [:ec2_ebs_volume_href, :component_href, :device, :mount])
+    def component_ec2_ebs_volumes(params)
+      pair = URI.decode({:component_ec2_ebs_volume => elems}.to_params).split('&').map {|l| l.split('=')}
+      h = Hash[*pair.flatten]
+      path = "component_ec2_ebs_volumes"
+      action(:post, path, h)
     end
+    alias_method :attach_to_server, :component_ec2_ebs_volumes
   end
 end

data/lib/right_resource/ec2_elastic_ip.rb

@@ -1,11 +1,6 @@
 class Ec2ElasticIp < RightResource::Base
   class << self
-    def update(id)
-      raise NotImplementedError
-    end
-  end
-
-  def update
-    raise NotImplementedError
+    undef :update
   end
+  undef :update
 end

data/lib/right_resource/ec2_ssh_key.rb

@@ -1,7 +1,5 @@
 class Ec2SshKey < RightResource::Base
   class << self
-    def index(id)
-      raise NotImplementedError
-    end
+    undef :index
   end
 end

data/lib/right_resource/multi_cloud_image.rb

@@ -1,27 +1,6 @@
 class MultiCloudImage < RightResource::Base
   class << self
-    def create
-      raise NotImplementedError
-    end
-
-    def update(id)
-      raise NotImplementedError
-    end
-
-    def destory(id)
-      raise NotImplementedError
-    end
-  end
-
-  def create
-    raise NotImplementedError
-  end
-
-  def update(id)
-    raise NotImplementedError
-  end
-
-  def destory(id)
-    raise NotImplementedError
+    undef :create, :update, :destory
   end
+  undef :create, :update, :destory
 end

data/lib/right_resource/right_script.rb

@@ -1,27 +1,6 @@
 class RightScript < RightResource::Base
   class << self
-    def create
-      raise NotImplementedError
-    end
-
-    def update(id)
-      raise NotImplementedError
-    end
-
-    def destory(id)
-      raise NotImplementedError
-    end
-  end
-
-  def create
-    raise NotImplementedError
-  end
-
-  def update(id)
-    raise NotImplementedError
-  end
-
-  def destory(id)
-    raise NotImplementedError
+    undef :create, :update, :destory
   end
+  undef :create, :update, :destory
 end

data/lib/right_resource/s3_bucket.rb

@@ -1,11 +1,6 @@
 class S3Bucket < RightResource::Base
   class << self
-    def update(id)
-      raise NotImplementedError
-    end
-  end
-
-  def update
-    raise NotImplementedError
+    undef :update
   end
+  undef :update
 end

data/lib/right_resource/server.rb

@@ -1,48 +1,116 @@
+# == define_methods 1
+# Server Action
+# * _start_
+# * _stop_
+# * _restart_
+#
+# === Parameters
+# * _id_ - RightScale server resource id(https://my.rightscale.com/servers/{id})
+# === Examples
+#   server_id = Server.index(:filter => "nickname=dev001").first.id
+#   Server.start(server_id)
+#
+# == define_methods 2
+# Server and other resource action
+# * _run_script_
+# * _attach_volume_
+# === Parameters
+# * _id_ - RightScale server resource id(https://my.rightscale.com/servers/{id})
+# * _params_ - Hash(ex. :right_script, :ec2_ebs_volume_href, :device)
+# === Examples
+#   server_id = 1
+#   params = {:ec2_ebs_volume_href => "https://my.rightscale.com/api/acct/##/ec2_ebs_volumes/1", :device => "/dev/sdj"}
+#   Server.attach_volume(server_id, params) # => 204 No Content
 class Server < RightResource::Base
   class << self
-    #TODO: refactor define_method or method_missing
-    def action; end
-    # server start(Starting created instance)
-    # === Examples
-    #   server_id = Server.index(:filter => "nickname=dev001").first.id
-    #   Server.start(server_id)
-    def start(id)
-      connection.post(element_path(id, :start))
-    end
-
-    # server stop(Starting created instance)
-    def stop(id)
-      connection.post(element_path(id, :stop))
+    [:start, :stop, :reboot].each do |act_method|
+      define_method(act_method) do |id|
+        path = element_path(id, act_method).sub(/\.#{format.extension}$/, '')
+        action(:post, path)
+      end
     end
 
-    # server restart(Starting created instance)
-    def reboot(id)
-      connection.post(element_path(id, :reboot))
+    [:run_script, :attach_volume].each do |act_method|
+      define_method(act_method) do |id,params|
+        elems = params.reject {|key,value| key == :right_script}  # select server resource params
+        pair = URI.decode({resource_name.to_sym => elems}.to_params).split('&').map {|l| l.split('=')}
+        h = Hash[*pair.flatten]
+        h["right_script"] = params[:right_script] if params.has_key?(:right_script)
+        path = element_path(id, act_method)
+        action(:post, path, h)
+      end
     end
 
-    # Run rightscript
-    # location header is status href
-    def run_script(id, params={})
-      raise NotImplementedError
-    end
-
-    def attach_volume(id, params={})
-      raise NotImplementedError
+    # Get sampleing data
+    # === Return
+    #   Hash (keys # => [:cf, :start, :vars, :lag_time, :end, :data :avg_lag_time])
+    # === Examples
+    #   server_id = 848422
+    #   params = {:start => -180, :end => -20, :plugin_name => "cpu-0", :plugin_type => "cpu-idle"}
+    #   Server.get_sketchy_data(server_id, params)
+    def get_sketchy_data(id, params)
+      path = element_path(id, :get_sketchy_data, params)
+      format.decode(action(:get, path)).generate_attributes
     end
 
-    def get_sketchy_data(id, params={})
-      raise NotImplementedError
+    # Get URL of Server monitoring graph
+    # === Examples
+    #   * General Graph
+    #     Server.monitoring(1)
+    #
+    #   * Custumize Graph
+    #     server_id = 1
+    #     params = {:graph_name => "cpu-0/cpu-idle", :size => "small", :period => "day", :title => "MyCpuGraph", :tz => "JST"}
+    #     Server.monitoring(server_id, params)
+    def monitoring(id, params={})
+      if params[:graph_name]
+        prefix_options = params[:graph_name]
+        params.delete(:graph_name)
+        path = element_path(id, :monitoring => prefix_options)
+      else
+        path = element_path(id, :monitoring)
+      end
+      format.decode(action(:get, path, params)).generate_attributes
     end
 
+    # Get Server settings(Subresource)
+    # === Examples
+    #   server_id = Server.index(:filter => "nickname=dev-001").first.id
+    #   settings = Server.settings(server_id)
     def settings(id)
       path = element_path(id, :settings)
-      generate_attributes(format.decode(connection.get(path)))
+      format.decode(action(:get, path)).generate_attributes
+    end
+
+    # Get status of any running jobs after calling to the servers resource to run_script
+    # === Parameters
+    # * +resource_ref+ - Hash[:id] or Hash[:href](execute run_script method response location header)
+    #                   (ex. Location: https://my.rightscale.com/api/acct/##/statuses/{id})
+    # === Examples
+    #   server_id = 1
+    #   right_script_id = 1
+    #   Server.run_script(server_id, :right_script => right_script_id)
+    #   # => 201 Created, location: https://my.rightscale.com/api/acct/##/statuses/12345
+    #
+    #   Server.statuses(:id => Server.resource_id) if Server.status == 201
+    #   or
+    #   Server.statuses(:href => Server.headers[:location]) if Server.status == 201
+    def statuses(resource_ref)
+      path = element_path(id, :get_sketchy_data, params)
+      format.decode(action(:get, path)).generate_attributes
     end
 
+    # Get Server tags(server or ec2_current_instance)
+    # === Parameters
+    # * +resource_href+ - server.href or server.ec2_current_href
+    # === Examples
+    #   server = Server.show(1)
+    #   tags = Server.tags(server.ec2_current_href)
+    #   # => [{"name"=>"rs_login:state=active"}, {"name"=>"rs_logging:state=active"}, {"name"=>"rs_monitoring:state=active"}]
     def tags(resource_href)
-      query_options = {'resource_href' => resource_href}
+      query_options = {:resource_href => resource_href}
       path = "tags/search.#{format.extension}#{query_string(query_options)}"
-      Hash[*format.decode(connection.get(path)).collect {|tag|
+      Hash[*format.decode(action(:get, path)).collect {|tag|
         tag['name'].split('=')
       }.flatten]
     end

data/lib/right_resource/server_array.rb

@@ -1,21 +1,42 @@
 class ServerArray < RightResource::Base
   class << self
+    # server array launch
+    # ==== Parameters
+    # * +id+ - RightScale server array resource id(https://my.rightscale.com/server_arrays/{id})
+    #
+    # === Examples
+    #   array_id = 1
+    #   ServerArray.launch(array_id)
     def launch(id)
-      connection.post(element_path(id, :launch))
+      path = element_path(id, :launch)
+      action(:post, path)
     end
 
+    # server array terminate all
+    # === Examples
+    #   ServerArray.terminate_all(1)
+    #   # => {:ec2_instances=>{"failure"=>[],
+    #          "success"=>[{"ec2_instance_href"=>"https://my.rightscale.com/api/acct/##/ec2_instances/1367"}]}}
     def terminate_all(id)
-      connection.post(element_path(id, :terminate_all))
+      path = element_path(id, :terminate_all)
+      format.decode(action(:post, path)).generate_attributes
     end
 
-    def run_script_on_all(id)
+    # Run script on all
+    # === Exception
+    # * +NotImplementedError+
+    def run_script_on_all(id, params)
       raise NotImplementedError
+#      pair = URI.decode({resource_name.to_sym => params}.to_params).split('&').map {|l| l.split('=')}
+#      h = Hash[*pair.flatten]
+#      path = element_path(id, :run_script_on_all)
+#      action(:post, path, h)
     end
 
     def instances(id)
       path = element_path(id, :instances)
-      result = format.decode(connection.get(path)).map do |instance|
-        generate_attributes(instance)
+      result = format.decode(action(:get, path)).map do |instance|
+        instance.generate_attributes
       end
     end
   end

data/lib/right_resource/server_template.rb

@@ -1,8 +1,11 @@
 class ServerTemplate < RightResource::Base
   class << self
+    # === Parameters
+    # * _id_ - ServerTemplate id
+    # * _params_ - Hash (keys = [:phase]) ex. 'boot', 'operational', 'decommission'
     def executables(id, params={})
       path = element_path(id, :executables, params)
-      instantiate_collection(format.decode(connection.get(path)))
+      format.decode(connection.get(path)).map {|x| x.generate_attributes}
     end
   end
 end

data/lib/right_resource/status.rb

@@ -1,31 +1,6 @@
 class Status < RightResource::Base
   class << self
-    def index(id)
-      raise NotImplementedError
-    end
-
-    def create
-      raise NotImplementedError
-    end
-
-    def update(id)
-      raise NotImplementedError
-    end
-
-    def destory(id)
-      raise NotImplementedError
-    end
-  end
-
-  def create
-    raise NotImplementedError
-  end
-
-  def update(id)
-    raise NotImplementedError
-  end
-
-  def destory(id)
-    raise NotImplementedError
+    undef :index, :create, :update, :destory
   end
+  undef :create, :update, :destory
 end

data/lib/right_resource/tag.rb

@@ -0,0 +1,66 @@
+# == define_methods
+# * _set_
+# * _unset_
+# === Examples
+#   Set tags for a resource
+#     ec2_href = Server.show(1).current_instance_href
+#     params = {:resource_href => ec2_href, :tags => ["xx99_server:role=dev", "xx99_server:group=dev"]}
+#     Tag.set(params)
+#     puts Tag.status
+#     p Tag.search(:resource_href => ec2_href)
+#   Unset tags for a resource
+#     Tag.unset(params)
+#     puts Tag.status
+#     p Tag.search(:resource_href => ec2_href)
+class Tag < RightResource::Base
+  class << self
+    undef :index, :show, :create, :update, :destory
+
+    [:set, :unset].each do |act_method|
+      define_method(act_method) do |params|
+        path = "#{get_tag_resource_path(act_method)}"
+        action(:put, path, params)
+      end
+    end
+
+    # Search tags for a resource(resource_href in params) or resources matching giving tags
+    # === Parameters
+    # * +params+ - Hash (keys = [:resource_href or :resource_type, :match_all, :tags])
+    # === Return
+    # Array(tags)
+    # === Examples
+    #   Get tags for a resource
+    #     Tag.search(:resource_href => "/ec2_instances/1")
+    #
+    #   Get resources matching tags
+    #     param = {:resource_type => "ec2_instance", :tags => ["x99_db:role=*"]}
+    #     servers = Tag.search(p).select {|server| server[:state] == "operational"}.map do |resource|
+    #       Server.new(resource)
+    #     end
+    #
+    #     param = {:resource_type => "ec2_instance", :match_all => 'true', :tags => ["x99_db:role=slave"]}
+    #     servers = Tag.search(p).select {|server| server[:state] == "operational"}.map do |resource|
+    #       Server.new(resource)
+    #     end
+    def search(params)
+      path = "#{get_tag_resource_path("search")}.#{format.extension}#{query_string(params)}"
+      result = format.decode(action(:get, path)).map do |tags|
+        tags.generate_attributes
+      end
+    end
+
+    # === Examples
+    #   Tag.taggable_resources
+    def taggable_resources
+#      "#{self.name.to_s.split('::').last}s/#{__method__}" if RUBY_VERSION >= "1.8.7"
+      path = get_tag_resource_path("taggable_resources")
+      RightResource::Formats::XmlFormat.decode(action(:get, path))
+    end
+
+    private
+    def get_tag_resource_path(method_name)
+      "#{self.name.to_s.split('::').last.downcase}s/#{method_name}"
+    end
+  end
+  undef :create, :update, :destory
+end

data/lib/right_resource.rb

@@ -27,7 +27,7 @@ require 'right_resource/ec2_ssh_key'
 require 'right_resource/server_array'
 require 'right_resource/ec2_ebs_snapshot'
 require 'right_resource/s3_bucket'
-#require 'right_resource/tag'
+require 'right_resource/tag'
 # Design API
 require 'right_resource/server_template'
 require 'right_resource/right_script'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rightresource
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Satoshi Ohki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 +09:00
+date: 2010-11-15 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,6 +80,8 @@ files:
 - lib/right_resource/alert_spec.rb
 - lib/right_resource/base.rb
 - lib/right_resource/connection.rb
+- lib/right_resource/core_ext/hash/generate_attributes.rb
+- lib/right_resource/core_ext/hash.rb
 - lib/right_resource/core_ext/object/tap.rb
 - lib/right_resource/core_ext/object.rb
 - lib/right_resource/core_ext.rb
@@ -101,6 +103,7 @@ files:
 - lib/right_resource/server_array.rb
 - lib/right_resource/server_template.rb
 - lib/right_resource/status.rb
+- lib/right_resource/tag.rb
 - lib/right_resource.rb
 has_rdoc: true
 homepage: https://github.com/satsv/rightresource