jeff 0.3.2 → 0.4.0

data/Guardfile

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

data/README.md

@@ -1,14 +1,14 @@
 # Jeff
 
 **Jeff** is a light-weight module that mixes in client behaviour for
-[Amazon Web Services (AWS)][aws]. It wraps [Excon][excon], parses with
-[Nokogiri][nokogiri], and implements [Signature Version 2][sign].
+[Amazon Web Services (AWS)][aws]. It wraps [Excon][excon] and implements 
+[Signature Version 2][sign].
 
 ![jeff][jeff]
 
 ## Usage
 
-Build a a hypothetical client.
+Build a hypothetical client.
 
 ```ruby
 class Client
@@ -20,15 +20,14 @@ Customise default headers and parameters.
 
 ```ruby
 class Client
-  headers 'User-Agent' => 'Client'
-  params  'Service'    => 'SomeService',
+  params  'Service'    => 'Service',
           'Tag'        => -> { tag }
 
   attr_accessor :tag
 end
 ```
 
-Set an AWS endpoint and credentials.
+Set AWS endpoint and credentials.
 
 ```ruby
 client = Client.new.tap do |config|
@@ -41,33 +40,16 @@ end
 You should now be able to access the endpoint.
 
 ```ruby
-res = client.post query: {},
-                  body:  'data'
-
-puts res.status    # => 200
-puts res.body.root # => { 'Foo' => 'Bar' }
-```
-
-### Chunked Requests
-
-You can upload large files performantly by passing a proc that delivers
-chunks.
-
-```ruby
-file = File.open 'data'
-chunker = -> { file.read Excon::CHUNK_SIZE).to_s }
-
-client.post query:         {},
-            request_block: chunker
+client.post query: { 'Foo' => 'Bar' },
+            body:  'data'
 ```
 
 ## Compatibility
 
-**Jeff** is compatible with [all Ruby 1.9 flavours][travis].
+**Jeff** is compatible with [Ruby 1.9 flavours][travis].
 
-[aws]:      http://aws.amazon.com/
-[excon]:    https://github.com/geemus/excon
-[jeff]:     http://f.cl.ly/items/0a3R3J0k1R2f423k1q2l/jeff.jpg
-[nokogiri]: http://nokogiri.org/
-[sign]:     http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
-[travis]:   http://travis-ci.org/#!/hakanensari/jeff
+[aws]:    http://aws.amazon.com/
+[excon]:  https://github.com/geemus/excon
+[jeff]:   http://f.cl.ly/items/0a3R3J0k1R2f423k1q2l/jeff.jpg
+[sign]:   http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
+[travis]: http://travis-ci.org/#!/hakanensari/jeff

data/jeff.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['hakan.ensari@papercavalier.com']
   gem.description   = %q{Minimum-viable Amazon Web Services (AWS) client}
   gem.summary       = %q{AWS client}
-  gem.homepage      = 'https://github.com/hakanensari/jeff'
+  gem.homepage      = 'https://github.com/papercavalier/jeff'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -16,8 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Jeff::VERSION
 
-  gem.add_dependency             'excon',    '~> 0.14.0'
-  gem.add_dependency             'nokogiri', '~> 1.5'
+  gem.add_dependency             'excon', '~> 0.15.0'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/lib/jeff.rb

@@ -1,12 +1,14 @@
-require 'time'
-
 require 'excon'
+require 'time'
 
 require 'jeff/secret'
-require 'jeff/streamer'
 require 'jeff/version'
 
+# Jeff is a light-weight module that mixes in client behaviour for Amazon Web
+# Services (AWS).
 module Jeff
+  USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
+
   MissingEndpoint = Class.new ArgumentError
   MissingKey      = Class.new ArgumentError
   MissingSecret   = Class.new ArgumentError
@@ -15,6 +17,13 @@ module Jeff
 
   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.
@@ -23,7 +32,7 @@ module Jeff
   #
   # Returns a query String.
   def build_query(hsh)
-    default_params
+    params
       .merge(hsh)
       .sort
       .map { |k, v| "#{k}=#{ escape v }" }
@@ -32,22 +41,10 @@ module Jeff
 
   # Internal: Returns an Excon::Connection.
   def connection
-    @connection ||= Excon.new endpoint, headers:    default_headers,
+    @connection ||= Excon.new endpoint, headers:    headers,
                                         idempotent: true
   end
 
