enstratus_helper 0.0.1

data/README.md

@@ -0,0 +1,41 @@
+# enstratus_helper
+enstratus_helper is a simple ruby class that helps making request to enStratus web service easier. With enstratus_helper, you only have to specify the resource you want to request, and it will handle the signature generation & HTTP header initialization for you.
+
+
+## Usage
+
+```ruby
+     require 'enstratus_helper'
+     access_key = "my_access_key"
+     secret_key = "super_secret_key"
+
+     ehelper = EnstratusHelper.new(:access_key => access_key, :secret_key => secret_key)
+
+     # You can specify whether to use json or xml format
+     ehelper = EnstratusHelper.new(:access_key => access_key, :secret_key => secret_key, :accept => 'application/json')
+
+     # Example of doing GET requests
+     puts ehelper.request :get, 'http://api.enstratus.com/api/enstratus/2011-02-24/geography/Region'
+     puts ehelper.request :get, 'http://api.enstratus.com/api/enstratus/2011-02-24/infrastructure/MachineImage?regionId=my_region_id'
+     puts ehelper.request :get, 'http://api.enstratus.com/api/enstratus/2011-02-24/infrastructure/Server'
+
+     # You can explicitly define GET request header. Here, we're explicitly specifying the format to be JSON
+     #puts ehelper.request :get, 'http://api.enstratus.com/api/enstratus/2011-02-24/admin/BillingCode', :header => {'Accept' => 'application/json'}
+
+     # Example of doing POST requests
+     xml_data =<<EOF
+     <addBillingCode>
+       <billingCode>
+         <name>API Dev 1</name>
+         <financeCode>API 1</financeCode>
+         <description>API Development</description>
+         <softQuota>USD50.00</softQuota>
+       </billingCode>
+     </addBillingCode>
+     EOF
+     json_data = {:addBillingCode => {:billingCode => {:name => 'API 3', :financeCode => "API 3", :description => "description", :softQuota => 'USD11.01', :hardQuota => 'USD11.11'}}}.to_json
+
+     ehelper.request :post, 'http://api.enstratus.com/api/enstratus/2011-02-24/admin/BillingCode', :data => xml_data
+     ehelper.request :post, 'http://api.enstratus.com/api/enstratus/2011-02-24/admin/BillingCode', :data => xml_data, :header => {'Accept' => 'application/xml'}
+     ehelper.request :post, 'http://api.enstratus.com/api/enstratus/2011-02-24/admin/BillingCode', :data => json_data, :header => {'Accept' => 'application/json'}
+```

data/lib/enstratus_helper.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'base64'
+require 'rest_client'
+require 'digest/sha2'
+require 'openssl'
+require 'uri'
+
+class EnstratusHelper
+  CONFIGURABLE_ATTRIBUTES = [
+    :details,
+    :accept,
+    :secret_key,
+    :access_key
+  ]
+  attr_accessor *CONFIGURABLE_ATTRIBUTES
+
+  def initialize(options = {})
+    CONFIGURABLE_ATTRIBUTES.each do |attribute_name|
+      self.send("#{attribute_name}=", options[attribute_name]) if options.has_key?(attribute_name)
+    end
+    @accept ||= 'application/xml'
+    @details ||= 'extended'
+  end
+
+  # Generates the required headers for talking to enStratus API 
+  # signature is of the following format: 
+  #   BASE64(SHA256(ACCESS_KEY:METHOD:URI:TIMESTAMP:USER_AGENT))
+  def generate_header(uri, http_method, options={})
+    http_method = http_method.to_s.upcase
+    path = URI.parse(uri).path
+    timestamp = Time.now.to_i * 1000
+    signature = "#{@access_key}:#{http_method}:#{path}:#{timestamp}:#{self.class}"
+    signature = EnstratusHelper::sign(@secret_key, signature)
+    {'x-esauth-access' => @access_key, 'x-esauth-signature' => signature, 
+     'x-esauth-timestamp' => timestamp, 'User-agent' => self.class, 
+     'x-es-details' => details, 'Accept' => accept}
+  end
+
+  # Sends the request to the given URI using the specified method (GET by default)
+  # Returns the response object (of the rest-client library)
+  def request(method, uri, options={})
+    response = nil
+    data = options[:data]
+    header = generate_header(uri, method)
+    header = header.merge(options[:header]) if options[:header]
+    begin
+      case method
+      when :get
+        response = RestClient.send(method, uri, header)
+      when :delete
+        response = RestClient.send(method, uri, header)
+      when :post
+        header[:content_type] = 'application/xml'
+        response = RestClient.send(method, uri, data, header)
+      when :put
+        response = RestClient.send(method, uri, data, header)
+      else
+        raise "HTTP method #{method} not supported"  
+      end
+    rescue => e
+      puts e.inspect
+    end
+    response
+  end
+
+  # Generates the signature for talking to enStratus
+  def self.sign(key, str_to_sign)
+    digest = OpenSSL::Digest::Digest.new('sha256')
+    Base64.encode64(OpenSSL::HMAC.digest(digest, key, str_to_sign)).gsub("\n","")
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: enstratus_helper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Darren Dao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: darrendao@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/enstratus_helper.rb
+homepage: http://github.com/darrendao/enstratus_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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.8.11
+signing_key: 
+specification_version: 2
+summary: Simple ruby wrapper to make it easier to talk to enStratus API
+test_files: []
+
+has_rdoc: true