roda-parse-request 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e3b856b38214108afc6d6189d04eff69891a185
+  data.tar.gz: 610dd77acdbd59c68ea77c61a85cb3955bc793a7
+SHA512:
+  metadata.gz: 0de60c292612009d318286cd624a36f70d8c487678b06cda38be2d9350b9e92ae5abee99456d5daec53c4ac5b251afdf2ad15cad7aa86b683b2518ced4f53bd9
+  data.tar.gz: c11050feec31265706b6ca688324dd75ae8aca6d0f0dc82d688e99aa88118d39c39c97ffa460dbc464a75086c77dade693385899d04c0dfb3b7415d22dc1a619

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    roda-parse-request (0.0.1)
+      roda (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    roda (1.3.0)
+      rack
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rack-test
+  rake (~> 10.0)
+  roda-parse-request!
+  rspec (~> 3.1)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 3scale
+
+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,70 @@
+# roda-parse-request
+
+[roda](http://roda.jeremyevans.net/) plugin which automatically parses JSON and url-encoded requests
+
+
+## Usage
+
+In your `Gemfile`:
+
+```ruby
+gem 'roda-parse-request'
+```
+
+
+In your roda app:
+
+```ruby
+require 'roda'
+require 'roda-parse-request'
+
+class App < Roda
+  plugin :parse_request
+
+  route do |r|
+
+    r.post do
+      # You can use request.parsed_body here
+      # By default, it will contain response.body parsed as a json or url-encoded
+      # request (if the request was sent with the appropiate content-type headers)
+    end
+  end
+end
+```
+
+
+## Customization
+
+It is possible to add your own parsers to the plugin, like so:
+
+```ruby
+require 'roda'
+require 'roda-parse-request'
+
+class App < Roda
+  plugin :parse_request, parsers: {
+    'upcase'  => ->(data) { data.upcase },
+  }
+
+  route do |r|
+
+    r.post do
+      # You can still use json and url-encoded parsed requests in request.parsed_body
+      # But now, if you get a request with Content-Type = 'upcase', the body
+      # will be automatically set to all caps.
+    end
+  end
+end
+```
+
+See the specs for more examples
+
+## Running specs
+
+Clone the repo, run `bundle` and then `rspec`.
+
+
+## License
+
+MIT License (see LICENSE)
+

data/Rakefile

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

data/lib/roda-parse-request.rb

@@ -0,0 +1 @@
+require 'roda/parse_request'

data/lib/roda/parse_request.rb

@@ -0,0 +1,50 @@
+require 'roda'
+require 'roda/parse_request/version'
+
+require 'uri'
+require 'json'
+
+class Roda
+  module ParseRequest
+
+    OPTS = {}.freeze
+
+    DEFAULT_PARSERS = {
+      'application/x-www-form-urlencoded' => ->(data) { URI.decode_www_form(data) },
+      'application/json' => ->(data) { JSON.parse(data) }
+    }.freeze
+
+    IDENTITY_PARSER = (->(data) { data }).freeze
+
+    # Set the classes to automatically convert to JSON
+    def self.configure(app, opts=OPTS)
+      parsers = DEFAULT_PARSERS.merge(opts[:parsers] || {})
+      app.opts[:parse_request_parsers] ||= parsers
+      app.opts[:parse_request_parsers].freeze
+    end
+
+    module ClassMethods
+      def parse_request_parsers
+        opts[:parse_request_parsers]
+      end
+    end
+
+    module RequestMethods
+      def parsed_body
+        @parsed_body ||= parse_body(body)
+      end
+
+      private
+
+      def parse_body(input)
+        data = input.read; input.rewind
+
+        parser = roda_class.parse_request_parsers[media_type] || IDENTITY_PARSER
+
+        parser.call(data)
+      end
+    end
+  end
+
+  RodaPlugins.register_plugin(:parse_request, ParseRequest)
+end

data/lib/roda/parse_request/version.rb

@@ -0,0 +1,5 @@
+class Roda
+  module ParseRequest
+    VERSION = "0.0.1"
+  end
+end

data/roda-parse-request.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roda/parse_request/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roda-parse-request"
+  spec.version       = Roda::ParseRequest::VERSION
+  spec.authors       = ["Michal Cichra", "Enrique García"]
+  spec.email         = ["michal@o2h.cz"]
+  spec.summary       = %q{Roda plugin which parses the request body of JSON and url-encoded requests automatically}
+  spec.description   = %q{It also accepts custom transformations via configuration.}
+  spec.homepage      = "https://github.com/3scale/roda-parse-request"
+  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 "rspec", "~> 3.1"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_dependency "roda", "~> 1.3"
+end

data/spec/roda_parse_request_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+RSpec.describe Roda::ParseRequest do
+
+  context "default parsers" do
+
+    let(:app) do
+      Class.new(Roda) do
+        plugin :parse_request
+
+        route do |r|
+          r.post do
+            request.parsed_body.to_json
+          end
+        end
+      end.app.freeze
+    end
+
+    it 'parses json' do
+      post '/', '{"valid":true}', 'CONTENT_TYPE' => 'application/json'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('{"valid":true}')
+    end
+
+    it 'parses urlencoded' do
+      post '/', 'a=b&c=d', 'CONTENT_TYPE' => 'application/x-www-form-urlencoded'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('[["a","b"],["c","d"]]')
+    end
+
+    it 'works when no parser is found' do
+      post '/', 'hello', 'CONTENT_TYPE' => 'something/not-expected'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('"hello"')
+    end
+
+  end
+
+  context "custom parsers" do
+    let(:app) do
+      Class.new(Roda) do
+        plugin :parse_request, parsers: {
+          'hodor'            => ->(data) { 'hodor' },
+          'upcase'           => ->(data) { data.upcase },
+          'application/json' => ->(data) { '<xml>troll</xml>' }
+        }
+
+        route do |r|
+          r.post do
+            request.parsed_body.to_json
+          end
+        end
+      end.app.freeze
+    end
+
+    it 'works with the simplest case' do
+      post '/', 'hey', 'CONTENT_TYPE' => 'hodor'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('"hodor"')
+    end
+
+    it 'can access the data' do
+      post '/', 'hey', 'CONTENT_TYPE' => 'upcase'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('"HEY"')
+    end
+
+    it 'can use the default parsers' do
+      post '/', 'a=b&c=d', 'CONTENT_TYPE' => 'application/x-www-form-urlencoded'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('[["a","b"],["c","d"]]')
+    end
+
+    it 'can override default parsers' do
+      post '/', '{"valid":true}', 'CONTENT_TYPE' => 'application/json'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('"<xml>troll</xml>"')
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+require 'roda/parse_request'
+require 'rack/test'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+
+  config.include Rack::Test::Methods
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 4
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: roda-parse-request
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michal Cichra
+- Enrique García
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-03 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: It also accepts custom transformations via configuration.
+email:
+- michal@o2h.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/roda-parse-request.rb
+- lib/roda/parse_request.rb
+- lib/roda/parse_request/version.rb
+- roda-parse-request.gemspec
+- spec/roda_parse_request_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/3scale/roda-parse-request
+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.5
+signing_key: 
+specification_version: 4
+summary: Roda plugin which parses the request body of JSON and url-encoded requests
+  automatically
+test_files:
+- spec/roda_parse_request_spec.rb
+- spec/spec_helper.rb
+has_rdoc: