right_api_client 1.5.1

data/lib/right_api_client/helper.rb

@@ -0,0 +1,192 @@
+# Methods shared by the Client, Resource and Resources.
+module RightApi::Helper
+  # Some resource_types are not the same as the last thing in the URL, put these here to ensure consistency
+  INCONSISTENT_RESOURCE_TYPES = {
+    'current_instance' => 'instance',
+    'data'  => 'monitoring_metric_data',
+    'setting'  => 'multi_cloud_image_setting'
+  }
+
+  # 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'],
+    :destroy  => ['deployment', 'server_array', 'server', 'ssh_key', 'volume', 'volume_snapshot', 'volume_attachment', 'backup'],
+    :update   => ['deployment', 'instance', 'server_array', 'server', 'backup'],
+    :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 = {
+    'instances' => {:multi_terminate => 'do_post', :multi_run_executable => 'do_post'},
+    'inputs'    => {:multi_update    => 'do_put'},
+    'tags'      => {:by_tag          => 'do_post', :by_resource => 'do_post', :multi_add => 'do_post', :multi_delete =>'do_post'},
+    'backups'   => {:cleanup         => 'do_post'}
+  }
+
+  # List of resources that are available as instance-facing calls
+  INSTANCE_FACING_RESOURCES = [:backups, :live_tasks, :volumes, :volume_attachments, :volume_snapshots, :volume_types]
+
+  # Helper used to add methods to classes dynamically
+  def define_instance_method(meth, &blk)
+    (class << self; self; end).module_eval do
+      define_method(meth, &blk)
+    end
+  end
+
+  # Helper method that returns all api methods available to a client or resource
+  def api_methods
+    self.methods(false)
+  end
+
+  # Helper method that creates instance methods out of the associated resources from links
+  # Some resources have many links with the same rel.
+  # We want to capture all these href in the same method, returning an array
+  def get_associated_resources(client, links, associations)
+    # First go through the links and group the rels together
+    rels = {}
+    links.each do |link|
+      if rels[link['rel'].to_sym]  # if we have already seen this rel attribute
+        rels[link['rel'].to_sym] << link['href']
+      else
+        rels[link['rel'].to_sym] = [link['href']]
+      end
+    end
+
+    # Note: hrefs will be an array, even if there is only one link with that rel
+    rels.each do |rel,hrefs|
+      # Add the link to the associations set if present. This is to accommodate ResourceDetail objects
+      associations << rel if associations != nil
+
+      # Create methods so that the link can be followed
+      define_instance_method(rel) do |*args|
+        if hrefs.size == 1 # Only one link for the specific rel attribute
+          if has_id(*args) || is_singular?(rel)
+            # User wants a single resource. Either doing a show, update, delete...
+            # get the resource_type
+
+            # Special case: calling .data you don't want a resources object back
+            # but rather all its details since you cannot do a show
+            return RightApi::ResourceDetail.new(client, *client.do_get(hrefs.first, *args)) if rel == :data
+
+            if is_singular?(rel)
+              # Then the href will be: /resource_type/:id
+              resource_type = get_singular(hrefs.first.split('/')[-2])
+            else
+              # Else the href will be: /resource_type
+              resource_type = get_singular(hrefs.first.split('/')[-1])
+            end
+            path = add_id_and_params_to_path(hrefs.first, *args)
+            RightApi::Resource.process(client, resource_type, path)
+          else
+            # Returns the class of this resource
+            resource_type = hrefs.first.split('/')[-1]
+            path = add_id_and_params_to_path(hrefs.first, *args)
+            RightApi::Resources.new(client, path, resource_type)
+          end
+        else
+          # There were multiple links with the same relation name
+          # This occurs in tags.by_resource
+          resources = []
+          if has_id(*args) || is_singular?(rel)
+            hrefs.each do |href|
+              # User wants a single resource. Either doing a show, update, delete...
+              if is_singular?(rel)
+                resource_type = get_singular(href.split('/')[-2])
+              else
+                resource_type = get_singular(href.split('/')[-1])
+              end
+              path = add_id_and_params_to_path(href, *args)
+              resources << RightApi::Resource.process(client, resource_type, path)
+            end
+          else
+            hrefs.each do |href|
+              # Returns the class of this resource
+              resource_type = href.split('/')[-1]
+              path = add_id_and_params_to_path(href, *args)
+              resources << RightApi::Resources.new(client, path, resource_type)
+            end
+          end
+          # return the array of resource objects
+          resources
+        end
+      end
+    end
+  end
+
+
+  # Helper method that checks whether params contains a key :id
+  def has_id(params = {})
+    params.has_key?(:id)
+  end
+
+  # Helper method that adds filters and other parameters to the path
+  # Normally you would just pass a hash of query params to RestClient,
+  # but unfortunately it only takes them as a hash, and for filtering
+  # we need to pass multiple parameters with the same key. The result
+  # is that we have to build up the query string manually.
+  # This does not modify the original_path but will change the params
+  def add_id_and_params_to_path(original_path, params = {})
+    path = original_path.dup
+
+    path += "/#{params.delete(:id)}" if has_id(params)
+    filters = params.delete(:filter)
+    params_string = params.map{|k,v| "#{k.to_s}=#{CGI::escape(v.to_s)}" }.join('&')
+    if filters && filters.any?
+      path += "?filter[]=" + filters.map{|f| CGI::escape(f) }.join('&filter[]=')
+      path += "&#{params_string}"
+    else
+      path += "?#{params_string}"
+    end
+
+    # If present, remove ? and & at end of path
+    path.chomp!('&')
+    path.chomp!('?')
+    path
+  end
+
+  # Helper method that inserts the given term at the correct place in the path
+  # If there are parameters in the path then insert it before them.
+  # Will not change path.
+  def insert_in_path(path, term)
+    if path.index('?')
+      # sub returns a copy of path
+      new_path = path.sub('?', "/#{term}?")
+    else
+      new_path = "#{path}/#{term}"
+    end
+  end
+
+  # Helper method that checks whether the string is singular
+  def is_singular?(str)
+    return true if ['data'].include?(str.to_s)
+    (str.to_s)[-1] != 's'
+  end
+
+  # Does not modify links
+  def get_href_from_links(links)
+    if links
+      self_link = links.detect{|link| link["rel"] == "self"}
+      return self_link["href"] if self_link
+    end
+    return nil
+  end
+
+  # This will modify links
+  def get_and_delete_href_from_links(links)
+    if links
+      self_link = links.detect{|link| link["rel"] == "self"}
+      return links.delete(self_link)["href"] if self_link
+    end
+    return nil
+  end
+
+  # Will not change obj
+  def get_singular(obj)
+    str = obj.to_s.dup
+    str.chomp!('s')
+    str
+  end
+end

