ace-client 0.0.2 → 0.0.3

data/README.md

@@ -90,15 +90,83 @@ you can specify your http method with :http_method option (Default is :post).
     p sqs.last_response      # currently HTTParty::Response object
     p sqs.last_response_time # returned in seconds (Float object)
 
+### Dry-Run Mode
+
+If you want to get request information rather than sending actual request, use `dryrun` instead of `action`.
+`dryrun` returns HTTParty::Request object that would have been performed if you have used `action`.
+On HTTParty::Request class, see HTTParty's document.
+
+    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']
+    )
+    req = sqs.dryrun('CreateQueue', 'QueueName' => 'queue001')
+    puts req.uri.to_s
+    # => https://sqs.ap-northeast-1.amazonaws.com/?QueueName=queue001&Action=CreateQueue&SignatureVersion=2&SignatureMethod=HmacSHA256&AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Timestamp=2013-11-19T08%3A53%3A40.115Z&Version=2012-11-05&Signature=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
+
+### Setting User-Agent in HTTP Request Header
+
+Specify `:user_agent` option in your constructor.
+
+    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'],
+      :user_agent => "ace-client v#{AceClient::VERSION}"
+    )
+
+### Output Sample Request/Response Log
+
+Set :sampler option to output AWS-document-like logs.
+
+If you write code like this:
+
+    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'],
+      :sampler => {
+        :output => STDOUT,
+        :echo => {
+          'AWSAccessKeyId' => '<AWS Access Key Id>',
+          'Signature' => '<Signature>'
+        }
+      }
+    )
+    sqs.action('CreateQueue', 'QueueName' => 'queue001')
+
+Then output would be:
+
+    # CreateQueue
+    ## request
+    https://sqs.ap-northeast-1.amazonaws.com/
+        ?Action=CreateQueue
+        &QueueName=queue001
+        &Version=2012-11-05
+        &SignatureVersion=2
+        &SignatureMethod=HmacSHA256
+        &Timestamp=2013-11-19T10%3A51%3A46.110Z
+        &AWSAccessKeyId=<AWS Access Key Id>
+        &Signature=<Signature>
+    ## response
+    <?xml version="1.0"?>
+    <CreateQueueResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
+        <CreateQueueResult>
+            <QueueUrl>https://sqs.ap-northeast-1.amazonaws.com/370162190418/queue001</QueueUrl>
+        </CreateQueueResult>
+        <ResponseMetadata>
+            <RequestId>1406b1f3-c3e5-51ac-a291-faf686e77b1e</RequestId>
+        </ResponseMetadata>
+    </CreateQueueResponse>
+
 ## 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)

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/ace-client/base.rb

@@ -11,7 +11,9 @@ module AceClient
     attr_accessor :http_proxy
     attr_accessor :http_method
     attr_accessor :use_ssl
+    attr_accessor :last_response
     attr_accessor :last_response_time
+    attr_accessor :user_agent
 
     def initialize(options)
       @access_key_id = options[:access_key_id]
@@ -22,6 +24,7 @@ module AceClient
       @use_ssl = options[:use_ssl] || true
       @version = options[:version]
       @path = options[:path] || '/'
+      @user_agent = options[:user_agent]
       set_http_proxy
     end
 

data/lib/ace-client/query2.rb

@@ -1,17 +1,20 @@
 require 'openssl'
 require 'cgi'
+require 'nokogiri'
 
 module AceClient
   class Query2 < Base
     attr_accessor :http_method
     attr_accessor :signature_method # TODO: HMAC-SHA256 or HMAC-SHA1
+    attr_accessor :sampler
 
     format :xml
-    #debug_output $stderr
+    debug_output $stderr
 
     def initialize(options={})
       super(options)
       @signature_method = options[:signature_method] || 'HmacSHA256'
+      @sampler = options[:sampler]
     end
 
     def action(action, params={})
@@ -19,7 +22,12 @@ module AceClient
       execute(params)
     end
 
-    def execute(params={})
+    def dryrun(action, params={})
+      params.update('Action' => action)
+      execute(params, true)
+    end
+
+    def execute(params={}, dryrun=false)
       @params = params
       @params.update(
         'SignatureVersion' => '2',
@@ -30,15 +38,57 @@ module AceClient
       @params['Version'] = @version if @version
       @params['Signature'] = create_signature
 
-      response = record_response do
-        response = self.class.send(
-           http_method,
-           endpoint_url + @path,
-          :headers => {'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8', 'User-Agent' => 'ace-client v0.0.1'},
-          :query => @params
-        )
+      options = {
+        :headers => {
+          'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8'
+        },
+        :query => @params
+      }
+      options[:headers]['User-Agent'] = @user_agent if @user_agent
+
+      if http_method == :get
+        http_method_class = Net::HTTP::Get
+      elsif http_method == :post
+        http_method_class = Net::HTTP::Post
       end
-      response
+
+      request = HTTParty::Request.new(http_method_class, endpoint_url + @path, options)
+      if dryrun
+        request
+      else
+        sample_request(request) if @sampler
+        response = record_response { request.perform }
+        sample_response(response) if @sampler
+        response
+      end
+    end
+
+    def sample_request(request)
+      query = request.options[:query].dup
+      variable_keys = %w(Version SignatureVersion SignatureMethod Timestamp AWSAccessKeyId Signature)
+      variables = {}
+      variable_keys.each do |key|
+        variables[key] = query.delete(key)
+      end
+      action = query.delete('Action')
+      @sampler[:output].puts "# #{action}"
+      @sampler[:output].puts "## request"
+      @sampler[:output].puts "#{request.path.to_s}"
+      @sampler[:output].puts "    ?Action=#{action}"
+      query.each do |key, value|
+        @sampler[:output].puts "    &#{key}=#{CGI.escape(value)}"
+      end
+      variable_keys.each do |key|
+        if variables[key]
+          value = @sampler[:echo][key] || CGI.escape(variables[key])
+          @sampler[:output].puts "    &#{key}=#{value}"
+        end
+      end
+    end
+
+    def sample_response(response)
+      @sampler[:output].puts "## response"
+      @sampler[:output].puts Nokogiri::XML(response.body).to_xml(:indent => 4)
     end
 
     def endpoint_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ace-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000Z
+date: 2013-11-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &205459260 !ruby/object:Gem::Requirement
+  requirement: &14649500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *205459260
+  version_requirements: *14649500
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &205458020 !ruby/object:Gem::Requirement
+  requirement: &14631440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *205458020
+  version_requirements: *14631440
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &205456560 !ruby/object:Gem::Requirement
+  requirement: &14629720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *205456560
+  version_requirements: *14629720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &205455020 !ruby/object:Gem::Requirement
+  requirement: &14628680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.7
   type: :development
   prerelease: false
-  version_requirements: *205455020
+  version_requirements: *14628680
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &205451940 !ruby/object:Gem::Requirement
+  requirement: &14626240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *205451940
+  version_requirements: *14626240
 description: Simple ACE(Amazon Compatible Environment) Client
 email: tily05@gmail.com
 executables: []
@@ -101,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4396621125697628092
+      hash: 2867422504911211089
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: