jeff 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a639f62956efb161e7a7e49ff2e7871c4fe047c
-  data.tar.gz: fd8e1451516c459c319994c8abc14322c6cd5d3c
+  metadata.gz: 531fd2a3ff845560616632dda4f42b79afafdd38
+  data.tar.gz: 058f220f25b627ee5d9343f396686922b2dc99f6
 SHA512:
-  metadata.gz: bd5fef3ff0d648da00600818d716b4c16c666477c7abbc9290b9bf51763bd10ad9fb93e15cbfa7bb869147bd3b6b4ab4229b5963a80fa7d14fceb8656387f9c5
-  data.tar.gz: 61e31b449e13ca70ff3df5c85c6ebb3d69e8ebd2c2d49357061593165f4efabd1c50345fde89789db6bf3aba793170399c0da914cbf79c834b89c985052e1679
+  metadata.gz: cecaa486900adfbd6505e38ebb2b39a05846033be3fd12231997a7241948e145531278ecce7a63a5cb13480f2ace09c614afc8f07a1ab9dd4c5cf4e1a568ef5d
+  data.tar.gz: 5c46914754a2cd3f3efb4aeeb4da4941c744226bc443686bcf1c5f9162a798288130fdd1d5c67c684ae419ee984b04e66b840fce7e969d1ec176e6a73443f54a

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
+bin
 pkg

data/README.md

@@ -13,17 +13,21 @@ A minimal example:
 Request = Struct.new(:aws_access_key_id, :aws_secret_access_key) do
   include Jeff
 
-  def aws_endpoint; 'https://mws.amazonservices.com/Products/2011-10-01'; end
+  def aws_endpoint
+    'https://mws.amazonservices.com/Products/2011-10-01'
+  end
 end
 
-req = Request.new('foo', 'bar')
+req = Request.new('key', 'secret')
 res = req.get(query: { 'Action' => 'GetServiceStatus' })
 
 puts res.body.match(/Status>([^<]+)/)[1]
+# => "GREEN"
 ```
 
-[Vacuum][vac] provides an example implementation.
+[Vacuum][vac] and [Peddler][ped] implement Jeff.
 
 [sig]: http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
-[vac]: https://github.com/hakanensari/vacuum
 [jef]: http://f.cl.ly/items/0a3R3J0k1R2f423k1q2l/jeff.jpg
+[vac]: https://github.com/hakanensari/vacuum
+[ped]: https://github.com/papercavalier/peddler

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.25.0'
+  gem.add_dependency 'excon', '~> 0.26.0'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'rake'
 

data/lib/jeff.rb

@@ -1,5 +1,4 @@
-# Our only external dependency. Excon is currently my preferred HTTP client in
-# Ruby.
+# The only external dependency.
 require 'excon'
 
 # Standard library dependencies.
@@ -15,22 +14,43 @@ require 'jeff/version'
 # It's Jeff, as in Jeff Bezos.
 module Jeff
   # Converts a query value to a sorted query string.
-  Query = Struct.new(:values) do
+  class Query
+    attr :values
+
+    def initialize(values)
+      @values = values
+    end
+
     def to_s
       values.sort.map { |k, v| "#{k}=#{ Utils.escape(v) }" }.join('&')
     end
   end
 
   # Calculates an MD5sum for file being uploaded.
-  Content = Struct.new(:body) do
+  class Content
+    attr :body
+
+    def initialize(body)
+      @body = body
+    end
+
     def md5
       Base64.encode64(OpenSSL::Digest::MD5.digest(body)).strip
     end
   end
 
   # Signs an AWS request.
-  Request = Struct.new(:method, :host, :path, :query_string) do
-    def sign(aws_secret_access_key)
+  class Request
+    attr :method, :host, :path, :query_string
+
+    def initialize(method, host, path, query_string)
+      @method = method
+      @host = host
+      @path = path
+      @query_string = query_string
+    end
+
+    def sign_with(aws_secret_access_key)
       Signature.new(aws_secret_access_key).sign(string_to_sign)
     end
 
@@ -52,7 +72,7 @@ module Jeff
     end
 
     def secret
-      @secret or raise ArgumentError, 'Missing secret'
+      @secret or raise ArgumentError.new('Missing secret')
     end
   end
 
@@ -89,10 +109,9 @@ module Jeff
     )
   end
 
-  # An HTTP connection. It's reusable, which, as the author of Excon puts it,
-  # is more performant!
+  # A reusable HTTP connection.
   def connection
-    @connection ||= Excon.new(endpoint,
+    @connection ||= Excon.new(aws_endpoint,
       headers: { 'User-Agent' => USER_AGENT },
       expects: 200,
       omit_default_port: true
@@ -102,13 +121,28 @@ module Jeff
   # Accessors for required AWS attributes.
   attr_accessor :aws_endpoint, :aws_access_key_id, :aws_secret_access_key
 
-  # We'll keep these around so we don't break dependent libraries.
-  alias endpoint aws_endpoint
-  alias endpoint= aws_endpoint=
-  alias key aws_access_key_id
-  alias key= aws_access_key_id=
-  alias secret aws_secret_access_key
-  alias secret= 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
+  end
 
   # Generate HTTP request verb methods.
   Excon::HTTP_VERBS.each do |method|
@@ -145,10 +179,10 @@ module Jeff
         options[:path] || connection.data[:path],
         query_string
       )
-      .sign(aws_secret_access_key)
+      .sign_with(aws_secret_access_key)
 
     # Return options after appending an escaped signature to query.
-    options.update(query: "#{query_string}&Signature=#{Utils.escape(signature)}")
+    options.merge(query: "#{query_string}&Signature=#{Utils.escape(signature)}")
   end
 
   module ClassMethods

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/jeff_spec.rb

@@ -35,7 +35,7 @@ describe Jeff do
 
   it 'sets a User-Agent header for the client connection' do
     client = @klass.new
-    client.endpoint = 'http://example.com/'
+    client.aws_endpoint = 'http://example.com/'
     client.connection.data[:headers]['User-Agent'].wont_be_nil
   end
 
@@ -43,9 +43,9 @@ describe Jeff do
     it "makes a #{method.upcase} request" do
       Excon.stub({ }, { status: 200 })
       client = @klass.new
-      client.endpoint = 'http://example.com/'
-      client.key = 'foo'
-      client.secret = 'bar'
+      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
@@ -56,9 +56,9 @@ describe Jeff do
       { body: params[:headers]['Content-MD5'] }
     end
     client = @klass.new
-    client.endpoint = 'http://example.com/'
-    client.key = 'foo'
-    client.secret = 'bar'
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-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.25.0
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement