sinatra-avro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74b847c334a0acd04d84f5fbfc19277f53181316
+  data.tar.gz: a79f2ef7e84dd9a5b8a13f1b4c66c2f367ce938f
+SHA512:
+  metadata.gz: 7301c468c09573e7facef164a6afa85b2d57f3b8e9b5f8597025ea97964b990d2e5ae32900b232e1b3122def74ce2f98d9161418a08df92b84fb9f65890c4fb9
+  data.tar.gz: 5b22aa2c57860ad511c8af6da1d113666729ab9b9755a34352edcd1ee6e9eff7e852c815ff8bff939af243b041c1e65dd1fb6cdeaf578bd1141ec62ba55fcb0a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Daniel Schierbeck
+
+MIT License
+
+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,66 @@
+# Sinatra::Avro
+
+A Sinatra plugin that allows encoding requests and responses using Apache Avro.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-avro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-avro
+
+## Usage
+
+In your Sinatra app:
+
+```ruby
+require 'sinatra/avro'
+
+get '/' do
+  schema = <<-SCHEMA
+    {
+      "name": "person",
+      "type": "record",
+      "fields": [
+        { "name": "name", "type": "string" },
+        { "name": "age", "type": "long" }
+      ]
+    }
+  SCHEMA
+
+  avro({ "name" => "Jane", "age" => 42 }, schema: schema)
+end
+```
+
+Alternatively, store your schemas in `schemas/<schema-name>.avsc` and refer to them by name:
+
+```ruby
+get '/' do
+  # Will use the schema defined by `./schemas/person.avsc`.
+  avro({ "name" => "Jane", "age" => 42 }, schema_name: "person")
+end
+```
+
+You can configure which directory to look up schema files from using
+
+```ruby
+set :avro_schema_dir, "some/other/dir"
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sinatra-avro/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sinatra/avro/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Avro
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/avro.rb

@@ -0,0 +1,43 @@
+require 'sinatra/avro/version'
+require 'sinatra/base'
+require 'avro'
+
+module Sinatra
+  module Avro
+    MIME_TYPE = "avro/binary".freeze
+
+    def avro(object, options = {})
+      schema_json = fetch_avro_schema(options)
+
+      # Set the Content-Type response header.
+      content_type MIME_TYPE
+
+      avro_encode(object, schema_json)
+    end
+
+    def avro_encode(object, schema_json)
+      schema = ::Avro::Schema.parse(schema_json)
+      writer = ::Avro::IO::DatumWriter.new(schema)
+      io = StringIO.new
+
+      dw = ::Avro::DataFile::Writer.new(io, writer, schema)
+      dw << object.to_h
+      dw.close
+
+      io.string
+    end
+
+    def fetch_avro_schema(options = {})
+      options[:schema] || load_avro_schema(options.fetch(:schema_name))
+    end
+
+    def load_avro_schema(schema_name)
+      schema_path = File.join(settings.avro_schema_dir, schema_name + ".avsc")
+
+      File.read(schema_path)
+    end
+  end
+
+  Base.set :avro_schema_dir, "schemas"
+  Base.helpers Avro
+end

data/sinatra-avro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/avro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-avro"
+  spec.version       = Sinatra::Avro::VERSION
+  spec.authors       = ["Daniel Schierbeck"]
+  spec.email         = ["dasch@zendesk.com"]
+  spec.summary       = %q{A Sinatra plugin that allows encoding requests and responses using Apache Avro}
+  spec.homepage      = "https://github.com/dasch/sinatra-avro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "avro"
+  spec.add_dependency "sinatra"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "sinatra-contrib", "~> 1.4.2"
+end

data/spec/avro_spec.rb

@@ -0,0 +1,57 @@
+require 'sinatra/test_helpers'
+require 'json'
+
+describe Sinatra::Avro do
+  include Sinatra::TestHelpers
+
+  SCHEMA = {
+    type: "record",
+    name: "person",
+    fields: [
+      { name: "name", type: "string" },
+      { name: "age", type: "long" },
+    ]
+  }.to_json
+
+
+  it "allows serializing responses with Avro" do
+    mock_app do
+      get '/' do
+        data = { "name" => "Jane", "age" => 42 }
+        avro data, schema: SCHEMA
+      end
+    end
+
+    expect(decoded_data).to eq("name" => "Jane", "age" => 42)
+  end
+
+  it "allows loading the schema from disk automatically" do
+    mock_app do
+      set :avro_schema_dir, "spec/"
+      get '/' do
+        data = { "name" => "Jane", "age" => 42 }
+        avro data, schema_name: "person"
+      end
+    end
+
+    expect(decoded_data).to eq("name" => "Jane", "age" => 42)
+  end
+
+  it "sets the Content-Type header to avro/binary" do
+    mock_app do
+      get '/' do
+        data = { "name" => "Jane", "age" => 42 }
+        avro data, schema: SCHEMA
+      end
+    end
+
+    response = get('/')
+    expect(response["Content-Type"]).to eq "avro/binary"
+  end
+
+  def decoded_data
+    avro = get('/').body
+    reader = Avro::DataFile::Reader.new(StringIO.new(avro), Avro::IO::DatumReader.new)
+    data = reader.first
+  end
+end

data/spec/person.avsc

@@ -0,0 +1,8 @@
+{
+    "type": "record",
+    "name": "person",
+    "fields": [
+      { "name": "name", "type": "string" },
+      { "name": "age", "type": "long" }
+    ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'sinatra/avro'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-avro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro
+  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: sinatra
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: 
+email:
+- dasch@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/avro.rb
+- lib/sinatra/avro/version.rb
+- sinatra-avro.gemspec
+- spec/avro_spec.rb
+- spec/person.avsc
+- spec/spec_helper.rb
+homepage: https://github.com/dasch/sinatra-avro
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Sinatra plugin that allows encoding requests and responses using Apache
+  Avro
+test_files:
+- spec/avro_spec.rb
+- spec/person.avsc
+- spec/spec_helper.rb
+has_rdoc: