faraday_middleware-msgpack 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/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+ - 1.8.7
+ - 1.9.2
+ - 1.9.3
+
+script: bundle exec rake spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yuichi Tateno
+
+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,31 @@
+# FaradayMiddleware::Msgpack
+
+[![Build Status](https://secure.travis-ci.org/hotchpotch/faraday_middleware-msgpack.png?branch=master)](http://travis-ci.org/hotchpotch/faraday_middleware-msgpack)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faraday_middleware-msgpack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_middleware-msgpack
+
+## Examples
+
+```
+require 'faraday_middleware/msgpack'
+
+connection = Faraday.new do |conn|
+  conn.request :msgpack
+  conn.response :msgpack,  :content_type => %r{\bapplication/x-msgpack$}
+  conn.adapter Faraday.default_adapter
+end
+```
+

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/faraday_middleware-msgpack.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'faraday_middleware', '>= 0.8.0'
+  gem.add_dependency 'msgpack', '>= 0.4.7'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+
+  gem.name          = "faraday_middleware-msgpack"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Yuichi Tateno"]
+  gem.email         = ["hotchpotch@gmail.com"]
+  gem.description   = %q{faraday middleware msgpack}
+  gem.summary       = %q{faraday middleware msgpack}
+  gem.homepage      = "https://github.com/hotchpotch/faraday_middleware-msgpack"
+
+  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"]
+end

data/lib/faraday_middleware-msgpack.rb

@@ -0,0 +1 @@
+require "faraday_middleware/msgpack"

data/lib/faraday_middleware/msgpack.rb

@@ -0,0 +1,66 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  module Msgpack
+    # Public: parses response bodies with MessagePack.
+    class ParseMsgpack < ResponseMiddleware
+      dependency 'msgpack'
+
+      define_parser do |body|
+        if body.empty?
+          nil
+        else
+          ::MessagePack.unpack(body)
+        end
+      end
+    end
+
+    # base from FaradayMiddeware::EncodeJson
+    class EncodeMsgpack < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'.freeze
+      MIME_TYPE    = 'application/x-msgpack'.freeze
+
+      dependency do
+        require 'msgpack'
+      end
+
+      def call(env)
+        match_content_type(env) do |data|
+          env[:body] = encode data
+        end
+        @app.call env
+      end
+
+      def encode(data)
+        data.to_msgpack
+      end
+
+      def match_content_type(env)
+        if process_request?(env)
+          env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+          yield env[:body] unless env[:body].respond_to?(:to_str)
+        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
+  end
+end
+
+Faraday.register_middleware :response, :msgpack => FaradayMiddleware::Msgpack::ParseMsgpack
+Faraday.register_middleware :request, :msgpack => FaradayMiddleware::Msgpack::EncodeMsgpack
+
+

data/spec/encode_msgpack_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'faraday_middleware/msgpack'
+
+describe FaradayMiddleware::Msgpack::EncodeMsgpack do
+  let(:middleware) { described_class.new(lambda{|env| env}) }
+  let(:msgpack_body) { {:a => 1}.to_msgpack }
+
+  def process(body, content_type = nil)
+    env = {:body => body, :request_headers => Faraday::Utils::Headers.new}
+    env[:request_headers]['content-type'] = content_type if content_type
+    middleware.call(env)
+  end
+
+  def result_body() result[:body] end
+  def result_type() result[:request_headers]['content-type'] end
+
+  context "no body" do
+    let(:result) { process(nil) }
+
+    it "doesn't change body" do
+      expect(result_body).to be_nil
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context "empty body" do
+    let(:result) { process('') }
+
+    it "doesn't change body" do
+      expect(result_body).to be_empty
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context "string body" do
+    let(:result) { process(msgpack_body) }
+
+    it "doesn't change body" do
+      expect(result_body).to eq(msgpack_body)
+    end
+
+    it "adds content type" do
+      expect(result_type).to eq('application/x-msgpack')
+    end
+  end
+
+  context "object body" do
+    let(:result) { process({:a => 1}) }
+
+    it "encodes body" do
+      expect(result_body).to eq(msgpack_body)
+    end
+
+    it "adds content type" do
+      expect(result_type).to eq('application/x-msgpack')
+    end
+  end
+
+  context "empty object body" do
+    let(:result) { process({}) }
+
+    it "encodes body" do
+      expect(result_body).to eq({}.to_msgpack)
+    end
+  end
+
+  context "object body with msgpack type" do
+    let(:result) { process({:a => 1}, 'application/x-msgpack; charset=utf-8') }
+
+    it "encodes body" do
+      expect(result_body).to eq(msgpack_body)
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/x-msgpack; charset=utf-8')
+    end
+  end
+
+  context "object body with incompatible type" do
+    let(:result) { process({:a => 1}, 'application/xml; charset=utf-8') }
+
+    it "doesn't change body" do
+      expect(result_body).to eq({:a => 1})
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/xml; charset=utf-8')
+    end
+  end
+end

data/spec/parse_msgpack_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'faraday_middleware/msgpack'
+
+describe FaradayMiddleware::Msgpack::ParseMsgpack, :type => :response do
+  let(:msgpack_body) { {:a => 1}.to_msgpack }
+
+  context "no type matching" do
+    it "doesn't change nil body" do
+      expect(process(nil).body).to be_nil
+    end
+
+    it "returns false for empty body" do
+      expect(process('').body).to be_false
+    end
+
+    it "parses msgpack body" do
+      response = process(msgpack_body)
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to be_nil
+    end
+  end
+
+  context "with preserving raw" do
+    let(:options) { {:preserve_raw => true} }
+
+    it "parses msgpack body" do
+      response = process(msgpack_body)
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to eq(msgpack_body)
+    end
+
+    it "can opt out of preserving raw" do
+      response = process(msgpack_body, nil, :preserve_raw => false)
+      expect(response.env[:raw_body]).to be_nil
+    end
+  end
+
+  context "with regexp type matching" do
+    let(:options) { {:content_type => /\bmsgpack$/} }
+
+    it "parses msgpack body of correct type" do
+      response = process(msgpack_body, 'application/x-msgpack')
+      expect(response.body).to eq('a' => 1)
+    end
+
+    it "ignores msgpack body of incorrect type" do
+      response = process(msgpack_body, 'text/yaml-xml')
+      expect(response.body).to eq(msgpack_body)
+    end
+  end
+
+  it "chokes on invalid msgpack" do
+    expect{ process('hello') }.to raise_error(Faraday::Error::ParsingError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+
+require 'rspec'
+
+# Code from faraday_middleware/spec/spec_helper.rb
+module ResponseMiddlewareExampleGroup
+  def self.included(base)
+    base.let(:options) { Hash.new }
+    base.let(:headers) { Hash.new }
+    base.let(:middleware) {
+      described_class.new(lambda {|env|
+        Faraday::Response.new(env)
+      }, options)
+    }
+  end
+
+  def process(body, content_type = nil, options = {})
+    env = {
+      :body => body, :request => options,
+      :response_headers => Faraday::Utils::Headers.new(headers)
+    }
+    env[:response_headers]['content-type'] = content_type if content_type
+    middleware.call(env)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ResponseMiddlewareExampleGroup, :type => :response
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: faraday_middleware-msgpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuichi Tateno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: faraday middleware msgpack
+email:
+- hotchpotch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday_middleware-msgpack.gemspec
+- lib/faraday_middleware-msgpack.rb
+- lib/faraday_middleware/msgpack.rb
+- spec/encode_msgpack_spec.rb
+- spec/parse_msgpack_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hotchpotch/faraday_middleware-msgpack
+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: faraday middleware msgpack
+test_files:
+- spec/encode_msgpack_spec.rb
+- spec/parse_msgpack_spec.rb
+- spec/spec_helper.rb