cp-sparrow 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9052fb54e2eab83298497e0037a54c517bd7429a
-  data.tar.gz: 3c871cad86f27adf06bbdcc2cbf35bac4ed479fe
+  metadata.gz: 8c0adb0e16e2c7a97a4b7c4d6db2506cd3c3f91e
+  data.tar.gz: 7e58676322eb7f4981618f359ab3a2fcef609bd4
 SHA512:
-  metadata.gz: 92ec954024212d99c3e5d606072f1703131301774de50721360057aaffd256bfa5ef5659e62599153a2672720f5014c33d9023961351b9595e65237cfece1c55
-  data.tar.gz: 7c8ffca7814f4968e898b37d0a827871ce41d311795c92aca695076e6fd408741148f7ba1dafd3f5108dce76d83fee3f877c5c3da9de74c3a41a9cd165d1cd07
+  metadata.gz: e653bf471ed0d7d59ce627d1b26dd219b9807bf42e52663af3a3a4f884ea53c3a1c6472fdeb02cda302666ebdb2a9d293cbcdd0195d6f163b8581f1f38cec34c
+  data.tar.gz: a4542efb1cd4984760480db9b200bc1e6da846bbfde61b44294715c83ae3d625e486be14bef7bf01c9ccf4fa49daa6c0c9d91a4de6d6858e724e59e5094c2e0b

data/.travis.yml

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

data/README.md

@@ -2,6 +2,8 @@
 
 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)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,7 +16,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install sparrow
+    $ gem install cp-sparrow
 
 ## Usage
 

data/Rakefile

@@ -4,7 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 RAILS_VERSIONS = [
-  "3.2.17",
+  "3.2.21",
   "4.0.13"
 ]
 
@@ -12,14 +12,14 @@ def run_tests_for_version(version)
   commands = []
 
   commands << "rm Gemfile.lock"
-  commands << "export RAILS_VERSION=#{version}"
-  commands << "bundle update"
+  commands << "gem install rails -v #{version}"
+  commands << "bundle install"
   commands << "bundle exec rspec"
 
-  system(commands.join(';'))
+  system({'RAILS_VERSION' => version}, commands.join(';'))
 end
 
-task :default do
+task :all do
   RAILS_VERSIONS.each do |version|
     puts "Testing gem for rails version: #{version}"
     success = run_tests_for_version(version)
@@ -30,3 +30,7 @@ task :default do
     end
   end
 end
+
+task :default do
+  run_tests_for_version(ENV['RAILS_VERSION'] || '3.2.21')
+end

data/lib/sparrow/middleware.rb

@@ -24,12 +24,10 @@ module Sparrow
 
     def strategy
       if is_processable?
-        if last_env[Strategies::FormHash::REQUEST_FORM_HASH_KEY]
-          Strategies::FormHash
-        else
-          Strategies::RawInput
-        end
+        Rails.logger.debug 'Choosing strategy RawInput' if defined? Rails
+        Strategies::RawInput
       else
+        Rails.logger.debug 'Choosing strategy Ignore' if defined? Rails
         Strategies::Ignore
       end
     end
@@ -44,7 +42,7 @@ module Sparrow
     end
 
     def accepted_content_type?
-      content_type_equals?(request_content_type) || content_type_matches?(request_content_type)
+      content_type_equals?(content_type) || content_type_matches?(content_type)
     end
 
     def accepted_accept_header?
@@ -68,15 +66,6 @@ module Sparrow
       request_class.new(last_env)
     end
 
-    def request_content_type
-      content_type = request.content_type ||
-          last_env['CONTENT-TYPE'] ||
-          last_env['Content-Type'] ||
-          last_env['CONTENT_TYPE']
-
-      content_type.present? ? content_type : nil
-    end
-
     def content_type_equals?(type)
       Sparrow.configuration.allowed_content_types.include?(type)
     end

data/lib/sparrow/request_middleware.rb

@@ -7,5 +7,23 @@ module Sparrow
       strategy.handle(env, :request)
       env
     end
+
+    def content_type
+      my_content_type = request.content_type ||
+          last_env['CONTENT-TYPE'] ||
+          last_env['Content-Type'] ||
+          last_env['CONTENT_TYPE']
+
+      my_content_type.present? ? my_content_type : nil
+    end
+
+    def strategy
+      if is_processable? && last_env[Strategies::FormHash::REQUEST_FORM_HASH_KEY]
+        Rails.logger.debug 'Choosing strategy FormHash' if defined? Rails
+        Strategies::FormHash
+      else
+        super
+      end
+    end
   end
 end

data/lib/sparrow/response_middleware.rb

@@ -33,5 +33,12 @@ module Sparrow
     def unprocessable_status?
       @status.in?(500..511) || @status == 404
     end
+
+    def content_type
+      headers['Content-Type'].split(';').first #||
+          # last_env['CONTENT-TYPE'] ||
+          # last_env['Content-Type'] ||
+          # last_env['CONTENT_TYPE']
+    end
   end
 end

data/lib/sparrow/strategies/ignore.rb

@@ -34,6 +34,10 @@ module Sparrow
         @env
       end
 
+      def json_body
+        params
+      end
+
       def transform_params
         ensure_json
       end

data/lib/sparrow/version.rb

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

data/spec/integration/apps/rails_app/app/controllers/welcome_controller.rb

@@ -11,6 +11,16 @@ class WelcomeController < ApplicationController
     render json: {keys: extract_keys, camelCase: false, snake_case: true}
   end
 
+  def non_json_text_response
+    render text: "----- BEGIN PUBLIC KEY -----\n#{extract_keys}\n----- END PUBLIC KEY -----"
+  end
+
+  def non_json_binary_response
+    file = File.join(Rails.root, 'app', 'assets', 'images', 'grumpy-cat.gif')
+
+    send_file(file, filename: "#{params}.gif")
+  end
+
   def posts
     render json: {keys: extract_keys}
   end

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

@@ -51,9 +51,13 @@ Dummy::Application.routes.draw do
   root :to => 'welcome#index', defaults: { format: 'json' }
   post '/posts' => 'welcome#posts', defaults: {format: 'json'}
   get '/welcome' => 'welcome#show', default: {format: 'json'}
+  get '/welcome/non_json_text_response' => 'welcome#non_json_text_response', default: {format: 'json'}
+  get '/welcome/non_json_binary_response' => 'welcome#non_json_binary_response', default: {format: 'json'}
   get '/array_of_elements' => 'welcome#array_of_elements', default: {format: 'json'}
   get '/upcase_first_name' => 'welcome#upcase_first_name', default: {format: 'json'}
   get '/ignore' => 'welcome#ignore', default: {format: 'json'}
+  get '/ignore/non_json_text_response' => 'welcome#non_json_text_response', default: {format: 'json'}
+  get '/ignore/non_json_binary_response' => 'welcome#non_json_binary_response', default: {format: 'json'}
   get '/error' => 'welcome#error', default: {format: 'json'}
 
   # See how all your routes lay out with "rake routes"

data/spec/integration/rails/camel_caser_spec.rb

@@ -5,8 +5,9 @@ describe "camel caser middleware for Rails", type: :rails do
   let(:json_object) do
     {
       userName: 'dsci',
+      last_name: 'smith',
       bar:      { lordFüü: 12 },
-      "DE"      => 'german'
+      "DE"      => 'german',
     }
   end
   let(:json) { MultiJson.dump(json_object) }
@@ -32,21 +33,121 @@ describe "camel caser middleware for Rails", type: :rails do
     end
 
     context 'exclude paths' do
-      before do
-        get '/ignore', json_object, { 'CONTENT-TYPE'         => 'application/json',
-                                      'request-json-format'  => 'underscore',
-                                      'response-json-format' => 'underscore' }
+      context 'ignored json in and out' do
+        before do
+          get '/ignore', json_object, { 'CONTENT-TYPE'         => 'application/json',
+                                        'request-json-format'  => 'underscore',
+                                        'response-json-format' => 'underscore' }
+        end
+
+        subject { MultiJson.load(last_response.body) }
+
+        it 'should not touch the input keys and the response' do
+          expect(subject).to have_key('camelCase')
+          expect(subject).to have_key('snake_case')
+          expect(subject).to have_key('keys')
+          keys = subject['keys']
+          %w(userName lordFüü bar).each do |key|
+            expect(keys).to include(key)
+          end
+        end
       end
 
-      subject { MultiJson.load(last_response.body) }
+      context 'ignored json in and ignored text out' do
+        before do
+          get '/ignore/non_json_text_response', json_object,
+            { 'CONTENT-TYPE'         => 'application/json',
+              'request-json-format'  => 'underscore',
+              'response-json-format' => 'underscore' }
+        end
+
+        subject { last_response }
+
+        it { is_expected.to be_successful }
+
+        it 'should answer with a KEY' do
+          expect(subject.body).to match /BEGIN PUBLIC KEY/
+        end
+
+        it 'should not touch the keys' do
+          expect(subject.body).to match /userName/
+          expect(subject.body).to match /lordFüü/
+          expect(subject.body).to match /bar/
+          expect(subject.body).to match /last_name/
+        end
+
+        it 'should be content-type html' do
+          expect(subject.header['Content-Type']).to match /text\/html/
+        end
+      end
+
+      context 'ignored json in and ignored binary out' do
+        before do
+          get '/ignore/non_json_binary_response', json_object,
+            { 'CONTENT-TYPE'         => 'application/json',
+              'request-json-format'  => 'underscore',
+              'response-json-format' => 'underscore' }
+        end
+
+        subject { last_response }
+
+        it { is_expected.to be_successful }
+
+        it 'should be content-type gif' do
+          expect(subject.header['Content-Type']).to eql "image/gif"
+        end
+      end
+
+      context 'convert json in and ignored text out' do
+        before do
+          get '/welcome/non_json_text_response', json_object,
+            { 'CONTENT-TYPE'         => 'application/json',
+              'request-json-format'  => 'underscore',
+              'response-json-format' => 'underscore' }
+        end
+
+        subject { last_response }
+
+        it { is_expected.to be_successful }
+
+        it 'should answer with a KEY' do
+          expect(last_response.body).to match /BEGIN PUBLIC KEY/
+        end
+
+        it 'should touch the keys' do
+          expect(subject.body).to match /user_name/
+          expect(subject.body).to match /lord_füü/
+          expect(subject.body).to match /bar/
+          expect(subject.body).to match /last_name/
+        end
+
+        it 'should be content-type html' do
+          expect(last_response.header['Content-Type']).to match /text\/html/
+        end
+      end
+
+      context "convert json in and don't stumble over binary out" do
+        before do
+          get '/welcome/non_json_binary_response', json_object,
+            { 'CONTENT-TYPE'         => 'application/json',
+              'request-json-format'  => 'underscore',
+              'response-json-format' => 'underscore' }
+        end
 
-      it 'should not touch the input keys and the response' do
-        expect(subject).to have_key('camelCase')
-        expect(subject).to have_key('snake_case')
-        expect(subject).to have_key('keys')
-        keys = subject['keys']
-        %w(userName lordFüü bar).each do |key|
-          expect(keys).to include(key)
+        subject { last_response }
+
+        it { is_expected.to be_successful }
+
+        it 'should be content-type html' do
+          expect(last_response.header['Content-Type']).to eq('image/gif')
+        end
+
+        it 'should show the converted input params as file name content' do
+          expect(last_response.header['Content-Disposition']).
+            to include("user_name")
+
+          expect(last_response.header['Content-Disposition']).
+            to include("lord_füü")
         end
       end
     end
@@ -145,9 +246,8 @@ describe "camel caser middleware for Rails", type: :rails do
     end
 
     describe 'the configuration of allowed content types' do
-      it 'does not process requests and responses that have disallowed content
- types' do
-        get '/welcome', json_object, { 'CONTENT-TYPE'        => 'text/html',
+      it 'does not process requests and responses that have disallowed content types' do
+        get '/welcome', json_object, { 'CONTENT_TYPE'        => 'text/html',
                                        'request-json-format' => 'underscore' }
 
         last_json = MultiJson.load(last_response.body)
@@ -162,7 +262,8 @@ describe "camel caser middleware for Rails", type: :rails do
 
         post '/posts', json, { 'request-json-format'  => 'underscore',
                                'response-json-format' => 'underscore',
-                               'CONTENT-TYPE'         => 'something' }
+                               'CONTENT-TYPE'         => '' }
+
         last_json = MultiJson.load(last_response.body)
         expect(last_json['keys']).to include('userName')
         expect(last_json['keys']).to include('DE')
@@ -174,9 +275,8 @@ describe "camel caser middleware for Rails", type: :rails do
         end
 
         post '/posts', json, { 'request-json-format'  => 'underscore',
-                                           'response-json-format' => 'underscore',
-                                            'CONTENT_TYPE'         => ''
-                                          }
+                               'response-json-format' => 'underscore',
+                               'CONTENT_TYPE'         => ''}
 
         last_json = MultiJson.load(last_response.body)
         expect(last_json['keys']).to include('user_name')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cp-sparrow
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Daniel Schmidt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -181,6 +182,7 @@ files:
 - spec/integration/apps/rack_app/config.ru
 - spec/integration/apps/rails_app/README.rdoc
 - spec/integration/apps/rails_app/Rakefile
+- spec/integration/apps/rails_app/app/assets/images/grumpy-cat.gif
 - spec/integration/apps/rails_app/app/assets/javascripts/application.js
 - spec/integration/apps/rails_app/app/assets/stylesheets/application.css
 - spec/integration/apps/rails_app/app/controllers/application_controller.rb
@@ -251,6 +253,7 @@ test_files:
 - spec/integration/apps/rack_app/config.ru
 - spec/integration/apps/rails_app/README.rdoc
 - spec/integration/apps/rails_app/Rakefile
+- spec/integration/apps/rails_app/app/assets/images/grumpy-cat.gif
 - spec/integration/apps/rails_app/app/assets/javascripts/application.js
 - spec/integration/apps/rails_app/app/assets/stylesheets/application.css
 - spec/integration/apps/rails_app/app/controllers/application_controller.rb