rack-post_body_msgpack_parser 0.1.0

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/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-post_body_msgpack_parser.gemspec
+gemspec
+
+gem 'pry-debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Uchio KONDO
+
+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,29 @@
+# Rack::PostBodyMsgpackParser
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-post_body_msgpack_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-post_body_msgpack_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/rack-post_body_msgpack_parser.rb

@@ -0,0 +1 @@
+require "rack/post_body_msgpack_parser"

data/lib/rack/post_body_msgpack_parser.rb

@@ -0,0 +1,40 @@
+# Copied from a great job
+# https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/post_body_content_type_parser.rb
+
+require "rack"
+require "msgpack"
+
+module Rack
+  class PostBodyMsgpackParser
+    CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+    POST_BODY = 'rack.input'.freeze
+    FORM_INPUT = 'rack.request.form_input'.freeze
+    FORM_HASH = 'rack.request.form_hash'.freeze
+    FORM_HASH_MSGPACK = 'rack.request.form_hash_msgpack'.freeze
+
+    APPLICATION_MSGPACK_MIMES = ["application/x-msgpack", "application/x-mpac"]
+
+    def initialize(app, options={})
+      @app = app
+      @options = options
+    end
+
+    def override_params?
+      !! @options[:override_params]
+    end
+
+    def call(env)
+      if APPLICATION_MSGPACK_MIMES.include?(Rack::Request.new(env).media_type) && (body = env[POST_BODY].read).length != 0
+        env[POST_BODY].rewind # somebody might try to read this stream
+        body = MessagePack.unpack body
+        if override_params?
+          env.update(FORM_HASH => body, FORM_INPUT => env[POST_BODY])
+        end
+        env.update(FORM_HASH_MSGPACK => body)
+      end
+      @app.call(env)
+    end
+  end
+end
+
+require "rack/post_body_msgpack_parser/version"

data/lib/rack/post_body_msgpack_parser/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class PostBodyMsgpackParser
+    VERSION = "0.1.0"
+  end
+end

data/rack-post_body_msgpack_parser.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/post_body_msgpack_parser/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-post_body_msgpack_parser"
+  gem.version       = Rack::PostBodyMsgpackParser::VERSION
+  gem.authors       = ["Uchio KONDO"]
+  gem.email         = ["udzura@udzura.jp"]
+  gem.description   = %q{Parse post data by MessagePack}
+  gem.summary       = %q{Parse post data by MessagePack}
+  gem.homepage      = "https://github.com/udzura/rack-post_body_msgpack_parser"
+
+  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"]
+
+  gem.add_runtime_dependency 'rack', '>= 0'
+  gem.add_runtime_dependency 'msgpack', '>= 0'
+  gem.add_development_dependency 'rake', '>= 0'
+  gem.add_development_dependency 'rspec', '>= 0'
+  gem.add_development_dependency 'pry', '>= 0'
+  gem.add_development_dependency 'rack-test', '>= 0'
+  gem.add_development_dependency 'sinatra', '>= 1.3.0'
+  gem.add_development_dependency 'sinatra-contrib', '>= 0'
+end

data/spec/rack/post_body_msgpack_parser_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require 'json'
+require "rack/post_body_msgpack_parser"
+
+describe Rack::PostBodyMsgpackParser do
+  let(:msgpack_data) { MessagePack.pack({"the_key" => "THE VALUE", "sample" => [1, 2, 3]}) }
+  let(:json_data)    { JSON.dump({"the_key" => "THE VALUE", "sample" => [1, 2, 3]}) }
+
+  context 'not override_params' do
+    before do
+      mock_app do
+        use Rack::PostBodyMsgpackParser
+
+        helpers do
+          def msgpack_params
+            @_params ||= request.env['rack.request.form_hash_msgpack']
+          end
+        end
+
+        post '/test-it' do
+          if msgpack_params
+            "OK: keys: #{msgpack_params.keys}, values: #{msgpack_params.values}"
+          else
+            "No Data"
+          end
+        end
+      end
+    end
+
+    it "should ignore post when posted normally" do
+      post "/test-it", {foo: "bar"} do |response|
+        response.body.should == "No Data"
+      end
+      last_request.params.should have(1).pair
+    end
+
+    it "should accept post by msgpack data" do
+      header 'Content-Type', 'application/x-msgpack'
+      post "/test-it", {}, {:input => msgpack_data} do |response|
+        response.body.should include "OK"
+        response.body.should include %q(keys: ["the_key", "sample"])
+        response.body.should include %q(values: ["THE VALUE", [1, 2, 3]])
+      end
+      last_request.params.should be_empty
+    end
+
+    it "should ignore post by json data" do
+      header 'Content-Type', 'application/json'
+      post "/test-it", {}, {:input => json_data} do |response|
+        response.body.should == "No Data"
+      end
+      last_request.params.should be_empty
+    end
+  end
+
+  context 'not override_params' do
+    before do
+      mock_app do
+        use Rack::PostBodyMsgpackParser, override_params: true
+
+        post '/test-it' do
+          builder = ''
+          params.each_pair do |key, value|
+            builder << "#{key.to_s}=#{value.inspect} "
+          end
+          "OK: #{builder}"
+        end
+      end
+    end
+
+    it "should ignore post when posted normally" do
+      post "/test-it", {foo: "bar"} do |response|
+        response.body.should include %q(foo="bar")
+      end
+      last_request.params.should have(1).pair
+    end
+
+    it "should accept post by msgpack data" do
+      header 'Content-Type', 'application/x-msgpack'
+      post "/test-it", {}, {:input => msgpack_data} do |response|
+        response.body.should include %q(the_key="THE VALUE")
+        response.body.should include %q(sample=[1, 2, 3])
+      end
+      last_request.params.should have(2).pair
+    end
+
+    it "should ignore post by json data" do
+      header 'Content-Type', 'application/json'
+      post "/test-it", {}, {:input => json_data} do |response|
+        response.body.length.should == 4
+        response.body.should_not include %q(the_key="THE VALUE")
+        response.body.should_not include %q(sample=[1, 2, 3])
+      end
+      last_request.params.should be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rack/test'
+require 'sinatra/test_helpers'
+require 'pry' if ENV['PRY_DEBUG']
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include Sinatra::TestHelpers
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: rack-post_body_msgpack_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Uchio KONDO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse post data by MessagePack
+email:
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-post_body_msgpack_parser.rb
+- lib/rack/post_body_msgpack_parser.rb
+- lib/rack/post_body_msgpack_parser/version.rb
+- rack-post_body_msgpack_parser.gemspec
+- spec/rack/post_body_msgpack_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/udzura/rack-post_body_msgpack_parser
+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'
+      segments:
+      - 0
+      hash: 3806413066505115498
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3806413066505115498
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Parse post data by MessagePack
+test_files:
+- spec/rack/post_body_msgpack_parser_spec.rb
+- spec/spec_helper.rb