hyperdrive 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed1d1fd26b439a04e08d7fa1ba6e3106ded9bf3f
-  data.tar.gz: 7bf1556e09a0dbcbe4bcbebdfcbad9d241fad8b9
+  metadata.gz: 0b5a8dba0ecc2580c9ab5880da0499cd5a9bcd8e
+  data.tar.gz: 8746e9594475c4297e69e2e3852d8e1bd33aeb03
 SHA512:
-  metadata.gz: 63fc14ccc429e1a6840d83fcce3b60d8b5f2e78ae727bdc6d80c07dbc4b431a35715cc5c695187b59325b0ba8a064533edd2e006283228633ef02d0b355e94e1
-  data.tar.gz: 75002d0ad8130aa4e186c7b5699ae5476a61107c8b7acf522d9ee42c637dae719530947b285a5acb2df69c90fccec9b848d1b28ae60dcd11038c867d836f21d0
+  metadata.gz: 07610251fb906637c086757dfd289c35413d4abaa79d3c676898deb14c10ed829a0a75322b2ce435dd09cd9e429b93e5c2fc2533477f17d33e9e7178b159bc35
+  data.tar.gz: edde3f5f65a6f0157f1c538be9b938d3500d92455025d1a843283ff5544a4c9a4fbd2efdb034b9851d7ae0d7b9c4fd2a6f5f2bccba06653fa911a350bbaba30b

data/lib/hyperdrive/middleware.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'hyperdrive/middleware/accept'
+require 'hyperdrive/middleware/charset'
 require 'hyperdrive/middleware/cors'
 require 'hyperdrive/middleware/content_negotiation'
 require 'hyperdrive/middleware/error'

data/lib/hyperdrive/middleware/charset.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Hyperdrive
+  module Middleware
+    class Charset
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        unless %w(OPTIONS TRACE).include? env['REQUEST_METHOD']
+          charset = Rack::Accept::Charset.new(env['HTTP_ACCEPT_CHARSET'])
+          Hyperdrive::Utils.enforce_charset!(charset, env['hyperdrive.params'])
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/hyperdrive/server.rb

@@ -30,6 +30,7 @@ module Hyperdrive
             use Hyperdrive::Middleware::RequestMethod
             use Hyperdrive::Middleware::ParseJSONBody
             use Hyperdrive::Middleware::SanitizeParams
+            use Hyperdrive::Middleware::Charset
             use Hyperdrive::Middleware::Pagination
             use Hyperdrive::Middleware::RequiredParams
             use Hyperdrive::Middleware::CORS, hyperdrive.config[:cors]

data/lib/hyperdrive/utils.rb

@@ -23,5 +23,22 @@ module Hyperdrive
         ])
       end
     end
+
+    def self.enforce_charset!(charset, params)
+      encoding = charset.value == '*' ? 'UTF-8' : find_encoding(charset.value)
+      params.each_value do |value|
+        value.encode!(encoding) if value.is_a? String
+      end
+    end
+
+    private
+
+    def self.find_encoding(charset_value)
+      begin
+        Encoding.find(charset_value)
+      rescue
+        raise Hyperdrive::Errors::NotAcceptable.new(charset_value)
+      end
+    end
   end
 end

data/lib/hyperdrive/version.rb

@@ -1,3 +1,3 @@
 module Hyperdrive
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

data/spec/hyperdrive/middleware/charset_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Hyperdrive::Middleware::Charset do
+
+  def app
+    inner_app = ->(env) { [200, {}, [env['hyperdrive.params']]] }
+    Hyperdrive::Middleware::Charset.new(inner_app)
+  end
+
+  before do
+    @env = default_rack_env(default_resource).merge('hyperdrive.params' => {})
+    @env.merge!('REQUEST_METHOD' => 'POST')
+    @params = { id: '1001', name: 'John Connor'.encode('ASCII-8BIT') }
+  end
+
+  it "will enforce accept-charset encoding on param values" do
+    post '/', @params, @env.merge('hyperdrive.params' => @params)
+    last_response.body.must_equal "{:id=>\"1001\", :name=>\"John Connor\"}"
+  end
+end

data/spec/hyperdrive/utils_spec.rb

@@ -39,4 +39,28 @@ describe Hyperdrive::Utils do
       @subject[:collection].first[:skylanders].must_equal 155
     end
   end
+
+  context '.enforce_charset!' do
+    before do
+      @params = { id: '1001', name: 'John Connor'.encode('ASCII-8BIT') }
+    end
+
+    it 'enforces a specific encoding' do
+      encoding = Rack::Accept::Charset.new('ISO-8859-1')
+      Hyperdrive::Utils.enforce_charset!(encoding, @params)
+      @params[:name].encoding.must_equal Encoding.find('ISO-8859-1')
+    end
+
+    it 'enforces a default encoding' do
+      encoding = Rack::Accept::Charset.new('*')
+      Hyperdrive::Utils.enforce_charset!(encoding, @params)
+      @params[:name].encoding.must_equal Encoding.find('UTF-8')
+    end
+
+    it 'raises an exception for an invalid encoding' do
+      encoding = Rack::Accept::Charset.new('nonsense')
+      -> { Hyperdrive::Utils.enforce_charset!(encoding, @params) }
+        .must_raise Hyperdrive::Errors::NotAcceptable
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -32,7 +32,9 @@ module Hyperdrive
     def default_hyperdrive_env
       {
         'HTTP_ACCEPT' => 'application/vnd.hyperdrive.things+hal+json',
+        'HTTP_ACCEPT_CHARSET' => 'UTF-8',
         'hyperdrive.accept' => Rack::Accept::MediaType.new('HTTP_ACCEPT' => 'application/vnd.hyperdrive.things+hal+json;q=0.8'),
+        'hyperdrive.accept_charset' => Rack::Accept::Charset.new('HTTP_ACCEPT_CHARSET' => 'UTF-8'),
         'hyperdrive.resource' => hyperdrive.resources[:things],
         'hyperdrive.media_type' => 'application/vnd.hyperdrive.things+hal+json'
       }
@@ -54,6 +56,7 @@ module Hyperdrive
         'hyperdrive.media_type' => 'application/vnd.hyperdrive.things+hal+json'
       }
       default_env.merge!('hyperdrive.accept' => Rack::Accept::MediaType.new(default_env['HTTP_ACCEPT']))
+      default_env.merge!('hyperdrive.accept_charset' => Rack::Accept::Charset.new(default_env['HTTP_ACCEPT_CHARSET']))
       default_env.merge!('hyperdrive.resource' => resource) if resource
       default_env
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperdrive
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - StyleSeek Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linguistics
@@ -151,6 +151,7 @@ files:
 - lib/hyperdrive/instrumenters/noop.rb
 - lib/hyperdrive/middleware.rb
 - lib/hyperdrive/middleware/accept.rb
+- lib/hyperdrive/middleware/charset.rb
 - lib/hyperdrive/middleware/content_negotiation.rb
 - lib/hyperdrive/middleware/cors.rb
 - lib/hyperdrive/middleware/error.rb
@@ -188,6 +189,7 @@ files:
 - spec/hyperdrive/instrumenters/memory_spec.rb
 - spec/hyperdrive/instrumenters/noop_spec.rb
 - spec/hyperdrive/middleware/accept_spec.rb
+- spec/hyperdrive/middleware/charset_spec.rb
 - spec/hyperdrive/middleware/content_negotiation_spec.rb
 - spec/hyperdrive/middleware/cors_spec.rb
 - spec/hyperdrive/middleware/error_spec.rb
@@ -250,6 +252,7 @@ test_files:
 - spec/hyperdrive/instrumenters/memory_spec.rb
 - spec/hyperdrive/instrumenters/noop_spec.rb
 - spec/hyperdrive/middleware/accept_spec.rb
+- spec/hyperdrive/middleware/charset_spec.rb
 - spec/hyperdrive/middleware/content_negotiation_spec.rb
 - spec/hyperdrive/middleware/cors_spec.rb
 - spec/hyperdrive/middleware/error_spec.rb