avro-resolution_canonical_form 0.1.0.rc0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b215d8dafd28cb843b8a64936d6293631ca83ea
+  data.tar.gz: 260398add04f7503f3fdb68b04b7b009db08bb92
+SHA512:
+  metadata.gz: db330d565c3e1251ff07e976b9cd8f6199fb0ac9e54548513004edd83194d584dfeda71950583100106d27bf957f36f5712f67532676bb064ad92e9485ae19d7
+  data.tar.gz: aca2c3fcb923337b095adedf83ad181dae64463ea625d2e8cc18e7c01b1f62e392e70d92ce057b500d13f1cbc4a911261d76244dbdcfb94dbdc472209b4605da

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+Style/FileName:
+  Exclude:
+    - 'lib/avro-resolution_canonical_form.rb'
+
+RSpec/FilePath:
+  Enabled: false
+
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# avro-resolution_canonical_form
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,9 @@
+
+source 'https://rubygems.org'
+
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in avro-resolution_canonical_form.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Salsify, Inc
+
+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,107 @@
+# avro-resolution_canonical_form
+
+This gem defines a [Resolution Canonical Form](#resolution_canonical_form) for Avro schemas.
+This is similar to the [Parsing Canonical Form](http://avro.apache.org/docs/1.8.1/spec.html#Parsing+Canonical+Form+for+Schemas)
+from the Apache Avro spec, but extends is to also include attributes that are
+relevant to schema resolution and compatibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avro-resolution_canonical_form'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install avro-resolution_canonical_form
+
+## Resolution Canonical Form
+
+The Resolution Canonical Form extends the [Parsing Canonical Form](http://avro.apache.org/docs/1.8.1/spec.html#Parsing+Canonical+Form+for+Schemas)
+to include `default` and `aliases` attributes:
+
+* [ORDER] Order the appearance of fields in JSON objects as follows:
+  `name, type, fields, symbols, items, values, size, default, aliases`
+* [ALIASES] [Aliases](http://avro.apache.org/docs/1.8.1/spec.html#Aliases) for
+  named types and fields are converted to their fullname, using applicable
+  namespace, and sorted.
+
+## Ruby Support
+
+This currently gem requires the [avro-salsify-fork](https://github.com/salsify/avro)
+gem due to a bug in the Avro Ruby gem support for defaults. The fix for this issue
+will be included in Avro v1.8.2.
+
+### Aliases
+
+The Avro Ruby gem, including the avro-salsify-fork, does not yet include support
+for aliases. Aliases are included in the specification of the Resolution Canonical
+Form above, but not yet supported by this gem.
+
+## Usage
+
+`Avro::ResolutionCanonicalForm` subclasses `Avro::SchemaNormalization`
+and provides a `to_resolution_form` method that returns the resolution canonical
+form for the schema:
+
+```ruby
+require 'avro-resolution_canonical_form'
+
+schema = Avro::Schema.parse(<<-JSON)
+  {
+    "type": "record",
+    "name": "dimensions",
+    "aliases": ["dims", "eg.sizing"],
+    "namespace": "example",
+    "doc": "an example",
+    "fields": [
+      { "name": "height", "type": "int", "default": 1, "doc": "the height" },
+      { "name": "width", "aliases": ["across"], "type": "int", "doc": "the width" }
+    ]
+  }
+JSON
+
+Avro::ResolutionCanonicalForm.to_resolution_form(schema)
+#=> {"name":"example.dimensions","type":"record","fields":[{"name":"height","type":"int","default":1},{"name":"width","type":"int"}]}
+```
+
+A new method, `#sha256_resolution_fingerprint`, is added to `Avro::Schema` to
+return the SHA256 digest based on the resolution form above. This is similar to
+the existing `#sha256_fingerprint` which is based on the Parsing Canonical Form.
+
+```ruby
+schema.sha256_resolution_fingerprint
+
+#=> 80361294467930602613800428579400567035362599364974249578710466785512094641526
+```
+
+## Development
+
+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.
+
+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/salsify/avro-resolution_canonical_form.
+
+## 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,8 @@
+require 'bundler/gem_tasks'
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/avro-resolution_canonical_form.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'avro/resolution_canonical_form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'avro-resolution_canonical_form'
+  spec.version       = Avro::ResolutionCanonicalForm::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Unique identification of Avro schemas for schema resolution'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/avro-resolution_canonical_form'
+
+  spec.license       = 'MIT'
+
+  # Set 'allowed_push_post' to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |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 'rspec', '~> 3.4'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.46.0'
+  spec.add_development_dependency 'overcommit'
+  spec.add_development_dependency 'simplecov'
+  spec.add_runtime_dependency 'avro-salsify-fork', '>= 1.9.0.5'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'avro-resolution_canonical_form'
+
+# 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 -v
+
+bundle update
+
+overcommit --install

data/lib/avro-resolution_canonical_form.rb

@@ -0,0 +1,3 @@
+require 'avro/resolution_canonical_form/version'
+require 'avro/resolution_canonical_form'
+require 'avro/resolution_fingerprint'

data/lib/avro/resolution_canonical_form.rb

@@ -0,0 +1,31 @@
+require 'avro'
+
+module Avro
+  class ResolutionCanonicalForm < SchemaNormalization
+    def self.to_resolution_form(schema)
+      new.to_resolution_form(schema)
+    end
+
+    def to_resolution_form(schema)
+      MultiJson.dump(normalize_schema(schema))
+    end
+
+    private
+
+    # TODO: include aliases once the avro Ruby gem supports them
+    # Note: permitted values for defaults are not enforced here.
+    # That should be done at the schema level, and is not done currently
+    # in the Avro Ruby gem
+    def normalize_field(field)
+      default_value = if field.default?
+                        { default: field.default }
+                      else
+                        {}
+                      end
+      super.merge(default_value)
+    end
+
+    # TODO: Override normalize_named_type once the Avro Ruby gem supports aliases
+    # def normalized_named_type(schema, attributes = {})
+  end
+end

data/lib/avro/resolution_canonical_form/version.rb

@@ -0,0 +1,7 @@
+require 'avro'
+
+module Avro
+  class ResolutionCanonicalForm < SchemaNormalization
+    VERSION = '0.1.0.rc0'.freeze
+  end
+end

data/lib/avro/resolution_fingerprint.rb

@@ -0,0 +1,10 @@
+module Avro
+  class Schema
+    # Returns the SHA-256 fingerprint of the Resolution Canonical Form for the
+    # schema as an Integer
+    def sha256_resolution_fingerprint
+      resolution_form = ResolutionCanonicalForm.to_resolution_form(self)
+      Digest::SHA256.hexdigest(resolution_form).to_i(16)
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: avro-resolution_canonical_form
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-10 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: avro-salsify-fork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0.5
+description: Unique identification of Avro schemas for schema resolution
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- avro-resolution_canonical_form.gemspec
+- bin/console
+- bin/setup
+- lib/avro-resolution_canonical_form.rb
+- lib/avro/resolution_canonical_form.rb
+- lib/avro/resolution_canonical_form/version.rb
+- lib/avro/resolution_fingerprint.rb
+homepage: https://github.com/salsify/avro-resolution_canonical_form
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Unique identification of Avro schemas for schema resolution
+test_files: []