cp-sparrow 0.0.12 → 0.0.14

data/lib/sparrow/transformable.rb

@@ -1,24 +1,15 @@
-require 'sparrow/strategies/transform_params'
-require 'sparrow/strategies/json_format_strategies/json_format_strategy'
-
-if ActiveSupport::VERSION::STRING.match(/3\.\d+\.\d+/)
-  require 'active_support/core_ext/object/to_param'
-  require 'active_support/core_ext/object/to_query'
-end
-
 module Sparrow
+  ##
+  # Encapsulates json transform methods. This is basically the core entry point
+  # for all conversions done by the middleware.
   module Transformable
+    ##
+    # Does the conversion based on the selected strategy and HTTP header
+    # parameters provided
     def transform_params
       transform_params_strategy.transform(ensure_json)
     end
 
-    def transform_strategy
-      default  =
-          Sparrow.configuration.default_json_key_transformation_strategy(type)
-      strategy = json_format || default
-      strategy.to_sym
-    end
-
     def handle
       transform_query_string
     end
@@ -32,19 +23,23 @@ module Sparrow
     end
 
     private
+
     def json_format
-      if respond_to?(:env) then
+      if respond_to?(:env)
         env[Sparrow.configuration.json_format_header(type)]
       else
         nil
       end
     end
 
+    # Make sure we are always dealing with a Ruby representation of a JSON
+    # String, i.e. a Hash
     def ensure_json
       json_params = if !params.is_a?(Hash)
                       Sparrow::Strategies::JsonFormatStrategy.convert(params)
-                    elsif params.is_a?(Hash) && params.values == [nil] &&
-                      params.keys.length == 1
+                    elsif params.is_a?(Hash) &&
+                        params.values == [nil] &&
+                        params.keys.length == 1
                       params.keys.first
                     else
                       params
@@ -62,15 +57,28 @@ module Sparrow
     end
 
     def transform_params_strategy
-      transform_params = Sparrow::Strategies::TransformParams
-      transform_params.new(transform_strategy)
+      transform_strategy_options = {
+          camelize_ignore_uppercase_keys: Sparrow.configuration.camelize_ignore_uppercase_keys,
+          camelize_strategy:              Sparrow.configuration.camelize_strategy
+
+      }
+      transform_params           = Sparrow::Strategies::TransformParams
+      transform_params.new(transform_strategy, transform_strategy_options)
     end
 
+    ##
+    # Usualy 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)
       env['QUERY_STRING'] = transformed_hash.to_param
     end
 
+    def transform_strategy
+      default  =
+          Sparrow.configuration.default_json_key_transformation_strategy(type)
+      strategy = json_format || default
+      strategy.to_sym
+    end
   end
 end

data/lib/sparrow/version.rb

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

data/sparrow.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 such as camelCase and snake_case. Both converting responses and requests are
 supported.
   }
-  spec.homepage    = ""
+  spec.homepage    = "https://github.com/GateprotectGmbH/sparrow"
   spec.license     = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/integration/apps/rails_app/config/boot.rb

@@ -7,4 +7,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/integration/rack/camel_caser_spec.rb

@@ -31,7 +31,7 @@ describe "camel caser middleware", type: :rack do
       post '/', json
     end
 
-    subject do 
+    subject do
       MultiJson.load(last_response.body)
     end
 
@@ -43,7 +43,7 @@ describe "camel caser middleware", type: :rack do
 
     it 'converted the snake case fake key to camelCase' do
       expect(subject['fake_key']).to_not be_present
-      expect(subject['fakeKey']).to eq true
+      expect(subject['fakeKey']).to eq false
     end
   end
 end

data/spec/unit/camelize_key_spec.rb

@@ -1,19 +1,21 @@
 require 'spec_helper'
 
-describe Sparrow::Strategies::CamelizeKey do
+describe Sparrow::Strategies::KeyTransformation::CamelizeKey do
 
-  subject { Sparrow::Strategies::CamelizeKey.new }
+  subject(:camelize_key_strategy) do
+    Sparrow::Strategies::KeyTransformation::CamelizeKey.new
+  end
 
   describe '#transform_key' do
 
-    it 'should camelize it´s inputs (defaulting to lower case camelizing)' do
-      output = subject.transform_key("wireless_configuration")
-      expect(output).to eq("wirelessConfiguration")
+    it 'should camelize its inputs (defaulting to lower case camelizing)' do
+      output = camelize_key_strategy.transform_key('wireless_configuration')
+      expect(output).to eq('wirelessConfiguration')
     end
 
     it 'should leave all_uppercase strings as they are' do
-      output = subject.transform_key("DE")
-      expect(output).to eq("DE")
+      output = camelize_key_strategy.transform_key('DE')
+      expect(output).to eq('DE')
     end
   end
 end

data/spec/unit/configuration_spec.rb

@@ -6,11 +6,14 @@ module Sparrow
     its(:json_response_format_header) do
       is_expected.to eq 'response-json-format'
     end
+    its(:enable_logging) { is_expected.to be false }
     its(:excluded_routes) { is_expected.to eq [] }
     its(:default_json_request_key_transformation_strategy) do
       is_expected.to eq :camelize
     end
 
+    its(:camelize_strategy) { is_expected.to eq :lower }
+
     its(:default_json_response_key_transformation_strategy) do
       is_expected.to eq :camelize
     end

data/spec/unit/http_message.rb

@@ -0,0 +1,66 @@
+module Sparrow
+  describe HttpMessage, type: :unit do
+    let(:env) do
+      {
+        'Content-Type' => 'application/json; charset=utf-8',
+        'Accept'       => 'application/json',
+        'PATH_INFO'    => '/api/status.json',
+        'rack.input'   => '',
+        'rack.request.form_hash' => {
+          'panda' => 'bamboo'
+        }
+      }
+    end
+    subject(:request) { described_class.new(env) }
+
+    its(:path) { is_expected.to eq '/api/status.json' }
+    its(:accept) { is_expected.to eq 'application/json' }
+    it { is_expected.to be_form_hash }
+
+    describe '#content_type' do
+      it 'takes the content type until the ;' do
+        expect(request.content_type).to eq 'application/json'
+      end
+
+      context 'without env' do
+        let(:env) { {} }
+        it 'allows an unset content type' do
+          expect(request.content_type).to eq nil
+        end
+      end
+    end
+
+    it 'wraps the environment hash' do
+      expect(request.env).to eq env
+    end
+
+    describe '#request' do
+      it 'wraps the real request object' do
+        expect(request.request).to be_present
+      end
+
+      context 'when in a Rails environment' do
+        it 'wraps a ActionDispatch::Request object' do
+          require 'rails'
+          expect(request.request).to be_an_instance_of ::ActionDispatch::Request
+        end
+      end
+
+      context 'when in a Rack environment' do
+        before do
+          # unload Rails
+          Object.send(:remove_const, :Rails)
+        end
+
+        it 'wraps a Rack::Request object' do
+          expect(request.request).to be_an_instance_of ::Rack::Request
+        end
+      end
+    end
+
+    it 'delegates all unknown methods to the wrapped request object' do
+      # use params accessor as example
+      expect(request.params).to be
+    end
+  end
+end

data/spec/unit/logger_spec.rb

@@ -0,0 +1,6 @@
+module Sparrow
+  describe Logger, type: :unit do
+    subject(:logger) { Logger.new(true) }
+    it { is_expected.to be_enabled }
+  end
+end

data/spec/unit/{camel_caser_spec.rb → sparrow_spec.rb}

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe Sparrow do
-  describe 'configuration' do
+  describe '.configuration' do
     it 'should return a Configuration object' do
       expect(Sparrow.configuration).to(
           be_an_instance_of(Sparrow::Configuration))
     end
   end
 
-  describe 'configure' do
+  describe '.configure' do
     it 'should yield the configuration and save it' do
       Sparrow.configure do |configuration|
         configuration.json_request_format_header = 'panda'
@@ -20,4 +20,10 @@ describe Sparrow do
       expect(configuration.excluded_routes).to eq ['panda']
     end
   end
+
+  describe '.logger' do
+    it 'returns a Sparrow::Logger' do
+      expect(Sparrow.logger).to be_kind_of Sparrow::Logger
+    end
+  end
 end

data/spec/unit/steward_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Sparrow
+  describe Steward, type: :unit do
+    let(:env) do
+      {
+          'PATH_INFO'    => '/api/state',
+          'rack.input'   => 'teststring',
+          'CONTENT-TYPE' => 'application/json',
+          'ACCEPT'       => 'application/json'
+      }
+    end
+    let(:http_message) { RequestHttpMessage.new(env) }
+    let(:excluded_routes) { ['/api/model/certificates'] }
+    let(:allowed_accepts) { ['application/json'] }
+    let(:allowed_content_types) { ['application/json'] }
+    subject(:steward) do
+      Steward.new(http_message,
+                  allowed_accepts:       allowed_accepts,
+                  allowed_content_types: allowed_content_types,
+                  excluded_routes:       excluded_routes)
+    end
+
+    it { is_expected.to have_processable_http_message }
+    its(:http_message) { is_expected.to eq http_message }
+    its(:route_parser) { is_expected.to be_present }
+    its(:excluded_routes) { is_expected.to eq excluded_routes }
+    its(:allowed_accepts) { is_expected.to eq allowed_accepts }
+    its(:allowed_content_types) { is_expected.to eq allowed_content_types }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cp-sparrow
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Daniel Schmidt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,20 +158,28 @@ files:
 - lib/sparrow.rb
 - lib/sparrow/configuration.rb
 - lib/sparrow/core_ext/hash.rb
+- lib/sparrow/dependencies.rb
+- lib/sparrow/http_message.rb
+- lib/sparrow/logger.rb
 - lib/sparrow/middleware.rb
-- lib/sparrow/path_normalizer.rb
 - lib/sparrow/railtie.rb
+- lib/sparrow/request_http_message.rb
 - lib/sparrow/request_middleware.rb
+- lib/sparrow/response_http_message.rb
 - lib/sparrow/response_middleware.rb
+- lib/sparrow/response_steward.rb
 - lib/sparrow/route_parser.rb
+- lib/sparrow/steward.rb
+- lib/sparrow/strategies.rb
 - lib/sparrow/strategies/form_hash.rb
 - lib/sparrow/strategies/ignore.rb
-- lib/sparrow/strategies/json_format_strategies/array_strategy.rb
+- lib/sparrow/strategies/json_format_strategies.rb
+- lib/sparrow/strategies/json_format_strategies/array_json_format_strategy.rb
 - lib/sparrow/strategies/json_format_strategies/default_json_format_strategy.rb
 - lib/sparrow/strategies/json_format_strategies/json_format_strategy.rb
-- lib/sparrow/strategies/json_format_strategies/rack_body.rb
+- lib/sparrow/strategies/json_format_strategies/rack_body_json_format_strategy.rb
+- lib/sparrow/strategies/key_transformation.rb
 - lib/sparrow/strategies/key_transformation/camelize_key.rb
-- lib/sparrow/strategies/key_transformation/key_normalizer.rb
 - lib/sparrow/strategies/key_transformation/underscore_key.rb
 - lib/sparrow/strategies/raw_input.rb
 - lib/sparrow/strategies/transform_params.rb
@@ -219,12 +227,14 @@ files:
 - spec/support/rack_app_helper.rb
 - spec/support/rails_app_helper.rb
 - spec/support/unit_spec_helper.rb
-- spec/unit/camel_caser_spec.rb
 - spec/unit/camelize_key_spec.rb
 - spec/unit/configuration_spec.rb
-- spec/unit/path_normalizer_spec.rb
+- spec/unit/http_message.rb
+- spec/unit/logger_spec.rb
 - spec/unit/route_parser_spec.rb
-homepage: ''
+- spec/unit/sparrow_spec.rb
+- spec/unit/steward_spec.rb
+homepage: https://github.com/GateprotectGmbH/sparrow
 licenses:
 - MIT
 metadata: {}
@@ -244,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A POC to have a Rack middleware parsing the params keys into underscore
@@ -290,9 +300,10 @@ test_files:
 - spec/support/rack_app_helper.rb
 - spec/support/rails_app_helper.rb
 - spec/support/unit_spec_helper.rb
-- spec/unit/camel_caser_spec.rb
 - spec/unit/camelize_key_spec.rb
 - spec/unit/configuration_spec.rb
-- spec/unit/path_normalizer_spec.rb
+- spec/unit/http_message.rb
+- spec/unit/logger_spec.rb
 - spec/unit/route_parser_spec.rb
-has_rdoc: 
+- spec/unit/sparrow_spec.rb
+- spec/unit/steward_spec.rb

data/lib/sparrow/path_normalizer.rb

@@ -1,10 +0,0 @@
-require 'active_support/core_ext/string/starts_ends_with'
-
-module Sparrow
-  module PathNormalizer
-    def normalize_path(path)
-      path[/./m] = '' if path.starts_with?('/')
-      path
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-require 'sparrow/strategies/json_format_strategies/json_format_strategy'
-
-module Sparrow
-  module Strategies
-    class ArrayStrategy < JsonFormatStrategy
-      register_json_format
-
-      def match?(input)
-        input.is_a? Array
-      end
-
-      def convert(input)
-        input.first
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-require File.dirname(__FILE__) + '/json_format_strategy'
-
-module Sparrow
-  module Strategies
-    class RackBody < JsonFormatStrategy
-      register_json_format
-
-      def match?(input)
-        input.respond_to?(:body)
-      end
-
-      def convert(input)
-        input.body
-      end
-    end
-  end
-end