jeff 0.2.4 → 0.2.5

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
+amazon.yml
 pkg

data/Guardfile

@@ -1,4 +1,5 @@
 guard 'rspec', :cli => '-fd' do
+  notification :off
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }

data/README.md

@@ -76,32 +76,20 @@ Requests can be instrumented.
 ```ruby
 class Logger
   def self.instrument(name, params = {})
-    if name =~ /request/
-      $stderr.puts [
-        params[:scheme],
-        '://',
-        params[:host],
-        '/',
-        params[:path],
-        '?',
-        params[:query]
-      ].join
-      yield if block_given?
-    end
+   $stderr.puts name, params
+   yield if block_given?
   end
 end
 
-client.get query:        {},
-           instrumentor: Logger
+client.get query: {}, instrumentor: Logger
 ```
 
 ### Miscellaneous
 
-HTTP connections are persistent.
+* HTTP connections are persistent.
+* By default, Jeff will retry failed requests 4 times.
 
-By default, Jeff will retry failed requests 4 times.
-
-For more detailed configuration options, check out [excon][excon].
+For more detailed configuration options, read [excon][excon].
 
 ## Compatibility
 

data/examples/amazon.yml.example

@@ -0,0 +1,3 @@
+key:    foo
+secret: bar
+tag:    baz

data/examples/debug.rb

@@ -0,0 +1,41 @@
+$:.unshift File.expand_path '../../lib', __FILE__
+
+require 'yaml'
+
+require 'jeff'
+require 'pry'
+require 'pry-doc'
+
+class Client
+  include Jeff
+
+  params  'AssociateTag' => -> { tag },
+          'Service'      => 'AWSECommerceService',
+          'Version'      => '2011-08-01'
+
+  attr_accessor :tag
+
+  def initialize
+    self.key      = config['key']
+    self.secret   = config['secret']
+    self.tag      = config['tag']
+    self.endpoint = 'http://ecs.amazonaws.com/onca/xml'
+  end
+
+  def find(asins)
+    params = {
+      'Operation' => 'ItemLookup',
+      'ItemId'    => Array(asins).join(',')
+    }
+
+    get query: params
+  end
+
+  private
+
+  def config
+    @config ||= YAML.load_file File.expand_path '../amazon.yml', __FILE__
+  end
+end
+
+binding.pry

data/jeff.gemspec

@@ -16,9 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Jeff::VERSION
 
-  gem.add_dependency             'excon', '~> 0.14.2'
+  gem.add_dependency             'excon', '~> 0.14.3'
   gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 end

data/lib/jeff.rb

@@ -1,8 +1,8 @@
-require 'base64'
 require 'time'
 
 require 'excon'
 
+require 'jeff/secret'
 require 'jeff/version'
 
 module Jeff
@@ -10,32 +10,44 @@ module Jeff
   MissingKey      = Class.new ArgumentError
   MissingSecret   = Class.new ArgumentError
 
-  SHA256 = OpenSSL::Digest::SHA256.new
   UNRESERVED = /([^\w.~-]+)/
 
   def self.included(base)
     base.extend ClassMethods
   end
 
-  # Returns an Excon::Connection.
+  # Internal: Builds a sorted query.
+  #
+  # hsh - A hash of query parameters specific to the request.
+  #
+  # Returns a query String.
+  def build_query(hsh)
+    default_params
+      .merge(hsh)
+      .map { |k, v| "#{k}=#{ escape v }" }
+      .sort
+      .join '&'
+  end
+
+  # Internal: Returns an Excon::Connection.
   def connection
     @connection ||= Excon.new endpoint, headers:    default_headers,
                                         idempotent: true
   end
 
-  # Returns the Hash default request parameters.
+  # Internal: Returns the Hash default request parameters.
   def default_params
     self.class.params.reduce({}) do |a, (k, v)|
       a.update k => (v.is_a?(Proc) ? instance_exec(&v) : v)
     end
   end
 
-  # Returns the Hash default headers.
+  # Internal: Returns the Hash default headers.
   def default_headers
     self.class.headers
   end
 
-  # Gets the String AWS endpoint.
+  # Internal: Gets the String AWS endpoint.
   #
   # Raises a MissingEndpoint error if endpoint is missing.
   def endpoint
@@ -45,7 +57,7 @@ module Jeff
   # Sets the String AWS endpoint.
   attr_writer :endpoint
 
-  # Gets the String AWS access key id.
+  # Internal: Gets the String AWS access key id.
   #
   # Raises a MissingKey error if key is missing.
   def key
@@ -55,15 +67,21 @@ module Jeff
   # Sets the String AWS access key id.
   attr_writer :key
 
-  # Gets the String AWS secret key.
+  # Internal: Gets the Jeff::Secret.
   #
   # Raises a MissingSecret error if secret is missing.
   def secret
     @secret or raise MissingSecret
   end
 
-  # Sets the String AWS secret key.
-  attr_writer :secret
+  # Sets the AWS secret key.
+  #
+  # key - A String secret.
+  #
+  # Returns a Jeff::Secret.
+  def secret=(key)
+    @secret = Secret.new key
+  end
 
   # Generate HTTP request verb methods that sign queries and then delegate
   # request to Excon.
@@ -76,19 +94,6 @@ module Jeff
     DEF
   end
 
-  # Internal: Builds a sorted query.
-  #
-  # hsh - A hash of query parameters specific to the request.
-  #
-  # Returns a query String.
-  def build_query(hsh)
-    default_params
-      .merge(hsh)
-      .map { |k, v| "#{k}=#{ escape v }" }
-      .sort
-      .join '&'
-  end
-
   private
 
   def sign(opts)
@@ -96,13 +101,11 @@ module Jeff
 
     string_to_sign = [
       opts[:method].upcase,
-      opts[:host] || connection.connection[:host],
-      opts[:path] || connection.connection[:path],
+      connection_host,
+      opts[:path] || connection_path,
       query
     ].join "\n"
-
-    digest    = OpenSSL::HMAC.digest SHA256, secret, string_to_sign
-    signature = Base64.encode64(digest).chomp
+    signature = secret.sign string_to_sign
 
     opts.update query: [
        query,
@@ -110,6 +113,14 @@ module Jeff
     ].join('&')
   end
 
+  def connection_host
+    [connection.connection[:host], connection.connection[:port]].join ':'
+  end
+
+  def connection_path
+    connection.connection[:path]
+  end
+
   def escape(val)
     val.to_s.gsub(UNRESERVED) do
       '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase

data/lib/jeff/secret.rb

@@ -0,0 +1,21 @@
+require 'base64'
+
+module Jeff
+  class Secret
+    SHA256 = OpenSSL::Digest::SHA256.new
+
+    def initialize(key)
+      @key = key
+    end
+
+    def sign(message)
+      Base64.encode64(digest(message)).chomp
+    end
+
+    private
+
+    def digest(message)
+      OpenSSL::HMAC.digest SHA256, @key, message
+    end
+  end
+end

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/spec/jeff/secret_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Jeff
+  describe Secret do
+    let(:secret) { Secret.new 'key' }
+
+    describe '#sign' do
+      after { secret.sign 'message' }
+
+      it 'should digest' do
+        secret.should_receive(:digest)
+              .and_return double.as_null_object
+      end
+      it 'should Base64-encode' do
+        Base64.should_receive(:encode64)
+              .and_return double.as_null_object
+      end
+    end
+  end
+end

data/spec/jeff_spec.rb

@@ -128,6 +128,8 @@ describe Jeff do
           end
         end
 
+        after { Excon.stubs.clear }
+
         it "should make a #{method.upcase} request" do
           subject[:method].should eql method.to_sym
         end
@@ -151,6 +153,8 @@ describe Jeff do
         end
       end
 
+      after { Excon.stubs.clear }
+
       it 'should retry' do
         client.get(mock: true).status.should be 200
       end

data/spec/spec_helper.rb

@@ -1,4 +1,12 @@
-require 'pry'
+begin
+  require 'pry'
+  require 'pry-doc'
+rescue LoadError
+end
 require 'rspec'
 
 require 'jeff'
+
+RSpec.configure do |c|
+  c.order = :random
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.14.3
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +89,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/amazon.yml.example
+- examples/debug.rb
 - jeff.gemspec
 - lib/jeff.rb
+- lib/jeff/secret.rb
 - lib/jeff/version.rb
+- spec/jeff/secret_spec.rb
 - spec/jeff_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hakanensari/jeff
@@ -122,18 +110,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 13761434509478082
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 13761434509478082
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -141,5 +123,7 @@ signing_key:
 specification_version: 3
 summary: AWS client
 test_files:
+- spec/jeff/secret_spec.rb
 - spec/jeff_spec.rb
 - spec/spec_helper.rb
+has_rdoc: