ace-client 0.0.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 tily
+
+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,106 @@
+# ACE (Amazon Compatible Environment) Client
+
+## Synopsis
+
+Simple ACE (Amazon Compatible Environment) client for debugging and testing.
+On ACE, see [Transcend Computing | Amazon Compatible Environment](http://www.transcendcomputing.com/features/amazon-compatible-environment/).
+
+## Background
+
+On the view of API testing, AWS SDK is too complicated and not easy to fall back to lower levels like creating signature and sending requests.
+Also, it validates parameters on the client side, and we can not test server-side validation.
+ace-client solves this problem, and provide simple interface to test ACE environments.
+
+## Features
+
+* no client-side validation
+* no dynamic API exception (both success and error response is returned as raw response)
+
+## Usage
+
+### Good Old Query + Sig2 Client
+
+RDS:
+
+    require 'ace-client'
+
+    rds = AceClient::Query2.new(
+      :endpoint => 'rds.ap-northeast-1.amazonaws.com',
+      :access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+      :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+    )
+    res = rds.action('DescribeDBEngineVersions', 'MaxRecords' => '20')
+    p res['DescribeDBEngineVersionsResponse']['DescribeDBEngineVersionsResult']['DBEngineVersions']['DBEngineVersion'].first
+    # => {"DBParameterGroupFamily"=>"mysql5.1", "Engine"=>"mysql", "DBEngineDescription"=>"MySQL Community Edition", "EngineVersion"=>"5.1.50", "DBEngineVersionDescription"=>"MySQL 5.1.50"}
+
+SQS:
+
+    require 'ace-client'
+    
+    sqs = AceClient::Query2.new(
+      :endpoint => 'sqs.ap-northeast-1.amazonaws.com',
+      :version => '2012-11-05',
+      :access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+      :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+    )
+    p sqs.action('CreateQueue', 'QueueName' => 'queue001')
+    # => #<HTTParty::Response:0x163e5308 parsed_response={"CreateQueueResponse"=>{"CreateQueueResult"=>{"QueueUrl"=>"https://sqs.ap-northeast-1.amazonaws.com/370162190418/queue001"}, "ResponseMetadata"=>{"RequestId"=>"66640219-a36d-54d8-8c56-491a1f19fa2c"}}}, @response=#<Net::HTTPOK 200 OK readbody=true>, @headers={"server"=>["Server"], "date"=>["Mon, 18 Nov 2013 06:56:52 GMT"], "content-type"=>["text/xml"], "content-length"=>["333"], "connection"=>["close"], "x-amzn-requestid"=>["66640219-a36d-54d8-8c56-491a1f19fa2c"]}>
+
+### Query + Sig4 Client
+
+(coming soon)
+
+### JSON + Sig4 Client
+
+(coming soon)
+
+### Setting HTTP Proxy
+
+Construct your client with :http_proxy option (Proxy user and password is not currently supported.)
+
+    sqs = AceClient::Query2.new(
+      :endpoint => 'sqs.ap-northeast-1.amazonaws.com',
+      :access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+      :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY'],
+      :http_proxy => 'http://example.com:8080'
+    )
+    p rdb.action('ListQueues')
+
+### GET/POST Support
+
+you can specify your http method with :http_method option (Default is :post).
+
+    sqs = AceClient::Query2.new(
+      :http_method => :get,
+      :endpoint => 'sqs.ap-northeast-1.amazonaws.com',
+      :access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+      :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY'],
+      :http_proxy => 'http://example.com:8080'
+    )
+    p sqs.action('ListQueues')
+
+### Getting Last Response Info
+
+    sqs = AceClient::Query2.new(
+      :endpoint => 'sqs.ap-northeast-1.amazonaws.com',
+      :access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+      :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+    )
+    p sqs.action('ListQueues')
+    p sqs.last_response      # currently HTTParty::Response object
+    p sqs.last_response_time # returned in seconds (Float object)
+
+## TODO
+
+* user agent support
+* query + sig4 support
+* json + sig4 support
+* dry run mode (for genarating signatures)
+* logging
+  * human readable 'Sample Request & Response' format
+    * masking access_key_id and signature
+* handle redirects
+* socket/connection timeout configuration
+* rewrite query and header before/after genrating signature (maybe hook-like interface)
+
+## Copyright

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ace-client"
+  gem.homepage = "http://github.com/tily/ace-client"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple ACE(Amazon Compatible Environment) Client}
+  gem.description = %Q{Simple ACE(Amazon Compatible Environment) Client}
+  gem.email = "tily05@gmail.com"
+  gem.authors = ["tily"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ace-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/ace-client.rb

@@ -0,0 +1,7 @@
+require 'ace-client/base'
+require 'ace-client/query2'
+require 'ace-client/query4'
+
+module AceClient
+  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').chomp
+end

data/lib/ace-client/base.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+require 'uri'
+
+module AceClient
+  class Base
+    include HTTParty
+
+    attr_accessor :access_key_id
+    attr_accessor :secret_access_key
+    attr_accessor :endpoint
+    attr_accessor :http_proxy
+    attr_accessor :http_method
+    attr_accessor :use_ssl
+    attr_accessor :last_response_time
+
+    def initialize(options)
+      @access_key_id = options[:access_key_id]
+      @secret_access_key = options[:secret_access_key]
+      @endpoint = options[:endpoint]
+      @http_proxy = options[:http_proxy]
+      @http_method = options[:http_method] || :post
+      @use_ssl = options[:use_ssl] || true
+      @version = options[:version]
+      @path = options[:path] || '/'
+      set_http_proxy
+    end
+
+    def set_http_proxy
+      if @http_proxy
+        uri = URI.parse(@http_proxy)
+        self.class.http_proxy(uri.scheme + '://' + uri.host, uri.port)
+      end
+    end
+
+    def record_response
+      start_time = Time.now
+      @last_response = yield
+      @last_response_time = Time.now - start_time
+      @last_response
+    end
+  end
+end

data/lib/ace-client/query2.rb

@@ -0,0 +1,65 @@
+require 'openssl'
+require 'cgi'
+
+module AceClient
+  class Query2 < Base
+    attr_accessor :http_method
+    attr_accessor :signature_method # TODO: HMAC-SHA256 or HMAC-SHA1
+
+    format :xml
+    #debug_output $stderr
+
+    def initialize(options={})
+      super(options)
+      @signature_method = options[:signature_method] || 'HmacSHA256'
+    end
+
+    def action(action, params={})
+      params.update('Action' => action)
+      execute(params)
+    end
+
+    def execute(params={})
+      @params = params
+      @params.update(
+        'SignatureVersion' => '2',
+        'SignatureMethod' => @signature_method,
+        'AWSAccessKeyId' => @access_key_id,
+        'Timestamp' => Time.now.getutc.iso8601.sub(/Z/, sprintf(".%03dZ",(Time.now.getutc.usec/1000)))
+      )
+      @params['Version'] = @version if @version
+      @params['Signature'] = create_signature
+
+      response = record_response do
+        response = self.class.send(
+           http_method,
+           endpoint_url,
+          :headers => {'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8', 'User-Agent' => 'ace-client v0.0.1'},
+          :query => @params
+        )
+      end
+      response
+    end
+
+    def endpoint_url
+      protocol = use_ssl ? 'https' : 'http' 
+      protocol + '://' + endpoint
+    end
+
+    def create_signature
+      digest = OpenSSL::Digest::Digest.new(@signature_method.downcase.gsub(/hmac/, ''))
+      Base64.encode64(OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)).strip
+    end
+
+    def string_to_sign
+      p [@http_method.to_s.upcase, @endpoint, @path, canonical_query_string].join("\n")
+      [@http_method.to_s.upcase, @endpoint, @path, canonical_query_string].join("\n")
+    end
+
+    def canonical_query_string
+      @params.sort.collect { |param|
+        "#{CGI::escape(param[0])}=#{CGI::escape(param[1])}"
+      }.join("&").gsub('+', '%20').gsub('%7E', '~')
+    end
+  end
+end

data/lib/ace-client/query4.rb

@@ -0,0 +1,5 @@
+module AceClient
+  class Query4 < Base
+    # not implemented yet
+  end
+end

data/spec/ace-client_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AceClient" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ace-client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ace-client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- tily
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &57501080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *57501080
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &57500260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *57500260
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &57499240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *57499240
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &57495300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *57495300
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &57493560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *57493560
+description: Simple ACE(Amazon Compatible Environment) Client
+email: tily05@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/ace-client.rb
+- lib/ace-client/base.rb
+- lib/ace-client/query2.rb
+- lib/ace-client/query4.rb
+- spec/ace-client_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tily/ace-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4298272965098336729
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: Simple ACE(Amazon Compatible Environment) Client
+test_files: []