faraday_middleware-avro 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8bad56934fe452ad4852f8cd056f9264664dd3f
+  data.tar.gz: 08402b3490fda0864aaf8b2bcee0cebc4d74fafd
+SHA512:
+  metadata.gz: efde4336f74534bd98f50a8aa270634c9843d4495dc4bcd5f34b52c891cc4ee0c83365a0671529c1ae9d9d097374a49032d9eb520488b05a7938aeed05e0a10f
+  data.tar.gz: 5e4a535d8c14392f7ec6b3c273d11e040db16378b43c777b4c8e2e262a156306bc9d9ee113cc8fc7a3195e9697b98cd1e3922baa6b51716cb1e3476ff6516ab7

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_middleware-avro.gemspec
+ruby "2.1.2"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    faraday_middleware-avro (0.0.2)
+      avro_turf (>= 0.4.1)
+      faraday_middleware (>= 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    avro (1.7.7)
+      multi_json
+    avro_turf (0.4.1)
+      avro (~> 1.7.7)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  byebug
+  faraday_middleware-avro!
+  pry
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Guilherme Cavalcanti
+
+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,46 @@
+# FaradayMiddleware::Avro
+
+Faraday request middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_middleware-avro'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+connection = Faraday.new do |conn|
+  conn.request :avro, schemas_path: File.expand_path(File.dirname(__FILE__))
+  conn.adapter Faraday.default_adapter
+end
+
+
+offer = { name: "Minha oferta",
+    unit: "Kg",
+    seller_code: "123",
+    seller_categories: "Categoria 1",
+    catalogs: ["outono"]
+}
+
+connection.post("http://0.0.0.0:3000/endpoint", offer, 'Avro-Schema' => 'offer')
+```
+
+## Todo
+
+- Make it possible to pass the schema
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/faraday_middleware-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/faraday_middleware-avro.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_middleware/avro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_middleware-avro"
+  spec.version       = FaradayMiddleware::Avro::VERSION
+  spec.authors       = ["Guilherme Cavalcanti"]
+  spec.email         = ["guiocavalcanti@gmail.com"]
+  spec.summary       = "Faraday middleware to encode and decode HTTP requests using avro"
+  spec.description   = "Faraday middleware to encode and decode HTTP requests using avro"
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "faraday_middleware", '>= 0.8.0'
+  spec.add_dependency "avro_turf", ">= 0.4.1"
+end

data/lib/faraday_middleware/avro.rb

@@ -0,0 +1,11 @@
+require 'avro_turf'
+require 'faraday_middleware/response_middleware'
+require 'faraday_middleware/avro/version'
+require 'faraday_middleware/avro/request/encode_avro'
+require 'faraday_middleware/avro/response/parse_avro'
+require 'faraday_middleware/avro/register'
+
+module FaradayMiddleware
+  module Avro
+  end
+end

data/lib/faraday_middleware/avro/register.rb

@@ -0,0 +1,2 @@
+Faraday::Request.register_middleware avro: FaradayMiddleware::Avro::EncodeAvro
+Faraday::Response.register_middleware avro: FaradayMiddleware::Avro::ParseAvro

data/lib/faraday_middleware/avro/request/encode_avro.rb

@@ -0,0 +1,48 @@
+class FaradayMiddleware::Avro::EncodeAvro < Faraday::Middleware
+  CONTENT_TYPE = 'Content-Type'.freeze
+  MIME_TYPE    = 'avro/binary'.freeze
+
+  def initialize(app, options={})
+    super(app)
+    @schemas_path = \
+      options[:schemas_path] || File.expand_path(File.dirname(__FILE__))
+  end
+
+  def call(env)
+    match_content_type(env) do |data|
+      schema = env[:request_headers]['Avro-Schema']
+      env[:body] = encode(data, schema)
+    end
+
+    @app.call env
+  end
+
+  def encode(data, schema)
+    avro = AvroTurf.new(schemas_path: @schemas_path)
+    data = JSON.parse data if data.respond_to?(:to_str)
+
+    avro.encode(data, schema_name: schema)
+  end
+
+  def match_content_type(env)
+    if process_request?(env)
+      env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+      yield env[:body]
+    end
+  end
+
+  def process_request?(env)
+    type = request_type(env)
+    has_body?(env) and (type.empty? or type == MIME_TYPE)
+  end
+
+  def has_body?(env)
+    body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+  end
+
+  def request_type(env)
+    type = env[:request_headers][CONTENT_TYPE].to_s
+    type = type.split(';', 2).first if type.index(';')
+    type
+  end
+end

data/lib/faraday_middleware/avro/response/parse_avro.rb

@@ -0,0 +1,17 @@
+class FaradayMiddleware::Avro::ParseAvro < FaradayMiddleware::ResponseMiddleware
+  def process_response(env)
+    env[:raw_body] = env[:body] if preserve_raw?(env)
+    env[:body] = parse(env[:body], env[:response_headers]['Avro-Schema'])
+  end
+
+  def parse(body, schema_name)
+    avro = AvroTurf.new(schemas_path: schemas_path)
+    avro.decode(body, schema_name: schema_name) unless body.empty?
+  end
+
+  private
+
+  def schemas_path
+    @options[:schemas_path] || File.expand_path(File.dirname(__FILE__))
+  end
+end

data/lib/faraday_middleware/avro/version.rb

@@ -0,0 +1,5 @@
+module FaradayMiddleware
+  module Avro
+    VERSION = "0.0.2"
+  end
+end

data/spec/faraday_middleware/avro/request/encode_avro_spec.rb

@@ -0,0 +1,68 @@
+RSpec.describe FaradayMiddleware::Avro::EncodeAvro do
+  subject { described_class.new application }
+
+  let(:application) { double 'Application' }
+  let(:environment) do
+    {
+      request_headers: request_headers,
+      body: body,
+    }
+  end
+  let(:request_headers) do
+    {
+      'Content-Type' => content_type,
+      'Avro-Schema' => avro_schema,
+    }
+  end
+  let(:content_type) { 'avro/binary' }
+  let(:avro_schema) { 'person' }
+  let(:body) { { name: 'Buck' } }
+  let(:response) { double 'Response', on_complete: nil }
+  let(:parsed_body) { double 'Binary', class: :binary }
+
+  describe '#call' do
+    before do
+      allow_any_instance_of(AvroTurf).to receive(:encode)
+                                     .and_return(parsed_body)
+      expect(application).to receive(:call)
+                         .with(environment)
+                         .and_return(response)
+    end
+
+    it 'changes the body type' do
+      subject.call(environment)
+
+      expect(environment[:body].class).to be :binary
+    end
+
+    context 'when request content is not Avro' do
+      let(:content_type) { 'text/json' }
+
+      it 'doest not change the body type' do
+        subject.call(environment)
+
+        expect(environment[:body].class).to be body.class
+      end
+    end
+
+    context 'when request has no body' do
+      let(:body) { nil }
+
+      it 'doest not change the body type' do
+        subject.call(environment)
+
+        expect(environment[:body].class).to be body.class
+      end
+    end
+
+    context 'when request body responds to #to_str' do
+      let(:body) { { name: 'Buck '}.to_json }
+
+      it 'changes the body type' do
+        subject.call(environment)
+
+        expect(environment[:body].class).to be parsed_body.class
+      end
+    end
+  end
+end

data/spec/faraday_middleware/avro/response/parse_avro_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe FaradayMiddleware::Avro::ParseAvro do
+  subject { described_class.new application }
+
+  let(:application) { double 'Application' }
+  let(:env) { { body: body, response_headers: response_headers } }
+  let(:body) { double 'Binary', respond_to?: false, empty?: empty_body }
+  let(:response_headers) do
+    { 'Content-Type' => content_type, 'Avro-Schema' => schema_name }
+  end
+  let(:content_type) { 'avro/binary' }
+  let(:schema_name) { 'person' }
+  let(:empty_body) { false }
+
+  before do
+    allow(subject).to receive(:preserve_raw?).and_return false
+  end
+
+  describe '#process_response' do
+    let(:parsed_body) { { person: { name: 'Buck' } } }
+
+    before do
+      expect(subject).to receive(:parse).with(body, schema_name)
+                                        .and_return(parsed_body)
+    end
+
+    it 'rewrites body with parsed params' do
+      subject.process_response(env)
+
+      expect(env[:body]).to eq parsed_body
+    end
+  end
+
+  describe '#parse' do
+    it 'decodes response body with AvroTurf' do
+      expect_any_instance_of(AvroTurf).to receive(:decode)
+                                      .with(body, schema_name: schema_name)
+
+      subject.parse(body, schema_name)
+    end
+
+    context 'when body is empty' do
+      let(:empty_body) { true }
+
+      it 'does not decode response body' do
+        expect_any_instance_of(AvroTurf).to_not receive(:decode)
+
+        subject.parse(body, schema_name)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'faraday_middleware/avro'
+require 'pry'

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: faraday_middleware-avro
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Guilherme Cavalcanti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !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: byebug
+  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: rspec
+  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: pry
+  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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: avro_turf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: Faraday middleware to encode and decode HTTP requests using avro
+email:
+- guiocavalcanti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday_middleware-avro.gemspec
+- lib/faraday_middleware/avro.rb
+- lib/faraday_middleware/avro/register.rb
+- lib/faraday_middleware/avro/request/encode_avro.rb
+- lib/faraday_middleware/avro/response/parse_avro.rb
+- lib/faraday_middleware/avro/version.rb
+- spec/faraday_middleware/avro/request/encode_avro_spec.rb
+- spec/faraday_middleware/avro/response/parse_avro_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Faraday middleware to encode and decode HTTP requests using avro
+test_files:
+- spec/faraday_middleware/avro/request/encode_avro_spec.rb
+- spec/faraday_middleware/avro/response/parse_avro_spec.rb
+- spec/spec_helper.rb