engaging-networks-rest 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a126fa7b16483ced7dfe2a92d73813f676c66e9023ac0441a511dca1a2cf2f
-  data.tar.gz: 3455f32e368b6f49915fb5429de01e62c2fa9514740e767ba4a43f02609f277f
+  metadata.gz: 1c8fe675cfb462733d9a827b08f8714f6399d43649bdf92ee2e871d6516ed55f
+  data.tar.gz: ba88d33736c1c1972281eb1f5c1c0e47278f619148173acd1a0ba63a0a93ad17
 SHA512:
-  metadata.gz: 79c178cdc855862dd88c2393c20f08f3b58b65560fa46281c968945c9cd35423c0452588c5ff4b0f2fcd503f4edb2f0f3c28bd366b34d02b4fbaca49c07e1879
-  data.tar.gz: 9db9deb4c6b0d183697c8c209bbd8c0d69375f961b456a4ba3d93d3a4df8381e825dbaeea22d320cf5209992cd3b62859364979dc7e4b9a2e6078f37abfbc916
+  metadata.gz: ff15125d0c3a29b05deb70bc0738e982b6d2a6fbabd2e7b2fb445b984f6dc461a0e33243f99ca4b11eeb6ea79be8589a080374d7094b403d3201f689366bff56
+  data.tar.gz: 8de4bc283e4268841185ef724419a47395318562613b02f3389a346a8f7ca3b834668abf6440c857fd7ada7097bd2fc44b3b478d7e1fcd6fcaf9c4e388d040be

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 gem 'faraday', '~> 0.15'
+gem 'faraday_middleware'
 
 group :development do
   gem 'rspec', '>= 0'

data/Rakefile

@@ -26,11 +26,11 @@ Juwelier::Tasks.new do |gem|
 end
 Juwelier::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rspec_opts = '--color'
 end
 
 desc "Code coverage detail"
@@ -39,7 +39,8 @@ task :simplecov do
   Rake::Task['test'].execute
 end
 
-task :default => :test
+desc 'Default: run specs.'
+task :default => :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.1

data/engaging-networks-rest.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: engaging-networks-rest 0.3.0 ruby lib
+# stub: engaging-networks-rest 0.4.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "engaging-networks-rest".freeze
-  s.version = "0.3.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jacinda Moore".freeze]
-  s.date = "2019-01-08"
+  s.date = "2019-03-11"
   s.description = "Client gem for the ENS API to Engaging Networks".freeze
   s.email = "jacinda@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
@@ -33,13 +33,14 @@ Gem::Specification.new do |s|
     "lib/engaging_networks_rest.rb",
     "lib/engaging_networks_rest/client.rb",
     "lib/engaging_networks_rest/client/pages.rb",
+    "lib/engaging_networks_rest/response/raise_error.rb",
     "spec/client/pages_spec.rb",
     "spec/client_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/controlshift/engaging-networks-rest".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.7".freeze
+  s.rubygems_version = "2.7.9".freeze
   s.summary = "Client gem for the ENS API to Engaging Networks".freeze
 
   if s.respond_to? :specification_version then
@@ -47,29 +48,32 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<faraday>.freeze, ["~> 0.15"])
+      s.add_runtime_dependency(%q<faraday_middleware>.freeze, [">= 0"])
       s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
       s.add_development_dependency(%q<webmock>.freeze, ["~> 3.4"])
       s.add_development_dependency(%q<faker>.freeze, ["~> 1.9"])
       s.add_development_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
-      s.add_development_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
+      s.add_development_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
     else
       s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
+      s.add_dependency(%q<faraday_middleware>.freeze, [">= 0"])
       s.add_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
       s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
       s.add_dependency(%q<faker>.freeze, ["~> 1.9"])
       s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
-      s.add_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
+      s.add_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
     end
   else
     s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
+    s.add_dependency(%q<faraday_middleware>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
     s.add_dependency(%q<faker>.freeze, ["~> 1.9"])
     s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
-    s.add_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
+    s.add_dependency(%q<faraday-detailed_logger>.freeze, ["~> 2.1", ">= 2.1.2"])
   end
 end
 

data/example.rb

@@ -13,6 +13,10 @@ def instrument_connection_with_extended_logging(client)
   }
 
   faraday_builder = ->(faraday) do
+    faraday.request :json
+    faraday.response :json, :content_type => /\bjson$/
+    faraday.use Faraday::Response::Logger if ENV['DEBUG']
+    faraday.use  EngagingNetworksRest::Response::RaiseError
     faraday.response :detailed_logger
     faraday.adapter Faraday.default_adapter
   end

data/lib/engaging_networks_rest/client.rb

@@ -1,6 +1,7 @@
 require 'faraday'
-require 'json'
+require 'faraday_middleware'
 require 'engaging_networks_rest/client/pages'
+require 'engaging_networks_rest/response/raise_error'
 
 module EngagingNetworksRest
   class Client
@@ -11,18 +12,25 @@ module EngagingNetworksRest
     def initialize(api_key:)
       @api_key = api_key
 
-      @connection = Faraday.new(url: "https://#{ENS_DOMAIN}")
+      @connection = Faraday.new(url: "https://#{ENS_DOMAIN}") do |conn|
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+
+        conn.use Faraday::Response::Logger if ENV['DEBUG']
+        conn.use EngagingNetworksRest::Response::RaiseError
+
+        conn.adapter :net_http
+      end
     end
 
     def authenticate!
       response = connection.post do |req|
-        req.url '/ens/service/authenticate'
         req.headers['Content-Type'] = 'application/json'
+        req.url '/ens/service/authenticate'
         req.body = api_key
       end
 
-      parsed_body = JSON.parse(response.body)
-      @ens_auth_key = parsed_body['ens-auth-token']
+      @ens_auth_key = response.body['ens-auth-token']
     end
 
     def authenticated?
@@ -47,14 +55,14 @@ module EngagingNetworksRest
       end
 
       response = connection.send(method) do |req|
+        req.headers['Content-Type'] = 'application/json'
         req.path = path
         req.params = params
-        req.headers['Content-Type'] = 'application/json'
         req.headers['ens-auth-token'] = ens_auth_key
         req.body = ::JSON.generate(body) unless body.empty?
       end
 
-      JSON.parse(response.body)
+      response.body
     end
   end
 end

data/lib/engaging_networks_rest/client/pages.rb

@@ -15,7 +15,12 @@ module EngagingNetworksRest
       end
 
       def process_page_request(page_id:, supporter_data:)
-        post(path: "/ens/service/page/#{page_id}/process", body: {supporter: supporter_data})
+        response = post(path: "/ens/service/page/#{page_id}/process", body: {supporter: supporter_data})
+        if response['status'] == 'SUCCESS'
+          return response
+        end
+
+        raise "Unexpected 'status' value on response: #{response}"
       end
     end
   end

data/lib/engaging_networks_rest/response/raise_error.rb

@@ -0,0 +1,29 @@
+module EngagingNetworksRest
+  module Response
+    class NotFound < StandardError ; end
+    class Unauthorized < StandardError ; end
+    class InternalError < StandardError; end
+
+    class RaiseError < Faraday::Response::Middleware
+      def on_complete(response)
+        status_code = response[:status].to_i
+        if (400...600).include? status_code
+          case status_code
+          when 401
+            raise Unauthorized.new(error_message(response))
+          when 404
+            raise NotFound.new(error_message(response))
+          when 500
+            raise InternalError.new(error_message(response))
+          else
+            raise StandardError.new(error_message(response))
+          end
+        end
+      end
+
+      def error_message(response)
+        "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} \n\n #{response[:body] if response[:body]}"
+      end
+    end
+  end
+end

data/spec/client/pages_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe EngagingNetworksRest::Client::Pages do
   let(:api_key) { 'abc-123' }
   let(:ens_auth_key) { 'tmp-auth-key-456' }
-  let(:standard_headers) { {'Content-Type' => 'application/json', 'ens-auth-token' => ens_auth_key} }
+  let(:standard_headers) { {'Content-Type' => 'application/json', 'Ens-Auth-Token' => ens_auth_key} }
 
   subject { EngagingNetworksRest::Client.new(api_key: api_key) }
 
@@ -19,14 +19,14 @@ describe EngagingNetworksRest::Client::Pages do
     shared_examples_for 'list pages' do
       it 'should get pages' do
         stub_request(:get, pages_url).with(headers: standard_headers, query: {'type' => page_type, 'status' => page_status})
-          .to_return(body: response.to_json)
+          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: response.to_json)
 
         expect(subject.pages(type: page_type, status: page_status)).to eq response
       end
 
       it 'should omit status param if not specified' do
         stub_request(:get, pages_url).with(headers: standard_headers, query: {'type' => page_type})
-          .to_return(body: response.to_json)
+          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: response.to_json)
 
         expect(subject.pages(type: page_type)).to eq response
       end
@@ -57,13 +57,25 @@ describe EngagingNetworksRest::Client::Pages do
     let(:email) { Faker::Internet.email }
     let(:supporter_hash) { {'firstName' => 'Joe', 'lastName' => 'Smith', 'emailAddress' => email, 'customField1' => 'foo'} }
     let(:response) { {'id' => '1234567', 'status' => 'SUCCESS', 'supporterEmailAddress' => email, 'supporterId' => '98765'} }
+    let(:failure_response) { {'status' => 'ERROR', 'message' => 'Something went wrong'} }
 
     shared_examples_for 'process page request' do
-      it 'should process the page request' do
+      it 'should process the page request and return its ID' do
         stub_request(:post, page_req_url).with(body: {supporter: supporter_hash}.to_json, headers: standard_headers)
-          .to_return(body: response.to_json)
+          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: response.to_json)
 
-        expect(subject.process_page_request(page_id: page_id, body: {supporter: supporter_hash})).to eq response
+        result = subject.process_page_request(page_id: page_id, supporter_data: supporter_hash)
+
+        expect(result['id']).to eq '1234567'
+        expect(result['supporterId']).to eq '98765'
+        expect(result['supporterEmailAddress']).to eq email
+      end
+
+      it 'should raise if response status is not SUCCESS' do
+        stub_request(:post, page_req_url).with(body: {supporter: supporter_hash}.to_json, headers: standard_headers)
+          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: failure_response.to_json)
+
+        expect { subject.process_page_request(page_id: page_id, supporter_data: supporter_hash) }.to raise_error(RuntimeError, /Unexpected 'status' value on response.*Something went wrong/)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: engaging-networks-rest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jacinda Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,22 +112,22 @@ dependencies:
   name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 description: Client gem for the ENS API to Engaging Networks
 email: jacinda@controlshiftlabs.com
 executables: []
@@ -136,6 +150,7 @@ files:
 - lib/engaging_networks_rest.rb
 - lib/engaging_networks_rest/client.rb
 - lib/engaging_networks_rest/client/pages.rb
+- lib/engaging_networks_rest/response/raise_error.rb
 - spec/client/pages_spec.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
@@ -159,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Client gem for the ENS API to Engaging Networks