rack-json_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d50763e213f11a75f3c2c990b6ed9eb76eb0e4a1
+  data.tar.gz: 16a9d5f905b50f2aa5773bfa9c77cf94987b1a42
+SHA512:
+  metadata.gz: bd11e5fb0a4e8bafb6e704699ac07327c284bdbff81b52bc6649f0b059bcfade3c370b0eec609822da86b05ddc853e4abe2911010be3ac76063274c2240e6eb4
+  data.tar.gz: 298beff0f18a69fab3ff1d240cbdb158bf9cf97d45133ca9922825fc24568a0d1ae454b8f59c1e6a2a41ac189d1d46f04fb56f6d80709e0f21f3c221194f4658

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+/vendor/bundle/
+
+# log dir
+/log/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - '*.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.simplecov

@@ -0,0 +1,9 @@
+unless ARGV.any? { |e| e =~ /guard-rspec/ }
+  SimpleCov.start do
+    coverage_dir 'log/coverage'
+    formatter SimpleCov::Formatter::HTMLFormatter
+
+    command_name 'rspec'
+    maximum_coverage_drop 1
+  end
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+addons:
+  code_climate:
+    repo_token: b6750d5cc830de5ca5da5f6ba3c95b7129924f36b6c572e1a38301892b241e2a
+before_install: gem install bundler -v 1.12.5
+after_success:
+  - bundle exec codeclimate-test-reporter log/coverage/.resultset.json

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log_syringe.gemspec
+gemspec
+
+group :development do
+  gem 'codeclimate-test-reporter', github: 'codeclimate/ruby-test-reporter'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 MESO Digital Services GmbH
+
+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,56 @@
+# Rack::JsonParser
+
+[![Travis CI](https://travis-ci.org/meso-unimpressed/rack-json_parser.svg?branch=master)](https://travis-ci.org/meso-unimpressed/rack-json_parser)
+[![Code Climate](https://codeclimate.com/github/meso-unimpressed/rack-json_parser/badges/gpa.svg)](https://codeclimate.com/github/meso-unimpressed/rack-json_parser)
+[![Test Coverage](https://codeclimate.com/github/meso-unimpressed/rack-json_parser/badges/coverage.svg)](https://codeclimate.com/github/meso-unimpressed/rack-json_parser/coverage)
+[![Issue Count](https://codeclimate.com/github/meso-unimpressed/rack-json_parser/badges/issue_count.svg)](https://codeclimate.com/github/meso-unimpressed/rack-json_parser)
+
+A simple Rack middleware for parsing json from request bodies
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-json_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-json_parser
+
+## Usage
+
+```ruby
+# config.ru
+
+use MyErrorHandler
+use Rack::JSONParser, content_type: 'application/json'
+run MyApp
+```
+
+The named param `content_type` is optional and defaults to `application/json`
+you can use arrays, regexes or arrays of regexes here. Anything really which
+will evaluate to true when using the case operator `===` against the request
+content type.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+[meso-unimpressed/rack-json_parser](https://github.com/meso-unimpressed/rack-json_parser).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/json_parser'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/json_parser.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require 'json'
+require 'rack'
+
+require 'rack/json_parser/version'
+require 'rack/json_parser/bad_request'
+require 'rack/json_parser/unprocessable_entity'
+
+module Rack
+  # Parses JSON body of requests and handles errors
+  class JSONParser
+    # An error indicatating that parsing the json body failed
+    class ParseError < BadRequest
+      def initialize(error)
+        super("parsing json failed: #{error.message}")
+      end
+    end
+
+    # An error raised if body is nil or empty
+    class EmptyBodyError < BadRequest
+      def initialize
+        super('cannot process empty body')
+      end
+    end
+
+    # An error raised on invalid content types
+    class InvalidContentTypeError < BadRequest
+      def initialize(content_type)
+        super("cannot process content type #{content_type}")
+      end
+    end
+
+    # An error raised if the top level of the json document is not a hash
+    class NotAnObjectError < UnprocessableEntity
+      def initialize
+        super("document's top level must be an object")
+      end
+    end
+
+    def initialize(app, content_type: 'application/json')
+      @app = app
+      @content_type = content_type
+    end
+
+    def call(env)
+      parse(env) if should_have_body?(env)
+      @app.call(env)
+    end
+
+    private
+
+    def should_have_body?(env)
+      env.key?('CONTENT_LENGTH')
+    end
+
+    def parse(env)
+      request = Rack::Request.new(env)
+      body = request.body.read
+      request.body.rewind
+      validate_request!(request, body)
+
+      parsed_body = JSON.parse(body)
+      raise NotAnObjectError unless parsed_body.is_a?(Hash)
+
+      env['rack.request.form_input'] = request.body
+      env['rack.request.form_hash'] = parsed_body
+    rescue JSON::ParserError => error
+      raise ParseError, error
+    end
+
+    def validate_request!(request, body)
+      validate_body!(body)
+      validate_content_type!(request)
+    end
+
+    def validate_body!(body)
+      raise EmptyBodyError if body.nil? || body.empty?
+    end
+
+    def validate_content_type!(request)
+      content_type = request.content_type
+
+      case content_type
+      when *@content_type then true
+      else raise InvalidContentTypeError, content_type
+      end
+    end
+  end
+end

data/lib/rack/json_parser/bad_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'rack/json_parser/error'
+
+module Rack
+  class JSONParser
+    # A error signaling that the application should respond with bad request
+    class BadRequest < Error
+      def initialize(detail)
+        super('Bad request', detail: detail, status_code: 400)
+      end
+    end
+  end
+end

data/lib/rack/json_parser/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Rack
+  class JSONParser
+    # Base class for all JSONParser errors
+    class Error < RuntimeError
+      attr_reader :status_code, :title, :detail
+
+      def initialize(title, detail: nil, status_code: 500)
+        @status_code = status_code
+        @title = title
+        @detail = detail
+
+        super([title, detail].compact.join(' - '))
+      end
+    end
+  end
+end

data/lib/rack/json_parser/unprocessable_entity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'rack/json_parser/error'
+
+module Rack
+  class JSONParser
+    # A error signaling that the application should respond with
+    # unprocessable entity
+    class UnprocessableEntity < Error
+      def initialize(detail)
+        super('UnprocessableEntity', detail: detail, status_code: 422)
+      end
+    end
+  end
+end

data/lib/rack/json_parser/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Rack
+  class JSONParser
+    VERSION = '0.1.0'
+  end
+end

data/rack-json_parser.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/json_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-json_parser'
+  spec.version       = Rack::JSONParser::VERSION
+  spec.authors       = ['Joakim Reinert']
+  spec.email         = ['reinert@meso.net']
+
+  spec.summary       = 'A tiny rack middleware for parsing json request bodies'
+  spec.description   =
+    'Provides a middleware for parsing json from request bodies to be ' \
+    'accessed from request params'
+  spec.homepage      = 'https://github.com/meso-unimpressed/rack-json_parser'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.4'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.1'
+  spec.add_development_dependency 'simplecov', '~> 0.1'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+
+  spec.add_dependency 'rack', '~> 2.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rack-json_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides a middleware for parsing json from request bodies to be accessed
+  from request params
+email:
+- reinert@meso.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/json_parser.rb
+- lib/rack/json_parser/bad_request.rb
+- lib/rack/json_parser/error.rb
+- lib/rack/json_parser/unprocessable_entity.rb
+- lib/rack/json_parser/version.rb
+- rack-json_parser.gemspec
+homepage: https://github.com/meso-unimpressed/rack-json_parser
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A tiny rack middleware for parsing json request bodies
+test_files: []