dighasher 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c9a0ea0041870c2bd8a1a8289cd5f16b6888f5e2
4
+ data.tar.gz: 5d62a9f174e9efc57278eda61955dc97ac934d9a
5
+ SHA512:
6
+ metadata.gz: fb077d6ee86286172dc3ddd9e7877fb765f5f7163965428a91c8d4649d80dc5d573c73c63fce93c5858e5f2cf19cda5802a7aa364afc4d8f549844988024f09f
7
+ data.tar.gz: a199b0d26a07efc167922114587c187c209f40a2c231646eba55b7c5ba3995e1ef44dcba84c9ba57a5646773c183e66ddceb3224457ac7325c19e093b5492604
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.8
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in dighasher.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 h.shigemoto
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # Dighasher
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'dighasher'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install dighasher
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ 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.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "dighasher"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/dighasher.gemspec ADDED
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dighasher/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dighasher"
8
+ spec.version = Dighasher::VERSION
9
+ spec.authors = ["h.shigemoto"]
10
+ spec.email = ["corporation.ore@gmail.com"]
11
+ spec.summary = %q{This gem is generate hash. Use digest lib.}
12
+ spec.description = %q{This gem is generate hash. Use digest lib. Digest use MD5, SHA1, SHA256, SHA512, SHA2.}
13
+ spec.homepage = "https://github.com/h-shigemoto/dighasher"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
17
+ # delete this section to allow pushing this gem to any host.
18
+ # if spec.respond_to?(:metadata)
19
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
20
+ # else
21
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
22
+ # end
23
+
24
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ spec.bindir = "exe"
26
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
27
+ spec.require_paths = ["lib"]
28
+
29
+ spec.add_development_dependency "bundler", "~> 1.10"
30
+ spec.add_development_dependency "rake", "~> 10.0"
31
+ spec.add_development_dependency "rspec", "~> 3.0"
32
+ end
@@ -0,0 +1,50 @@
1
+ require 'digest/md5'
2
+ require 'digest/sha1'
3
+ require 'digest/sha2'
4
+
5
+ # Digest Instance Generator
6
+ module DigestGenerator
7
+
8
+ # MD5 Hash Constant
9
+ MD5 = 1
10
+ # SHA1 Hash Constant
11
+ SHA1 = 2
12
+ # SHA256 Hash Constant
13
+ SHA256 = 3
14
+ # SHA512 Hash Constant
15
+ SHA512 = 4
16
+ # SHA2 Hash Constant
17
+ SHA2 = 5
18
+
19
+ # generate digest instance.
20
+ # @param [integer] mode Hash mode. use DigestGenerator constant.
21
+ # @param [String] str target string
22
+ # @param [integer] bitlen SHA2 bitlength. 256 or 384 or 512.
23
+ # @return [Digest] digest lib instance
24
+ def self.generate_digest(mode, str=nil, bitlen=256)
25
+
26
+ digest = nil
27
+
28
+ # generate digest instance
29
+ case mode
30
+ when MD5 then
31
+ digest = Digest::MD5.new
32
+ when SHA1 then
33
+ digest = Digest::SHA1.new
34
+ when SHA256 then
35
+ digest = Digest::SHA256.new
36
+ when SHA512 then
37
+ digest = Digest::SHA512.new
38
+ when SHA2 then
39
+ digest = Digest::SHA2.new(bitlen)
40
+ else
41
+ digest = nil
42
+ end
43
+
44
+ # set str
45
+ if (digest && str)
46
+ digest.update(str)
47
+ end
48
+ digest
49
+ end
50
+ end
@@ -0,0 +1,3 @@
1
+ module Dighasher
2
+ VERSION = "0.1.0"
3
+ end
data/lib/dighasher.rb ADDED
@@ -0,0 +1,135 @@
1
+ require "dighasher/version"
2
+ require "dighasher/digest_generator"
3
+
4
+ module Dighasher
5
+
6
+ # Hash Generate Class
7
+ class Generator
8
+
9
+ # constructor
10
+ # @param [integer] mode Hash mode. DigestGenerator::Xxxx constant.
11
+ # @param [String] str target string
12
+ # @param [integer] bitlen SHA2 bitlength. 256 or 384 or 512.
13
+ def initialize(mode, str=nil, bitlen=256)
14
+
15
+ # generate digest instance
16
+ @digest = DigestGenerator::generate_digest(mode, str, bitlen)
17
+ @mode = mode
18
+ @bitlen = bitlen
19
+ @base_str = str
20
+ end
21
+
22
+ # update hash target string.
23
+ # @param [String] str update string
24
+ def update(str)
25
+
26
+ # unless str, no update.
27
+ return unless str
28
+
29
+ # update str.
30
+ @digest.update(str)
31
+
32
+ # if @base_str equals nil, @base_str set empty.
33
+ @base_str = '' unless @base_str
34
+ @base_str << str
35
+ end
36
+
37
+ # reset digest instance.
38
+ def reset
39
+
40
+ # reset @digest
41
+ @digest.reset
42
+ @base_str = nil
43
+ end
44
+
45
+ # compare str and hash str.
46
+ # @param [String] str compare target string
47
+ # @param [String] temp_add_str temporary additional string.
48
+ # @return [boolean] true:equal hash / false:not equal hash
49
+ def equals(str, temp_add_str=nil)
50
+
51
+ # if exist temporary add string, dup @digest and add str.
52
+ eq_digest = get_temporary_digest(temp_add_str)
53
+ # generate compare digest instance.
54
+ comp_digest = DigestGenerator.generate_digest(@mode, str, @bitlen)
55
+
56
+ # compare hex digest value.
57
+ return eq_digest == comp_digest.hexdigest
58
+ end
59
+
60
+ # generate hash.
61
+ # @param [boolean] use_hex_string if true, use hexdigest. else, use digest.
62
+ # @param [String] temp_add_str temporary additional string.
63
+ # @return [Byte / String] hash
64
+ def generate_hash(use_hex_string=true, temp_add_str=nil)
65
+
66
+ # if exist temp_add_str, dup @digest and add str.
67
+ hash_digest = get_temporary_digest(temp_add_str)
68
+ hash = use_hex_string ? hash_digest.hexdigest : hash_digest.digest
69
+ hash
70
+ end
71
+
72
+ # generate hash.
73
+ # reset after generate hash.
74
+ # @param [boolean] use_hex_string if true, use hexdigest. else, use digest.
75
+ # @return [Byte / String] hash.
76
+ def generate_hash!(use_hex_string=true)
77
+
78
+ # generate hash and @digest reset.
79
+ hash = use_hex_string ? @digest.hexdigest! : @digest.digest!
80
+ @base_str = nil
81
+ hash
82
+ end
83
+
84
+ # generate file hash.
85
+ # reset before generate hash.
86
+ # @param [String] file_path target file path
87
+ # return [String] hash
88
+ def file_hash(file_path)
89
+
90
+ @digest.reset
91
+ @base_str = nil
92
+ @digest.file(file_path).to_s
93
+ end
94
+
95
+ # get digest instance.
96
+ # @return [Digest] digest lib instance.
97
+ def digest
98
+ @digest
99
+ end
100
+
101
+ # get digest mode.
102
+ # @return [integer] digest mode. DigestGenerator constant.
103
+ def mode
104
+ @mode
105
+ end
106
+
107
+ # get byte length
108
+ # @return [integer] bitlen. Use DigestGenerator::SHA2 mode only.
109
+ def bitlen
110
+ @bitlen
111
+ end
112
+
113
+ # get hash base string.
114
+ # @return [String] hash base string.
115
+ def base_str
116
+ @base_str
117
+ end
118
+
119
+ private
120
+
121
+ # get temporary digest(dup @digest) and add string.
122
+ # @param [String] temp_add_str temporary additional string.
123
+ # @return [String] temporary digest instance.
124
+ def get_temporary_digest(temp_add_str)
125
+
126
+ # if not exist temp_add_str, return @digest
127
+ return @digest unless temp_add_str
128
+
129
+ # dup @digest and add str.
130
+ temp_digest = @digest.dup
131
+ temp_digest.update(temp_add_str)
132
+ temp_digest
133
+ end
134
+ end
135
+ end
metadata ADDED
@@ -0,0 +1,102 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dighasher
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - h.shigemoto
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: This gem is generate hash. Use digest lib. Digest use MD5, SHA1, SHA256,
56
+ SHA512, SHA2.
57
+ email:
58
+ - corporation.ore@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - CODE_OF_CONDUCT.md
67
+ - Gemfile
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - dighasher.gemspec
74
+ - lib/dighasher.rb
75
+ - lib/dighasher/digest_generator.rb
76
+ - lib/dighasher/version.rb
77
+ homepage: https://github.com/h-shigemoto/dighasher
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.6.3
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: This gem is generate hash. Use digest lib.
101
+ test_files: []
102
+ has_rdoc: