hmac_auth 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f30e0e9490b860f44af2da4885052d04a43b8ce
-  data.tar.gz: d4ed10940edc8424b3f9b11f956066b0d562504b
+SHA256:
+  metadata.gz: 73a1a89fb2b9e884e48e63010b1789adbec35875addf7a31f4b2f23db18df0b7
+  data.tar.gz: 34e220446f3a001004b9b30baf0e43999fc05f73d3fed0b6e136bf10e13dba7e
 SHA512:
-  metadata.gz: 772f07d010cada71be0ffdd849eb597d68f880abf1227b5cb2eacbaaf1240ea9204e5b65cf9fef1542e9d1c274b0ebc9e86980e19f88f33a30cdc96dcdce12af
-  data.tar.gz: 7525acae2eb1ac3dd83019745979735486551dd42f1a0eae269be9f70d46a20d97fca6890f7586ecfb08084602128b19c18db9e81a3a16cc33f6831d608b7a3a
+  metadata.gz: b04e5f129f440990890465f6937374092516733f1f128abaae1b5a334450a437fa27aa75bfb0d035d18874edc5beff0242117fe6246b60043c022698f0c30254
+  data.tar.gz: 658deb0eb376fa9c03618c2c82ef3d406443a7c5db45887b8e0b2fcff0f409f4d02db7175a7772ba2161c2434121972a5b4be7855433c4f1f58348bdfbcca3b7

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 .bundle
 .config
@@ -14,3 +13,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.2.5
+  - 2.3.1
 script: bundle exec rspec

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.4.0
+MAINTAINER Gebhard Woestemeyer <g@ctr.lc>
+ENV LANG=C.UTF-8
+ENV PATH=/app/bin:$PATH
+WORKDIR /app
+COPY . .
+RUN bundle install --local
+CMD ["rspec"]

data/README.md

@@ -3,50 +3,45 @@
 [![Build Status](https://travis-ci.org/gewo/hmac_auth.png)](https://travis-ci.org/gewo/hmac_auth/)
 [![Code Coverage](https://coveralls.io/repos/gewo/hmac_auth/badge.png)](https://coveralls.io/r/gewo/hmac_auth)
 
-```
-    __  ____  ______   _________         __  __
-   / / / /  |/  /   | / ____/   | __  __/ /_/ /_
-  / /_/ / /|_/ / /| |/ /   / /| |/ / / / __/ __ \
- / __  / /  / / ___ / /___/ ___ / /_/ / /_/ / / /
-/_/ /_/_/  /_/_/  |_\____/_/  |_\__,_/\__/_/ /_/
+        __  ____  ______   _________         __  __
+       / / / /  |/  /   | / ____/   | __  __/ /_/ /_
+      / /_/ / /|_/ / /| |/ /   / /| |/ / / / __/ __ \
+     / __  / /  / / ___ / /___/ ___ / /_/ / /_/ / / /
+    /_/ /_/_/  /_/_/  |_\____/_/  |_\__,_/\__/_/ /_/
 
-```
 
 Ruby gem providing HMAC based message signing and verification. Without
 fancy Rails integration.
 
 ## Installation
 
-```ruby
-gem 'hmac_auth'       # Gemfile
-gem install hmac_auth # manual
-```
+    gem 'hmac_auth'       # Gemfile
+    gem install hmac_auth # manual
 
 ## Usage
 
-```ruby
-# Configuration
-HMACAuth.secret      = 't0p_s3cr3!!eins1'
-HMACAuth.reject_keys = %w(action controller format)
-HMACAuth.valid_for   = 15.minutes
+    # Configuration
+    HMACAuth.secret           = 't0p_s3cr3!!eins1'
+    HMACAuth.reject_keys      = %w(action controller format)
+    HMACAuth.valid_for        = 15.minutes
+    HMACAuth.keep_values_type = false
 
-to_be_signed = {
-  b: 2,
-  a: { d: 4, c: 3 }
-}
+    to_be_signed = {
+      b: 2,
+      a: { d: 4, c: 3 }
+    }
 
-signed = HMACAuth::Signature.sign to_be_signed
-# => Hash including 'timestamp' and 'signature'
+    signed = HMACAuth::Signature.sign to_be_signed
+    # => Hash including 'timestamp' and 'signature'
 
-HMACAuth::Signature.verify(signed)                        # => true
-HMACAuth::Signature.verify(signed.merge(evil: 'yes'))     # => false
-HMACAuth::Signature.verify(signed, secret: 'good guess?') # => false
+    HMACAuth::Signature.verify(signed)                        # => true
+    HMACAuth::Signature.verify(signed.merge(evil: 'yes'))     # => false
+    HMACAuth::Signature.verify(signed, secret: 'good guess?') # => false
 
-sleep 20.minutes
-HMACAuth::Signature.verify(signed)                        # => false
+    sleep 20.minutes
+    HMACAuth::Signature.verify(signed)                        # => false
 
-# That's it. Nothing more, nothing less.
-```
+    # That's it. Nothing more, nothing less.
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,4 @@
+version: "2"
+services:
+  app:
+    build: .

data/hmac_auth.gemspec

@@ -1,7 +1,5 @@
 # encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hmac_auth/version'
+require File.expand_path('../lib/hmac_auth/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'hmac_auth'

data/lib/hmac_auth.rb

@@ -11,7 +11,8 @@ require 'hmac_auth/signature'
 module HMACAuth
   mattr_accessor :secret,
     :reject_keys,
-    :valid_for
+    :valid_for,
+    :keep_values_type
 
   # The shared secret.
   self.secret = nil
@@ -22,4 +23,6 @@ module HMACAuth
   # Time the signature is valid when verifying
   self.valid_for = 15.minutes
 
+  # Keep or not the values type when signing
+  self.keep_values_type = false
 end

data/lib/hmac_auth/signature.rb

@@ -16,6 +16,8 @@ module HMACAuth
       @secret = options.delete(:secret) || HMACAuth.secret
       @valid_for = options.delete(:valid_for) || HMACAuth.valid_for
       @reject_keys = options.delete(:reject_keys) || HMACAuth.reject_keys
+      @keep_values_type = options.delete(:keep_values_type) ||
+        HMACAuth.keep_values_type
       @_params = params
 
       raise Error.new 'You *must* tell me a secret!' unless @secret
@@ -50,6 +52,12 @@ module HMACAuth
         end]
       end
 
+      def deep_stringify_skip_values(hash)
+        Hash[hash.map do |k, v|
+          [k.to_s, v.is_a?(Hash) ? deep_stringify_skip_values(v) : v]
+        end]
+      end
+
       def valid_timestamp
         timestamp && timestamp >= valid_for.ago.to_i
       end
@@ -69,11 +77,20 @@ module HMACAuth
       end
 
       def params
-        @params ||= deep_stringify(@_params.reject do |k, v|
+        reject_keys!
+        @params ||= if keep_values_type
+           deep_stringify_skip_values(reject_keys!)
+        else
+          deep_stringify(reject_keys!)
+        end
+      end
+
+      def reject_keys!
+        @_params.reject do |k, v|
           reject_keys.include? k
-        end)
+        end
       end
 
-      attr_reader :secret, :valid_for, :reject_keys
+      attr_reader :secret, :valid_for, :reject_keys, :keep_values_type
   end
 end

data/lib/hmac_auth/version.rb

@@ -1,4 +1,4 @@
 # coding: utf-8
 module HMACAuth
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/signature_spec.rb

@@ -24,38 +24,38 @@ module HMACAuth
 
         context 'valid' do
           let(:timestamp) { 10.minutes.ago.to_i.to_s }
-          it { should be_true }
+          it { should be_truthy }
         end
 
         context 'invalid' do
           let(:timestamp) { 20.minutes.ago.to_i }
-          it { should be_false }
+          it { should be_falsy }
         end
       end
     end
 
     describe '.sign' do
-      def signature(hash)
-        HMACAuth::Signature.sign(hash, secret: secret)['signature']
-      end
-
       describe 'hash' do
         subject { HMACAuth::Signature.sign(params, secret: secret) }
 
-        it { should be_a Hash }
-        its(['signature']) { should be_a String }
-        its(['timestamp']) { should be }
-        its(['b']) { should be_a String }
+        it { expect(subject).to be_a Hash }
+        it { expect(subject['signature']).to be_a String }
+        it { expect(subject['timestamp']).to be }
+        it { expect(subject['b']).to be_a String }
 
         context 'nested hash' do
           subject { HMACAuth::Signature.sign(params, secret: secret)['a'] }
-          it { should be_a Hash }
-          its(['d']) { should == '4' }
-          its(['c']) { should == '3' }
+          it { expect(subject).to be_a Hash }
+          it { expect(subject['d']).to eq '4' }
+          it { expect(subject['c']).to eq '3' }
         end
       end
 
       describe 'unsorted input' do
+        def signature(hash)
+          HMACAuth::Signature.sign(hash, secret: secret)['signature']
+        end
+
         let(:hasha) { { a: 1, b: { c: 3, d: 4 } } }
         let(:hashd) { { b: { d: 4, c: 3 }, a: 1 } }
 
@@ -63,6 +63,37 @@ module HMACAuth
           signature(hasha).should == signature(hashd)
         end
       end
+
+      context 'when keep_values_type is true' do
+        describe 'hash' do
+          subject do
+            HMACAuth::Signature.sign(
+              params,
+              secret: secret,
+              keep_values_type: true
+            )
+          end
+
+          it { expect(subject).to be_a Hash }
+          it { expect(subject['signature']).to be_a String }
+          it { expect(subject['timestamp']).to be }
+          it { expect(subject['b']).to be_a Integer }
+
+          context 'nested hash' do
+            subject do
+              HMACAuth::Signature.sign(
+                params,
+                secret: secret,
+                keep_values_type: true
+              )['a']
+            end
+
+            it { expect(subject).to be_a Hash }
+            it { expect(subject['d']).to eq 4 }
+            it { expect(subject['c']).to eq 3 }
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hmac_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gebhard Wöstemeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,14 +90,13 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- docker-compose.yml
 - hmac_auth.gemspec
 - lib/hmac_auth.rb
 - lib/hmac_auth/error.rb
@@ -105,6 +104,27 @@ files:
 - lib/hmac_auth/version.rb
 - spec/signature_spec.rb
 - spec/spec_helper.rb
+- vendor/cache/activesupport-5.0.1.gem
+- vendor/cache/concurrent-ruby-1.0.5.gem
+- vendor/cache/coveralls-0.8.19.gem
+- vendor/cache/diff-lcs-1.3.gem
+- vendor/cache/docile-1.1.5.gem
+- vendor/cache/i18n-0.8.1.gem
+- vendor/cache/json-2.0.3.gem
+- vendor/cache/minitest-5.10.1.gem
+- vendor/cache/rake-12.0.0.gem
+- vendor/cache/rspec-3.5.0.gem
+- vendor/cache/rspec-core-3.5.4.gem
+- vendor/cache/rspec-expectations-3.5.0.gem
+- vendor/cache/rspec-mocks-3.5.0.gem
+- vendor/cache/rspec-support-3.5.0.gem
+- vendor/cache/simplecov-0.12.0.gem
+- vendor/cache/simplecov-html-0.10.0.gem
+- vendor/cache/term-ansicolor-1.4.0.gem
+- vendor/cache/thor-0.19.4.gem
+- vendor/cache/thread_safe-0.3.6.gem
+- vendor/cache/tins-1.13.2.gem
+- vendor/cache/tzinfo-1.2.2.gem
 homepage: https://github.com/gewo/hmac_auth
 licenses:
 - MIT
@@ -124,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby gem providing HMAC based message signing and verification. Without fancy

data/.ruby-gemset

@@ -1 +0,0 @@
-hmac_auth

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.0

data/Gemfile.lock

@@ -1,61 +0,0 @@
-PATH
-  remote: .
-  specs:
-    hmac_auth (0.1.2)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.1.8)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.1)
-      tzinfo (~> 1.1)
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    diff-lcs (1.2.5)
-    docile (1.1.1)
-    i18n (0.6.11)
-    json (1.8.1)
-    mime-types (2.0)
-    minitest (5.5.0)
-    multi_json (1.8.4)
-    rake (10.1.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    thread_safe (0.3.4)
-    tins (0.13.1)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  coveralls
-  hmac_auth!
-  rake
-  rspec
-  simplecov