faraday_hal_middleware 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7dfcf33673587d8a191c777693982e0a57fbb62c
-  data.tar.gz: 4574a17a050286f76b88dcbe37dc0d48b79f36d5
+SHA256:
+  metadata.gz: 129ae7965c9e0d8c0e7b4e83386f4555a1b694d704b559f18e7f62e16b815851
+  data.tar.gz: 639ae15211c5ec76fe2e29492a7c0fc2791127eddfd65360fb9442453cd7d825
 SHA512:
-  metadata.gz: b64e1ff0ae0429c6bea0d9cf35c186af9f813299599da0cea2485b5e5361a42e672adc2b4909237121c111e700e8eb535ce16843c2afde1e42aaf51ff9408942
-  data.tar.gz: dbe371ddfa9e31b8d30ae33953e7a25d873d4f69e3bf36424af9c81aa1d82d646c2fdc69c2472de9a96fd64c721b7e2b8eb54d651a63ebef9584eea575396bf0
+  metadata.gz: cd2271ad2df1acec1af6c6eeaba8ba187869a4196e0bb7d3a0c1b7b44f9fd699fe73d2affc7286d136f4e933c672673b236ef5aee11d9c40910f4cd7013442d5
+  data.tar.gz: 85c9cac01aa86c83994a19336db03754e9530b0dbe047c2a7fa11c51c6f996ea4921fdde98c51cf2c5c44360be6be2c428c227b87ce55c4fcd01014c460ac523

data/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: lint
+on: [push, pull_request]
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle exec rubocop
+

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+---
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
+    name: test (${{ matrix.ruby }})
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install --jobs=3 --retry=3 --path=vendor/bundle
+      - run: bundle exec rake spec

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,83 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-02-01 13:35:51 UTC using RuboCop version 1.60.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'faraday_hal_middleware.gemspec'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 10
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/unit/request_spec.rb'
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/unit/request_spec.rb'
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 7
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/unit/request_spec.rb'
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 4
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/unit/response_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/faraday/hal_json.rb'

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+### 0.2.0 (2024/02/01)
+
+* [#11](https://github.com/fetch/faraday_hal_middleware/pull/11): Refactor into Faraday::HalJson::Request and Response - [@dblock](https://github.com/dblock).
+* [#9](https://github.com/fetch/faraday_hal_middleware/pull/9): Added support for Faraday 2, removed dependency on deprecated `faraday_hal_middleware` - [@dblock](https://github.com/dblock).
+
+### 0.1.1 (2020/05/10)
+
+* [#6](https://github.com/fetch/faraday_hal_middleware/pull/6): Added CHANGELOG, CONTRIBUTING and RELEASING - [@dblock](https://github.com/dblock).
+* [#5](https://github.com/fetch/faraday_hal_middleware/pull/5): Added RuboCop, Ruby-style linter - [@dblock](https://github.com/dblock).
+* [#4](https://github.com/fetch/faraday_hal_middleware/pull/4): Added Travis-CI - [@dblock](https://github.com/dblock).
+* [#7](https://github.com/fetch/faraday_hal_middleware/pull/7): Require `faraday_middleware` >= 0.9 - [@dblock](https://github.com/dblock).
+
+### 0.1.0 (2018/01/10)
+
+* [#1](https://github.com/fetch/faraday_hal_middleware/pull/1): Loosen Faraday dependency - [@espen](https://github.com/espen).
+
+### 0.0.1 (2014/12/01)
+
+* Initial public release - [@koenpunt](https://github.com/koenpunt).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to FaradayHalMiddleware
+
+This project is work of [many contributors](https://github.com/fetch/faraday_hal_middleware/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/fetch/faraday_hal_middleware/pulls), [propose features and discuss issues](https://github.com/fetch/faraday_hal_middleware/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/fetch/faraday_hal_middleware) and check out your copy.
+
+```
+git clone https://github.com/contributor/faraday_hal_middleware.git
+cd faraday_hal_middleware
+git remote add upstream https://github.com/fetch/faraday_hal_middleware.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/faraday_hal_middleware and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/fetch/faraday_hal_middleware/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'json'
 gem 'rake', '>= 0.9'
 
+group :development do
+  gem 'rubocop', '1.60.2'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+end
+
 group :test do
   gem 'rspec', '>= 3'
   gem 'webmock'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Koen Punt <koen@fetch.nl>
+Copyright (c) 2014-2018 Koen Punt <koen@fetch.nl> and contributors.
 
 MIT License
 

data/README.md

@@ -1,29 +1,42 @@
 # FaradayHalMiddleware
 
-Faraday Middleware for JSON HAL requests and responses
+[Faraday](https://github.com/lostisland/faraday) Middleware for JSON HAL requests and responses with `application/hal+json` content-type.
+
+[![test](https://github.com/fetch/faraday_hal_middleware/actions/workflows/test.yml/badge.svg)](https://github.com/fetch/faraday_hal_middleware/actions/workflows/test.yml)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'faraday_hal_middleware'
+```ruby
+gem 'faraday_hal_middleware'
+```
+
+Use version 0.1.1 for Faraday 1.x, and >= 0.2.0 for newer versions of Faraday.
 
-And then execute:
+## Usage
 
-    $ bundle
+Use `faraday_hal_middleware`.
 
-Or install it yourself as:
+```ruby
+require 'faraday_hal_middleware'
 
-    $ gem install faraday_hal_middleware
+connection = Faraday.new 'http://example.com/api' do |conn|
+  conn.request :hal_json
+  conn.response :hal_json, content_type: /\bjson$/
 
-## Usage
+  conn.adapter Faraday.default_adapter
+end
+```
 
-TODO: Write usage instructions here
+This gem is notably used in [Hyperclient](https://github.com/codegram/hyperclient), see [hyperclient#81](https://github.com/codegram/hyperclient/pull/81) for details.
 
 ## 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
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright & License
+
+Copyright (c) 2014-2018 Koen Punt <koen@fetch.nl> and contributors.
+
+MIT License, see [LICENSE.txt](LICENSE.txt) for details.

data/RELEASING.md

@@ -0,0 +1,61 @@
+# Releasing FaradayHalMiddleware
+
+There're no hard rules about when to release faraday_hal_middleware. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/fetch/faraday_hal_middleware) for all supported platforms.
+
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+faraday_hal_middleware 0.2.2 built to pkg/faraday_hal_middleware-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed faraday_hal_middleware 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/google-finance/version.rb](lib/google-finance/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/google-finance/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -1,6 +1,11 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
 
-task :default => [:spec]
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/faraday_hal_middleware.gemspec

@@ -1,25 +1,24 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'faraday_hal_middleware/version'
+
+require 'faraday/hal_json/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'faraday_hal_middleware'
-  spec.version       = FaradayHalMiddleware::VERSION
+  spec.version       = Faraday::HalJson::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.summary       = 'Faraday Middleware for JSON HAL requests and responses.'
+  spec.description   = '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']
-
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/faraday/hal_json/request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Faraday
+  module HalJson
+    # 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 Request < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'
+      MIME_TYPE    = 'application/hal+json'
+
+      def on_request(env)
+        match_content_type(env) do |data|
+          env[:body] = encode(data)
+        end
+      end
+
+      private
+
+      def encode(data)
+        if options[:encoder].is_a?(Array) && options[:encoder].size >= 2
+          options[:encoder][0].public_send(options[:encoder][1], data)
+        elsif options[:encoder].respond_to?(:dump)
+          options[:encoder].dump(data)
+        else
+          ::JSON.generate(data)
+        end
+      end
+
+      def match_content_type(env)
+        return unless process_request?(env)
+
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        body?(env) && (type.empty? || type == MIME_TYPE)
+      end
+
+      def body?(env)
+        body = env[:body]
+        case body
+        when true, false
+          true
+        when nil
+          # NOTE: nil can be converted to `"null"`, but this middleware doesn't process `nil` for the compatibility.
+          false
+        else
+          !(body.respond_to?(:to_str) && body.empty?)
+        end
+      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
+end

data/lib/faraday/hal_json/response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Faraday
+  module HalJson
+    # JSON+HAL is just JSON
+    class Response < ::Faraday::Response::Json; end
+  end
+end

data/lib/faraday/hal_json/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module HalJson
+    VERSION = '0.2.0'
+  end
+end

data/lib/faraday/hal_json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'hal_json/version'
+require_relative 'hal_json/request'
+require_relative 'hal_json/response'
+
+module Faraday
+  module HalJson
+    ::Faraday::Request.register_middleware(hal_json: ::Faraday::HalJson::Request)
+    ::Faraday::Response.register_middleware(hal_json: ::Faraday::HalJson::Response)
+  end
+end

data/lib/faraday_hal_middleware.rb

@@ -1,20 +1,4 @@
-require 'faraday_hal_middleware/version'
-require 'faraday'
-require 'faraday_middleware'
-
-module FaradayHalMiddleware
-
-end
+# frozen_string_literal: true
 
-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
+require 'faraday'
+require_relative 'faraday/hal_json'

data/spec/spec_helper.rb

@@ -1,43 +1,11 @@
+# frozen_string_literal: true
+
 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
+require 'faraday_hal_middleware'
 
 RSpec.configure do |config|
-  config.include EnvCompatibility
-  config.include ResponseMiddlewareExampleGroup, :type => :response
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

data/spec/unit/{encode_hal_json_spec.rb → request_spec.rb}

@@ -1,18 +1,26 @@
-require 'faraday_middleware/request/encode_hal_json'
+# frozen_string_literal: true
 
-describe FaradayMiddleware::EncodeHalJson do
-  let(:middleware) { described_class.new(lambda{|env| env}) }
+require 'spec_helper'
+
+# mostly https://github.com/lostisland/faraday/blob/main/spec/faraday/request/json_spec.rb
+describe Faraday::HalJson::Request, type: :request do
+  let(:middleware) { described_class.new(->(env) { Faraday::Response.new(env) }) }
 
   def process(body, content_type = nil)
-    env = {:body => body, :request_headers => Faraday::Utils::Headers.new}
+    env = { body: body, request_headers: Faraday::Utils::Headers.new }
     env[:request_headers]['content-type'] = content_type if content_type
-    middleware.call(faraday_env(env))
+    middleware.call(Faraday::Env.from(env)).env
+  end
+
+  def result_body
+    result[:body]
   end
 
-  def result_body() result[:body] end
-  def result_type() result[:request_headers]['content-type'] end
+  def result_type
+    result[:request_headers]['content-type']
+  end
 
-  context "no body" do
+  context 'no body' do
     let(:result) { process(nil) }
 
     it "doesn't change body" do
@@ -24,7 +32,7 @@ describe FaradayMiddleware::EncodeHalJson do
     end
   end
 
-  context "empty body" do
+  context 'empty body' do
     let(:result) { process('') }
 
     it "doesn't change body" do
@@ -36,42 +44,42 @@ describe FaradayMiddleware::EncodeHalJson do
     end
   end
 
-  context "string body" do
+  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
+    it 'adds content type' do
       expect(result_type).to eq('application/hal+json')
     end
   end
 
-  context "object body" do
-    let(:result) { process({:a => 1}) }
+  context 'object body' do
+    let(:result) { process(a: 1) }
 
-    it "encodes body" do
+    it 'encodes body' do
       expect(result_body).to eq('{"a":1}')
     end
 
-    it "adds content type" do
+    it 'adds content type' do
       expect(result_type).to eq('application/hal+json')
     end
   end
 
-  context "empty object body" do
+  context 'empty object body' do
     let(:result) { process({}) }
 
-    it "encodes body" do
+    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') }
+  context 'object body with json type' do
+    let(:result) { process({ a: 1 }, 'application/hal+json; charset=utf-8') }
 
-    it "encodes body" do
+    it 'encodes body' do
       expect(result_body).to eq('{"a":1}')
     end
 
@@ -80,11 +88,11 @@ describe FaradayMiddleware::EncodeHalJson do
     end
   end
 
-  context "object body with incompatible type" do
-    let(:result) { process({:a => 1}, 'application/xml; charset=utf-8') }
+  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})
+      expect(result_body).to eq(a: 1)
     end
 
     it "doesn't change content type" do

data/spec/unit/response_spec.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# copy of https://github.com/lostisland/faraday/blob/main/spec/faraday/response/json_spec.rb
+describe Faraday::HalJson::Response do
+  let(:options) { {} }
+  let(:headers) { {} }
+  let(:middleware) do
+    described_class.new(lambda { |env|
+      Faraday::Response.new(env)
+    }, **options)
+  end
+
+  def process(body, content_type = 'application/json', 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.from(env))
+  end
+
+  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
+  end
+
+  context 'with default regexp type matching' do
+    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
+    expect { process('{!') }.to raise_error(Faraday::ParsingError)
+  end
+
+  it 'includes the response on the ParsingError instance' do
+    process('{') { |env| env[:response] = Faraday::Response.new }
+    raise 'Parsing should have failed.'
+  rescue Faraday::ParsingError => e
+    expect(e.response).to be_a(Faraday::Response)
+  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
+
+  context 'JSON options' do
+    let(:body) { '{"a": 1}' }
+    let(:result) { { a: 1 } }
+    let(:options) do
+      {
+        parser_options: {
+          symbolize_names: true
+        }
+      }
+    end
+
+    it 'passes relevant options to JSON parse' do
+      expect(JSON).to receive(:parse)
+        .with(body, options[:parser_options])
+        .and_return(result)
+
+      response = process(body)
+      expect(response.body).to eq(result)
+    end
+  end
+
+  context 'with decoder' do
+    let(:decoder) do
+      double('Decoder').tap do |e|
+        allow(e).to receive(:load) { |s, opts| JSON.parse(s, opts) }
+      end
+    end
+
+    let(:body) { '{"a": 1}' }
+    let(:result) { { a: 1 } }
+
+    context 'when decoder is passed as object' do
+      let(:options) do
+        {
+          parser_options: {
+            decoder: decoder,
+            option: :option_value,
+            symbolize_names: true
+          }
+        }
+      end
+
+      it 'passes relevant options to specified decoder\'s load method' do
+        expect(decoder).to receive(:load)
+          .with(body, { option: :option_value, symbolize_names: true })
+          .and_return(result)
+
+        response = process(body)
+        expect(response.body).to eq(result)
+      end
+    end
+
+    context 'when decoder is passed as an object-method pair' do
+      let(:options) do
+        {
+          parser_options: {
+            decoder: [decoder, :load],
+            option: :option_value,
+            symbolize_names: true
+          }
+        }
+      end
+
+      it 'passes relevant options to specified decoder\'s method' do
+        expect(decoder).to receive(:load)
+          .with(body, { option: :option_value, symbolize_names: true })
+          .and_return(result)
+
+        response = process(body)
+        expect(response.body).to eq(result)
+      end
+    end
+
+    context 'when decoder is not passed' do
+      let(:options) do
+        {
+          parser_options: {
+            symbolize_names: true
+          }
+        }
+      end
+
+      it 'passes relevant options to JSON parse' do
+        expect(JSON).to receive(:parse)
+          .with(body, { symbolize_names: true })
+          .and_return(result)
+
+        response = process(body)
+        expect(response.body).to eq(result)
+      end
+    end
+  end
+end

metadata

@@ -1,69 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: faraday_hal_middleware
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Koen Punt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday
   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'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-description: Faraday Middleware for JSON HAL requests and responses
+        version: '2.0'
+description: Faraday Middleware for JSON HAL requests and responses.
 email:
 - koen@fetch.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - faraday_hal_middleware.gemspec
+- lib/faraday/hal_json.rb
+- lib/faraday/hal_json/request.rb
+- lib/faraday/hal_json/response.rb
+- lib/faraday/hal_json/version.rb
 - 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
+- spec/unit/request_spec.rb
+- spec/unit/response_spec.rb
 homepage: https://github.com/fetch/faraday_hal_middleware
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,12 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.6
+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
+summary: Faraday Middleware for JSON HAL requests and responses.
+test_files: []

data/lib/faraday_hal_middleware/version.rb

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

data/lib/faraday_middleware/request/encode_hal_json.rb

@@ -1,52 +0,0 @@
-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

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

data/spec/unit/parse_hal_json_spec.rb

@@ -1,79 +0,0 @@
-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'].each do |data|
-      expect{ process(data) }.to raise_error(Faraday::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