avromatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 329e7d74bd13cdd0237363d54e44afbefca210de
+  data.tar.gz: 7c9e9357c7933615a82a9c6ad76e7c679d8068ce
+SHA512:
+  metadata.gz: 364418e416fc2bb56157765a0662177c705d0c1bf7632080f0f5ee5603e571ca253cff575f30e11ab1c22bac3ca433cd3a1a726d66c5cab441b4373546e3cdf3
+  data.tar.gz: af17cbc43d42a4e0545df4ff92c0d34372ad5be3877db490f0f72636328599860146f18b986a48d6fd5b703a9081a37899dcd169b5c483b1d018ec7f1a0c8141

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# avromatic changelog
+
+## v0.1.0
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Avromatic currently depends on a fork of AvroTurf for some changes that
+# have not been accepted/released.
+gem 'avro_turf', github: 'salsify/avro_turf', branch: 'salsify-master'
+
+# Specify your gem's dependencies in avromatic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,162 @@
+# Avromatic
+
+[![Build Status](https://travis-ci.org/salsify/avromatic.svg?branch=master)][travis]
+
+[travis]: http://travis-ci.org/salsify/avromatic
+
+`Avromatic` generates Ruby models from Avro schemas and provides utilities to
+encode and decode them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avromatic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install avromatic
+
+## Usage
+
+### Configuration
+
+`Avromatic` supports the following configuration:
+
+* registry_url: URL for the schema registry. The schema registry is used to store
+  Avro schemas so that they can be referenced by id.
+* schema_store: The schema store is used to load Avro schemas from the filesystem.
+  It should be an object that responds to `find(name, namespace = nil)` and
+  returns an `Avro::Schema` object.
+* messaging: An `AvroTurf::Messaging` object may be specified and will be shared
+  by all models. If unspecified a new messaging object is created based on the
+  schema store and registry_url.
+* logger: The logger is for the schema registry client.
+
+### Models
+
+Models may be defined based on an Avro schema for a record.
+
+The Avro schema can be specified by name and loaded using the schema store:
+
+```ruby
+class MyModel
+  include Avromatic::Model.build(schema_name :my_model)
+end
+```
+
+Or an `Avro::Schema` object can be specified directly:
+
+```ruby
+class MyModel
+  include Avromatic::Model.build(schema: schema_object)
+end
+
+```
+
+Models are generated as [Virtus](https://github.com/solnic/virtus) value
+objects. `Virtus` attributes are added for each field in the Avro schema
+including any default values defined in the schema. `ActiveModel` validations
+are used to define validations on certain types of fields.
+
+A model may be defined with both a key and a value schema:
+
+```ruby
+class MyTopic
+  include Avromatic::Model.build(value_schema_name: :topic_value,
+                                 key_schema_name: :topic_key)
+end
+```
+
+When key and value schemas are both specified, attributes are added to the model
+for the union of the fields in the two schemas.
+
+A model can also be generated as an anonymous class that can be assigned to a
+constant:
+
+```ruby
+MyModel = Avromatic::Model.model(schema_name :my_model)
+```
+
+#### Encode/Decode
+
+Models can be encoded using Avro leveraging a schema registry to encode a schema
+id at the beginning of the value.
+
+```ruby
+model.avro_message_value
+```
+
+If a model has a Avro schema for a key, then the key can also be encoded
+prefixed with a schema id.
+
+```ruby
+model.avro_message_key
+```
+
+A model instance can be created from an Avro-encoded value and an Avro-encoded
+optional key:
+
+```ruby
+MyTopic.deserialize(message_key, message_value)
+```
+
+Or just a value if only one schema is used:
+
+```ruby
+MyValue.deserialize(message_value)
+```
+
+#### Decoder
+
+A stream of messages encoded from various models can be deserialized using
+`Avromatic::Model::Decoder`. The decoder must be initialized with the list
+of models to decode:
+
+```ruby
+decoder = Avromatic::Model::Decoder.new(MyModel1, MyModel2)
+
+decoder.decode(model1_key, model1_value)
+# => instance of MyModel1
+decoder.decode(model2_value)
+# => instance of MyModel2
+```
+
+#### Validations
+
+The following validations are supported:
+
+- The size of the value for a fixed type field.
+- The value for an enum type field is in the declared set of values.
+- Presence of a value for required fields.
+
+#### Unsupported/Future
+
+The following types/features are not supported for generated models:
+
+- Generic union fields: The special case of an optional field, the union of `:null` and
+  another type, is supported.
+- Reused models for nested records: Currently an anonymous model class is
+  generated for each subrecord.
+
+## 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/avromatic.
+
+
+## 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,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "avro/builder"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :avro do
+  desc 'Generate Avro schema files used by specs'
+  task :generate_spec do
+    root = 'spec/avro/dsl'
+    Avro::Builder.add_load_path(root)
+    Dir["#{root}/**/*.rb"].each do |dsl_file|
+      puts "Generating Avro schema from #{dsl_file}"
+      output_file = dsl_file.sub('/dsl/', '/schema/').sub(/\.rb$/, '.avsc')
+      schema = Avro::Builder.build(File.read(dsl_file))
+      FileUtils.mkdir_p(File.dirname(output_file))
+      File.write(output_file, schema.end_with?("\n") ? schema : schema << "\n")
+    end
+  end
+end
+
+task :default => :spec

data/avromatic.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'avromatic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "avromatic"
+  spec.version       = Avromatic::VERSION
+  spec.authors       = ["Salsify Engineering"]
+  spec.email         = ["engineering@salsify.com"]
+
+  spec.summary       = %q{Generate Ruby models from Avro schemas}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/salsify/avromatic.git"
+  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_runtime_dependency "avro", ">= 1.7.7"
+  spec.add_runtime_dependency "virtus"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "activemodel"
+  spec.add_runtime_dependency "avro_turf"
+  spec.add_runtime_dependency "private_attr"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "avro-builder", ">= 0.3.2"
+  # For FakeSchemaRegistryServer
+  spec.add_development_dependency "sinatra"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "avromatic"
+
+# 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/lib/avromatic/model/attributes.rb

@@ -0,0 +1,141 @@
+require 'active_support/core_ext/object/duplicable'
+require 'ice_nine/core_ext/object'
+
+module Avromatic
+  module Model
+
+    # This module supports defining Virtus attributes for a model based on the
+    # fields of Avro schemas.
+    module Attributes
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def add_avro_fields
+          if key_avro_schema
+            check_for_field_conflicts!
+            define_avro_attributes(key_avro_schema)
+          end
+          define_avro_attributes(avro_schema)
+        end
+
+        private
+
+        def check_for_field_conflicts!
+          (key_avro_field_names & value_avro_field_names).each_with_object([]) do |name, conflicts|
+              if schema_fields_differ?(name)
+                conflicts << "Field '#{name}' has a different type in each schema: "\
+                             "value #{value_avro_fields_by_name[name]}, "\
+                             "key #{key_avro_fields_by_name[name]}"
+              end
+          end.tap do |conflicts|
+            raise conflicts.join("\n") if conflicts.any?
+          end
+        end
+
+        # The Avro::Schema::Field#== method is lame. It just compares
+        # <field>.type.type_sym.
+        def schema_fields_differ?(name)
+          key_avro_fields_by_name[name].to_avro !=
+            value_avro_fields_by_name[name].to_avro
+        end
+
+        def define_avro_attributes(schema)
+          schema.fields.each do |field|
+            field_class = avro_field_class(field.type)
+
+            attribute(field.name,
+                      field_class,
+                      avro_field_options(field))
+
+            add_validation(field)
+          end
+        end
+
+        def add_validation(field)
+          case field.type.type_sym
+          when :enum
+            validates(field.name,
+                      inclusion: { in: Set.new(field.type.symbols.map(&:freeze)).freeze })
+          when :fixed
+            validates(field.name, length: { is: field.type.size })
+          end
+
+          add_required_validation(field)
+        end
+
+        def add_required_validation(field)
+          if required?(field) && field.default.nil?
+            validates(field.name, presence: true)
+          end
+        end
+
+        # An optional field is represented as a union where the first member
+        # is null.
+        def optional?(field)
+          field.type.type_sym == :union &&
+            field.type.schemas.first.type_sym == :null
+        end
+
+        def required?(field)
+          !optional?(field)
+        end
+
+        def avro_field_class(field_type)
+          case field_type.type_sym
+          when :string, :bytes, :fixed
+            String
+          when :boolean
+            Axiom::Types::Boolean
+          when :int, :long
+            Integer
+          when :float, :double
+            Float
+          when :enum
+            String
+          when :null
+            NilClass
+          when :array
+            Array[avro_field_class(field_type.items)]
+          when :map
+            Hash[String => avro_field_class(field_type.values)]
+          when :union
+            union_field_class(field_type)
+          when :record
+            # TODO: This should add the generated model to a module.
+            # A hash of generated models should be kept by name for reuse.
+            Class.new do
+              include Avromatic::Model.build(schema: field_type)
+            end
+          else
+            raise "Unsupported type #{field_type}"
+          end
+        end
+
+        def union_field_class(field_type)
+          # TODO: This is a hack until I find a better solution for unions with
+          # Virtus. This only handles a union for a optional field with :null
+          # and one other type.
+          schemas = field_type.schemas.reject { |schema| schema.type_sym == :null }
+          raise "Only the union of null with one other type is supported #{field_type}" if schemas.size > 1
+          avro_field_class(schemas.first)
+        end
+
+        def avro_field_options(field)
+          if field.default
+            {
+              default: default_for(field.default),
+              lazy: true
+            }
+          else
+            { }
+          end
+        end
+
+        def default_for(value)
+          value.duplicable? ? value.dup.deep_freeze : value
+        end
+      end
+
+    end
+  end
+end

data/lib/avromatic/model/builder.rb

@@ -0,0 +1,65 @@
+require 'virtus'
+require 'active_support/concern'
+require 'active_model'
+require 'avromatic/model/configuration'
+require 'avromatic/model/value_object'
+require 'avromatic/model/configurable'
+require 'avromatic/model/attributes'
+require 'avromatic/model/serialization'
+
+module Avromatic
+  module Model
+
+    # This class implements generating models from Avro schemas.
+    class Builder
+
+      attr_reader :mod, :config
+
+      # For options see Avromatic::Model.build
+      def self.model(**options)
+        Class.new do
+          include Avromatic::Model::Builder.new(**options).mod
+
+          # Name is required for attribute validations on an anonymous class.
+          def self.name
+            super || (@name ||= config.avro_schema.name.classify)
+          end
+        end
+      end
+
+      # For options see Avromatic::Model.build
+      def initialize(**options)
+        @mod = Module.new
+        @config = Avromatic::Model::Configuration.new(**options)
+        define_included_method
+      end
+
+      def inclusions
+        [
+          ActiveModel::Validations,
+          Virtus.value_object,
+          Avromatic::Model::Configurable,
+          Avromatic::Model::Attributes,
+          Avromatic::Model::ValueObject,
+          Avromatic::Model::Serialization
+        ]
+      end
+
+      private
+
+      def define_included_method
+        with_builder do |builder|
+          mod.define_singleton_method(:included) do |model_class|
+            model_class.include(*builder.inclusions)
+            model_class.config = builder.config
+            model_class.add_avro_fields
+          end
+        end
+      end
+
+      def with_builder
+        yield(self)
+      end
+    end
+  end
+end

data/lib/avromatic/model/configurable.rb

@@ -0,0 +1,43 @@
+module Avromatic
+  module Model
+
+    # This concern adds methods for configuration for a model generated from
+    # Avro schema(s).
+    module Configurable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        attr_accessor :config
+        delegate :avro_schema, :value_avro_schema, :key_avro_schema, to: :config
+
+        def value_avro_field_names
+          @value_avro_field_names ||= value_avro_schema.fields.map(&:name).map(&:to_sym).freeze
+        end
+
+        def key_avro_field_names
+          @key_avro_field_names ||= key_avro_schema.fields.map(&:name).map(&:to_sym).freeze
+        end
+
+        def value_avro_fields_by_name
+          @value_avro_fields_by_name ||= mapped_by_name(value_avro_schema)
+        end
+
+        def key_avro_fields_by_name
+          @key_avro_fields_by_name ||= mapped_by_name(key_avro_schema)
+        end
+
+        private
+
+        def mapped_by_name(schema)
+          schema.fields.each_with_object(Hash.new) do |field, result|
+            result[field.name.to_sym] = field
+          end
+        end
+      end
+
+      delegate :avro_schema, :value_avro_schema, :key_avro_schema,
+               :value_avro_field_names, :key_avro_field_names,
+               to: :class
+    end
+  end
+end

data/lib/avromatic/model/configuration.rb

@@ -0,0 +1,47 @@
+module Avromatic
+  module Model
+
+    # This class holds configuration for a model build from Avro schema(s).
+    class Configuration
+
+      attr_reader :avro_schema, :key_avro_schema
+      delegate :schema_store, to: Avromatic
+
+      # Either schema(_name) or value_schema(_name), but not both, must be
+      # specified.
+      #
+      # @param options [Hash]
+      # @option options [Avro::Schema] :schema
+      # @option options [String, Symbol] :schema_name
+      # @option options [Avro::Schema] :value_schema
+      # @option options [String, Symbol] :value_schema_name
+      # @option options [Avro::Schema] :key_schema
+      # @option options [String, Symbol] :key_schema_name
+      # @option options [schema store] :schema_store
+      def initialize(**options)
+        @avro_schema = find_avro_schema(**options)
+        raise ArgumentError.new('value_schema(_name) or schema(_name) must be specified') unless avro_schema
+        @key_avro_schema = find_schema_by_option(:key_schema, **options)
+      end
+
+      alias_method :value_avro_schema, :avro_schema
+
+      private
+
+      def find_avro_schema(**options)
+        if (options[:value_schema] || options[:value_schema_name]) &&
+          (options[:schema] || options[:schema_name])
+          raise ArgumentError.new('Only one of value_schema(_name) and schema(_name) can be specified')
+        end
+        find_schema_by_option(:value_schema, **options) || find_schema_by_option(:schema, **options)
+      end
+
+      def find_schema_by_option(option_name, **options)
+        schema_name_option = :"#{option_name}_name"
+        options[option_name] ||
+          (options[schema_name_option] && schema_store.find(options[schema_name_option]))
+
+      end
+    end
+  end
+end

data/lib/avromatic/model/decoder.rb

@@ -0,0 +1,102 @@
+require 'private_attr'
+require 'avro_turf/schema_registry'
+
+module Avromatic
+  module Model
+
+    # This class is used to decode Avro messages to their corresponding models.
+    class Decoder
+      extend PrivateAttr
+
+      MAGIC_BYTE = [0].pack("C").freeze
+
+      class UnexpectedKeyError < StandardError
+        def initialize(schema_key)
+          super("Unexpected schemas #{schema_key}")
+        end
+      end
+
+       class MagicByteError < StandardError
+         def initialize(magic_byte)
+           super("Expected data to begin with a magic byte, got '#{magic_byte}'")
+         end
+       end
+
+      class DuplicateKeyError < StandardError
+        def initialize(*models)
+          super("Multiple models #{models} have the same key "\
+                "'#{Avromatic::Model::Decoder.model_key(models.first)}'")
+        end
+      end
+
+      private_attr_reader :schema_names_by_id, :model_map, :schema_registry
+
+      def self.model_key(model)
+        [model.key_avro_schema && model.key_avro_schema.fullname,
+         model.value_avro_schema.fullname]
+      end
+
+      delegate :model_key, to: :class
+
+      # @param *models [generated models] Models to register for decoding.
+      # @param schema_registry [Avromatic::SchemaRegistryClient] Optional schema
+      #   registry client.
+      # @param registry_url [String] Optional URL for schema registry server.
+      def initialize(*models, schema_registry: nil, registry_url: nil)
+        @model_map = build_model_map(models)
+        @schema_names_by_id = {}
+        @schema_registry = schema_registry ||
+          (registry_url && AvroTurf::SchemaRegistry.new(registry_url, logger: Avromatic.logger)) ||
+          Avromatic.build_schema_registry
+      end
+
+      # If two arguments are specified then the first is interpreted as the
+      # message key and the second is the message value. If there is only one
+      # arg then it is used as the message value.
+      # @return [Avromatic model]
+      def decode(*args)
+        message_key, message_value = args.size > 1 ? args : [nil, args.first]
+        value_schema_name = schema_name_for_data(message_value)
+        key_schema_name = schema_name_for_data(message_key) if message_key
+        deserialize([key_schema_name, value_schema_name], message_key, message_value)
+      end
+
+      private
+
+      def deserialize(model_key, message_key, message_value)
+        raise UnexpectedKeyError.new(model_key) unless model_map.key?(model_key)
+        model_map[model_key].deserialize(message_key, message_value)
+      end
+
+      def schema_name_for_data(data)
+        validate_magic_byte!(data)
+        schema_id = extract_schema_id(data)
+        lookup_schema_name(schema_id)
+      end
+
+      def lookup_schema_name(schema_id)
+        schema_names_by_id.fetch(schema_id) do
+          schema = Avro::Schema.parse(schema_registry.fetch(schema_id))
+          schema_names_by_id[schema_id] = schema.fullname
+        end
+      end
+
+      def extract_schema_id(data)
+        data[1..4].unpack('N').first
+      end
+
+      def validate_magic_byte!(data)
+        first_byte = data[0]
+        raise MagicByteError.new(first_byte) if first_byte != MAGIC_BYTE
+      end
+
+      def build_model_map(models)
+        models.each_with_object(Hash.new) do |model, map|
+          key = model_key(model)
+          raise DuplicateKeyError.new(map[key], model) if map.key?(key) && !model.equal?(map[key])
+          map[key] = model
+        end
+      end
+    end
+  end
+end

data/lib/avromatic/model/serialization.rb

@@ -0,0 +1,81 @@
+require 'avro_turf/messaging'
+
+module Avromatic
+  module Model
+
+    # This concern adds support for serialization to a model
+    # generated from Avro schema(s).
+    module Serialization
+      extend ActiveSupport::Concern
+
+      delegate :messaging, to: :class
+
+      included do |model_class|
+        model_class.messaging = Avromatic.messaging ||
+          Avromatic.build_messaging
+      end
+
+      module Encode
+        def avro_message_value
+          messaging.encode(
+            value_attributes_for_avro,
+            schema_name: value_avro_schema.fullname)
+        end
+
+        def avro_message_key
+          raise 'Model has no key schema' unless key_avro_schema
+          messaging.encode(
+            key_attributes_for_avro,
+            schema_name: key_avro_schema.fullname)
+        end
+
+        protected
+
+        def value_attributes_for_avro
+          avro_hash(value_avro_field_names)
+        end
+
+        private
+
+        def key_attributes_for_avro
+          avro_hash(key_avro_field_names)
+        end
+
+        def avro_hash(fields)
+          attributes.slice(*fields).each_with_object(Hash.new) do |(key, value), result|
+            result[key.to_s] = if value.is_a?(Avromatic::Model::Attributes)
+                                 value.value_attributes_for_avro
+                               else
+                                 value
+                               end
+          end
+        end
+      end
+      include Encode
+
+      # This module provides methods to deserialize an Avro-encoded value and
+      # an optional Avro-encoded key as a new model instance.
+      module Decode
+
+        # If two arguments are specified then the first is interpreted as the
+        # message key and the second is the message value. If there is only one
+        # arg then it is used as the message value.
+        def deserialize(*args)
+          message_key, message_value = args.size > 1 ? args : [nil, args.first]
+          key_attributes = message_key && messaging.decode(message_key, schema_name: key_avro_schema.fullname)
+          value_attributes = messaging.decode(message_value, schema_name: avro_schema.fullname)
+
+          new(value_attributes.merge!(key_attributes || {}))
+        end
+      end
+
+      module ClassMethods
+        # The messaging object acts as an intermediary talking to the schema
+        # registry and using returned/specified schemas to decode/encode.
+        attr_accessor :messaging
+
+        include Decode
+      end
+    end
+  end
+end

data/lib/avromatic/model/value_object.rb

@@ -0,0 +1,25 @@
+module Avromatic
+  module Model
+
+    # This module is used to override the comparisons defined by
+    # Virtus::Equalizer which is pulled in by Virtus::ValueObject.
+    module ValueObject
+      def eql?(other)
+        other.instance_of?(self.class) && attributes == other.attributes
+      end
+      alias_method :==, :eql?
+
+      def hash
+        attributes.hash
+      end
+
+      def inspect
+        "#<#{self.class.name} #{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(', ') }>"
+      end
+
+      def to_s
+        "#<%s:0x00%x>" % [self.class.name, object_id.abs * 2]
+      end
+    end
+  end
+end

data/lib/avromatic/model.rb

@@ -0,0 +1,49 @@
+require 'avromatic/model/builder'
+require 'avromatic/model/decoder'
+
+module Avromatic
+  module Model
+
+    # Returns a module that can be included in a class to define a model
+    # based on Avro schema(s).
+    #
+    # Example:
+    #   class MyTopic
+    #     include Avromatic::Model.build(schema_name: :topic_value,
+    #                                      key_schema_name: :topic_key)
+    #   end
+    #
+    # Either schema(_name) or value_schema(_name) must be specified.
+    #
+    # value_schema(_name) is handled identically to schema(_name) and is
+    # treated like an alias for use when both a value and a key schema are
+    # specified.
+    #
+    # Options:
+    #   value_schema_name:
+    #     The full name of an Avro schema. The schema will be loaded
+    #     using the schema store.
+    #   value_schema:
+    #     An Avro::Schema.
+    #   schema_name:
+    #     The full name of an Avro schema. The schema will be loaded
+    #     using the schema store.
+    #   schema:
+    #     An Avro::Schema.
+    #   key_schema_name:
+    #     The full name of an Avro schema for the key. When an instance of
+    #     the model is encoded, this schema will be used to encode the key.
+    #     The schema will be loaded using the schema store.
+    #   key_schema:
+    #     An Avro::Schema for the key.
+    def self.build(**options)
+      Builder.new(**options).mod
+    end
+
+    # Returns an anonymous class, that can be assigned to a constant,
+    # defined based on Avro schema(s). See Avromatic::Model.build.
+    def self.model(**options)
+      Builder.model(**options)
+    end
+  end
+end

data/lib/avromatic/railtie.rb

@@ -0,0 +1,9 @@
+module Avromatic
+  class Railtie < Rails::Railtie
+    initializer 'avromatic.configure' do
+      SalsifyAvro.configure do |config|
+        config.logger = Rails.logger
+      end
+    end
+  end
+end

data/lib/avromatic/version.rb

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

data/lib/avromatic.rb

@@ -0,0 +1,33 @@
+require 'avromatic/version'
+require 'avromatic/model'
+require 'avro_turf'
+require 'avro_turf/messaging'
+
+module Avromatic
+  class << self
+    attr_accessor :registry_url, :schema_store, :logger, :messaging
+  end
+
+  self.logger = Logger.new($stdout)
+
+  def self.configure
+    yield self
+  end
+
+  def self.build_schema_registry
+    raise 'Avromatic must be configured with a registry_url' unless registry_url
+    AvroTurf::CachedSchemaRegistry.new(
+      AvroTurf::SchemaRegistry.new(registry_url, logger: logger))
+  end
+
+  def self.build_messaging
+    raise 'Avromatic must be configured with a registry_url' unless registry_url
+    raise 'Avromatic must be configured with a schema_store' unless schema_store
+    AvroTurf::Messaging.new(
+      registry_url: Avromatic.registry_url,
+      schema_store: Avromatic.schema_store,
+      logger: Avromatic.logger)
+  end
+end
+
+require 'avromatic/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: avromatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: avro_turf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: private_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: webmock
+  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-builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+description: Generate Ruby models from Avro schemas
+email:
+- engineering@salsify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- avromatic.gemspec
+- bin/console
+- bin/setup
+- lib/avromatic.rb
+- lib/avromatic/model.rb
+- lib/avromatic/model/attributes.rb
+- lib/avromatic/model/builder.rb
+- lib/avromatic/model/configurable.rb
+- lib/avromatic/model/configuration.rb
+- lib/avromatic/model/decoder.rb
+- lib/avromatic/model/serialization.rb
+- lib/avromatic/model/value_object.rb
+- lib/avromatic/railtie.rb
+- lib/avromatic/version.rb
+- log/.gitkeep
+homepage: https://github.com/salsify/avromatic.git
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Generate Ruby models from Avro schemas
+test_files: []