faraday_hal_middleware 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3637cc5447e62741f3caaa3e072397a77f1f0cb
+  data.tar.gz: 8e04a568630bc6483f97244fca384369c4c45550
+SHA512:
+  metadata.gz: 281711339d4ba5c6b6269ba6d030401554d503b7da0c90f52138416364c27770a96d0f772ab5c31656a2de410f8869da4007b0bcafdc9d7c8d603a763959dc3a
+  data.tar.gz: a52c62b9784cde48d71dc48f1dea6ae4588283c4e3a953ca0d03b78263ef32f40d746bca51b030901ab89af520a36956d62deee8cddc713fd9d99bf616f873eb

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'json'
+gem 'rake', '>= 0.9'
+
+group :test do
+  gem 'rspec', '>= 3'
+  gem 'webmock'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Koen Punt <koen@fetch.nl>
+
+MIT 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.
+
+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,29 @@
+# FaradayHalMiddleware
+
+Faraday Middleware for JSON HAL requests and responses
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faraday_hal_middleware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_hal_middleware
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/fetch/faraday_hal_middleware/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/faraday_hal_middleware.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_hal_middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faraday_hal_middleware'
+  spec.version       = FaradayHalMiddleware::VERSION
+  spec.authors       = ['Koen Punt']
+  spec.email         = ['koen@fetch.nl']
+  spec.summary       = %q{Faraday Middleware for JSON HAL requests and responses}
+  spec.description   = %q{Faraday Middleware for JSON HAL requests and responses}
+  spec.homepage      = 'https://github.com/fetch/faraday_hal_middleware'
+  spec.license       = 'MIT'
+
+  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_dependency 'faraday_middleware', ['>= 0.9', '< 0.10']
+
+end

data/lib/faraday_hal_middleware.rb

@@ -0,0 +1,20 @@
+require 'faraday_hal_middleware/version'
+require 'faraday'
+require 'faraday_middleware'
+
+module FaradayHalMiddleware
+
+end
+
+module FaradayMiddleware
+  autoload :EncodeHalJson,     'faraday_middleware/request/encode_hal_json'
+  autoload :ParseHalJson,      'faraday_middleware/response/parse_hal_json'
+
+  if Faraday::Middleware.respond_to? :register_middleware
+    Faraday::Request.register_middleware \
+          :hal_json    => lambda { EncodeHalJson }
+
+    Faraday::Response.register_middleware \
+          :hal_json    => lambda { ParseHalJson }
+  end
+end

data/lib/faraday_hal_middleware/version.rb

@@ -0,0 +1,3 @@
+module FaradayHalMiddleware
+  VERSION = "0.0.1"
+end

data/lib/faraday_middleware/request/encode_hal_json.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+
+module FaradayMiddleware
+  # 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 EncodeHalJson < Faraday::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+    MIME_TYPE    = 'application/hal+json'.freeze
+
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
+
+    def call(env)
+      match_content_type(env) do |data|
+        env[:body] = encode data
+      end
+      @app.call env
+    end
+
+    def encode(data)
+      ::JSON.dump data
+    end
+
+    def match_content_type(env)
+      if process_request?(env)
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      has_body?(env) and (type.empty? or type == MIME_TYPE)
+    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

data/lib/faraday_middleware/response/parse_hal_json.rb

@@ -0,0 +1,7 @@
+require 'faraday_middleware/response/parse_json'
+
+module FaradayMiddleware
+  # JSON+HAL is just JSON
+  class ParseHalJson < ParseJson
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'faraday'
+
+module EnvCompatibility
+  def faraday_env(env)
+    if defined?(Faraday::Env)
+      Faraday::Env.from(env)
+    else
+      env
+    end
+  end
+end
+
+module ResponseMiddlewareExampleGroup
+  def self.included(base)
+    base.let(:options) { Hash.new }
+    base.let(:headers) { Hash.new }
+    base.let(:middleware) {
+      described_class.new(lambda {|env|
+        Faraday::Response.new(env)
+      }, options)
+    }
+  end
+
+  def process(body, content_type = nil, options = {})
+    env = {
+      :body => body, :request => options,
+      :request_headers => Faraday::Utils::Headers.new,
+      :response_headers => Faraday::Utils::Headers.new(headers)
+    }
+    env[:response_headers]['content-type'] = content_type if content_type
+    yield(env) if block_given?
+    middleware.call(faraday_env(env))
+  end
+end
+
+RSpec.configure do |config|
+  config.include EnvCompatibility
+  config.include ResponseMiddlewareExampleGroup, :type => :response
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/encode_hal_json_spec.rb

