Merge pull request #115 from Talkdesk/fix-faraday-encoder

Fix dropped values from queries by using FlatParamsEncoder

Author: dblock

.rubocop_todo.yml

@@ -25,7 +25,7 @@ Metrics/MethodLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 391
+  Max: 398
 
 # Offense count: 1
 Style/AsciiComments:

.travis.yml

@@ -10,13 +10,18 @@ matrix:
     - rvm: 2.3.1
     - rvm: 2.3.0
     - rvm: 2.2.5
+    - rvm: 2.4.0
     - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: jruby-9.1.6.0
+    - rvm: jruby-9.1.7.0
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-2
 
+before_install:
+  - gem update --system
+  - gem install bundler
+
 bundler_args: --without development

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 0.8.3 (Next)
 
+* [#115](https://github.com/codegram/hyperclient/pull/115): Fix dropped values from queries by using FlatParamsEncoder - [@ivoanjo](https://github.com/ivoanjo).
 * Your contribution here.
 
 ### 0.8.2 (December 31, 2016)

features/api_navigation.feature

@@ -12,6 +12,11 @@ Feature: API navigation
     When I search for a post with a templated link
     Then the API should receive the request with all the params
 
+  Scenario: Templated links with multiple values
+    Given I connect to the API
+    When I search for posts by tag with a templated link
+    Then the API should receive the request for posts by tag with all the params
+
   Scenario: Attributes
     Given I connect to the API
     When I load a single post

features/steps/api_navigation.rb

@@ -17,6 +17,14 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
     assert_requested :get, 'http://api.example.org/search?q=something'
   end
 
+  step 'I search for posts by tag with a templated link' do
+    api._links.tagged._expand(tags: %w(foo bar))._resource
+  end
+
+  step 'the API should receive the request for posts by tag with all the params' do
+    assert_requested :get, 'http://api.example.org/search?tags=foo&tags=bar'
+  end
+
   step 'I load a single post' do
     @post = api._links.posts._links.last_post
   end

features/support/api.rb

@@ -5,6 +5,8 @@ module API
   include Spinach::Fixtures
 
   before do
+    WebMock::Config.instance.query_values_notation = :flat_array
+
     stub_request(:any, %r{api.example.org*}).to_return(body: root_response, headers: { 'Content-Type' => 'application/hal+json' })
     stub_request(:get, 'api.example.org/posts').to_return(body: posts_response, headers: { 'Content-Type' => 'application/hal+json' })
     stub_request(:get, 'api.example.org/posts/1').to_return(body: post_response, headers: { 'Content-Type' => 'application/hal+json' })

features/support/fixtures.rb

@@ -8,6 +8,7 @@ def root_response
               "self": { "href": "/" },
               "posts": { "href": "/posts" },
               "search": { "href": "/search{?q}", "templated": true },
+              "tagged": { "href": "/search{?tags*}", "templated": true },
               "api:authors": { "href": "/authors" },
               "next": { "href": "/page2" }
           }

lib/hyperclient/entry_point.rb

@@ -40,6 +40,7 @@ def initialize(url, &_block)
       @entry_point = self
       @options = { async: true }
       @connection = nil
+      @resource = nil
       yield self if block_given?
     end
 
@@ -138,6 +139,7 @@ def default_faraday_block
         connection.request :hal_json
         connection.response :hal_json, content_type: /\bjson$/
         connection.adapter :net_http
+        connection.options.params_encoder = Faraday::FlatParamsEncoder
       end
     end
 

test/hyperclient/entry_point_test.rb

@@ -33,11 +33,14 @@ module Hyperclient
 
         it 'creates a Faraday connection with the default block' do
           handlers = entry_point.connection.builder.handlers
+
           handlers.must_include Faraday::Response::RaiseError
           handlers.must_include FaradayMiddleware::FollowRedirects
           handlers.must_include FaradayMiddleware::EncodeHalJson
           handlers.must_include FaradayMiddleware::ParseHalJson
           handlers.must_include Faraday::Adapter::NetHttp
+
+          entry_point.connection.options.params_encoder.must_equal Faraday::FlatParamsEncoder
         end
 
         it 'raises a  ConnectionAlreadyInitializedError if attempting to modify headers' do
@@ -172,12 +175,15 @@ module Hyperclient
 
         it 'creates a Faraday connection with the default block plus any additional handlers' do
           handlers = entry_point.connection.builder.handlers
+
           handlers.must_include Faraday::Request::OAuth
           handlers.must_include Faraday::Response::RaiseError
           handlers.must_include FaradayMiddleware::FollowRedirects
           handlers.must_include FaradayMiddleware::EncodeHalJson
           handlers.must_include FaradayMiddleware::ParseHalJson
           handlers.must_include Faraday::Adapter::NetHttp
+
+          entry_point.connection.options.params_encoder.must_equal Faraday::FlatParamsEncoder
         end
       end
     end