cp-sparrow 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d21e1f781a7f5f4a27d6d8c286cd46d9af31cba4
-  data.tar.gz: 838ed5f0629f44eb18c8041c1dcaf3d5048b1630
+  metadata.gz: f6203b666448091c6aa36a5df6892f488a8bc96b
+  data.tar.gz: 9baa9565eba84c01ce3c0c742403892101c96a48
 SHA512:
-  metadata.gz: 99f670f75b1a3dc078130af3d946738f80705f1c79e26922afbbcba0921aecaa1c38bc7edd1253fb3f0a07fbad8c9635f5d6a7e332a407b4109d8b122a59c301
-  data.tar.gz: cd0a34026665ddfd21c075a05af4839b5f1995cc0d45d70009a205329a2862dd8eb752b243f5fa6c1937b2e973245a3130a2d2c33d25ced0bccbef71761b41df
+  metadata.gz: 151bd8ceaf5864f652d6479fa4bcfe84151b84fe3045b298a4208fd9edaed7a1ca1b573c758062f019824657bef7384f5d4ff5b5bf1f937f225273ae531cc834
+  data.tar.gz: c18506cee9974098896291c53ed2b836110411717600598ae7bde84b1b23dbce326e11c87e7a717a8e3e1292ae7fc5405c373861011b9dded0227af41748c775

data/.gitignore

@@ -22,3 +22,4 @@ tmp
 .idea
 .project
 hoogfile.yml
+.tags*

data/.ruby-version

@@ -1 +1 @@
-2.2
+2.3.1

data/.travis.yml

@@ -1,8 +1,5 @@
 language: ruby
 rvm:
-# - 2.0.0
-- 2.1.0
-# - 2.2.0
+  - 2.3.1
 env:
-  - RAILS_VERSION: 3.2.21
-  - RAILS_VERSION: 4.0.13
+  - RAILS_VERSION: 4.2.6

data/README.md

@@ -1,14 +1,17 @@
 # Sparrow
 
+[![Little Sparrow by Apofiss](http://orig07.deviantart.net/d937/f/2015/064/c/1/little_sparrow_by_apofiss-d5wpswt.jpg)](http://www.deviantart.com/art/Little-Sparrow-357282461)
+
 A Rack middleware for converting the params keys and JSON response keys of a Rack application.
 
 [![Build Status](https://travis-ci.org/GateprotectGmbH/sparrow.svg?branch=master)](https://travis-ci.org/GateprotectGmbH/sparrow) [![Gem Version](https://badge.fury.io/rb/cp-sparrow.svg)](http://badge.fury.io/rb/cp-sparrow)
+[![Code Climate](https://codeclimate.com/github/GateprotectGmbH/sparrow/badges/gpa.svg)](https://codeclimate.com/github/GateprotectGmbH/sparrow)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'cp-sparrow', require: 'sparrow'
+    gem 'cp-sparrow'
 
 And then execute:
 
@@ -58,7 +61,7 @@ Example:
 
 ### default_json_request_key_transformation_strategy
 
-> `String`. Default: `camelize`
+> `String`. Default: `underscore`
 
 Defines how the middleware should treat incoming parameters via Request. Which means how they get tranformed, i.e. defining _underscore_ here means that incoming parameters get underscore. Possible values are _underscore_ and _camelize_
 
@@ -133,7 +136,7 @@ Example:
 
 > `Symbol`. Default: `:lower`
 
-Defines which strategy to use when camelizing keys. Possible options are `:lower` and `:upper`, which tells the middleware to 
+Defines which strategy to use when camelizing keys. Possible options are `:lower` and `:upper`, which tells the middleware to
 start camelized keys with an uppercased character or with a lowercased character.
 
 Example:

data/Rakefile

@@ -4,8 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 RAILS_VERSIONS = [
-  "3.2.21",
-  "4.0.13"
+  "4.2.6"
 ]
 
 def run_tests_for_version(version)
@@ -16,7 +15,7 @@ def run_tests_for_version(version)
   commands << "bundle install"
   commands << "bundle exec rspec"
 
-  system({'RAILS_VERSION' => version}, commands.join(';'))
+  system({'RAILS_VERSION' => version}, commands.join(' && '))
 end
 
 task :all do
@@ -24,13 +23,15 @@ task :all do
     puts "Testing gem for rails version: #{version}"
     success = run_tests_for_version(version)
 
-    if not success
+    unless success
       puts "Test suite aborted, errors occured."
       exit($?.exitstatus)
     end
   end
 end
 
-task :default do
-  run_tests_for_version(ENV['RAILS_VERSION'] || '3.2.21')
-end
+# task :default do
+#   run_tests_for_version(ENV['RAILS_VERSION'] || '4.2.6')
+# end
+
+task default: :spec

data/lib/cp-sparrow.rb

@@ -0,0 +1 @@
+require 'sparrow'

data/lib/sparrow/configuration.rb

@@ -21,7 +21,7 @@ module Sparrow
       @json_request_format_header                        = 'request-json-format'
       @json_response_format_header                       = 'response-json-format'
       @excluded_routes                                   = []
-      @default_json_request_key_transformation_strategy  = :camelize
+      @default_json_request_key_transformation_strategy  = :underscore
       @default_json_response_key_transformation_strategy = :camelize
       @camelize_ignore_uppercase_keys                    = true
       @allowed_content_types                             = %w[
@@ -35,6 +35,10 @@ module Sparrow
       @camelize_strategy      = :lower
     end
 
+    def active_support_legacy_version
+      /3\.\d+\.\d+/
+    end
+
     ##
     # @param type [String] the http message type.
     #   Must be either 'request' or 'response'.

data/lib/sparrow/core_ext/hash.rb

@@ -1,23 +1,28 @@
-class Hash
-  # Defines deep_transform_keys as available in ActiveSupport >= 4.0.2.
-  # See {http://apidock.com/rails/v4.2.1/Hash/deep_transform_keys}
-  def deep_transform_keys(&block)
-    deep_transform_in_object(self, &block)
-  end
+module Sparrow
+  module CoreExt
+    module Hash
+      refine ::Hash do
+        # Defines deep_transform_keys as available in ActiveSupport >= 4.0.2.
+        # See {http://apidock.com/rails/v4.2.1/Hash/deep_transform_keys}
+        def deep_transform_keys(&block)
+          deep_transform_in_object(self, &block)
+        end
 
-  private 
+        private
 
-  def deep_transform_in_object(obj, &block)
-    case obj 
-      when Hash
-        obj.each_with_object({}) do |(key,value), result|
-          result[yield(key)] = deep_transform_in_object(value, &block)
+        def deep_transform_in_object(obj, &block)
+          case obj
+            when ::Hash
+              obj.each_with_object({}) do |(key,value), result|
+                result[yield(key)] = deep_transform_in_object(value, &block)
+              end
+            when Array
+              obj.map { |el| deep_transform_in_object(el, &block) }
+            else
+              obj
+          end
         end
-      when Array
-        obj.map { |el| deep_transform_in_object(el, &block) }
-      else
-        obj
+      end
     end
   end
 end
-

data/lib/sparrow/dependencies.rb

@@ -2,14 +2,23 @@ require 'active_support/core_ext/object'
 require 'active_support/core_ext/string'
 require 'active_support/version'
 
-if ActiveSupport::VERSION::STRING.match(/3\.\d+\.\d+/)
+module Sparrow
+  module_function
+
+  def uses_active_support_legacy_version?
+    active_support_legacy_version = /3\.\d+\.\d+/
+    ActiveSupport::VERSION::STRING.match(active_support_legacy_version)
+  end
+end
+
+if Sparrow.uses_active_support_legacy_version?
   require 'sparrow/core_ext/hash'
   require 'active_support/core_ext/object/to_param'
   require 'active_support/core_ext/object/to_query'
 end
 
 unless defined?(Rails)
-  require 'active_support/core_ext/logger'
+  require 'active_support/logger'
 end
 
 require 'singleton'

data/lib/sparrow/logger.rb

@@ -39,7 +39,7 @@ module Sparrow
     # @param [Boolean] enabled logging enabled
     def initialize(enabled)
       self.enabled = enabled
-      @logger = if defined?(Rails) then
+      @logger = if defined?(Rails)
                   Rails.logger
                 else
                   ::Logger.new(STDOUT)

data/lib/sparrow/railtie.rb

@@ -2,10 +2,10 @@ module Sparrow
   class Railtie < Rails::Railtie
     initializer 'sparrow.insert_middleware' do |app|
       # handle request
-      app.config.middleware.insert_after 'Rails::Rack::Logger',
-                                          'Sparrow::RequestMiddleware'
+      app.config.middleware.insert_after Rails::Rack::Logger,
+                                          Sparrow::RequestMiddleware
       # handle response
-      app.config.middleware.use 'Sparrow::ResponseMiddleware'
+      app.config.middleware.use Sparrow::ResponseMiddleware
     end
   end
 end

data/lib/sparrow/request_http_message.rb

@@ -16,7 +16,7 @@ module Sparrow
     # The HTTP Content Type Field
     # @return [String] the HTTP Content Type
     def content_type
-      request.content_type || super
+      request.content_type.presence || super
     end
   end
 end

data/lib/sparrow/response_middleware.rb

@@ -15,14 +15,14 @@ module Sparrow
     private
 
     def steward
+      configuration = Sparrow.configuration
       ResponseSteward.new(http_message,
-                          allowed_content_types:  Sparrow.configuration.allowed_content_types,
-                          allowed_accepts:        Sparrow.configuration.allowed_accepts,
-                          excluded_routes:        Sparrow.configuration.excluded_routes,
-                          ignored_response_codes: Sparrow.configuration.ignored_response_codes)
+                          allowed_content_types:  configuration.allowed_content_types,
+                          allowed_accepts:        configuration.allowed_accepts,
+                          excluded_routes:        configuration.excluded_routes,
+                          ignored_response_codes: configuration.ignored_response_codes)
     end
 
-
     def converted_response_body
       # return the original body if we are not going to process it
       return body unless steward.has_processable_http_message?

data/lib/sparrow/route_parser.rb

@@ -29,7 +29,7 @@ module Sparrow
     # @see #exclude?
     # @see #excluded_routes
     def allow?(path)
-      not exclude?(path)
+      !exclude?(path)
     end
 
     ##

data/lib/sparrow/strategies/ignore.rb

@@ -46,8 +46,8 @@ module Sparrow
         input = @env[HttpMessage::RACK_INPUT_KEY].gets
 
         begin
-          @env[HttpMessage::FORM_HASH_KEY] = MultiJson.load(input)
-        rescue MultiJson::ParseError
+          @env[HttpMessage::FORM_HASH_KEY] = JSON.parse(input)
+        rescue JSON::ParserError
           # ignore
         ensure
           @env[HttpMessage::RACK_INPUT_KEY].rewind

data/lib/sparrow/strategies/json_format_strategies/default_json_format_strategy.rb

@@ -11,7 +11,7 @@ module Sparrow
       # fallback.
       # @param [Object] input the JSON input
       # @return [Boolean] True
-      def match?(input)
+      def match?(_input)
         true
       end
 

data/lib/sparrow/strategies/json_format_strategies/json_format_strategy.rb

@@ -9,7 +9,7 @@ module Sparrow
     class JsonFormatStrategy
       ##
       # Empty constructor. Does nothing.
-      def initialize(*args)
+      def initialize(*_args)
       end
 
       ##
@@ -29,22 +29,23 @@ module Sparrow
       #  i.e. an Array, a String or a RackBody
       # @return [String] the formatted JSON
       def self.convert(body)
-        strategy = json_format_strategies.detect do |strategy|
-          strategy.match?(body)
+        strategy = json_format_strategies.detect do |strategy_candidate|
+          strategy_candidate.match?(body)
         end
         strategy.convert(body)
       end
 
-      private
       def self.init(*args)
         @@json_format_strategies ||= Array.new(args)
       end
+      private_class_method :init
 
       def self.json_format_strategies
         init
         default = Sparrow::Strategies::DefaultJsonFormatStrategy.instance
         @@json_format_strategies.reject(&:blank?) + [default]
       end
+      private_class_method :json_format_strategies
     end
   end
 end

data/lib/sparrow/strategies/key_transformation/underscore_key.rb

@@ -7,7 +7,7 @@ module Sparrow
         ##
         # Create a new UnderscoreKey Strategy
         # Does nothing except returning a plain instance.
-        def initialize(*args)
+        def initialize(*_args)
           # no initialization needed
         end
 

data/lib/sparrow/strategies/transform_params.rb

@@ -3,6 +3,10 @@ module Sparrow
     ##
     # Core class to trigger the conversion
     class TransformParams
+      if Sparrow.uses_active_support_legacy_version?
+        using Sparrow::CoreExt::Hash
+      end
+
       ##
       # the strategy stating how to convert the JSON
       # @return [KeyTransformation] key transformation strategy
@@ -51,7 +55,7 @@ module Sparrow
       private
 
       def create_key_transformation_strategy(key_transformation_strategy)
-        class_name = "#{key_transformation_strategy.to_s}_key"
+        class_name = "#{key_transformation_strategy}_key"
         class_name = class_name.camelize
         full_strategy_class_name =
             "Sparrow::Strategies::KeyTransformation::#{class_name}"

data/lib/sparrow/transformable.rb

@@ -16,10 +16,10 @@ module Sparrow
 
     def json_body
       json = parsable_json_string(transform_params)
-      MultiJson.load(json)
+      JSON.parse(json)
       json
-    rescue MultiJson::ParseError
-      MultiJson.dump(ensure_json)
+    rescue JSON::ParserError
+      JSON.generate(ensure_json)
     end
 
     private
@@ -38,19 +38,19 @@ module Sparrow
       json_params = if !params.is_a?(Hash)
                       Sparrow::Strategies::JsonFormatStrategy.convert(params)
                     elsif params.is_a?(Hash) &&
-                        params.values == [nil] &&
-                        params.keys.length == 1
+                        params.values.compact.empty? &&
+                        params.keys.one?
                       params.keys.first
                     else
                       params
                     end
-      return MultiJson.load(json_params) if json_params.is_a?(String)
+      return JSON.parse(json_params) if json_params.is_a?(String)
       json_params
     end
 
     def parsable_json_string(transformable_params)
       if [Hash, Array].include? transformable_params.class
-        MultiJson.dump(transformable_params)
+        JSON.generate(transformable_params)
       else
         transformable_params
       end
@@ -67,7 +67,7 @@ module Sparrow
     end
 
     ##
-    # Usualy Query String parameters want to get transformed as well
+    # Usually Query String parameters want to get transformed as well
     def transform_query_string
       env_query_hash      = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
       transformed_hash    = transform_params_strategy.transform(env_query_hash)

data/lib/sparrow/version.rb

@@ -1,3 +1,3 @@
 module Sparrow
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/sparrow.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
-rails_version = ENV["RAILS_VERSION"] || "3.2.21"
+rails_version = ENV["RAILS_VERSION"] || "4.2.6"
+ruby_version = File.open(File.join(__dir__, '.ruby-version')).read.chomp
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sparrow/version'
 
@@ -17,19 +18,20 @@ supported.
   }
   spec.homepage    = "https://github.com/GateprotectGmbH/sparrow"
   spec.license     = "MIT"
+  spec.required_ruby_version = ">= #{ruby_version}"
 
   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_runtime_dependency "activesupport", ">= 3.2.17"
+  spec.add_runtime_dependency "activesupport", "<= 4.2.6"
+
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", '~> 3'
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "multi_json"
   spec.add_development_dependency "rails", rails_version
 end

data/spec/integration/apps/rack_app/app.rb

@@ -1,17 +1,34 @@
 class App
 
   def call(env)
+    @env = env
     params = env["rack.input"].gets
-    response = Rack::Response.new
-    response['Content-Type'] = 'application/json'
-    response.write(json_response(params))
+    @params = JSON.parse(params || '{}')
+    header = {
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
+    }
+
+    response = Rack::Response.new(
+      json_response(params),
+      status,
+      header)
     response.finish
   end
 
   private
 
+  def status
+    path = @env['PATH_INFO']
+    if path =~ /error$/
+      @params['error_code'] || 500
+    else
+      200
+    end
+  end
+
   def json_response(params)
-    hsh_params = MultiJson.load(params)
+    hsh_params = @params
     keys = hsh_params.reduce([]) do |result, (key, value)|
       result << key
       if value.is_a?(Hash)
@@ -19,7 +36,7 @@ class App
       end
       result
     end.flatten
-    MultiJson.dump({
+    JSON.generate({
                        keys: keys,
                        fakeKey: true,
                        fake_key: false