@@ -0,0 +1,94 @@
+require 'faraday_middleware/request/encode_hal_json'
+
+describe FaradayMiddleware::EncodeHalJson do
+  let(:middleware) { described_class.new(lambda{|env| env}) }
+
+  def process(body, content_type = nil)
+    env = {:body => body, :request_headers => Faraday::Utils::Headers.new}
+    env[:request_headers]['content-type'] = content_type if content_type
+    middleware.call(faraday_env(env))
+  end
+
+  def result_body() result[:body] end
+  def result_type() result[:request_headers]['content-type'] end
+
+  context "no body" do
+    let(:result) { process(nil) }
+
+    it "doesn't change body" do
+      expect(result_body).to be_nil
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context "empty body" do
+    let(:result) { process('') }
+
+    it "doesn't change body" do
+      expect(result_body).to be_empty
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context "string body" do
+    let(:result) { process('{"a":1}') }
+
+    it "doesn't change body" do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it "adds content type" do
+      expect(result_type).to eq('application/hal+json')
+    end
+  end
+
+  context "object body" do
+    let(:result) { process({:a => 1}) }
+
+    it "encodes body" do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it "adds content type" do
+      expect(result_type).to eq('application/hal+json')
+    end
+  end
+
+  context "empty object body" do
+    let(:result) { process({}) }
+
+    it "encodes body" do
+      expect(result_body).to eq('{}')
+    end
+  end
+
+  context "object body with json type" do
+    let(:result) { process({:a => 1}, 'application/hal+json; charset=utf-8') }
+
+    it "encodes body" do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/hal+json; charset=utf-8')
+    end
+  end
+
+  context "object body with incompatible type" do
+    let(:result) { process({:a => 1}, 'application/xml; charset=utf-8') }
+
+    it "doesn't change body" do
+      expect(result_body).to eq({:a => 1})
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/xml; charset=utf-8')
+    end
+  end
+end

data/spec/unit/parse_hal_json_spec.rb

@@ -0,0 +1,79 @@
+require 'faraday_middleware/response/parse_hal_json'
+
+describe FaradayMiddleware::ParseHalJson, :type => :response do
+  context "no type matching" do
+    it "doesn't change nil body" do
+      expect(process(nil).body).to be_nil
+    end
+
+    it "nullifies empty body" do
+      expect(process('').body).to be_nil
+    end
+
+    it "parses json body" do
+      response = process('{"a":1}')
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to be_nil
+    end
+  end
+
+  context "with preserving raw" do
+    let(:options) { {:preserve_raw => true} }
+
+    it "parses json body" do
+      response = process('{"a":1}')
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to eq('{"a":1}')
+    end
+
+    it "can opt out of preserving raw" do
+      response = process('{"a":1}', nil, :preserve_raw => false)
+      expect(response.env[:raw_body]).to be_nil
+    end
+  end
+
+  context "with regexp type matching" do
+    let(:options) { {:content_type => /\bjson$/} }
+
+    it "parses json body of correct type" do
+      response = process('{"a":1}', 'application/x-json')
+      expect(response.body).to eq('a' => 1)
+    end
+
+    it "ignores json body of incorrect type" do
+      response = process('{"a":1}', 'text/json-xml')
+      expect(response.body).to eq('{"a":1}')
+    end
+  end
+
+  context "with array type matching" do
+    let(:options) { {:content_type => %w[a/b c/d]} }
+
+    it "parses json body of correct type" do
+      expect(process('{"a":1}', 'a/b').body).to be_a(Hash)
+      expect(process('{"a":1}', 'c/d').body).to be_a(Hash)
+    end
+
+    it "ignores json body of incorrect type" do
+      expect(process('{"a":1}', 'a/d').body).not_to be_a(Hash)
+    end
+  end
+
+  it "chokes on invalid json" do
+    ['{!', '"a"', 'true', 'null', '1'].each do |data|
+      expect{ process(data) }.to raise_error(Faraday::Error::ParsingError)
+    end
+  end
+
+  context "HEAD responses" do
+    it "nullifies the body if it's only one space" do
+      response = process(' ')
+      expect(response.body).to be_nil
+    end
+
+    it "nullifies the body if it's two spaces" do
+      response = process(' ')
+      expect(response.body).to be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: faraday_hal_middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Koen Punt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Faraday Middleware for JSON HAL requests and responses
+email:
+- koen@fetch.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday_hal_middleware.gemspec
+- lib/faraday_hal_middleware.rb
+- lib/faraday_hal_middleware/version.rb
+- lib/faraday_middleware/request/encode_hal_json.rb
+- lib/faraday_middleware/response/parse_hal_json.rb
+- spec/spec_helper.rb
+- spec/unit/encode_hal_json_spec.rb
+- spec/unit/parse_hal_json_spec.rb
+homepage: https://github.com/fetch/faraday_hal_middleware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Faraday Middleware for JSON HAL requests and responses
+test_files:
+- spec/spec_helper.rb
+- spec/unit/encode_hal_json_spec.rb
+- spec/unit/parse_hal_json_spec.rb
+has_rdoc: