Merge pull request zendesk#266 from zendesk/fneves/handle_bad_characters

Handling bad utf-8 characters on a response

Author: Fábio Neves

lib/zendesk_api/client.rb

@@ -13,6 +13,7 @@
 require 'zendesk_api/middleware/response/callback'
 require 'zendesk_api/middleware/response/deflate'
 require 'zendesk_api/middleware/response/gzip'
+require 'zendesk_api/middleware/response/sanitize_response'
 require 'zendesk_api/middleware/response/parse_iso_dates'
 require 'zendesk_api/middleware/response/parse_json'
 require 'zendesk_api/middleware/response/raise_error'
@@ -142,6 +143,7 @@ def build_connection
  builder.use ZendeskAPI::Middleware::Response::Logger, config.logger if config.logger
  builder.use ZendeskAPI::Middleware::Response::ParseIsoDates
  builder.use ZendeskAPI::Middleware::Response::ParseJson
+ builder.use ZendeskAPI::Middleware::Response::SanitizeResponse
 
  adapter = config.adapter || Faraday.default_adapter
 

lib/zendesk_api/middleware/response/sanitize_response.rb

@@ -0,0 +1,13 @@
+require 'scrub_rb'
+
+module ZendeskAPI
+ module Middleware
+ module Response
+ class SanitizeResponse < Faraday::Response::Middleware
+ def on_complete(env)
+ env[:body].scrub!('')
+ end
+ end
+ end
+ end
+end

spec/core/middleware/response/sanitize_response_spec.rb

@@ -0,0 +1,19 @@
+require 'core/spec_helper'
+
+describe ZendeskAPI::Middleware::Response::SanitizeResponse do
+ def fake_response(data)
+ stub_json_request(:get, %r{blergh}, data)
+ response = client.connection.get('blergh')
+ expect(response.status).to eq(200)
+ response
+ end
+
+ describe 'with bad characters' do
+ let(:response) { fake_response("{\"x\":\"2012-02-01T13:14:15Z\", \"y\":\"\u0315\u0316\u01333\u0270\u022712awesome!\ud83d\udc4d\"}") }
+
+ it 'removes bad characters' do
+ expect(response.body.to_s.valid_encoding?).to be(true)
+ expect(response.body['y'].to_s).to eq("\u0315\u0316\u01333\u0270\u022712awesome!")
+ end
+ end
+end

zendesk_api.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
  s.add_runtime_dependency "inflection"
  s.add_runtime_dependency "multipart-post", "~> 2.0"
  s.add_runtime_dependency "mime-types"
+ s.add_runtime_dependency "scrub_rb", "~> 1.0.1"
 
  s.files = `git ls-files -x Gemfile.lock`.split("\n") rescue ''
  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")