phc_string_format 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9796f936f745ffb9ab58df7b1369eed449de3511
-  data.tar.gz: 285a076299d2ee829d9db68fd7a1286344999fa0
+SHA256:
+  metadata.gz: f2c0d23fc35b585de7e270b87439a5ae61c53213f10442f8b5e576484e985d2d
+  data.tar.gz: 5ccf72ce6afe6ac8e16a8fb6904341007e7698daf2ddd85b25296d5179c7cca2
 SHA512:
-  metadata.gz: 32ed90c87744f57f92b96bffc1a408985099e06acfe12f0aebba5763dc9ba9e1dea9a46c594e2067c77b84a103850abb8f6d3ec91563a4b9797f3f078d62735d
-  data.tar.gz: b0bca224d19fce7a6df03f1850f6418aa3d420680c6e16b8d6595c9cf5045e84420bc67b14161d44ecb9bd821c01aebb280da5eb4f4c80aac1bdbe32ca5d166f
+  metadata.gz: 59d704eeda40482c8b55c1ee0e398c3da3b09c70fcff60e05106411c8bf2e43246c57d9b6bbaebf2af5f1ae855105ce915847bee79a09bb67f2b3436d5b21bb6
+  data.tar.gz: 5518af92641a14e47ba3bc552bf9e3da25ece970b479ac2e5708fe868eebbb6571b4725b22e8b0374eeb0f0215d550e11054ccb4e7a1883bc8d286fa9df51677

data/.reek.yml

@@ -0,0 +1,25 @@
+---
+detectors:
+
+  DuplicateMethodCall:
+    exclude:
+    - 'PhcStringFormat::PhcString#self.parse'
+  FeatureEnvy:
+    exclude:
+      - 'PhcStringFormat::PhcString#parse_params'
+
+  LongParameterList:
+    max_params: 6
+    overrides:
+      initialize:
+        max_params: 6
+
+  TooManyStatements:
+    max_statements: 10
+
+  TooManyInstanceVariables:
+    max_instance_variables: 6
+
+  UncommunicativeModuleName:
+    accept:
+    - B64

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  Exclude:
+  - bin/*
+  - pkg/*
+  - tmp/**/*
+  - lib/*/version.rb
+  - spec/spec_helper.rb
+  - Gemfile
+  - '*.gemspec'
+  - Rakefile
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 6
+
+Metrics/PerceivedComplexity:
+  Max: 10

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in phc_string_format.gemspec
 gemspec
+
+gem "rubocop", "~> 0.58.2", require: false, :groups => [:development, :test]
+
+gem "reek", "~> 5.0", require: false, :groups => [:development, :test]

data/Gemfile.lock

@@ -1,22 +1,47 @@
 PATH
   remote: .
   specs:
-    phc_string_format (0.3.0)
+    phc_string_format (0.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     byebug (10.0.2)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
     coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
+    kwalify (0.7.2)
     method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
+    rainbow (3.0.0)
     rake (10.5.0)
+    reek (5.0.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
+      rainbow (>= 2.0, < 4.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -30,6 +55,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thread_safe (0.3.6)
+    unicode-display_width (1.4.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
@@ -39,7 +80,9 @@ DEPENDENCIES
   phc_string_format!
   pry-byebug (~> 3.6)
   rake (~> 10.0)
+  reek (~> 5.0)
   rspec (~> 3.0)
+  rubocop (~> 0.58.2)
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -5,7 +5,7 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/naokikimura/phc_string_format/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/naokikimura/phc_string_format?targetFile=Gemfile.lock)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/cbcb6fa3556447a4af16980f3cc6f1eb)](https://app.codacy.com/app/naokikimura/phc_string_format?utm_source=github.com&utm_medium=referral&utm_content=naokikimura/phc_string_format&utm_campaign=badger)
 
-TODO: Describe your gem
+PHC string format implemented by Ruby
 
 ## Installation
 
@@ -25,7 +25,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'phc_string_format'
+
+encrypted_password = '$argon2i$v=19$m=4096,t=3,p=1$IfH5R3O3r3501DfGnGr2rw$DfQ8Hv9R2eF2uBs1dR99IGjVjDl/rpkJIkaNyZ1g3pk'
+
+# parse
+phc_string_params = PhcStringFormat::Formatter.parse(encrypted_password)
+# => {:id=>"argon2i", :version=>19, :params=>{"m"=>4096, "t"=>3, "p"=>1}, :salt=>"!\xF1\xF9Gs\xB7\xAF~t\xD47\xC6\x9Cj\xF6\xAF", :hash=>"\r\xF4<\x1E\xFFQ\xD9\xE1v\xB8\e5u\x1F} h\xD5\x8C9\x7F\xAE\x99\t\"F\x8D\xC9\x9D`\xDE\x99"}
+
+# format
+password_hash = PhcStringFormat::Formatter.format(phc_string_params)
+
+password_hash == phc_string_format
+```
 
 ## Development
 

data/lib/phc_string_format.rb

@@ -1,5 +1,7 @@
-require "phc_string_format/version"
-require "base64"
+require 'phc_string_format/b64'
+require 'phc_string_format/formatter'
+require 'phc_string_format/phc_string'
+require 'phc_string_format/version'
 
 #
 # PHC string format implemented by Ruby
@@ -8,59 +10,9 @@ require "base64"
 #  $<id>[$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]
 #  ```
 #
+# See:
+# - https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md
+# - https://github.com/P-H-C/phc-string-format/pull/4
+#
 module PhcStringFormat
-  module Formatter
-    def self.format(id:, version: nil, params: {}, salt: '', hash: '', hint: {salt: {encoding: 'base64'}})
-      raise ArgumentError.new, 'id is required' if id.nil?
-      raise ArgumentError.new, 'hash needs salt' if (salt.nil? || salt.empty?) && !(hash.nil? || hash.empty?)
-
-      elements = [
-        id,
-        ("v=#{version}" if version),
-        (params.map{|e| e.join '='}.join(',') if params),
-        hint.dig(:salt, :encoding) == '7bit' ? salt : short_strict_encode64(salt),
-        short_strict_encode64(hash)
-      ]
-      "$#{elements.select{|e| !(e.nil? || e.empty?)}.join('$')}"
-    end
-
-    def self.parse(string, pick: nil ,hint: {salt: {encoding: 'base64'}})
-      pick = [:id, :version, :params, :salt, :hash] unless pick
-      elements = string.split(/\$/, 6)
-      elements.shift
-      id = shift_and_parse elements, pick.include?(:id), &-> (e) { e }
-      version = shift_and_parse(elements, pick.include?(:version), &@@parse_version) if (elements.first || '').start_with?('v=')
-      params = shift_and_parse(elements, pick.include?(:params), &@@parse_parameter_string) if (elements.first || '').include?('=')
-      salt = shift_and_parse elements, pick.include?(:salt), &-> (e) {
-        hint.dig(:salt, :encoding) == '7bit' ? e : short_strict_decode64(e)
-      }
-      hash = shift_and_parse elements, pick.include?(:hash), &-> (e) { short_strict_decode64(e) }
-      {id: id, version: version, params: params, salt: salt, hash: hash}.select {|_,v| v}
-    end
-
-    def self.shift_and_parse(elements, picks, &proc)
-      element = elements.shift
-      proc.call(element) if picks
-    end
-
-    @@parse_version = -> (string) {
-      @@parse_parameter_string.call(string)['v']
-    }
-
-    @@parse_parameter_string = -> (string) {
-      string.split(/,/).map {|e| e.split '='}.each_with_object({}){|e, h| k, v = e; h[k] = (/\A-?\d+(.\d+)?\Z/.match(v) ? v.to_i : v)}
-    }
-
-    def self.short_strict_encode64(bin)
-      return nil unless bin
-      Base64.strict_encode64(bin).delete('=')
-    end
-
-    def self.short_strict_decode64(bin)
-      return nil unless bin
-      Base64.strict_decode64(bin + '=' * (-bin.size % 4))
-    end
-
-    private_class_method :short_strict_encode64, :short_strict_decode64
-  end
 end

data/lib/phc_string_format/b64.rb

@@ -0,0 +1,21 @@
+require 'base64'
+
+module PhcStringFormat
+  #
+  # Implementation of B64
+  #
+  # See:
+  # - https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md#b64
+  #
+  module B64
+    def self.encode(bin)
+      return nil unless bin
+      Base64.strict_encode64(bin).delete('=')
+    end
+
+    def self.decode(bin)
+      return nil unless bin
+      Base64.strict_decode64(bin + '=' * (-bin.size % 4))
+    end
+  end
+end

data/lib/phc_string_format/formatter.rb

@@ -0,0 +1,14 @@
+module PhcStringFormat
+  #
+  # Formatter for stringifying and parsing PHC-string-format.
+  #
+  module Formatter
+    def self.format(**kwargs)
+      PhcString.create(kwargs).to_s
+    end
+
+    def self.parse(string, hint: {}, pick: nil)
+      PhcString.parse(string, hint: hint).to_h(pick)
+    end
+  end
+end

data/lib/phc_string_format/phc_string.rb

@@ -0,0 +1,83 @@
+module PhcStringFormat
+  #
+  # Parser for parsing PHC-string-format.
+  #
+  class PhcString
+    def self.parse(string, hint: {})
+      string ||= ''
+      elements = string.split(/\$/, 6)
+      elements.shift
+      id = elements.shift
+      version = elements.shift if (elements.first || '').start_with?('v=')
+      params = elements.shift if (elements.first || '').include?('=')
+      salt = elements.shift
+      hash = elements.shift
+      PhcString.new(id, version, params, salt, hash, hint)
+    end
+
+    def self.create(id:, version: nil, params: {}, salt: '', hash: '', hint: {})
+      PhcString.new(
+        id,
+        ("v=#{version}" if version),
+        (params.map { |entry| entry.join '=' }.join(',') if params),
+        hint.dig(:salt, :encoding) == '7bit' ? salt : B64.encode(salt),
+        B64.encode(hash),
+        hint
+      )
+    end
+
+    def initialize(id, version_string, params_string, encoded_salt, encoded_hash, hint)
+      raise ArgumentError.new, 'id is required' unless id
+      if (!encoded_salt || encoded_salt.empty?) && !(!encoded_hash || encoded_hash.empty?)
+        raise ArgumentError.new, 'hash needs salt'
+      end
+
+      @id = id
+      @version_string = version_string
+      @params_string = params_string
+      @encoded_salt = encoded_salt
+      @encoded_hash = encoded_hash
+      @hint = hint
+    end
+
+    def to_s
+      '$' + [
+        @id,
+        @version_string,
+        @params_string,
+        @encoded_salt,
+        @encoded_hash
+      ].reject { |element| !element || element.empty? }.join('$')
+    end
+
+    def to_h(pick = nil)
+      pick ||= %i[id version params salt hash]
+      {
+        id: (@id if pick.include?(:id)),
+        version: (parse_version(@version_string) if pick.include?(:version)),
+        params: (parse_params(@params_string) if pick.include?(:params)),
+        salt:
+          if pick.include?(:salt)
+            @hint.dig(:salt, :encoding) == '7bit' ? e : B64.decode(@encoded_salt)
+          end,
+        hash: (B64.decode(@encoded_hash) if pick.include?(:hash))
+      }.select { |_, value| value }
+    end
+
+    private
+
+    def parse_version(version_string)
+      parse_params(version_string)['v']
+    end
+
+    def parse_params(params_string)
+      mapper = ->(param) { param.split '=' }
+      reducer = lambda do |param, params|
+        name, value = param
+        params[name] = value =~ /\A-?\d+(.\d+)?\Z/ ? value.to_i : value
+      end
+      params_string ||= ''
+      params_string.split(/,/).map(&mapper).each_with_object({}, &reducer)
+    end
+  end
+end

data/lib/phc_string_format/version.rb

@@ -1,3 +1,3 @@
 module PhcStringFormat
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phc_string_format
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - naokikimura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -85,6 +87,9 @@ files:
 - bin/console
 - bin/setup
 - lib/phc_string_format.rb
+- lib/phc_string_format/b64.rb
+- lib/phc_string_format/formatter.rb
+- lib/phc_string_format/phc_string.rb
 - lib/phc_string_format/version.rb
 - phc_string_format.gemspec
 homepage: https://github.com/naokikimura/phc_string_format
@@ -109,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: PHC string format implemented by Ruby.