-  # 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
-
-  # Internal: Returns the Hash default headers.
-  def default_headers
-    self.class.headers
-  end
-
   # Internal: Gets the String AWS endpoint.
   #
   # Raises a MissingEndpoint error if endpoint is missing.
@@ -58,6 +55,11 @@ module Jeff
   # 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.
@@ -68,6 +70,13 @@ module Jeff
   # 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.is_a?(Proc) ? instance_exec(&v) : v)
+    end
+  end
+
   # Internal: Gets the Jeff::Secret.
   #
   # Raises a MissingSecret error if secret is missing.
@@ -84,18 +93,13 @@ module Jeff
     @secret = Secret.new key
   end
 
-  # Generate HTTP request verb methods that sign queries and then delegate
-  # request to Excon.
-  Excon::HTTP_VERBS. each do |method|
+  # Generate HTTP request verb methods that sign queries and return response
+  # bodies as IO objects.
+  Excon::HTTP_VERBS.each do |method|
     eval <<-DEF
       def #{method}(opts = {})
-        streamer = Streamer.new
-        opts.update method:         :#{method},
-                    response_block: streamer
-        res = connection.request sign opts
-        res.body = streamer
-
-        res
+        opts.update method: :#{method}
+        connection.request sign opts
       end
     DEF
   end
@@ -134,16 +138,13 @@ module Jeff
   end
 
   module ClassMethods
-    # Amazon recommends that libraries identify themselves via a User Agent.
-    USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
-
     # Gets/Updates the default headers.
     #
     # hsh - A Hash of headers.
     #
     # Returns the Hash headers.
     def headers(hsh = nil)
-      @headers ||= { 'User-Agent' => USER_AGENT }
+      @headers ||= {}
       @headers.update hsh if hsh
 
       @headers
@@ -155,12 +156,7 @@ module Jeff
     #
     # Returns the Hash parameters.
     def params(hsh = nil)
-      @params ||= {
-        'AWSAccessKeyId'   => -> { key },
-        'SignatureVersion' => '2',
-        'SignatureMethod'  => 'HmacSHA256',
-        'Timestamp'        => -> { Time.now.utc.iso8601 }
-      }
+      @params ||= {}
       @params.update hsh if hsh
 
       @params

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/spec/jeff_spec.rb

@@ -61,8 +61,8 @@ describe Jeff do
       client.key = 'key'
     end
 
-    describe '#default_params' do
-      subject { client.default_params }
+    describe '#params' do
+      subject { client.params }
 
       it 'should include the key' do
         subject['AWSAccessKeyId'].should eql client.key
@@ -116,11 +116,13 @@ describe Jeff do
 
     Excon::HTTP_VERBS.each do |method|
       describe "##{method}" do
-        subject { client.send(method, mock: true).body.root['request'] }
+        subject do
+          client.send(method, mock: true).body
+        end
 
         before do
           Excon.stub({ method: method.to_sym }) do |params|
-            { body: "<request>#{params[:method]}</request>" }
+            { body: method, status: 200 }
           end
         end
 
@@ -132,12 +134,12 @@ describe Jeff do
       end
     end
 
-    context 'given a failed request' do
+    context 'given a temporary failure' do
       before do
         has_run = false
         Excon.stub({ method: :get }) do |params|
           if has_run
-            { status: 200 }
+            { body: 'ok', status: 200 }
           else
             has_run = true
             raise Excon::Errors::SocketError.new Exception.new 'Mock Error'
@@ -148,21 +150,7 @@ describe Jeff do
       after { Excon.stubs.clear }
 
       it 'should retry' do
-        client.get(mock: true).status.should be 200
-      end
-    end
-
-    context 'given a malformed XML' do
-      before do
-        Excon.stub({ method: :get }) do |params|
-          { body: "\n<?xml version=\"1.0\" ?><foo/>" }
-        end
-      end
-
-      after { Excon.stubs.clear }
-
-      it 'should not raise an error' do
-        client.get mock: true
+        client.get(mock: true).body.should eq 'ok'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-07-30 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.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,23 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -105,20 +89,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/amazon.yml.example
-- examples/debug.rb
 - jeff.gemspec
 - lib/jeff.rb
-- lib/jeff/document.rb
 - lib/jeff/secret.rb
