jeff 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82378ea1928f533eef948deb4b9b399de0557052
-  data.tar.gz: ed55093dec599ac419c8ebd0b9cd23ebf708591d
+SHA256:
+  metadata.gz: dc9894a6715f02b0f754506e90c496c8d7e1b6cdb946f3c77ce7faa631326753
+  data.tar.gz: 9c6682d0ac05ecf197e63d699a26fa03b511217f99f6c5b27116d94b42a3c09d
 SHA512:
-  metadata.gz: 0cca7126a19eb30bf2d1426e03c93b58dcd3fce5b1c173780758857a2f997b1c4d684f470877b829f2583259a4aa98917f7e6606dc6b0235e1deb69c650c35a8
-  data.tar.gz: 68f2b190aeb08c4da0113f923ba89bbc4b9859885e461cdf632d353508e0445fa85f54abc15903922cc4eebfcac62aed80667c08a56f392a2eaf79ed8872a285
+  metadata.gz: ee5723d12feee028535333062240988d6784073b31d5da7e523eac3f522dde158da75aeed3ff82b814121b9eda018a5085a9bb0587f250e4d059c69910e378b4
+  data.tar.gz: a4d102f669bdd2cef1ceff5b169a6c2d63582b7314d613ea50538b08df81fcdcc60e69f23db541a395570f6d09fd69b83c1072207a3eff119518a4a003e888ac

data/README.md

@@ -1,9 +1,10 @@
 # Jeff
 
-Jeff is a small mixin that [signs requests][signature] to some Amazon Web Services. My gems [Vacuum][vacuum] and [Peddler][peddler] build on Jeff.
+[![Build](https://github.com/hakanensari/jeff/workflows/build/badge.svg)](https://github.com/hakanensari/jeff/actions)
+
+Jeff is a small mixin that signs requests to Amazon with their legacy [Signature Version 2][signature]. Currently, my [Peddler][peddler] gem still uses Jeff.
 
 <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
+[signature]: https://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html
 [peddler]:   https://github.com/papercavalier/peddler

data/lib/jeff.rb

@@ -1,12 +1,12 @@
-# Jeff's only external dependency.
-require "excon"
+# frozen_string_literal: true
 
-# Standard library dependencies.
-require "base64"
-require "openssl"
-require "time"
+require 'excon'
 
-require "jeff/version"
+require 'base64'
+require 'openssl'
+require 'time'
+
+require 'jeff/version'
 
 # Jeff mixes in client behaviour for Amazon Web Services (AWS) that require
 # Signature version 2 authentication.
@@ -22,7 +22,7 @@ module Jeff
     def to_s
       values
         .sort { |a, b| a[0].to_s <=> b[0].to_s }
-        .map { |k, v| "#{k}=#{Utils.escape(v)}" }.join("&")
+        .map { |k, v| "#{k}=#{Utils.escape(v)}" }.join('&')
     end
   end
 
@@ -61,7 +61,7 @@ module Jeff
 
   # Calculates an RFC 2104-compliant HMAC signature.
   class Signature
-    SHA256 = OpenSSL::Digest::SHA256.new
+    SHA256 = OpenSSL::Digest.new('SHA256')
 
     def initialize(secret)
       @secret = secret
@@ -72,18 +72,18 @@ module Jeff
     end
 
     def secret
-      @secret || fail(ArgumentError, "Missing secret")
+      @secret || raise(ArgumentError, 'Missing secret')
     end
   end
 
   # Because Ruby's CGI escapes tilde, use a custom escape.
   module Utils
-    UNRESERVED = /([^\w.~-]+)/
+    UNRESERVED = /([^\w.~-]+)/.freeze
 
     def self.escape(val)
       val.to_s.gsub(UNRESERVED) do
         match = Regexp.last_match[1]
-        "%" + match.unpack("H2" * match.bytesize).join("%").upcase
+        "%#{match.unpack('H2' * match.bytesize).join('%')}".upcase
       end
     end
   end
@@ -96,11 +96,13 @@ 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 }
     )
+
+    super
   end
 
   # A reusable HTTP connection.
@@ -117,11 +119,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
 
   def proxy=(url)
@@ -130,22 +132,22 @@ module Jeff
 
   # Generate HTTP request verb methods.
   Excon::HTTP_VERBS.each do |method|
-    eval <<-DEF
+    eval <<-RUBY, binding, __FILE__, __LINE__ + 1
       def #{method}(options = {})
         options.store(:method, :#{method})
         add_md5_digest options
         sign options
-        #{"move_query_to_body options" if method == "post"}
+        #{'move_query_to_body options' if method == 'post'}
         connection.request(options)
       end
-    DEF
+    RUBY
   end
 
   private
 
   def default_connection_params
     {
-      headers: { "User-Agent" => self.class.user_agent },
+      headers: { 'User-Agent' => self.class.user_agent },
       expects: 200,
       omit_default_port: true
     }
@@ -153,9 +155,10 @@ module Jeff
 
   def add_md5_digest(options)
     return unless options.key?(:body)
+
     md5 = Content.new(options[:body]).md5
     query = options[:query] ||= {}
-    query.store("ContentMD5Value", md5)
+    query.store('ContentMD5Value', md5)
   end
 
   def sign(options)
@@ -165,8 +168,8 @@ module Jeff
 
     # Generate signature.
     signature = Signer
-      .new(options[:method], connection.data[:host], options[:path] || connection.data[:path], query_string)
-      .sign_with(aws_secret_access_key)
+                .new(options[:method], connection.data[:host], options[:path] || connection.data[:path], query_string)
+                .sign_with(aws_secret_access_key)
 
     # Append escaped signature to query.
     options.store(:query, "#{query_string}&Signature=#{Utils.escape(signature)}")
@@ -176,20 +179,21 @@ module Jeff
     return if options[:body]
 
     options[:headers] ||= {}
-    options[:headers].store("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
+    options[:headers].store('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8')
     options.store(:body, options.delete(:query))
   end
 
   def default_query_values
     self.class.params
-      .reduce({}) do |qv, (k, v)|
-        v = v.respond_to?(:call) ? instance_exec(&v) : v
+        .reduce({}) do |qv, (k, v)|
+      v = v.respond_to?(:call) ? instance_exec(&v) : v
 
-        # Ignore keys with nil values
-        v.nil? ? qv : qv.update(k => v)
-      end
+      # Ignore keys with nil values
+      v.nil? ? qv : qv.update(k => v)
+    end
   end
 
+  # Defines class-level methods
   module ClassMethods
     # Gets/updates default request parameters.
     def params(hsh = {})
@@ -208,7 +212,7 @@ module Jeff
     # identify the application, its version number, programming language, and
     # host.
     def default_user_agent
-      "Jeff/#{VERSION} (Language=Ruby; #{`hostname`.chomp})"
+      "Jeff/#{VERSION} (Language=Ruby; #{Socket.gethostname})"
     end
   end
 end

data/lib/jeff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jeff
-  VERSION = "2.0.0"
+  VERSION = '2.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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:
 - me@hakanensari.com
@@ -59,23 +73,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- jeff.gemspec
 - lib/jeff.rb
 - lib/jeff/version.rb
-- test/test_jeff.rb
 homepage: https://github.com/hakanensari/jeff
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,17 +89,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: An AWS client
-test_files:
-- test/test_jeff.rb
+test_files: []

data/.gitignore

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

data/.rubocop.yml

@@ -1,2 +0,0 @@
-StringLiterals:
-  EnforcedStyle: double_quotes

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.3
-  - 2.4.0
-  - jruby-9000
-  - ruby-head
-sudo: false

data/CHANGELOG.md

@@ -1,20 +0,0 @@
-# 1.3.0 15/4/2015
-
-- Handle overly long request queries
-  See https://github.com/hakanensari/peddler/issues/36
-
-# 1.2.0 23/1/2015
-
-- Discard parameters with nil values
-
-# 1.1.0 15/10/2014
-
-- Allow customising user agent
-
-# 1.0.1 18/12/2013
-
-- Relax Excon dependency version
-
-# 1.0.0 25/11/2013
-
-- First stable release

data/Gemfile

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

data/Rakefile

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

data/jeff.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.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         = ["me@hakanensari.com"]
-  gem.description   = %q{An Amazon Web Services client}
-  gem.summary       = %q{An AWS client}
-  gem.homepage      = "https://github.com/hakanensari/jeff"
-  gem.license       = "MIT"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  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.required_ruby_version = ">= 1.9"
-end

data/test/test_jeff.rb

@@ -1,171 +0,0 @@
-require "minitest/autorun"
-require "minitest/pride"
-require_relative "../lib/jeff"
-
-# We may need to set ciphers explicitly on jRuby
-# see https://github.com/jruby/warbler/issues/340
-Excon.defaults[:ciphers] = "DEFAULT" if RUBY_ENGINE == "jruby"
-
-class TestJeff < Minitest::Test
-  def setup
-    @klass = Class.new { include Jeff }
-  end
-
-  def test_delegates_unset_aws_credential_to_env_vars
-    key = "123456"
-    client = @klass.new
-    %w(aws_access_key_id aws_secret_access_key).each do |attr|
-      ENV[attr.upcase] = key
-      assert_equal key, client.send(attr)
-      ENV[attr.upcase] = nil
-      refute_equal key, client.send(attr)
-    end
-  end
-
-  def test_has_required_request_query_parameters
-    %w(AWSAccessKeyId SignatureMethod SignatureVersion Timestamp).each do |key|
-      assert @klass.params.key?(key)
-    end
-  end
-
-  def test_configures_request_query_parameters
-    @klass.params "Foo" => "bar"
-    assert @klass.params.key?("Foo")
-  end
-
-  def test_allows_dynamic_values_for_request_query_parameters
-    @klass.params "Foo" => -> { bar }
-    client = @klass.new
-    def client.bar; "baz"; end
-    assert client.bar, client.send(:default_query_values).fetch("Foo")
-    assert_kind_of Proc, @klass.params["Foo"]
-  end
-
-  def test_discards_request_query_parameters_with_nil_values
-    @klass.params "Foo" => -> { bar }
-    client = @klass.new
-    def client.bar; end
-    refute client.send(:default_query_values).key?("Foo")
-  end
-
-  def test_requires_signature
-    signature = Jeff::Signature.new(nil)
-    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
-  end
-
-  def test_handles_symbol_keys
-    query = Jeff::Query.new(foo: 1, bar: 2)
-    assert_equal "bar=2&foo=1", query.to_s
-  end
-
-  def test_sets_user_agent_header
-    client = @klass.new
-    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_escapes_space
-    assert_equal "%20", Jeff::Utils.escape(" ")
-    query = Jeff::Query.new("foo" => "bar baz")
-    assert_equal "foo=bar%20baz", query.to_s
-  end
-
-  def test_escapes_multibyte_character
-    assert_equal "%E2%80%A6", Jeff::Utils.escape("…")
-  end
-
-  def test_does_not_escape_tilde
-    assert_equal "~%2C", Jeff::Utils.escape("~,")
-  end
-end
-
-class TestJeffInAction < Minitest::Test
-  def setup
-    klass = Class.new { include Jeff }
-    @client = klass.new
-    @client.aws_endpoint = "http://example.com/"
-    @client.aws_access_key_id = "foo"
-    @client.aws_secret_access_key = "bar"
-  end
-
-  def teardown
-    Excon.stubs.clear
-  end
-
-  Excon::HTTP_VERBS.each do |method|
-    define_method "test_makes_#{method}_request" do
-      Excon.stub({}, status: 200)
-      assert_equal 200, @client.send(method, mock: true).status
-    end
-  end
-
-  def test_adds_content_md5_request_header_if_given_a_request_body
-    Excon.stub({}) do |request_params|
-      { body: request_params[:query]["ContentMD5Value"] }
-    end
-    refute_empty @client.post(body: "foo", mock: true).body
-  end
-
-  def test_moves_query_to_body_if_post
-    Excon.stub({}) do |request_params|
-      { body: request_params[:body] }
-    end
-
-    res = @client.post(query: { foo: "bar" }, mock: true)
-    assert_includes res.body, "foo=bar"
-  end
-
-  def test_does_not_move_query_to_body_if_body_is_set
-    Excon.stub({}) do |request_params|
-      { body: request_params[:body] }
-    end
-
-    res = @client.post(query: { foo: "bar" }, body: "baz", mock: true)
-    assert_equal "baz", res.body
-  end
-
-  def test_does_not_move_query_to_body_if_not_post
-    Excon.stub({}) do |request_params|
-      { body: request_params[:body] }
-    end
-
-    res = @client.get(query: { foo: "bar" }, mock: true)
-    assert_nil res.body
-  end
-
-  def test_sets_proper_encoding_header
-    Excon.stub({}) do |request_params|
-      { headers: request_params[:headers] }
-    end
-
-    res = @client.post(query: { foo: "bar" }, mock: true)
-    assert_includes res.headers["Content-Type"], "UTF-8"
-  end
-
-  def test_gets_from_an_actual_endpoint
-    @client.aws_endpoint = "https://mws.amazonservices.com/Sellers/2011-07-01"
-    res = @client.post(query: { "Action" => "GetServiceStatus" })
-    assert_equal 200, res.status
-  end
-
-  def test_has_no_proxy_by_default
-    refute @client.connection.proxy
-  end
-
-  def test_sets_proxy
-    @client.proxy = "http://my.proxy:4321"
-    assert @client.connection.proxy
-  end
-end