tent-canonical-json 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tent-canonical-json.gemspec
+gemspec
+
+gem 'json-pointer', :git => 'git://github.com/tent/json-pointer-ruby.git', :branch => 'master'

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013 Apollic Software, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Apollic Software, LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,32 @@
+# TentCanonicalJson [![Build Status](https://travis-ci.org/tent/tent-canonical-json-ruby.png)](https://travis-ci.org/tent/tent-canonical-json-ruby)
+
+Derive Tent canonical json from post.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tent-canonical-json'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tent-canonical-json
+
+## Usage
+
+```ruby
+post = Hash.new # replace with hash representation of post json
+TentCanonicalJson.encode(post) # => canonical json string
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec

data/lib/tent-canonical-json.rb

@@ -0,0 +1,154 @@
+require "tent-canonical-json/version"
+require "json-pointer"
+require "yajl"
+
+class TentCanonicalJson
+  REMOVE = %w[ /permissions /received_at /version/received_at /version/id ].freeze
+  REMOVE_MATCHING = {
+    "/mentions/*/public" => false
+  }.freeze
+  MOVE = {
+    "/original_entity" => "/entity",
+    "/mentions/*/original_entity" => "/mentions/{index}/entity",
+    "/version/parents/*/original_entity" => "/version/parents/{index}/entity"
+  }.freeze
+  REMOVE_EMPTY = %w[ /app /attachments /mentions /content /licenses /version/parents /version/message /version ].freeze
+  REMOVE_MATCHING_PATHS = {
+    "/version/parents/*/post" => "/id",
+    "/version/parents/*/entity" => "/entity",
+    "/mentions/*/post" => "/id",
+    "/mentions/*/entity" => "/entity"
+  }.freeze
+
+  def self.encode(post)
+    new(post).encode
+  end
+
+  def initialize(post)
+    @post = stringify_keys(post.dup)
+  end
+
+  def encode
+    cleanup
+    sorted_encode
+  end
+
+  private
+
+  def cleanup
+    REMOVE.each do |path|
+      pointer = JsonPointer.new(@post, path)
+      pointer.delete
+    end
+
+    MOVE.each_pair do |path, target_path|
+      pointer = JsonPointer.new(@post, path)
+      next unless pointer.exists?
+
+      if path =~ %r{/\*/}
+        pointer.value.each_with_index do |value, index|
+          next unless value
+          target_pointer = JsonPointer.new(@post, target_path.sub('{index}', index.to_s))
+          target_pointer.value = value
+        end
+        pointer.delete
+      else
+        target_pointer = JsonPointer.new(@post, target_path)
+        target_pointer.value = pointer.value if pointer.value
+        pointer.delete
+      end
+    end
+
+    REMOVE_MATCHING.each_pair do |path, value|
+      pointer = JsonPointer.new(@post, path)
+      next unless pointer.exists?
+
+      pointer.value.each_with_index do |pointer_value, index|
+        next unless pointer_value == value
+        delete_path = path.split('/')
+        delete_path.pop
+        delete_path = delete_path.join('/').sub('*', index.to_s)
+        delete_pointer = JsonPointer.new(@post, delete_path)
+        delete_pointer.delete
+      end
+    end
+
+    REMOVE_EMPTY.each do |path|
+      pointer = JsonPointer.new(@post, path)
+      pointer.delete if obj_empty?(pointer.value)
+    end
+
+    REMOVE_MATCHING_PATHS.each_pair do |path, other_path|
+      pointer = JsonPointer.new(@post, path)
+      next unless pointer.exists?
+      other_pointer = JsonPointer.new(@post, other_path)
+      next unless other_pointer.exists?
+
+      pointer.value.each_with_index do |value, index|
+        delete_pointer = JsonPointer.new(@post, path.sub('*', index.to_s))
+        delete_pointer.delete if value == other_pointer.value
+      end
+    end
+  end
+
+  def sorted_encode(hash=@post)
+    sorted_keys = hash.keys.sort
+    encoded_values = hash.inject({}) do |memo, (k,v)|
+      memo[k] = case v
+      when Hash
+        sorted_encode(v)
+      when Array
+        json = v.map { |i|
+          case i
+          when Hash
+            sorted_encode(i)
+          else
+            Yajl::Encoder.encode(i)
+          end
+        }.join(",")
+        "[#{json}]"
+      else
+        Yajl::Encoder.encode(v)
+      end
+      memo
+    end
+    json = sorted_keys.map do |key|
+      "#{key.to_s.inspect}:#{encoded_values[key]}"
+    end.join(",")
+    "{#{json}}"
+  end
+
+  def stringify_keys(hash)
+    hash.inject(Hash.new) do |new_hash, (key, val)|
+      new_hash[key.to_s] = case val
+      when Hash
+        stringify_keys(val)
+      when Array
+        val.map { |v|
+          case v
+          when Hash
+            stringify_keys(v)
+          else
+            v
+          end
+        }
+      else
+        val
+      end
+      new_hash
+    end
+  end
+
+  def obj_empty?(obj)
+    case obj
+    when Hash
+      obj.keys.empty?
+    when Array
+      obj.empty?
+    when String
+      obj == ""
+    when NilClass
+      true
+    end
+  end
+end

data/lib/tent-canonical-json/version.rb

@@ -0,0 +1,3 @@
+class TentCanonicalJson
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/canonical_json_encode_method_examples.rb

@@ -0,0 +1,5 @@
+shared_examples "a canonical json encode method" do
+  it "encodes post" do
+    expect(described_class.encode(post)).to eq(encoded_post)
+  end
+end

data/spec/tent-canonical-json_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+require 'tent-canonical-json'
+require 'support/canonical_json_encode_method_examples'
+
+describe TentCanonicalJson do
+  describe ".encode" do
+    let(:time) { (Time.now.to_f * 1000).to_i }
+
+    context "with no removable members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :version => {
+            :parents => [
+              {
+                :version => "6438326334656235323631636239633861613938353565646436376431626431",
+                :entity => "https://other.example.org",
+                :post => "f4fa728bc8daf2a322e47ee4fc865a49",
+              },
+              {
+                :version => "6637666262613665303633366638393065353666626266333238336535323463",
+              }
+            ],
+            :published_at => time,
+            :message => "A short description of changes made.",
+          },
+          :mentions => [
+            {
+              :post => "23a5b25940d6f3a75748f1edb5628e80",
+              :entity => "https://foo.example.com",
+            },
+            {
+              :version => "3963663737376166653332336561393031306331333933356262396438316264",
+              :entity => "https://bar.example.org",
+              :post => "2c2ca13f2af0b5cb557867ec86e75451",
+            }
+          ],
+          :licenses => [
+            {
+              :url => "https://somelicense.example.org",
+            }
+          ],
+          :content => {
+            :zombies => {
+              :kills => 1200,
+              :escapes => 32,
+              :kills_without_wepon => 100,
+            },
+            :demons => {
+              :kills => 13,
+              :kills_without_wepon => 2,
+              :escapes => 43,
+            },
+            :vamps => {
+              :kills => 43,
+              :kills_without_wepon => 14,
+              :escapes => 200,
+              :tricked_into_sunlight => 13,
+            },
+          },
+        }
+      end
+
+      let(:encoded_post) do
+        %({"content":{"demons":{"escapes":43,"kills":13,"kills_without_wepon":2},"vamps":{"escapes":200,"kills":43,"kills_without_wepon":14,"tricked_into_sunlight":13},"zombies":{"escapes":32,"kills":1200,"kills_without_wepon":100}},"entity":"https://entity.example.org","id":"d8a3884345df0d6854d4bec893a4649e","licenses":[{"url":"https://somelicense.example.org"}],"mentions":[{"entity":"https://foo.example.com","post":"23a5b25940d6f3a75748f1edb5628e80"},{"entity":"https://bar.example.org","post":"2c2ca13f2af0b5cb557867ec86e75451","version":"3963663737376166653332336561393031306331333933356262396438316264"}],"published_at":#{time},"type":"https://example.com/types/foo/v0#","version":{"message":"A short description of changes made.","parents":[{"entity":"https://other.example.org","post":"f4fa728bc8daf2a322e47ee4fc865a49","version":"6438326334656235323631636239633861613938353565646436376431626431"},{"version":"6637666262613665303633366638393065353666626266333238336535323463"}],"published_at":#{time}}})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+
+    context "with removable members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :received_at => time,
+          :version => {
+            :id => "3963663737376166653332336561393031306331333933356262396438316264",
+            :received_at => time,
+            :published_at => time,
+            :message => "Hello World!",
+          },
+          :permissions => {
+            :public => true
+          },
+        }
+      end
+
+      let(:encoded_post) do
+        %({"entity":"https://entity.example.org","id":"d8a3884345df0d6854d4bec893a4649e","published_at":#{time},"type":"https://example.com/types/foo/v0#","version":{"message":"Hello World!","published_at":#{time}}})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+
+    context "with removable empty members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :version => {
+            :published_at => time,
+            :parents => [],
+            :message => "",
+          },
+          :content => {},
+          :mentions => [],
+          :licenses => [],
+          :app => {},
+          :attachments => [],
+        }
+      end
+
+      let(:encoded_post) do
+        %({"entity":"https://entity.example.org","id":"d8a3884345df0d6854d4bec893a4649e","published_at":#{time},"type":"https://example.com/types/foo/v0#","version":{"published_at":#{time}}})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+
+    context "with redundant members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :version => {
+            :published_at => time,
+            :message => "Hello World!",
+            :parents => [
+              {
+                :version => "6330626530393234306663623531643735623232616166663462663434323163",
+                :entity => "https://entity.example.org",
+                :post => "d8a3884345df0d6854d4bec893a4649e",
+              },
+              {
+                :version => "3933383165396136376161333631373531636561393031373863303934616436",
+                :entity => "https://entity.example.org",
+              }
+            ],
+          },
+          :mentions => [
+            {
+              :post => "d8a3884345df0d6854d4bec893a4649e",
+              :entity => "https://entity.example.org",
+              :version => "6136643936666130356662323433613133303832613231313935656264313236",
+            }
+          ],
+        }
+      end
+
+      let(:encoded_post) do
+        %({"entity":"https://entity.example.org","id":"d8a3884345df0d6854d4bec893a4649e","mentions":[{"version":"6136643936666130356662323433613133303832613231313935656264313236"}],"published_at":#{time},"type":"https://example.com/types/foo/v0#","version":{"message":"Hello World!","parents":[{"version":"6330626530393234306663623531643735623232616166663462663434323163"},{"version":"3933383165396136376161333631373531636561393031373863303934616436"}],"published_at":#{time}}})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+
+    context "with conditional removable members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :mentions => [
+            {
+              :public => false,
+              :entity => "https://foobar.example.com"
+            }
+          ]
+        }
+      end
+
+      let(:encoded_post) do
+        %({"entity":"https://entity.example.org","id":"d8a3884345df0d6854d4bec893a4649e","published_at":#{time},"type":"https://example.com/types/foo/v0#"})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+
+    context "with movable members" do
+      let(:post) do
+        {
+          :id => "d8a3884345df0d6854d4bec893a4649e",
+          :entity => "https://entity.example.org",
+          :original_entity => "https://baz.example.org",
+          :type => "https://example.com/types/foo/v0#",
+          :published_at => time,
+          :version => {
+            :parents => [
+              {
+                :version => "6438326334656235323631636239633861613938353565646436376431626431",
+                :entity => "https://other.example.org",
+                :original_entity => "https://thefirstother.example.org"
+              }
+            ],
+            :published_at => time,
+            :message => "A short description of changes made.",
+          },
+          :mentions => [
+            {
+              :entity => "https://foobar.example.com",
+              :original_entity => "https://bar.example.com"
+            }
+          ]
+        }
+      end
+
+      let(:encoded_post) do
+        %({"entity":"https://baz.example.org","id":"d8a3884345df0d6854d4bec893a4649e","mentions":[{"entity":"https://bar.example.com"}],"published_at":#{time},"type":"https://example.com/types/foo/v0#","version":{"message":"A short description of changes made.","parents":[{"entity":"https://thefirstother.example.org","version":"6438326334656235323631636239633861613938353565646436376431626431"}],"published_at":#{time}}})
+      end
+
+      it_behaves_like "a canonical json encode method"
+    end
+  end
+end

data/tent-canonical-json.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tent-canonical-json/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tent-canonical-json"
+  gem.version       = TentCanonicalJson::VERSION
+  gem.authors       = ["Jesse Stuart"]
+  gem.email         = ["jesse@jessestuart.ca"]
+  gem.description   = %q{Derive Tent canonical json from post}
+  gem.summary       = %q{Derive Tent canonical json from post}
+  gem.homepage      = "https://github.com/tent/tent-canonical-json-ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "json-pointer"
+  gem.add_runtime_dependency "yajl-ruby"
+
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: tent-canonical-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-pointer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Derive Tent canonical json from post
+email:
+- jesse@jessestuart.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tent-canonical-json.rb
+- lib/tent-canonical-json/version.rb
+- spec/spec_helper.rb
+- spec/support/canonical_json_encode_method_examples.rb
+- spec/tent-canonical-json_spec.rb
+- tent-canonical-json.gemspec
+homepage: https://github.com/tent/tent-canonical-json-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Derive Tent canonical json from post
+test_files:
+- spec/spec_helper.rb
+- spec/support/canonical_json_encode_method_examples.rb
+- spec/tent-canonical-json_spec.rb