-- lib/jeff/streamer.rb
 - lib/jeff/version.rb
-- spec/jeff/document_spec.rb
 - spec/jeff/secret_spec.rb
-- spec/jeff/streamer_spec.rb
 - spec/jeff_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/hakanensari/jeff
+homepage: https://github.com/papercavalier/jeff
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -130,12 +108,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -177229951203254918
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -177229951203254918
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -143,9 +127,6 @@ signing_key:
 specification_version: 3
 summary: AWS client
 test_files:
-- spec/jeff/document_spec.rb
 - spec/jeff/secret_spec.rb
-- spec/jeff/streamer_spec.rb
 - spec/jeff_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/examples/amazon.yml.example

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

data/examples/debug.rb

@@ -1,41 +0,0 @@
-$:.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/lib/jeff/document.rb

@@ -1,48 +0,0 @@
-require 'nokogiri'
-
-module Jeff
-  class Document < Nokogiri::XML::SAX::Document
-    def characters(val)
-      val.strip!
-      unless val.empty?
-        (node['__content__'] ||= '') << val
-      end
-    end
-
-    def end_element(key)
-      child = @stack.pop
-
-      if child.keys == ['__content__']
-        child = child['__content__']
-      end
-
-      case node[key]
-      when Array
-        node[key] << child
-      when Hash, String
-        node[key] = [node[key], child]
-      else
-        node[key] = child
-      end
-    end
-
-    def start_element(key, attrs = [])
-      @stack << {}
-      attrs.each { |attr| node.store *attr }
-    end
-
-    def start_document
-      @stack = [{}]
-    end
-
-    def root
-      @stack.first
-    end
-
-    private
-
-    def node
-      @stack.last
-    end
-  end
-end

data/lib/jeff/streamer.rb

@@ -1,22 +0,0 @@
-require 'jeff/document'
-
-module Jeff
-  class Streamer
-    def initialize
-      @parser = Nokogiri::XML::SAX::PushParser.new Document.new
-    end
-
-    def call(chunk, remaining_bytes, total_bytes)
-      @parser << chunk.sub(/^\n/, '')
-      @parser.finish if remaining_bytes == 0
-    end
-
-    def document
-      @parser.document
-    end
-
-    def root
-      document.root
-    end
-  end
-end

data/spec/jeff/document_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-module Jeff
-  describe Document do
-    let(:io) do
-      StringIO.new %{
-        <?xml version=\"1.0\" ?>
-        <ItemAttributes>
-          <Title>Anti-Oedipus</Title>
-          <Author>Gilles Deleuze</Author>
-          <Author>Felix Guattari</Author>
-          <Creator Role="Translator">Robert Hurley</Creator>
-        </ItemAttributes>
-      }.strip
-    end
-
-    let(:doc) { described_class.new }
-    let(:parser) { Nokogiri::XML::SAX::Parser.new doc }
-
-    before do
-      io.rewind
-      parser.parse io
-    end
-
-    describe '#root' do
-      subject { doc.root['ItemAttributes'] }
-
-      it { should be_a Hash }
-
-      it 'should handle only children' do
-        subject['Title'].should eql 'Anti-Oedipus'
-      end
-
-      it 'should hande arrays' do
-        subject['Author'].should be_an Array
-      end
-
-      it 'should handle attributes' do
-        creator = subject['Creator']
-        creator['Role'].should eql 'Translator'
-        creator['__content__'].should eql 'Robert Hurley'
-      end
-
-      it 'should ignore space between tags' do
-        should_not have_key '__content__'
-      end
-    end
-  end
-end

data/spec/jeff/streamer_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-module Jeff
-  describe Streamer do
-    let(:streamer) { Streamer.new }
-
-    let(:xml) do
-      %{
-        <?xml version="1.0" ?>
-        <foo>
-          <bar>1</bar>
-        </foo>
-      }.strip.gsub />\s+</, '><'
-    end
-
-    it 'should parse a stream' do
-      bytes_sent  = 0
-      total_bytes = xml.size
-
-      xml.scan(/.{1,8}/m).each do |chunk|
-        bytes_sent += chunk.size
-        streamer.call chunk, total_bytes - bytes_sent, total_bytes
-      end
-
-      streamer.root.should have_key 'foo'
-    end
-  end
-end