jeff 0.4.3 → 0.5.0

data/README.md

@@ -7,14 +7,6 @@
 
 ![jeff][jeff]
 
-## Usage
-
-```ruby
-class Service
-  include Jeff
-end
-```
-
 [stat]: https://secure.travis-ci.org/papercavalier/jeff.png
 [trav]: http://travis-ci.org/papercavalier/jeff
 [aws]:  http://aws.amazon.com/

data/jeff.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Jeff::VERSION
 
-  gem.add_dependency             'excon', '~> 0.16.0'
+  gem.add_dependency             'excon', '~> 0.18.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 

data/lib/jeff.rb

@@ -1,7 +1,180 @@
-require 'jeff/serviceable'
+require 'base64'
+require 'digest/md5'
+require 'excon'
+require 'time'
 
+require 'jeff/secret'
+require 'jeff/version'
+
+# Mixes in Amazon Web Services (AWS) client behaviour.
 module Jeff
+  MissingEndpoint = Class.new ArgumentError
+  MissingKey      = Class.new ArgumentError
+  MissingSecret   = Class.new ArgumentError
+
+  UNRESERVED = /([^\w.~-]+)/
+
+  # A User-Agent header that identifies the application, its version number,
+  # and programming language.
+  #
+  # Amazon recommends to include one in requests to AWS endpoints.
+  USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
+
   def self.included(base)
-    base.send :include, Serviceable
+    base.extend ClassMethods
+
+    base.headers 'User-Agent'       => USER_AGENT
+
+    base.params  'AWSAccessKeyId'   => -> { key },
+                 'SignatureVersion' => '2',
+                 'SignatureMethod'  => 'HmacSHA256',
+                 'Timestamp'        => -> { Time.now.utc.iso8601 }
+  end
+
+  # Internal: Builds a sorted query.
+  #
+  # hsh - A hash of query parameters specific to the request.
+  #
+  # Returns a query String.
+  def build_query(hsh)
+    params
+      .merge(hsh)
+      .sort
+      .map { |k, v| "#{k}=#{ escape v }" }
+      .join('&')
+  end
+
+  # Internal: Returns an Excon::Connection.
+  def connection
+    @connection ||= Excon.new(endpoint, headers: headers, expects: 200)
+  end
+
+  # Internal: Gets the String AWS endpoint.
+  #
+  # Raises a MissingEndpoint error if endpoint is missing.
+  def endpoint
+    @endpoint or raise MissingEndpoint
+  end
+
+  # Sets the String AWS endpoint.
+  attr_writer :endpoint
+
+  # Internal: Returns the Hash default headers.
+  def headers
+    self.class.headers
+  end
+
+  # Internal: Gets the String AWS access key id.
+  #
+  # Raises a MissingKey error if key is missing.
+  def key
+    @key or raise MissingKey
+  end
+
+  # Sets the String AWS access key id.
+  attr_writer :key
+
+  # Internal: Returns the Hash default request parameters.
+  def params
+    self.class.params.reduce({}) do |a, (k, v)|
+      a.update k => (v.respond_to?(:call) ? instance_exec(&v) : v)
+    end
+  end
+
+  # Internal: Gets the Jeff::Secret.
+  #
+  # Raises a MissingSecret error if secret is missing.
+  def secret
+    @secret or raise MissingSecret
+  end
+
+  # 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.
+  Excon::HTTP_VERBS.each do |method|
+    eval <<-DEF
+      def #{method}(opts = {})
+        opts.update :method => :#{method}
+        if opts[:body]
+          opts[:headers] ||= {}
+          opts[:headers].update 'Content-MD5' => calculate_md5(opts[:body])
+        end
+
+        connection.request(sign(opts))
+      end
+    DEF
+  end
+
+  private
+
+  def calculate_md5(body)
+    Base64.encode64(Digest::MD5.digest(body)).strip
+  end
+
+  def connection_host
+    [
+      connection.data[:host],
+      connection.data[:port]
+    ].join ':'
+  end
+
+  def connection_path
+    connection.data[:path]
+  end
+
+  def escape(val)
+    val.to_s.gsub(UNRESERVED) do
+      '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
+    end
+  end
+
+  def sign(opts)
+    query = build_query(opts[:query] || {})
+
+    string_to_sign = [
+      opts[:method].upcase,
+      connection_host,
+      opts[:path] || connection_path,
+      query
+    ].join "\n"
+    signature = secret.sign(string_to_sign)
+
+    opts.update query: [
+       query,
+       "Signature=#{escape(signature)}"
+    ].join('&')
+  end
+
+  module ClassMethods
+    # Gets/Updates the default headers.
+    #
+    # hsh - A Hash of headers.
+    #
+    # Returns the Hash headers.
+    def headers(hsh = nil)
+      @headers ||= {}
+      @headers.update(hsh) if hsh
+
+      @headers
+    end
+
+    # Gets/Updates the default request parameters.
+    #
+    # hsh - A Hash of parameters (default: nil).
+    #
+    # Returns the Hash parameters.
+    def params(hsh = nil)
+      @params ||= {}
+      @params.update(hsh) if hsh
+
+      @params
+    end
   end
 end

data/lib/jeff/secret.rb

@@ -16,7 +16,7 @@ module Jeff
     private
 
     def digest(message)
-      OpenSSL::HMAC.digest SHA256, @key, message
+      OpenSSL::HMAC.digest(SHA256, @key, message)
     end
   end
 end

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/spec/jeff/secret_spec.rb

@@ -11,6 +11,7 @@ module Jeff
         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

data/spec/jeff_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe Jeff do
+  let(:klass)  { Class.new { include Jeff } }
+  let(:client) { klass.new }
+
+  describe '.headers' do
+    subject { klass.headers }
+
+    it { should have_key 'User-Agent' }
+
+    it 'should be configurable' do
+      klass.instance_eval do
+        headers 'Foo' => 'bar'
+      end
+
+      should have_key 'Foo'
+    end
+  end
+
+  describe '.params' do
+    subject { klass.params }
+
+    it { should have_key 'AWSAccessKeyId' }
+
+    it { should have_key 'SignatureMethod' }
+
+    it { should have_key 'SignatureVersion' }
+
+    it { should have_key 'Timestamp' }
+
+    it 'should be configurable' do
+      klass.instance_eval do
+        params 'Foo' => 'bar'
+      end
+
+      should have_key 'Foo'
+    end
+  end
+
+  describe '#endpoint' do
+    it 'should require a value' do
+      expect { client.endpoint }.to raise_error Jeff::MissingEndpoint
+    end
+  end
+
+  describe '#key' do
+    it 'should require a value' do
+      expect { client.key }.to raise_error Jeff::MissingKey
+    end
+  end
+
+  describe '#secret' do
+    it 'should require a value' do
+      expect { client.secret }.to raise_error Jeff::MissingSecret
+    end
+  end
+
+  context 'given a key' do
+    before do
+      client.key = 'key'
+    end
+
+    describe '#params' do
+      subject { client.params }
+
+      it 'should include the key' do
+        subject['AWSAccessKeyId'].should eql client.key
+      end
+
+      it 'should generate a timestamp' do
+        subject['Timestamp'].should be_a String
+      end
+    end
+
+    describe '#build_query' do
+      subject { client.build_query 'A10' => 1, 'A1' => 1 }
+
+      it 'should include default parameters' do
+        should match(/Timestamp/)
+      end
+
+      it 'should sort lexicographically' do
+        should match(/^A1=1&A10=/)
+      end
+    end
+  end
+
+  context 'given an endpoint' do
+    before do
+      client.endpoint = 'http://slowapi.com/delay/0'
+    end
+
+    describe "#connection" do
+      subject { client.connection }
+      let(:headers) { subject.data[:headers] }
+
+      it { should be_an Excon::Connection }
+
+      it 'should set default headers' do
+        headers.should eq klass.headers
+      end
+
+      it 'should cache itself' do
+        subject.should be client.connection
+      end
+    end
+  end
+
+  context 'given an endpoint, key, and secret' do
+    before do
+      client.endpoint = 'http://slowapi.com/delay/0'
+      client.key = 'key'
+      client.secret = 'secret'
+    end
+
+    Excon::HTTP_VERBS.each do |method|
+      describe "##{method}" do
+        subject { client.send(method, mock: true).body }
+
+        before do
+          Excon.stub({ method: method.to_sym }) do
+            { body: method, status: 200 }
+          end
+        end
+
+        after { Excon.stubs.clear }
+
+        it "should make a #{method.upcase} request" do
+          should eql method
+        end
+      end
+    end
+
+    context 'given a request body' do
+      subject { client.get(mock: true, body: 'foo').body }
+
+      before do
+        Excon.stub({ method: :get }) do |params|
+          { status: 200, body: params[:headers]['Content-MD5'] }
+        end
+      end
+
+      after { Excon.stubs.clear }
+
+      it "should add an Content-MD5 header" do
+        should_not be_empty
+      end
+    end
+
+    context 'given an HTTP status error' do
+      before do
+        Excon.stub({ method: :get }) do
+          { status: 503 }
+        end
+      end
+
+      after { Excon.stubs.clear }
+
+      it "should raise an error" do
+        expect {
+          client.get mock: true
+        }.to raise_error Excon::Errors::HTTPStatusError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,4 @@
-begin
-  require 'pry'
-  require 'pry-doc'
-rescue LoadError
-end
 require 'rspec'
-
 require 'jeff'
 
 RSpec.configure do |c|

metadata

@@ -1,64 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.4.3
   prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: excon
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
+    none: false
+  name: excon
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.16.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+        version: 0.18.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: rake
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: rspec
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: Minimum-viable Amazon Web Services (AWS) client
 email:
 - hakan.ensari@papercavalier.com
@@ -75,10 +75,9 @@ files:
 - jeff.gemspec
 - lib/jeff.rb
 - lib/jeff/secret.rb
-- lib/jeff/serviceable.rb
 - lib/jeff/version.rb
 - spec/jeff/secret_spec.rb
-- spec/jeff/serviceable_spec.rb
+- spec/jeff_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/papercavalier/jeff
 licenses: []
@@ -87,17 +86,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -106,6 +105,5 @@ specification_version: 3
 summary: AWS client
 test_files:
 - spec/jeff/secret_spec.rb
-- spec/jeff/serviceable_spec.rb
+- spec/jeff_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/jeff/serviceable.rb

@@ -1,184 +0,0 @@
-require 'base64'
-require 'digest/md5'
-require 'excon'
-require 'time'
-
-require 'jeff/secret'
-require 'jeff/version'
-
-module Jeff
-  # Mixes in Amazon Web Services (AWS) client behaviour.
-  module Serviceable
-    MissingEndpoint = Class.new ArgumentError
-    MissingKey      = Class.new ArgumentError
-    MissingSecret   = Class.new ArgumentError
-
-    UNRESERVED = /([^\w.~-]+)/
-
-    # A User-Agent header that identifies the application, its version number,
-    # and programming language.
-    #
-    # Amazon recommends to include one in requests to AWS endpoints.
-    USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
-
-    def self.included(base)
-      base.extend ClassMethods
-
-      base.headers 'User-Agent'       => USER_AGENT
-
-      base.params  'AWSAccessKeyId'   => -> { key },
-                   'SignatureVersion' => '2',
-                   'SignatureMethod'  => 'HmacSHA256',
-                   'Timestamp'        => -> { Time.now.utc.iso8601 }
-    end
-
-    # Internal: Builds a sorted query.
-    #
-    # hsh - A hash of query parameters specific to the request.
-    #
-    # Returns a query String.
-    def build_query(hsh)
-      params
-        .merge(hsh)
-        .sort
-        .map { |k, v| "#{k}=#{ escape v }" }
-        .join '&'
-    end
-
-    # Internal: Returns an Excon::Connection.
-    def connection
-      @connection ||= Excon.new endpoint,
-                                headers: headers,
-                                expects: 200
-    end
-
-    # Internal: Gets the String AWS endpoint.
-    #
-    # Raises a MissingEndpoint error if endpoint is missing.
-    def endpoint
-      @endpoint or raise MissingEndpoint
-    end
-
-    # Sets the String AWS endpoint.
-    attr_writer :endpoint
-
-    # Internal: Returns the Hash default headers.
-    def headers
-      self.class.headers
-    end
-
-    # Internal: Gets the String AWS access key id.
-    #
-    # Raises a MissingKey error if key is missing.
-    def key
-      @key or raise MissingKey
-    end
-
-    # Sets the String AWS access key id.
-    attr_writer :key
-
-    # Internal: Returns the Hash default request parameters.
-    def params
-      self.class.params.reduce({}) do |a, (k, v)|
-        a.update k => (v.respond_to?(:call) ? instance_exec(&v) : v)
-      end
-    end
-
-    # Internal: Gets the Jeff::Secret.
-    #
-    # Raises a MissingSecret error if secret is missing.
-    def secret
-      @secret or raise MissingSecret
-    end
-
-    # 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.
-    Excon::HTTP_VERBS.each do |method|
-      eval <<-DEF
-        def #{method}(opts = {})
-          opts.update method: :#{method}
-          if opts[:body]
-            opts[:headers] ||= {}
-            opts[:headers].update 'Content-MD5' => calculate_md5(opts[:body])
-          end
-
-          connection.request sign opts
-        end
-      DEF
-    end
-
-    private
-
-    def calculate_md5(body)
-      Base64.encode64(Digest::MD5.digest(body)).strip
-    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
-      end
-    end
-
-    def sign(opts)
-      query = build_query opts[:query] || {}
-
-      string_to_sign = [
-        opts[:method].upcase,
-        connection_host,
-        opts[:path] || connection_path,
-        query
-      ].join "\n"
-      signature = secret.sign string_to_sign
-
-      opts.update query: [
-         query,
-         "Signature=#{escape signature}"
-      ].join('&')
-    end
-
-    module ClassMethods
-      # Gets/Updates the default headers.
-      #
-      # hsh - A Hash of headers.
-      #
-      # Returns the Hash headers.
-      def headers(hsh = nil)
-        @headers ||= {}
-        @headers.update hsh if hsh
-
-        @headers
-      end
-
-      # Gets/Updates the default request parameters.
-      #
-      # hsh - A Hash of parameters (default: nil).
-      #
-      # Returns the Hash parameters.
-      def params(hsh = nil)
-        @params ||= {}
-        @params.update hsh if hsh
-
-        @params
-      end
-    end
-  end
-end

data/spec/jeff/serviceable_spec.rb

@@ -1,169 +0,0 @@
-require 'spec_helper'
-
-module Jeff
-  describe Serviceable do
-    let(:klass)  { Class.new { include Jeff } }
-    let(:client) { klass.new }
-
-    describe '.headers' do
-      subject { klass.headers }
-
-      it { should have_key 'User-Agent' }
-
-      it 'should be configurable' do
-        klass.instance_eval do
-          headers 'Foo' => 'bar'
-        end
-
-        should have_key 'Foo'
-      end
-    end
-
-    describe '.params' do
-      subject { klass.params }
-
-      it { should have_key 'AWSAccessKeyId' }
-
-      it { should have_key 'SignatureMethod' }
-
-      it { should have_key 'SignatureVersion' }
-
-      it { should have_key 'Timestamp' }
-
-      it 'should be configurable' do
-        klass.instance_eval do
-          params 'Foo' => 'bar'
-        end
-
-        should have_key 'Foo'
-      end
-    end
-
-    describe '#endpoint' do
-      it 'should require a value' do
-        expect { client.endpoint }.to raise_error Serviceable::MissingEndpoint
-      end
-    end
-
-    describe '#key' do
-      it 'should require a value' do
-        expect { client.key }.to raise_error Serviceable::MissingKey
-      end
-    end
-
-    describe '#secret' do
-      it 'should require a value' do
-        expect { client.secret }.to raise_error Serviceable::MissingSecret
-      end
-    end
-
-    context 'given a key' do
-      before do
-        client.key = 'key'
-      end
-
-      describe '#params' do
-        subject { client.params }
-
-        it 'should include the key' do
-          subject['AWSAccessKeyId'].should eql client.key
-        end
-
-        it 'should generate a timestamp' do
-          subject['Timestamp'].should be_a String
-        end
-      end
-
-      describe '#build_query' do
-        subject { client.build_query 'A10' => 1, 'A1' => 1 }
-
-        it 'should include default parameters' do
-          should match(/Timestamp/)
-        end
-
-        it 'should sort lexicographically' do
-          should match(/^A1=1&A10=/)
-        end
-      end
-    end
-
-    context 'given an endpoint' do
-      before do
-        client.endpoint = 'http://slowapi.com/delay/0'
-      end
-
-      describe "#connection" do
-        subject { client.connection }
-        let(:headers) { subject.connection[:headers] }
-
-        it { should be_an Excon::Connection }
-
-        it 'should set default headers' do
-          headers.should eq klass.headers
-        end
-
-        it 'should cache itself' do
-          subject.should be client.connection
-        end
-      end
-    end
-
-    context 'given an endpoint, key, and secret' do
-      before do
-        client.endpoint = 'http://slowapi.com/delay/0'
-        client.key = 'key'
-        client.secret = 'secret'
-      end
-
-      Excon::HTTP_VERBS.each do |method|
-        describe "##{method}" do
-          subject { client.send(method, mock: true).body }
-
-          before do
-            Excon.stub({ method: method.to_sym }) do
-              { body: method, status: 200 }
-            end
-          end
-
-          after { Excon.stubs.clear }
-
-          it "should make a #{method.upcase} request" do
-            should eql method
-          end
-        end
-      end
-
-      context 'given a request body' do
-        subject { client.get(mock: true, body: 'foo').body }
-
-        before do
-          Excon.stub({ method: :get }) do |params|
-            { status: 200, body: params[:headers]['Content-MD5'] }
-          end
-        end
-
-        after { Excon.stubs.clear }
-
-        it "should add an Content-MD5 header" do
-          should_not be_empty
-        end
-      end
-
-      context 'given an HTTP status error' do
-        before do
-          Excon.stub({ method: :get }) do
-            { status: 503 }
-          end
-        end
-
-        after { Excon.stubs.clear }
-
-        it "should raise an error" do
-          expect {
-            client.get mock: true
-          }.to raise_error Excon::Errors::HTTPStatusError
-        end
-      end
-    end
-  end
-end