jeff 0.7.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a66b88a3b909b10d4577dc89fe4da2bedf7905c7
-  data.tar.gz: edc367e887327c4e66ac370b256bc739fb6be19b
+  metadata.gz: 24de0bfe87f97a2aea2d0c061de58a2c84baadfa
+  data.tar.gz: 64005a0efd8e83d49e5967dc17577610c9880833
 SHA512:
-  metadata.gz: c5188fd0a85805c0201f81e0a5abc73f6dd3328d9194e5d643117a30474c8d4418650c5b42fb4500ae8c0fb006a30f1f7b7602867e1e5c031bb77b4a133dd102
-  data.tar.gz: eaf0891056bf51aeda8b8483715ae14334b1389a46d854110a4adb9c9ef8616dd3a7c749a6a3ce52c267d5b86ac4b1c9d74a87c86834fc2a93db4ad9560e492c
+  metadata.gz: 6323103376a7887a697808d401e5e98240811854ea0a9f2b099d87569b2e789a4684bfb658d2be159b43da008894cfac31a5d58a0ed1259623f147bf00acb732
+  data.tar.gz: 57ec8babfe50c0d041ae0641880cbcd6573eb81d89b6264ee3cf17fdce7d273e2e12a9e3ed5cb751c18cac73cabad7827349320aa34a12082ee94e90f298768b

data/.travis.yml

@@ -1,5 +1,5 @@
 rvm:
-  - 2.0.0
   - 1.9.3
+  - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.1.1

data/README.md

@@ -1,20 +1,26 @@
 # Jeff
 
-Jeff mixes in client behaviour for Amazon Web Services (AWS) which require
+Jeff mixes in client behaviour for Amazon Web Services (AWS) that require
 [Signature version 2 authentication][sig].
 
-Monsieur Jeff couples with [Excon][exc].
+Jeff builds on [Excon][exc].
 
 ![jeff][jef]
 
 ## Usage
 
-A somewhat contrived example:
+A minimal example:
 
 ```ruby
-Service = Struct.new(:aws_access_key_id, :aws_secret_access_key) do
+ProductsService = Struct.new(:aws_access_key_id, :aws_secret_access_key) do
   include Jeff
 
+  PARSER = /Status>([^<]+)/
+
+  def self.status
+    new('foo', 'bar').status
+  end
+
   def aws_endpoint
     'https://mws.amazonservices.com/Products/2011-10-01'
   end
@@ -22,13 +28,13 @@ Service = Struct.new(:aws_access_key_id, :aws_secret_access_key) do
   def status
     get(query: { 'Action' => 'GetServiceStatus' })
       .body
-      .match(/Status>([^<]+)/)
+      .match(PARSER)
       .[](1)
   end
 end
 
-srv = Service.new('key', 'secret')
-srv.status # => "GREEN"
+ProductsService.status
+# => "GREEN"
 ```
 
 [Vacuum][vac] and [Peddler][ped] implement Jeff.

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs.push 'lib'
-  t.test_files = FileList['spec/*_spec.rb']
+  t.test_files = FileList['test/test_*.rb']
   t.verbose = true
 end
 

data/jeff.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Jeff::VERSION
 
-  gem.add_dependency 'excon', '~> 0.28.0'
+  gem.add_dependency 'excon', '~> 0.29.0'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
 

data/lib/jeff.rb

@@ -1,4 +1,4 @@
-# The only external dependency.
+# Jeff's only external dependency.
 require 'excon'
 
 # Standard library dependencies.
@@ -10,8 +10,6 @@ require 'jeff/version'
 
 # Jeff mixes in client behaviour for Amazon Web Services (AWS) that require
 # Signature version 2 authentication.
-#
-# It's Jeff, as in Jeff Bezos.
 module Jeff
   # Converts a query value to a sorted query string.
   class Query
@@ -40,11 +38,11 @@ module Jeff
   end
 
   # Signs an AWS request.
-  class Request
+  class Signer
     attr :method, :host, :path, :query_string
 
     def initialize(method, host, path, query_string)
-      @method = method
+      @method = method.upcase
       @host = host
       @path = path
       @query_string = query_string
@@ -76,7 +74,7 @@ module Jeff
     end
   end
 
-  # Because Ruby's CGI escapes ~, we have to resort to writing our own escape.
+  # Because Ruby's CGI escapes tilde, use a custom escape.
   module Utils
     UNRESERVED = /([^\w.~-]+)/
 
@@ -87,11 +85,9 @@ module Jeff
     end
   end
 
-  # Amazon recommends to include a User-Agent header with every request to 
+  # Amazon recommends to include a User-Agent header with every request to
   # identify the application, its version number, programming language, and
   # host.
-  #
-  # If not happy, override.
   USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
 
   def self.included(base)
@@ -118,30 +114,16 @@ module Jeff
     )
   end
 
-  # Accessors for required AWS attributes.
-  attr_accessor :aws_endpoint, :aws_access_key_id, :aws_secret_access_key
-
-  # Keep these deprecated attribute accessors around for a while.
-  # TODO Remove when cutting v1.0.
-  %w(
-    endpoint aws_endpoint
-    endpoint= aws_endpoint=
-    key aws_access_key_id
-    key= aws_access_key_id=
-    secret aws_secret_access_key
-    secret= aws_secret_access_key=
-  ).each_slice(2) do |old, new|
-    if old.end_with?('=')
-      define_method(old) do |value|
-        warn "[DEPRECATION] Use #{new}"
-        self.send(new, value)
-      end
-    else
-      define_method(old) do
-        warn "[DEPRECATION] Use #{new}"
-        self.send(new)
-      end
-    end
+  attr_accessor :aws_endpoint
+
+  attr_writer :aws_access_key_id, :aws_secret_access_key
+
+  def aws_access_key_id
+    @aws_access_key_id || ENV['AWS_ACCESS_KEY_ID']
+  end
+
+  def aws_secret_access_key
+    @aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
   end
 
   # Generate HTTP request verb methods.
@@ -157,36 +139,33 @@ module Jeff
   private
 
   def build_options(options)
-    # Add a Content-MD5 header if we're uploading a file.
+    # Add Content-MD5 header if uploading a file.
     if options.has_key?(:body)
       md5 = Content.new(options[:body]).md5
       (options[:headers] ||= {}).store('Content-MD5', md5)
     end
 
-    # Build the query string.
-    values = self.class.params
-      .reduce({}) { |a, (k, v)|
-        a.update(k => (v.respond_to?(:call) ? instance_exec(&v) : v))
-      }
-      .merge(options.fetch(:query, {}))
-    query_string = Query.new(values).to_s
-
-    # Generate a signature.
-    signature = Request
-      .new(
-        options[:method].upcase,
-        connection.data[:host],
-        options[:path] || connection.data[:path],
-        query_string
-      )
+    # Build query string.
+    query_values = default_query_values.merge(options.fetch(:query, {}))
+    query_string = Query.new(query_values).to_s
+
+    # Generate signature.
+    signature = Signer
+      .new(options[:method], connection.data[:host], options[:path] || connection.data[:path], query_string)
       .sign_with(aws_secret_access_key)
 
     # Return options after appending an escaped signature to query.
     options.merge(query: "#{query_string}&Signature=#{Utils.escape(signature)}")
   end
 
+  def default_query_values
+    self.class.params.reduce({}) { |a, (k, v)|
+      a.update(k => (v.respond_to?(:call) ? instance_exec(&v) : v))
+    }
+  end
+
   module ClassMethods
-    # Gets and optionally updates the default request parameters.
+    # Gets/updates default request parameters.
     def params(hsh = {})
       (@params ||= {}).update(hsh)
     end

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.7.4'
+  VERSION = '1.0.0'
 end

data/test/test_jeff.rb

@@ -0,0 +1,75 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'jeff'
+
+Excon.defaults[:mock] = true
+
+class TestJeff < Minitest::Test
+  def setup
+    @klass = Class.new { include Jeff }
+  end
+
+  def test_delegates_unset_aws_credential_to_env_vars
+    key = '123456'
+    client = @klass.new
+    %w(aws_access_key_id aws_secret_access_key).each do |attr|
+      ENV[attr.upcase] = key
+      assert_equal key, client.send(attr)
+      ENV[attr.upcase] = nil
+      refute_equal key, client.send(attr)
+    end
+  end
+
+  def test_has_required_request_query_parameters
+    %w(AWSAccessKeyId SignatureMethod SignatureVersion Timestamp).each do |key|
+      assert @klass.params.has_key?(key)
+    end
+  end
+
+  def test_configures_request_query_parameters
+    @klass.instance_eval do
+      params 'Foo' => 'bar'
+    end
+    assert @klass.params.has_key?('Foo')
+  end
+
+  def test_requires_signature
+    signature = Jeff::Signature.new(nil)
+    assert_raises(ArgumentError) { signature.sign('foo') }
+  end
+
+  def test_sorts_request_query_parameters_lexicographically
+    query = Jeff::Query.new('A10' => 1, 'A1' => 1)
+    assert_equal 'A1=1&A10=1', query.to_s
+  end
+
+  def test_sets_user_agent_header
+    client = @klass.new
+    client.aws_endpoint = 'http://example.com/'
+    refute_nil client.connection.data[:headers]['User-Agent']
+  end
+
+  Excon::HTTP_VERBS.each do |method|
+    define_method "test_makes_#{method}_request" do
+      Excon.stub({ }, { status: 200 })
+      client = @klass.new
+      client.aws_endpoint = 'http://example.com/'
+      client.aws_access_key_id = 'foo'
+      client.aws_secret_access_key = 'bar'
+      assert_equal 200, client.send(method).status
+      Excon.stubs.clear
+    end
+  end
+
+  def test_adds_contet_md5_request_header_if_given_a_request_body
+    Excon.stub({ }) do |params|
+      { body: params[:headers]['Content-MD5'] }
+    end
+    client = @klass.new
+    client.aws_endpoint = 'http://example.com/'
+    client.aws_access_key_id = 'foo'
+    client.aws_secret_access_key = 'bar'
+    refute_empty client.post(body: 'foo').body
+    Excon.stubs.clear
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.29.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ files:
 - jeff.gemspec
 - lib/jeff.rb
 - lib/jeff/version.rb
-- spec/jeff_spec.rb
+- test/test_jeff.rb
 homepage: https://github.com/papercavalier/jeff
 licenses: []
 metadata: {}
@@ -93,4 +93,4 @@ signing_key:
 specification_version: 4
 summary: An AWS client
 test_files:
-- spec/jeff_spec.rb
+- test/test_jeff.rb

data/spec/jeff_spec.rb

@@ -1,65 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'jeff'
-
-Excon.defaults[:mock] = true
-
-describe Jeff do
-  before do
-    @klass = Class.new do
-      include Jeff
-    end
-  end
-
-  it 'has the required request query parameters' do
-    %w(AWSAccessKeyId SignatureMethod SignatureVersion Timestamp)
-      .each { |key| assert @klass.params.has_key?(key) }
-  end
-
-  it 'configures the request query parameters' do
-    @klass.instance_eval do
-      params 'Foo' => 'bar'
-    end
-    assert @klass.params.has_key?('Foo')
-  end
-
-  it 'requires a signature' do
-    sig = Jeff::Signature.new(nil)
-    proc { sig.sign('foo') }.must_raise ArgumentError
-  end
-
-  it 'sorts the request query parameters of the client lexicographically' do
-    query = Jeff::Query.new('A10' => 1, 'A1' => 1)
-    query.to_s.must_equal('A1=1&A10=1')
-  end
-
-  it 'sets a User-Agent header for the client connection' do
-    client = @klass.new
-    client.aws_endpoint = 'http://example.com/'
-    client.connection.data[:headers]['User-Agent'].wont_be_nil
-  end
-
-  Excon::HTTP_VERBS.each do |method|
-    it "makes a #{method.upcase} request" do
-      Excon.stub({ }, { status: 200 })
-      client = @klass.new
-      client.aws_endpoint = 'http://example.com/'
-      client.aws_access_key_id = 'foo'
-      client.aws_secret_access_key = 'bar'
-      client.send(method).status.must_equal 200
-      Excon.stubs.clear
-    end
-  end
-
-  it 'adds a Content-MD5 request header if there is a request body' do
-    Excon.stub({ }) do |params|
-      { body: params[:headers]['Content-MD5'] }
-    end
-    client = @klass.new
-    client.aws_endpoint = 'http://example.com/'
-    client.aws_access_key_id = 'foo'
-    client.aws_secret_access_key = 'bar'
-    client.post(body: 'foo').body.wont_be_empty
-    Excon.stubs.clear
-  end
-end