json_hasher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c43b96281db87452b4319a83b038ce3b7bbe4b9
+  data.tar.gz: 8f61ad2a9071b86b142565ccc9fce047d11e2787
+SHA512:
+  metadata.gz: 1127a0933a2eb23c0d11b0ef162ad038c6260c23ecae84eaf3b9d0e5b60e5ae6ff948155e4f070bf00d2c565db27fa40060a8fd52f1a4041f4a712558e8b5a8a
+  data.tar.gz: ad865d556091c64b944fcc852a929650dee0b0e95d0f1f917260efc89902d563492a0aa606472a88b5edb5c73c44e2d2fdb3d9dd6c53ebedea90285e6bbce5bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_hasher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Poorman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# JSONHasher
+
+Create a stable SHA-2 hash from a JSON object.
+
+JSON objects do not require the keys to be in any kind of order which can make creating a hash unstable. This gem solves that problem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_hasher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_hasher
+
+## Usage
+
+```ruby
+test_json_one = '[{ "foo": "bar", "ping": "pong" }]'
+test_json_two = '[{ "ping": "pong", "foo": "bar" }]'
+
+hashed_one = JSONHasher::Parser.new(test_json_one).to_sha2
+hashed_two = JSONHasher::Parser.new(test_json_two).to_sha2
+
+# hashed_one: c15915ccb473c4cecca65f940f6a36091f70333b9e8226dfe51ca247c73e56f1
+# hashed_two: c15915ccb473c4cecca65f940f6a36091f70333b9e8226dfe51ca247c73e56f1
+
+assert_equal hashed_one, hashed_two
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nickpoorman/ruby_json_hasher.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_hasher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_hasher.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_hasher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_hasher"
+  spec.version       = JSONHasher::VERSION
+  spec.authors       = ["Nick Poorman"]
+  spec.email         = ["nickpoorman@gmail.com"]
+
+  spec.summary       = "Create a stable SHA-2 hash from a JSON object."
+  spec.description   = "JSON objects do not require the keys to be in any kind of order which can make the hash unstable. This gem solves that problem."
+  spec.homepage      = "https://github.com/nickpoorman/ruby_json_hasher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/json_hasher.rb

@@ -0,0 +1,48 @@
+require 'json_hasher/version'
+require 'json'
+require 'digest/sha2'
+
+module JSONHasher
+  class Parser
+    def initialize(json_string)
+      raise 'JSONHasher only takes a String' unless json_string.is_a?(String)
+      @parsed_json = JSON.parse(json_string)
+    end
+
+    def to_sha2
+      hash_parsed_json(@parsed_json)
+    end
+
+    private
+
+    def hash_parsed_json(parsed_json)
+      case parsed_json.class.name
+      when 'Array'
+        hash_array(parsed_json)
+      when 'Hash'
+        hash_object(parsed_json)
+      else
+        hash_other(parsed_json)
+      end
+    end
+
+    def hash_array(array)
+      mapped = array.map do |elm|
+        hash_parsed_json(elm)
+      end
+      hash_other(mapped)
+    end
+
+    def hash_object(obj)
+      pairs = obj.to_a.sort_by(&:first)
+      hash_array(pairs)
+    end
+
+    def hash_other(value)
+      value_type = value.class.to_s
+      value_string = value.to_s
+      hashed = Digest::SHA2.new << "#{value_type}\"\"#{value_string}"
+      hashed.to_s
+    end
+  end
+end

data/lib/json_hasher/version.rb

@@ -0,0 +1,3 @@
+module JSONHasher
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: json_hasher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Poorman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: JSON objects do not require the keys to be in any kind of order which
+  can make the hash unstable. This gem solves that problem.
+email:
+- nickpoorman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_hasher.gemspec
+- lib/json_hasher.rb
+- lib/json_hasher/version.rb
+homepage: https://github.com/nickpoorman/ruby_json_hasher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Create a stable SHA-2 hash from a JSON object.
+test_files: []