dighasher 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adffae8a5c2c3e33e242056a905dfe960c419dd5
-  data.tar.gz: 6f0d9fa16e59c34f481a0ad27ee01e0898f4e63c
+  metadata.gz: 65327f504552d85df018251b7ec8ada5b8e374f5
+  data.tar.gz: 9186dd71c44464adb503733b951cc3a9c31b3850
 SHA512:
-  metadata.gz: 661fb71253917b39e55bba0852b8b81df53d13678643875637c05aee42a187993ad85d953264aae0cab99805cff534a2e8046e47fd407ed46b6d2a3a2e484410
-  data.tar.gz: 732fa4989bd313e9c75d76f95b9cf99c7984d6c06e590bcec5d2fa13665ead80c3e3e96ca010ffd89bd989e3a405723a74fdfae16253df38cd62680ad2d8b9b9
+  metadata.gz: dca3b2dcae36c349cf4e8c027d9146f6e2881afc0e1e482ec3f18dbdfd459eeefd44c4126fdf3af2270b89fe39b105c3f4eed0cf4caa8f87180b529e72a52dbb
+  data.tar.gz: 9825734ac4d44b274134b886515898fac85b507e01e98f8a2e300a7bfe2d5353f832dfcf0fed68763d3f7d028f20ce05296fd02f2d489de69b2fee87c7ea8bf0

data/README.md

@@ -2,7 +2,8 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dighasher`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+This gem provide generate hash method.
+Hash algorithm, MD5, SHA1, SHA256, SHA512, SHA2.
 
 ## Installation
 
@@ -22,7 +23,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This sample generate hash by MD5.
+
+```ruby
+require 'dighasher'
+
+generator = Dighasher::Generator.new(Dighasher::DigestGenerator::MD5, "hash target string.")
+
+# generate hash.
+hash = generator.generate_hash
+```
 
 ## Development
 
@@ -32,7 +42,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dighasher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/h-shigemoto/dighasher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/dighasher/digest_generator.rb

@@ -2,54 +2,58 @@ require 'digest/md5'
 require 'digest/sha1'
 require 'digest/sha2'
 
-# Digest Instance Generator
-module DigestGenerator
-
-  # MD5 Hash Constant
-  MD5 = 1
-  # SHA1 Hash Constant
-  SHA1 = 2
-  # SHA256 Hash Constant
-  SHA256 = 3
-  # SHA512 Hash Constant
-  SHA512 = 4
-  # SHA2 Hash Constant
-  SHA2 = 5
-
-  # get available hash.
-  def self.available
-    "Digest::MD5, Digest::SHA1, Digest::SHA256, Digest::SHA512, Digest::SHA2(256, 384, 512)"
-  end
+# Dighasher module.
+module Dighasher
 
-  # generate digest instance.
-  # @param [integer] mode Hash mode. use DigestGenerator constant.
-  # @param [String] str target string
-  # @param [integer] bitlen SHA2 bitlength. 256 or 384 or 512.
-  # @return [Digest] digest lib instance
-  def self.generate_digest(mode, str=nil, bitlen=256)
-
-    digest = nil
-
-    # generate digest instance
-    case mode
-    when MD5 then
-      digest = Digest::MD5.new
-    when SHA1 then
-      digest = Digest::SHA1.new
-    when SHA256 then
-      digest = Digest::SHA256.new
-    when SHA512 then
-      digest = Digest::SHA512.new
-    when SHA2 then
-      digest = Digest::SHA2.new(bitlen)
-    else
-      digest = nil
+  # Digest Instance Generator
+  class DigestGenerator
+
+    # MD5 Hash Constant
+    MD5 = 1
+    # SHA1 Hash Constant
+    SHA1 = 2
+    # SHA256 Hash Constant
+    SHA256 = 3
+    # SHA512 Hash Constant
+    SHA512 = 4
+    # SHA2 Hash Constant
+    SHA2 = 5
+
+    # get available hash.
+    def self.available
+      "Digest::MD5, Digest::SHA1, Digest::SHA256, Digest::SHA512, Digest::SHA2(256, 384, 512)"
     end
 
-    # set str
-    if (digest && str)
-      digest.update(str)
+    # generate digest instance.
+    # @param [integer] mode Hash mode. use DigestGenerator constant.
+    # @param [String] str target string
+    # @param [integer] bitlen SHA2 bitlength. 256 or 384 or 512.
+    # @return [Digest] digest lib instance
+    def self.generate_digest(mode, str=nil, bitlen=256)
+
+      digest = nil
+
+      # generate digest instance
+      case mode
+      when MD5 then
+        digest = Digest::MD5.new
+      when SHA1 then
+        digest = Digest::SHA1.new
+      when SHA256 then
+        digest = Digest::SHA256.new
+      when SHA512 then
+        digest = Digest::SHA512.new
+      when SHA2 then
+        digest = Digest::SHA2.new(bitlen)
+      else
+        digest = nil
+      end
+
+      # set str
+      if (digest && str)
+        digest.update(str)
+      end
+      digest
     end
-    digest
   end
 end

data/lib/dighasher/version.rb

@@ -1,3 +1,3 @@
 module Dighasher
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/dighasher.rb

@@ -14,7 +14,7 @@ module Dighasher
     def initialize(mode, str=nil, bitlen=256)
 
       # generate digest instance
-      @digest = DigestGenerator::generate_digest(mode, str, bitlen)
+      @digest = Dighasher::DigestGenerator::generate_digest(mode, str, bitlen)
       @mode = mode
       @bitlen = bitlen
       @base_str = str
@@ -26,7 +26,7 @@ module Dighasher
     def change_mode(mode, bitlen=256)
 
       # generate new digest instance
-      @digest = DigestGenerator::generate_digest(mode, @base_str, bitlen)
+      @digest = Dighasher::DigestGenerator::generate_digest(mode, @base_str, bitlen)
       @mode = mode
       @bitlen = bitlen
     end
@@ -63,7 +63,7 @@ module Dighasher
       # if exist temporary add string, dup @digest and add str.
       eq_digest = get_temporary_digest(temp_add_str)
       # generate compare digest instance.
-      comp_digest = DigestGenerator.generate_digest(@mode, str, @bitlen)
+      comp_digest = Dighasher::DigestGenerator.generate_digest(@mode, str, @bitlen)
 
       # compare hex digest value.
       return eq_digest == comp_digest.hexdigest
@@ -147,6 +147,6 @@ module Dighasher
 
   # get available hash.
   def self.available
-    DigestGenerator.available
+    Dighasher::DigestGenerator.available
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dighasher
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - h.shigemoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler