Add faraday-encoding to correctly set the response body encoding (#65)

* Fix response encoding

* rubocop

Co-authored-by: Chris Nelson <git@chrisnelson.io>

Author: chrisrbnelson

Gemfile.lock

@@ -4,36 +4,36 @@ PATH
     xpm_ruby (0.1.0)
       activesupport
       builder
-      dry-types
+      dry-types (~> 0.15.0)
       faraday
+      faraday-encoding
       ox (~> 2.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.0)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    dry-configurable (0.11.5)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
+    dry-inflector (0.2.1)
     dry-logic (0.6.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
@@ -45,15 +45,34 @@ GEM
       dry-equalizer (~> 0.2, >= 0.2.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.5, >= 0.5)
-    faraday (1.0.1)
+    faraday (1.6.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    i18n (1.8.2)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-encoding (0.0.5)
+      faraday
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     method_source (1.0.0)
-    minitest (5.14.0)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    ox (2.13.2)
+    ox (2.14.5)
     parallel (1.19.1)
     parser (2.7.1.1)
       ast (~> 2.4.0)
@@ -90,12 +109,12 @@ GEM
     rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     vcr (5.1.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

lib/xpm_ruby/connection.rb

@@ -1,4 +1,5 @@
 require "faraday"
+require "faraday/encoding"
 require "base64"
 
 module XpmRuby
@@ -12,8 +13,7 @@ def initialize(access_token:, xero_tenant_id:, url: nil)
     end
 
     def get(endpoint:, params: nil)
-      faraday_connection = Faraday.new(url)
-      response = faraday_connection.get(endpoint, params, headers)
+      response = build_connection(url: url).get(endpoint, params, headers)
       handle_response(response)
     rescue Faraday::ConnectionFailed => error
       raise ConnectionFailed.new(error.message)
@@ -22,8 +22,7 @@ def get(endpoint:, params: nil)
     end
 
     def post(endpoint:, data:)
-      faraday_connection = Faraday.new(url)
-      response = faraday_connection.post(endpoint, data, headers)
+      response = build_connection(url: url).post(endpoint, data, headers)
       handle_response(response)
     rescue Faraday::ConnectionFailed => error
       raise ConnectionFailed.new(error.message)
@@ -32,8 +31,7 @@ def post(endpoint:, data:)
     end
 
     def put(endpoint:, data:)
-      faraday_connection = Faraday.new(url)
-      response = faraday_connection.put(endpoint, data, headers)
+      response = build_connection(url: url).put(endpoint, data, headers)
       handle_response(response)
     rescue Faraday::ConnectionFailed => error
       raise ConnectionFailed.new(error.message)
@@ -42,8 +40,7 @@ def put(endpoint:, data:)
     end
 
     def delete(endpoint:, id:)
-      faraday_connection = Faraday.new(url)
-      response = faraday_connection.delete("#{endpoint}/#{id}", nil, headers)
+      response = build_connection(url: url).delete("#{endpoint}/#{id}", nil, headers)
       handle_response(response)
     rescue Faraday::ConnectionFailed => error
       raise ConnectionFailed.new(error.message)
@@ -53,6 +50,15 @@ def delete(endpoint:, id:)
 
     private
 
+    def build_connection(url:, adapter: Faraday.default_adapter)
+      Faraday.new(url) do |connection|
+        # use Faraday::Encoding middleware to correct the response encoding.
+        connection.response(:encoding)
+
+        connection.adapter(adapter)
+      end
+    end
+
     def headers
       { "Authorization" => @authorization, "xero-tenant-id" => @xero_tenant_id, "content_type" => "application/xml" }
     end

xpm_ruby.gemspec

@@ -34,14 +34,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency("byebug", "~> 11")
   spec.add_development_dependency("pry-byebug", "~> 3")
+  spec.add_development_dependency("vcr")
 
   spec.add_runtime_dependency("faraday")
+  spec.add_runtime_dependency("faraday-encoding")
   spec.add_runtime_dependency("ox", "~> 2.13")
 
-  spec.add_development_dependency("vcr")
-
   spec.add_runtime_dependency("activesupport")
   spec.add_runtime_dependency("builder")
 
-  spec.add_runtime_dependency("dry-types")
+  spec.add_runtime_dependency("dry-types", "~> 0.15.0")
 end