jeff 0.2.5 → 0.3.0

data/README.md

@@ -1,14 +1,15 @@
 # Jeff
 
-**Jeff** is a light-weight module that mixes in client behaviour for [Amazon
-Web Services (AWS)][aws]. It wraps the HTTP adapter [Excon][excon] and
-implements [Signature Version 2][sign].
+**Jeff** is a light-weight module that mixes in client behaviour for
+[Amazon Web Services (AWS)][aws]. It wraps [Excon][excon], parses
+responses with [Nokogiri][nokogiri], and implements [Signature Version
+2][sign].
 
 ![jeff][jeff]
 
 ## Usage
 
-Here's a hypothetical client.
+Build a a hypothetical client.
 
 ```ruby
 class Client
@@ -41,13 +42,17 @@ end
 You should now be able to access the endpoint.
 
 ```ruby
-client.post query: {},
-            body:  'data'
+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.
+You can upload large files performantly by passing a proc that delivers
+chunks.
 
 ```ruby
 file = File.open 'data'
@@ -57,47 +62,13 @@ client.post query:         {},
             request_block: chunker
 ```
 
-### Streaming Responses
-
-Similarly, you can download and parse large files performantly by passing a
-block that will receive chunks.
-
-```ruby
-streamer = ->(chunk, remaining, total) { puts chunk }
-
-client.get query:          {},
-           response_block: streamer
-```
-
-### Instrumentation
-
-Requests can be instrumented.
-
-```ruby
-class Logger
-  def self.instrument(name, params = {})
-   $stderr.puts name, params
-   yield if block_given?
-  end
-end
-
-client.get query: {}, instrumentor: Logger
-```
-
-### Miscellaneous
-
-* HTTP connections are persistent.
-* By default, Jeff will retry failed requests 4 times.
-
-For more detailed configuration options, read [excon][excon].
-
 ## Compatibility
 
-**Jeff** is Ruby 1.9-compatible. It is tested against [MRI 1.9.3 plus JRuby and
-Rubinius in 1.9 mode][travis].
+**Jeff** is compatible with [all Ruby 1.9 flavours][travis].
 
-[aws]:    http://aws.amazon.com/
-[excon]:  https://github.com/geemus/excon
-[sign]:   http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
-[jeff]:   http://f.cl.ly/items/0a3R3J0k1R2f423k1q2l/jeff.jpg
-[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
+[nokogiri]: http://nokogiri.org/
+[sign]:     http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
+[travis]:   http://travis-ci.org/#!/hakanensari/jeff

data/jeff.gemspec

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

data/lib/jeff.rb

@@ -3,6 +3,7 @@ require 'time'
 require 'excon'
 
 require 'jeff/secret'
+require 'jeff/streamer'
 require 'jeff/version'
 
 module Jeff
@@ -87,9 +88,14 @@ module Jeff
   # request to Excon.
   Excon::HTTP_VERBS. each do |method|
     eval <<-DEF
-      def #{method}(opts = {}, &block)
-        opts.update method: :#{method}
-        connection.request sign opts, &block
+      def #{method}(opts = {})
+        streamer = Streamer.new
+        opts.update method:         :#{method},
+                    response_block: streamer
+        res = connection.request sign opts
+        res.body = streamer
+
+        res
       end
     DEF
   end

data/lib/jeff/document.rb

@@ -0,0 +1,45 @@
+require 'nokogiri'
+
+module Jeff
+  class Document < Nokogiri::XML::SAX::Document
+    def characters(val)
+      (node['__content__'] ||= '') << val
+    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

@@ -0,0 +1,22 @@
+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/lib/jeff/version.rb

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

data/spec/jeff/document_spec.rb

@@ -0,0 +1,45 @@
+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.gsub />\s+</, '><'
+    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
+    end
+  end
+end

data/spec/jeff/streamer_spec.rb

@@ -0,0 +1,28 @@
+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

data/spec/jeff_spec.rb

@@ -120,22 +120,18 @@ describe Jeff do
 
     Excon::HTTP_VERBS.each do |method|
       describe "##{method}" do
-        subject { client.send(method, mock: true).body }
+        subject { client.send(method, mock: true).body.root['request'] }
 
         before do
           Excon.stub({ method: method.to_sym }) do |params|
-            { body: params }
+            { body: "<request>#{params[:method]}</request>" }
           end
         end
 
         after { Excon.stubs.clear }
 
         it "should make a #{method.upcase} request" do
-          subject[:method].should eql method.to_sym
-        end
-
-        it 'should append a signature' do
-          subject[:query].should match /.+&Signature=[^&]+$/
+          should eql method
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-07-11 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.3
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        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'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,9 +109,13 @@ files:
 - 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
@@ -123,7 +143,9 @@ 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: