faraday_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 797f339a60927cd80ecb7e6b6a61d992402e21cc
+  data.tar.gz: 181e9fbcff6c9a45754dd287bb54d71d09b695fb
+SHA512:
+  metadata.gz: dd2b02b134d0cc13fcca62b60669c62a5d9e5596337b1c06f0dc31d2a73ef7e9603e3a886467aa4995bfa336ff20b0f150b5bfe9c61fe28c7e56a17da6bd2118
+  data.tar.gz: 1d42a2368bc4d7525a000e32ffffda78a88332aadc771d1406d8cd4c61fc68a1ac0964a1e1c8782c119ff44e22215fdb11d569c7b59d54a9f8371ea4033316f5

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Editor files
+.*.sw*

data/.travis.yml

@@ -0,0 +1,25 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - jruby-head
+  - rbx-2
+  - ruby-head
+gemfile:
+  - Gemfile
+  - Gemfile-0.7.rb
+  - Gemfile-0.8.rb
+env:
+  - LC_ALL=C LANG=C
+  - LC_ALL=en_US.UTF-8 LANG=C
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+    - rvm: 2.2.2
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'json', :platforms => [:jruby, :rbx, :ruby_18]
+gem 'rake', '>= 0.9'
+
+group :test do
+  gem 'parallel', '= 1.3.3', :platforms => [:mri_19]
+  gem 'cane', '>= 2.2.2', :platforms => [:mri_19, :mri_20, :mri_21, :mri_22]
+  gem 'rspec', '>= 3'
+  gem 'simplecov'
+#  gem 'webmock'
+end
+
+platforms :ruby_18 do
+  gem 'iconv'
+end
+
+gemspec

data/Gemfile-0.7.rb

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../Gemfile', __FILE__))
+
+gem 'faraday', '~> 0.7.4'

data/Gemfile-0.7.rb.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    faraday_json (0.1.0)
+      faraday (>= 0.7.4, < 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    cane (2.6.2)
+      parallel
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    iconv (1.0.4)
+    json (1.8.2)
+    multipart-post (1.2.0)
+    parallel (1.3.3)
+    rack (1.6.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  cane (>= 2.2.2)
+  faraday (~> 0.7.4)
+  faraday_json!
+  iconv
+  json
+  parallel (= 1.3.3)
+  rake (>= 0.9)
+  rspec (>= 3)
+  simplecov

data/Gemfile-0.8.rb

@@ -0,0 +1,3 @@
+eval File.read(File.expand_path('../Gemfile', __FILE__))
+
+gem 'faraday', '~> 0.8.8'

data/Gemfile-0.8.rb.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    faraday_json (0.1.0)
+      faraday (>= 0.7.4, < 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cane (2.6.2)
+      parallel
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    iconv (1.0.4)
+    json (1.8.2)
+    multipart-post (1.2.0)
+    parallel (1.3.3)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  cane (>= 2.2.2)
+  faraday (~> 0.8.8)
+  faraday_json!
+  iconv
+  json
+  parallel (= 1.3.3)
+  rake (>= 0.9)
+  rspec (>= 3)
+  simplecov

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    faraday_json (0.1.0)
+      faraday (>= 0.7.4, < 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cane (2.6.2)
+      parallel
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    iconv (1.0.4)
+    json (1.8.2)
+    multipart-post (2.0.0)
+    parallel (1.3.3)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  cane (>= 2.2.2)
+  faraday_json!
+  iconv
+  json
+  parallel (= 1.3.3)
+  rake (>= 0.9)
+  rspec (>= 3)
+  simplecov

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright spriteCloud B.V. (http://www.spritecloud.com/) and other faraday_json
+contributors. All rights not covered below are reserved.
+
+MIT +no-false-attribs License
+
+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.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+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,30 @@
+# Introduction
+This is a character encoding-aware JSON middleware for Faraday.
+
+[![Build Status](https://travis-ci.org/spriteCloud/faraday_json.svg)](https://travis-ci.org/spriteCloud/faraday_json)
+
+The default JSON middleware from lostisland/faraday_middleware is not character
+encoding aware. This is problematic because by default, Ruby performs I/O based
+on locale settings. If your locale specifies one character encoding, but the
+request or response body is encoded in another, you will end up with a Ruby
+string that pretends to be one encoding, but cannot correctly be interpreted as
+such.
+
+Worse, Ruby 1.8 and later Ruby versions will not behave consistently, as 1.8
+does not yet understand character encodings internally. There is a lengthy
+discussion about this at https://bugs.ruby-lang.org/issues/2567 
+
+Still worse, JSON used to specify UTF-8 encoding as mandatory, but now loosened
+this to any Unicode character set. The result is that some JSON libraries still
+only understand UTF-8.
+
+This middleware fixes these issues rather brute-force by:
+
+  - Accepting the Content-Type charset value as the correct encoding, and
+    converting the body from Faraday adapters to this encoding.
+  - Only sending UTF-8 encoded JSON, converting raw data if necessary.
+  - Always setting the UTF-8 charset when sending this UTF-8 encoded JSON.
+
+When no charset is provided, all bets are off. The correct default would be to
+assume US-ASCII, but that may break some code. This middleware lets you override
+this default.

data/Rakefile

@@ -0,0 +1,28 @@
+ruby_19 = RUBY_VERSION > '1.9'
+ruby_mri = !defined?(RUBY_ENGINE) || 'ruby' == RUBY_ENGINE
+default_gemfile = ENV['BUNDLE_GEMFILE'] =~ /Gemfile$/
+
+if ruby_19 && ruby_mri && default_gemfile
+  task :default => [:enable_coverage, :spec, :quality]
+else
+  task :default => [:spec]
+end
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :enable_coverage do
+  ENV['COVERAGE'] = 'yes'
+end
+
+desc %(Check code quality metrics with Cane)
+task :quality do
+  sh 'cane',
+    '--abc-max=15',
+    '--style-measure=110',
+    '--gte=coverage/covered_percent,88.89',
+    '--max-violations=0'
+end

data/faraday_json.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_json"
+  spec.version       = FaradayJSON::VERSION
+  spec.authors       = ["Jens Finkhaeuser"]
+  spec.email         = ["foss@spritecloud.com"]
+  spec.description   = %q{This is a character encoding-aware JSON middleware for Faraday.}
+  spec.summary       = %q{This is a character encoding-aware JSON middleware for Faraday.}
+  spec.homepage      = "https://github.com/spriteCloud/faraday_json"
+  spec.license       = "MITNFA"
+
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'faraday', ['>= 0.7.4', '< 0.10']
+end

data/lib/faraday_json.rb

@@ -0,0 +1,22 @@
+#
+# FaradayJSON
+# https://github.com/spriteCloud/faraday_json
+#
+# Copyright (c) 2015 spriteCloud B.V. and other FaradayJSON contributors.
+# All rights reserved.
+#
+
+require 'faraday'
+
+module FaradayJSON
+  autoload :ParseJson,       'faraday_json/parse_json'
+
+  if Faraday::Middleware.respond_to? :register_middleware
+    Faraday::Request.register_middleware \
+      :json     => lambda { EncodeJson }
+
+    Faraday::Response.register_middleware \
+      :json     => lambda { ParseJson },
+      :json_fix => lambda { ParseJsonMimeTypeFix }
+  end
+end

data/lib/faraday_json/encode_json.rb

@@ -0,0 +1,94 @@
+#
+# FaradayJSON
+# https://github.com/spriteCloud/faraday_json
+#
+# Copyright (c) 2015 spriteCloud B.V. and other FaradayJSON contributors.
+# All rights reserved.
+#
+
+require 'faraday'
+require 'faraday_json/encoding'
+
+module FaradayJSON
+  # Request middleware that encodes the body as JSON.
+  #
+  # Processes only requests with matching Content-type or those without a type.
+  # If a request doesn't have a type but has a body, it sets the Content-type
+  # to JSON MIME-type.
+  #
+  # Doesn't try to encode bodies that already are in string form.
+  class EncodeJson < Faraday::Middleware
+    CONTENT_TYPE   = 'Content-Type'.freeze
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    MIME_TYPE      = 'application/json'.freeze
+    MIME_TYPE_UTF8 = 'application/json; charset=utf-8'.freeze
+
+    include ::FaradayJSON::Encoding
+
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
+
+    def call(env)
+      if process_request?(env)
+        body = env[:body]
+
+        # Detect and honour input charset. Basically, all requests without a
+        # charset should be considered malformed, but we can make a best guess.
+        # Whether the body is a string or another data structure does not
+        # matter: all strings *contained* within it must be encoded properly.
+        charset = request_charset(env)
+
+        # Strip BOM, if any
+        body = strip_bom(body, charset, { 'default_encoding' => 'us-ascii' })
+
+        # Transcode to UTF-8
+        body = to_utf8(body, charset, { 'force_input_charset' => true })
+
+        # If the body is a stirng, we assume it's already JSON. No further
+        # processing is necessary.
+        # XXX Is :to_str really a good indicator for Strings? Taken from old
+        #     code.
+        if not body.respond_to?(:to_str)
+          # If body isn't a string yet, we need to encode it. We also know it's
+          # then going to be UTF-8, because JSON defaults to that.
+          # Thanks to to_utf8 above, JSON.dump should not have any issues here.
+          body = ::JSON.dump(body)
+        end
+
+        env[:body] = body
+
+        # We'll add a content length, because otherwise we're relying on every
+        # component down the line properly interpreting UTF-8 - that can fail.
+        env[:request_headers][CONTENT_LENGTH] ||= env[:body].bytesize
+
+        # Always base the encoding we're sending in the content type header on
+        # the string encoding.
+        env[:request_headers][CONTENT_TYPE] = MIME_TYPE_UTF8
+      end
+      @app.call env
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      has_body?(env) and (type.empty? or type == MIME_TYPE)
+    end
+
+    def request_charset(env)
+      enc = env[:request_headers][CONTENT_TYPE].to_s
+      enc = enc.split(';', 2).last if enc.index(';')
+      enc = enc.split('=', 2).last if enc.index('=')
+      return enc
+    end
+
+    def has_body?(env)
+      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+    end
+
+    def request_type(env)
+      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+  end
+end