data/lib/right_api_client/resource.rb

@@ -0,0 +1,61 @@
+module RightApi
+  # Represents a Resource. This is a filler class for a single resource.
+  # This class dynamically adds methods and properties to instances depending on what type of resource they are.
+  class Resource
+    include Helper
+
+    # Will create a (or an array of) new Resource object(s)
+    # All parameters are treated as read only
+    def self.process(client, resource_type, path, data={})
+      if data.kind_of?(Array)  # This is needed for the index call to return an array of all the resources
+        data.collect do |obj|
+          # Ideally all objects should have a links attribute that will have a link called 'self' which is the href.
+          # For exceptions like inputs, use the path itself.
+          obj_href = client.get_href_from_links(obj["links"]) || path
+          ResourceDetail.new(client, resource_type, obj_href, obj)
+        end
+      else
+        RightApi::Resource.new(client, resource_type, path, data)
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} " +
+      "resource_type=\"#{@resource_type}\"" +
+      "#{', name='+@hash["name"].inspect if @hash.has_key?("name")}" +
+      "#{', resource_uid='+@hash["resource_uid"].inspect if @hash.has_key?("resource_uid")}>"
+    end
+
+    # Hash is only used for index calls so we can parse out the name and resource_uid for the inspect call
+    # All parameters are treated as read only
+    def initialize(client, resource_type, href, hash={})
+      if INCONSISTENT_RESOURCE_TYPES.has_key?(resource_type)
+        resource_type = INCONSISTENT_RESOURCE_TYPES[resource_type]
+      end
+      # For the inspect function:
+      @resource_type = resource_type
+      @hash = hash
+
+      # Add destroy method to relevant resources
+      if Helper::RESOURCE_ACTIONS[:destroy].include?(resource_type)
+        define_instance_method('destroy') do
+          client.do_delete(href)
+        end
+      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
+      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
+      end
+    end
+  end
+end

data/lib/right_api_client/resource_detail.rb

@@ -0,0 +1,115 @@
+module RightApi
+  # Takes the information returned from the API and converts it into instance methods
+  class ResourceDetail
+    include Helper
+    attr_reader :client, :attributes, :associations, :actions, :raw, :resource_type
+
+    def inspect
+      "#<#{self.class.name} " +
+      "resource_type=\"#{@resource_type}\"" +
+      "#{', name=' + name.inspect if self.respond_to?(:name)}" +
+      "#{', resource_uid='+ resource_uid.inspect if self.respond_to?(:resource_uid)}>"
+    end
+
+    # ResourceDetail will MODIFY hash
+    def initialize(client, resource_type, href, hash)
+      @client = client
+      @resource_type = resource_type
+      @raw = hash.dup
+      @attributes, @associations, @actions = Set.new, Set.new, Set.new
+
+      links = hash.delete('links') || []
+      raw_actions = hash.delete('actions') || []
+
+      # We have to delete the self href from the links because later we will
+      # go through these links and add them in as methods
+      self_hash = get_and_delete_href_from_links(links)
+      if self_hash != nil
+        hash['href'] = self_hash
+      end
+
+      # Add links to attributes set and create a method that returns the links
+      attributes << :links
+      define_instance_method(:links) { return links }
+
+      # Follow the actions:
+        # API doesn't tell us whether a resource action is a GET or a POST, but
+        # they are all post so add them all as posts for now.
+      raw_actions.each do |action|
+        action_name = action['rel']
+        # Add it to the actions set
+        actions << action_name.to_sym
+
+        define_instance_method(action_name.to_sym) do |*args|
+          action_href = hash['href'] + "/" + action['rel']
+          client.do_post(action_href, *args)
+        end
+      end
+
+      # Follow the links to create methods
+      get_associated_resources(client, links, associations)
+
+      # Some resources are not linked together, so they have to be manually
+      # added here.
+      case resource_type
+      when 'instance'
+        define_instance_method('live_tasks') do |*args|
+          if has_id(*args)
+            path = href + '/live/tasks'
+            path = add_id_and_params_to_path(path, *args)
+            RightApi::Resource.process(client, 'live_task', path)
+          end
+        end
+      end
+
+      # Add the rest as instance methods
+      hash.each do |k, v|
+        # If a parent resource is requested with a view then it might return
+        # extra data that can be used to build child resources here, without
+        # doing another get request.
+        if associations.include?(k.to_sym)
+          # v might be an array or hash so use include rather than has_key
+          if v.include?('links')
+            child_self_link = v['links'].find { |target| target['rel'] == 'self' }
+            if child_self_link
+              child_href = child_self_link['href']
+              if child_href
+                # Currently, only instances need this optimization, but in the
+                # future we might like to extract resource_type from child_href
+                # and not hard-code it.
+                if child_href.index('instance')
+                  define_instance_method(k) { RightApi::Resource.process(client, 'instance', child_href, v) }
+                end
+              end
+            end
+          end
+        else
+          # Add it to the attributes set and create a method for it
+          attributes << k.to_sym
+          define_instance_method(k) { return v }
+        end
+      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
+      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
+      end
+
+      # Add show method to relevant resources
+      if !Helper::RESOURCE_ACTIONS[:no_show].include?(resource_type)
+        define_instance_method('show') do |*args|
+          self
+        end
+      end
+    end
+  end
+end

data/lib/right_api_client/resources.rb

@@ -0,0 +1,51 @@
+module RightApi
+  # This class defines the different resource types and the methods that one can call on them
+  # This class dynamically adds methods and properties to instances depending on what type of resource they are.
+  # This is a filler class so that we don't always have to do an index before anything else
+  # This class gets instantiated when the user calls (for example) client.clouds ... (ie. when you want the generic class: no id present)
+  class Resources
+    include Helper
+
+    def inspect
+      "#<#{self.class.name} " +
+      "resource_type=\"#{@resource_type}\">"
+    end
+
+    # Since this is just a filler class, only define instance methods and the method api_methods()
+    # Resource_type should always be plural.
+    # All parameters are treated as read only
+    def initialize(client, path, resource_type)
+      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
+      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
+        end
+      end
+
+      # Adding in special cases
+      Helper::RESOURCE_SPECIAL_ACTIONS[resource_type].each do |meth, action|
+        # Insert_in_path will NOT modify path
+        action_path = insert_in_path(path, meth)
+        self.define_instance_method(meth) do |*args|
+          client.send action, action_path, *args
+        end
+      end if Helper::RESOURCE_SPECIAL_ACTIONS[resource_type]
+    end
+  end
+end

data/lib/right_api_client/version.rb

@@ -0,0 +1,8 @@
+# This gem is versioned with the usual X.Y.Z notation, where X.Y is the API version, and Z is the client version.
+module RightApi
+  class Client
+    API_VERSION = '1.5'
+    CLIENT_VERSION = '1'
+    VERSION = "#{API_VERSION}.#{CLIENT_VERSION}"
+  end
+end

data/login_to_client_irb.rb

@@ -0,0 +1,15 @@
+# A quick way to login to the API and jump into IRB so you can experiment with the client.
+# Add this to your bash profile to make it simpler:
+#   alias client='bundle exec ruby login_to_client_irb.rb'
+
+require File.expand_path('../lib/right_api_client', __FILE__)
+require 'yaml'
+require 'irb'
+
+begin
+  @client = RightApi::Client.new(YAML.load_file(File.expand_path('../config/login.yml', __FILE__)))
+  puts "logged-in to the API, use the '@client' variable to use the client, e.g. '@client.session.index.message' will output:"
+  puts @client.session.index.message
+end
+
+IRB.start