h 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fad455705cf418f3479dff439b6cf79e4b7c239c
-  data.tar.gz: a8d0d223ee5eeb2345ee8fcfcbdfd7aac8207ed4
+  metadata.gz: 6b16434031f5b5e709a131a094e25065701e207c
+  data.tar.gz: 1c0e43f7f37fa7727007eaae29bffb7fa5d9c3ed
 SHA512:
-  metadata.gz: 5e85f0c4d67071419213fac60b28ac073176ef8181cd21f6a73941930515272a093ecca8e6cf24d16447a8ad731b5cb2bd5d3fe458ebadf6ab8ea0c5ee675ad8
-  data.tar.gz: 8f6145528fdc206f37406272a02e50bd6eb20f70d4c8f42b596ce87aeaca787023a6b1a6dd05103e49a046d1739011fe38577cf87938033ee86daee99846ec40
+  metadata.gz: f35d34fc2ea767ec2c23dff59ebead4b2e4c51d58e7b0f7c0d47146a5957ef951a2a60419db4a10706f3e60edc0f63f90d98e05a8658e9d0ca217ab750484669
+  data.tar.gz: ef42be5f74e5450381a4e50ce75a167f2411ab7f46eed24423a53bf93ea9bc3a7057592d06d0434692288817075dd69f1443a63c1869c3cdea5c7a5e30207bd3

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.4.1

data/.travis.yml

@@ -1,5 +1,13 @@
 language: ruby
-script: 'bundle exec rake test:coverage'
+sudo: false
+cache: bundler
+script: 'bundle exec rake test:coverage --trace'
+before_install:
+  - gem install bundler
 rvm:
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
   - ruby-head
+  - jruby-head
+  - rbx-2

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+
 gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011, Cyril Wack
+Copyright (c) 2011, Cyril Kato
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Small tool that generates salted hashes, scented with the SHA2 function.
+Small tool that generates salted hashes, scented with the SHA-256 hash function.
 
 ## Why?
 
@@ -14,33 +14,41 @@ Small tool that generates salted hashes, scented with the SHA2 function.
 
 ## Configuration
 
-H reads its configuration from the `~/.h` file at initialization.  This file, which should be readable by its owner only, have the salt value.
+H reads its configuration from the `~/.h` file at initialization.
+This file, which should be readable by its owner only, have the salt value.
 
 ## Examples
 
 Generate a digest from the system:
 
-    $ echo "塩" > ~/.h
-    $ h シークレット
-    -q0zMnMSszj8D23a8aNJX_VYry9oSSLZ30XlHkmFt9I=
-    $ h secret 3
-    -q0
+```sh
+$ echo "my-secret" > ~/.h
 
-Same operation, from Ruby:
+$ h p@ssw0rd
+ff665753fe1d26bd6a721760fe3b6623568a9c51962d6bfc9b7fc73d1f1c14d5
 
-    irb(main):001:0> require "h"
-    true
-    irb(main):002:0> H::Generator.new("塩").input "シークレット", 3
-    "-q0"
+$ h シークレット
+069f550ba39da8f87b0229ad5e3d75814c472b1c5a109ff236f9184f49fb3a25
+```
+
+Same operations, with Ruby:
+
+```ruby
+require "h"
+
+builder = H::Builder.new("my-secret")
+
+builder.call("p@ssw0rd") # => ff665753fe1d26bd6a721760fe3b6623568a9c51962d6bfc9b7fc73d1f1c14d5
+builder.call("シークレット") # => 069f550ba39da8f87b0229ad5e3d75814c472b1c5a109ff236f9184f49fb3a25
+```
 
 ## Status
 
 * [![Gem Version](https://badge.fury.io/rb/h.png)](http://badge.fury.io/rb/h)
 * [![Build Status](https://secure.travis-ci.org/cyril/h.rb.png)](//travis-ci.org/cyril/h.rb)
 * [![Dependency Status](https://gemnasium.com/cyril/h.rb.svg)](//gemnasium.com/cyril/h.rb)
-* [![Inline docs](http://inch-ci.org/github/cyril/h.rb.png)](http://inch-ci.org/github/cyril/h.rb)
 * ![](https://ruby-gem-downloads-badge.herokuapp.com/h?type=total)
 
-* * *
+***
 
-Copyright (c) 2014 Cyril Wack, released under the [ISC license](LICENSE.md)
+Copyright (c) 2014 Cyril Kato, released under the [ISC license](LICENSE.md)

data/Rakefile

@@ -14,4 +14,4 @@ namespace :test do
 end
 
 task(:doc_stats) { ruby '-S yard stats' }
-task default: [:test, :doc_stats]
+task default: %i[test doc_stats]

data/VERSION.semver

@@ -1 +1 @@
-2.2.2
+3.0.0

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'qi'
+
+require 'irb'
+IRB.start

data/bin/h

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative File.join '..', 'lib', 'h'
+require_relative File.join('..', 'lib', 'h')
 
 CONF_PATH = File.join(File.expand_path('~'), '.h')
 
@@ -16,10 +16,12 @@ unless File.exist?(CONF_PATH)
   puts 'Done.'
 end
 
-h = H::Generator.new(File.open(CONF_PATH).readlines.first.chomp)
+secret  = File.open(CONF_PATH)
+              .readlines
+              .fetch(0)
+              .chomp
 
-puts h.input ARGV[0].to_s,  if ARGV[1].nil?
-                              44
-                            else
-                              ARGV[1].to_i
-                            end
+builder = H::Builder.new(secret)
+result  = builder.call(ARGV[0])
+
+puts result

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/h.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name          = 'h'
   spec.version       = File.read('VERSION.semver')
-  spec.authors       = ['Cyril Wack']
+  spec.authors       = ['Cyril Kato']
   spec.email         = ['contact@cyril.email']
   spec.homepage      = 'https://github.com/cyril/h.rb'
   spec.summary       = 'Salted hashes tool'
-  spec.description   = 'Small tool that generates salted hashes, scented ' \
+  spec.description   = 'Small tool that generates salted hashes, scented '    \
                        'with the SHA2 function, for those who prefer to put ' \
                        'makeup on passwords rather than yield them to Manager™.'
   spec.license       = 'ISC'
@@ -15,9 +15,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^test\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',    '~> 1.8'
-  spec.add_development_dependency 'fix',        '~> 0.9'
-  spec.add_development_dependency 'rake',       '~> 10.4'
-  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'bundler',    '~> 1.15'
+  spec.add_development_dependency 'fix',        '~> 0.17'
+  spec.add_development_dependency 'rake',       '~> 12.1'
   spec.add_development_dependency 'coveralls',  '~> 0.8'
 end

data/lib/h.rb

@@ -1,56 +1,21 @@
-require 'digest'
+require 'digest/sha2'
 
-# Namespace and main entry point for the H library.
 module H
-  # Class that generates cryptographic hash
-  class Generator
-    # Initialize a H instance.
-    #
-    # @param static_key [String] a random data
-    #
-    # @return [H::Generator] instance
-    #
-    def initialize(static_key)
-      @static_key = static_key
-    end
+  class Builder
+    attr_reader :secret
 
-    # Return a hash of +l+ length.
-    #
-    # @param m [String] a message
-    # @param l [Fixnum] the length of the returned string
-    #
-    # @return [String] salted cryptographic hash.
-    #
-    # @api public
-    def input(m, l)
-      m += @static_key
-      d = cryptographic_hash(m)
-      truncate d, l
+    def initialize(secret)
+      @secret = secret.to_s
     end
 
-    protected
-
-    # Build a hash from +m+ message.
-    #
-    # @param m [String] a message
-    #
-    # @return [String] cryptographic hash.
-    #
-    # @api private
-    def cryptographic_hash(m)
-      ::Digest::SHA256.base64digest(m).tr('+/', '-_')
+    def call(value)
+      ::Digest::SHA256.hexdigest(salt(value.to_s))
     end
 
-    # Truncate the given string from +lng+ param.
-    #
-    # @param str [String] a string to truncate
-    # @param lng [Fixnum] the length of the truncated string
-    #
-    # @return [String] truncated string.
-    #
-    # @api private
-    def truncate(str, lng)
-      str[0, lng]
+    private
+
+    def salt(value)
+      value + secret
     end
   end
 end

data/test/test_h.rb

@@ -1,39 +1,31 @@
 require_relative '_test_helper'
 
-Fix.describe H::Generator do
-  # basic test
-  on :new, 'my-salt' do
-    # returns a salted hash
-    on :input, '', 44 do
-      it { MUST Eql: 'rdOQxxmSfOy-3-HA7OrnqT2Pl2Y_I7Ojqsc1NwVP4sg=' }
+Fix.describe H::Builder do
+  on :new, 'my-secret' do
+    on :call, nil do
+      it { MUST eql '186ef76e9d6a723ecb570d4d9c287487d001e5d35f7ed4a313350a407950318e' }
     end
 
-    # returns another salted hash
-    on :input, 'p@ssw0rd', 44 do
-      it { MUST Eql: 'LCoF25LqK6yFMRs6OoQoZEI4GV4-gR7vd1JZtbi8swA=' }
+    on :call, 'p@ssw0rd' do
+      it { MUST eql 'ff665753fe1d26bd6a721760fe3b6623568a9c51962d6bfc9b7fc73d1f1c14d5' }
     end
 
-    # returns a salted hash of 8 chars
-    on :input, 'p@ssw0rd', 8 do
-      it { MUST Eql: 'LCoF25Lq' }
+    on :call, 'シークレット' do
+      it { MUST eql '069f550ba39da8f87b0229ad5e3d75814c472b1c5a109ff236f9184f49fb3a25' }
     end
   end
 
-  # exotic test
-  on :new, '塩' do
-    # returns a different salted hash
-    on :input, 'p@ssw0rd', 44 do
-      it { MUST_NOT Eql: 'LCoF25LqK6yFMRs6OoQoZEI4GV4-gR7vd1JZtbi8swA=' }
+  on :new, nil do
+    on :call, nil do
+      it { MUST eql 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' }
     end
 
-    # returns a salted hash
-    on :input, 'シークレット', 44 do
-      it { MUST Eql: '-q0zMnMSszj8D23a8aNJX_VYry9oSSLZ30XlHkmFt9I=' }
+    on :call, 'p@ssw0rd' do
+      it { MUST eql 'a075d17f3d453073853f813838c15b8023b8c487038436354fe599c3942e1f95' }
     end
 
-    # returns a salted hash of 3 chars
-    on :input, 'シークレット', 3 do
-      it { MUST Eql: '-q0' }
+    on :call, 'シークレット' do
+      it { MUST eql '2f1a3e825632d6d5c2085839b7d82e38d9e7435d5cafb1d38801db87335ba0dd' }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
-- Cyril Wack
+- Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: fix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +71,9 @@ description: Small tool that generates salted hashes, scented with the SHA2 func
 email:
 - contact@cyril.email
 executables:
+- console
 - h
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,6 +82,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardoc/checksums"
+- ".yardoc/complete"
 - ".yardoc/object_types"
 - ".yardoc/objects/root.dat"
 - ".yardoc/proxy_types"
@@ -102,7 +91,9 @@ files:
 - README.md
 - Rakefile
 - VERSION.semver
+- bin/console
 - bin/h
+- bin/setup
 - h.gemspec
 - lib/h.rb
 - test/_test_helper.rb
@@ -129,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Salted hashes tool
@@ -138,4 +129,3 @@ test_files:
 - test/support.rb
 - test/support/coverage.rb
 - test/test_h.rb
-has_rdoc: