jeff 0.2.0 → 0.2.2

data/README.md

@@ -37,6 +37,7 @@ client = Client.new.tap do |config|
   config.secret   = 'secret'
 end
 ```
+
 You should now be able to access the endpoint.
 
 ```ruby
@@ -44,7 +45,9 @@ client.post query: {},
             body:  'data'
 ```
 
-Make a chunked request.
+### Chunked Requests
+
+You can upload large files performantly by passing a proc that delivers chunks.
 
 ```ruby
 file = File.open 'data'
@@ -54,7 +57,10 @@ client.post query:         {},
             request_block: chunker
 ```
 
-Stream a response.
+### 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 }
@@ -63,7 +69,33 @@ client.get query:          {},
            response_block: streamer
 ```
 
-HTTP connections are persistent.
+### Instrumentation
+
+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
+  end
+end
+
+client.get query:        {},
+           instrumentor: Logger
+```
+
+For more detailed configuration options, check out the [excon README][excon].
 
 [aws]:   http://aws.amazon.com/
 [excon]: https://github.com/geemus/excon

data/lib/jeff.rb

@@ -70,14 +70,14 @@ module Jeff
     eval <<-DEF
       def #{method}(opts = {}, &block)
         opts.update method: :#{method}
-        request opts, &block
+        connection.request sign opts, &block
       end
     DEF
   end
 
   # Internal: Builds a sorted query.
   #
-  # hsh - A hash of parameters specific to request.
+  # hsh - A hash of query parameters specific to the request.
   #
   # Returns a query String.
   def build_query(hsh)
@@ -88,30 +88,25 @@ module Jeff
       .join '&'
   end
 
-  # Internal: Signs a message.
-  #
-  # message - A String to sign.
-  #
-  # Returns a String signature.
-  def sign(message)
-    digest = OpenSSL::HMAC.digest SHA256, secret, message
-    Base64.encode64(digest).chomp
-  end
-
   private
 
-  def request(opts, &block)
+  def sign(opts)
     query = build_query opts[:query] || {}
+
     string_to_sign = [
-      opts[:method],
-      host,
-      path,
+      opts[:method].upcase,
+      opts[:host] || connection.connection[:host],
+      opts[:path] || connection.connection[:path],
       query
     ].join "\n"
-    signature = sign string_to_sign
-    opts[:query] = [query, "Signature=#{escape signature}"].join '&'
 
-    connection.request opts, &block
+    digest    = OpenSSL::HMAC.digest SHA256, secret, string_to_sign
+    signature = Base64.encode64(digest).chomp
+
+    opts.update query: [
+       query,
+       "Signature=#{escape signature}"
+    ].join('&')
   end
 
   def escape(val)
@@ -120,18 +115,6 @@ module Jeff
     end
   end
 
-  def host
-    @host ||= url.host
-  end
-
-  def path
-    @path ||= url.path
-  end
-
-  def url
-    @url ||= URI endpoint
-  end
-
   module ClassMethods
     # Amazon recommends that libraries identify themselves via a User Agent.
     USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/spec/jeff_spec.rb

@@ -90,19 +90,6 @@ describe Jeff do
     end
   end
 
-  context 'given a key and a secret' do
-    before do
-      client.key = 'key'
-      client.secret = 'secret'
-    end
-
-    describe '#sign' do
-      subject { client.sign 'foo' }
-
-      it { should be_a String }
-    end
-  end
-
   context 'given an endpoint' do
     before do
       client.endpoint = 'http://slowapi.com/delay/0'
@@ -133,32 +120,20 @@ describe Jeff do
 
     Excon::HTTP_VERBS.each do |method|
       describe "##{method}" do
-        subject { client.send method, mock: true }
+        subject { client.send(method, mock: true).body }
 
-        it "should make a #{method.upcase} request" do
-          Excon.stub({ method: method.to_sym }, { body: method })
-          subject.body.should eql method
-        end
-
-        it 'should include default headers' do
+        before do
           Excon.stub({ method: method.to_sym }) do |params|
-            { body: params[:headers] }
+            { body: params }
           end
-          subject.body.should have_key 'User-Agent'
         end
 
-        it 'should include parameters' do
-          Excon.stub({ method: method.to_sym }) do |params|
-            { body: params[:query] }
-          end
-          subject.body.should match client.build_query({})
+        it "should make a #{method.upcase} request" do
+          subject[:method].should eql method.to_sym
         end
 
         it 'should append a signature' do
-          Excon.stub({ method: method.to_sym }) do |params|
-            { body: params[:query] }
-          end
-          subject.body.should match /Signature=[^&]+$/
+          subject[:query].should match /.+&Signature=[^&]+$/
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -137,4 +137,3 @@ summary: AWS client
 test_files:
 - spec/jeff_spec.rb
 - spec/spec_helper.rb
-has_rdoc: