jeff 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7dc14e469ed9bff6b7b93326df76629ee207ff
-  data.tar.gz: a2a4c1e52d690d4bb8d21a10bfdac7d5a1b6d144
+  metadata.gz: 2acf8a725f47146cc30fbae49e80c7b264596681
+  data.tar.gz: 76ae8492c0281afdbd8b5b48c213a65abe774b22
 SHA512:
-  metadata.gz: 22f4c89066d57d64575ce4940b444a4de9b958aaaa1227892f75cda23c0add9226cba2be7c204e00078fdc26debd44cc71b518f7a4dfee5ea4334b9459f5941d
-  data.tar.gz: ca9944259a9f2f7a2156ba0677145031eacaa090ec851df55df69015f08a40ce714a3f88c1e33dd7f9c31b264e77e47630a0a2b6284e1fba08414042f2913da2
+  metadata.gz: 664387a93beb1ba57352c12fd1937952a7f6ddca07118a3ab7bc114737b69f59108c7e2603fa31a1b38cfe5573a931eb113f17c7719f25aa9d0d14cf2e325b98
+  data.tar.gz: 0644c4f20f9a14ef53ca6c618534569c8e88277d177c136460dbfa3352b104122d53c475c2cc9e73b4f8fe6ddb7f7b7dd5923a2da844530bf644df1a058586e5

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
+.bundle
 bin
 pkg

data/.travis.yml

@@ -1,5 +1,6 @@
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  - rbx-2.1.1
+  - rbx-2

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
-gem 'jruby-openssl', platform: :jruby
+
+gem "jruby-openssl", platform: :jruby
+gem "rubysl", platform: :rbx

data/README.md

@@ -1,14 +1,8 @@
 # Jeff
 
-Jeff [signs requests][signature] to some Amazon Web Services.
+Jeff is a small mixin that [signs requests][signature] to some Amazon Web Services. My gems [Vacuum][vacuum] and [Peddler][peddler] build on Jeff.
 
-[Vacuum][vacuum] and [Peddler][peddler] mix in Jeff.
-
-## Usage
-
-<img src="http://f.cl.ly/items/0q0X2f0U053F1U3h131N/jeff-2.jpg">
-<img src="http://f.cl.ly/items/0I1U1p3E3r1z2V2x3l35/jeff-1.jpg">
-<img src="http://f.cl.ly/items/161x3q280o0U3d3v352H/jeff-3.jpg">
+<img src="http://cl.ly/XatM/jeff.gif" style="display: inline-block; max-width: 300px; margin: 1em auto;">
 
 [signature]: http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
 [vacuum]:    https://github.com/hakanensari/vacuum

data/Rakefile

@@ -1,10 +1,9 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs.push 'lib'
-  t.test_files = FileList['test/test_*.rb']
-  t.verbose = true
+  t.libs.push "lib"
+  t.test_files = FileList["test/test_*.rb"]
 end
 
-task :default => [:test]
+task default: :test

data/jeff.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require File.expand_path('../lib/jeff/version.rb', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require File.expand_path("../lib/jeff/version.rb", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Hakan Ensari']
-  gem.email         = ['hakan.ensari@papercavalier.com']
+  gem.authors       = ["Hakan Ensari"]
+  gem.email         = ["me@hakanensari.com"]
   gem.description   = %q{An Amazon Web Services client}
   gem.summary       = %q{An AWS client}
-  gem.homepage      = 'https://github.com/papercavalier/jeff'
+  gem.homepage      = "https://github.com/hakanensari/jeff"
 
   gem.files         = `git ls-files`.split($\)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = 'jeff'
-  gem.require_paths = ['lib']
+  gem.name          = "jeff"
+  gem.require_paths = ["lib"]
   gem.version       = Jeff::VERSION
 
-  gem.add_dependency 'excon', '>= 0.22.1'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'rake'
+  gem.add_dependency "excon", ">= 0.22.1"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rake"
 
-  gem.required_ruby_version = '>= 1.9'
+  gem.required_ruby_version = ">= 1.9"
 end

data/lib/jeff.rb

@@ -1,12 +1,12 @@
-# Jeff's only external dependency.
-require 'excon'
+# Jeff"s only external dependency.
+require "excon"
 
 # Standard library dependencies.
-require 'base64'
-require 'openssl'
-require 'time'
+require "base64"
+require "openssl"
+require "time"
 
-require 'jeff/version'
+require "jeff/version"
 
 # Jeff mixes in client behaviour for Amazon Web Services (AWS) that require
 # Signature version 2 authentication.
@@ -20,7 +20,7 @@ module Jeff
     end
 
     def to_s
-      values.sort.map { |k, v| "#{k}=#{ Utils.escape(v) }" }.join('&')
+      values.sort.map { |k, v| "#{k}=#{ Utils.escape(v) }" }.join("&")
     end
   end
 
@@ -70,26 +70,21 @@ module Jeff
     end
 
     def secret
-      @secret or raise ArgumentError.new('Missing secret')
+      @secret or raise ArgumentError.new("Missing secret")
     end
   end
 
-  # Because Ruby's CGI escapes tilde, use a custom escape.
+  # Because Ruby"s CGI escapes tilde, use a custom escape.
   module Utils
     UNRESERVED = /([^\w.~-]+)/
 
     def self.escape(val)
       val.to_s.gsub(UNRESERVED) do
-        '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
+        "%" + $1.unpack("H2" * $1.bytesize).join("%").upcase
       end
     end
   end
 
-  # Amazon recommends to include a User-Agent header with every request to
-  # identify the application, its version number, programming language, and
-  # host.
-  USER_AGENT = "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
-
   def self.included(base)
     base.extend(ClassMethods)
 
@@ -98,17 +93,17 @@ module Jeff
     # Add other common parameters using `Jeff.params` if required in your
     # implementation.
     base.params(
-      'AWSAccessKeyId'   => -> { aws_access_key_id },
-      'SignatureVersion' => '2',
-      'SignatureMethod'  => 'HmacSHA256',
-      'Timestamp'        => -> { Time.now.utc.iso8601 }
+      "AWSAccessKeyId"   => -> { aws_access_key_id },
+      "SignatureVersion" => "2",
+      "SignatureMethod"  => "HmacSHA256",
+      "Timestamp"        => -> { Time.now.utc.iso8601 }
     )
   end
 
   # A reusable HTTP connection.
   def connection
     @connection ||= Excon.new(aws_endpoint,
-      headers: { 'User-Agent' => USER_AGENT },
+      headers: { "User-Agent" => self.class.user_agent },
       expects: 200,
       omit_default_port: true
     )
@@ -119,11 +114,11 @@ module Jeff
   attr_writer :aws_access_key_id, :aws_secret_access_key
 
   def aws_access_key_id
-    @aws_access_key_id || ENV['AWS_ACCESS_KEY_ID']
+    @aws_access_key_id || ENV["AWS_ACCESS_KEY_ID"]
   end
 
   def aws_secret_access_key
-    @aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
+    @aws_secret_access_key || ENV["AWS_SECRET_ACCESS_KEY"]
   end
 
   # Generate HTTP request verb methods.
@@ -142,7 +137,7 @@ module Jeff
     # Add Content-MD5 header if uploading a file.
     if options.has_key?(:body)
       md5 = Content.new(options[:body]).md5
-      (options[:headers] ||= {}).store('Content-MD5', md5)
+      (options[:headers] ||= {}).store("Content-MD5", md5)
     end
 
     # Build query string.
@@ -169,5 +164,23 @@ module Jeff
     def params(hsh = {})
       (@params ||= {}).update(hsh)
     end
+
+    def user_agent
+      @user_agent ||= default_user_agent
+
+    end
+
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+    end
+
+    private
+
+    # Amazon recommends to include a User-Agent header with every request to
+    # identify the application, its version number, programming language, and
+    # host.
+    def default_user_agent
+      "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
+    end
   end
 end

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = '1.0.1'
+  VERSION = "1.1.0"
 end

data/test/test_jeff.rb

@@ -1,8 +1,6 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'jeff'
-
-Excon.defaults[:mock] = true
+require "minitest/autorun"
+require "minitest/pride"
+require_relative "../lib/jeff"
 
 class TestJeff < Minitest::Test
   def setup
@@ -10,7 +8,7 @@ class TestJeff < Minitest::Test
   end
 
   def test_delegates_unset_aws_credential_to_env_vars
-    key = '123456'
+    key = "123456"
     client = @klass.new
     %w(aws_access_key_id aws_secret_access_key).each do |attr|
       ENV[attr.upcase] = key
@@ -28,48 +26,68 @@ class TestJeff < Minitest::Test
 
   def test_configures_request_query_parameters
     @klass.instance_eval do
-      params 'Foo' => 'bar'
+      params "Foo" => "bar"
     end
-    assert @klass.params.has_key?('Foo')
+    assert @klass.params.has_key?("Foo")
   end
 
   def test_requires_signature
     signature = Jeff::Signature.new(nil)
-    assert_raises(ArgumentError) { signature.sign('foo') }
+    assert_raises(ArgumentError) { signature.sign("foo") }
   end
 
   def test_sorts_request_query_parameters_lexicographically
-    query = Jeff::Query.new('A10' => 1, 'A1' => 1)
-    assert_equal 'A1=1&A10=1', query.to_s
+    query = Jeff::Query.new("A10" => 1, "A1" => 1)
+    assert_equal "A1=1&A10=1", query.to_s
   end
 
   def test_sets_user_agent_header
     client = @klass.new
-    client.aws_endpoint = 'http://example.com/'
-    refute_nil client.connection.data[:headers]['User-Agent']
+    client.aws_endpoint = "http://example.com/"
+    assert_includes client.connection.data[:headers]["User-Agent"], "Jeff"
+  end
+
+  def test_allows_customizing_user_agent
+    @klass.user_agent = "CustomApp/1.0"
+    client = @klass.new
+    client.aws_endpoint = "http://example.com/"
+    assert_equal "CustomApp/1.0", client.connection.data[:headers]["User-Agent"]
+  end
+
+  def test_does_not_escape_tilde
+    assert_equal "~%2C", Jeff::Utils.escape("~,")
   end
 
   Excon::HTTP_VERBS.each do |method|
     define_method "test_makes_#{method}_request" do
       Excon.stub({ }, { status: 200 })
       client = @klass.new
-      client.aws_endpoint = 'http://example.com/'
-      client.aws_access_key_id = 'foo'
-      client.aws_secret_access_key = 'bar'
-      assert_equal 200, client.send(method).status
+      client.aws_endpoint = "http://example.com/"
+      client.aws_access_key_id = "foo"
+      client.aws_secret_access_key = "bar"
+      assert_equal 200, client.send(method, mock: true).status
       Excon.stubs.clear
     end
   end
 
-  def test_adds_contet_md5_request_header_if_given_a_request_body
+  def test_adds_content_md5_request_header_if_given_a_request_body
     Excon.stub({ }) do |params|
-      { body: params[:headers]['Content-MD5'] }
+      { body: params[:headers]["Content-MD5"] }
     end
     client = @klass.new
-    client.aws_endpoint = 'http://example.com/'
-    client.aws_access_key_id = 'foo'
-    client.aws_secret_access_key = 'bar'
-    refute_empty client.post(body: 'foo').body
+    client.aws_endpoint = "http://example.com/"
+    client.aws_access_key_id = "foo"
+    client.aws_secret_access_key = "bar"
+    refute_empty client.post(body: "foo", mock: true).body
     Excon.stubs.clear
   end
+
+  def test_integration
+    client = @klass.new
+    client.aws_access_key_id = "foo"
+    client.aws_secret_access_key = "bar"
+    client.aws_endpoint = "https://mws.amazonservices.com/Sellers/2011-07-01"
+    res = client.post(query: { "Action" => "GetServiceStatus"})
+    assert_equal 200, res.status
+  end
 end

metadata

@@ -1,66 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.22.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.22.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: An Amazon Web Services client
 email:
-- hakan.ensari@papercavalier.com
+- me@hakanensari.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -70,7 +70,7 @@ files:
 - lib/jeff.rb
 - lib/jeff/version.rb
 - test/test_jeff.rb
-homepage: https://github.com/papercavalier/jeff
+homepage: https://github.com/hakanensari/jeff
 licenses: []
 metadata: {}
 post_install_message: 
@@ -79,20 +79,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An AWS client
 test_files:
 - test/test_jeff.rb
-has_rdoc: