itrp-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89081124a0ce058991107658acc89152c8d4118e
-  data.tar.gz: b92af38225ebdbd0592f508b4e5ddd7fb6c6983c
+  metadata.gz: c3cc5dc93a1f84864b1550821fca09d2305b220e
+  data.tar.gz: 8586c686d6519573534a9991288bb7bfe3ac7bf8
 SHA512:
-  metadata.gz: 232eeb5ef89f2e2f6c83266eb95a777ecccfa891e9b7fed8ea88c51c332183c7ffec3aaaed8eb259c66a540a0d86d0152fb65612aab779f463cd8ad7b24f6249
-  data.tar.gz: acc1b94b7a6ea21c695a0f44ef3d332a601f0ac3c77af43499c79cb386424aa0958498a5d2cb62b4184f83eb96b04356b99129b3f693f81663767db02e257cf4
+  metadata.gz: 2e7b2e85e0ab75834e490f0917cb7dd7e1fbae1fe0126519771349d244bec66e2422f9c483cd813bfb648e7745dfe5fefc13d710ff8531268c4c45ef7cec1c06
+  data.tar.gz: e51bdaf000aca2f5b471428ca9575d488516766ea2626cfcc92400917b25b76468c53d3476023ae731bca7401c10699839d16efec78716019f14c2b3ff0207fa

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 ITRP Inc.
+Copyright (c) 2017 ITRP Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/itrp/client.rb

@@ -132,7 +132,11 @@ module Itrp
         token = response[:token]
         while true
           response = get("/import/#{token}")
-          raise ::Itrp::Exception.new("Unable to monitor progress for #{type} import. #{response.message}") unless response.valid?
+          unless response.valid?
+            sleep(5)
+            response = get("/import/#{token}") # single retry to recover from a network error
+            raise ::Itrp::Exception.new("Unable to monitor progress for #{type} import. #{response.message}") unless response.valid?
+          end
           # wait 30 seconds while the response is OK and import is still busy
           break unless ['queued', 'processing'].include?(response[:state])
           @logger.debug { "Import of '#{csv.path}' is #{response[:state]}. Checking again in 30 seconds." }
@@ -165,7 +169,11 @@ module Itrp
         token = response[:token]
         while true
           response = get("/export/#{token}")
-          raise ::Itrp::Exception.new("Unable to monitor progress for '#{data[:type]}' export. #{response.message}") unless response.valid?
+          unless response.valid?
+            sleep(5)
+            response = get("/export/#{token}") # single retry to recover from a network error
+            raise ::Itrp::Exception.new("Unable to monitor progress for '#{data[:type]}' export. #{response.message}") unless response.valid?
+          end
           # wait 30 seconds while the response is OK and export is still busy
           break unless ['queued', 'processing'].include?(response[:state])
           @logger.debug { "Export of '#{data[:type]}' is #{response[:state]}. Checking again in 30 seconds." }

data/lib/itrp/client/version.rb

@@ -1,5 +1,5 @@
 module Itrp
   class Client
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/spec/lib/itrp/client_spec.rb

@@ -287,7 +287,6 @@ describe Itrp::Client do
       @import_processing_response = {body: {state: 'processing'}.to_json}
       @import_done_response = {body: {state: 'done', results: {errors: 0, updated: 1, created: 1, failures: 0, unchanged: 0, deleted: 0}}.to_json}
       @import_failed_response = {body: {state: 'error', message: 'Invalid byte sequence in UTF-8 on line 2', results: {errors: 1, updated: 1, created: 0, failures: 1, unchanged: 0, deleted: 0}}.to_json}
-      @server_failed_response = {body: {state: 'error', message: 'Invalid byte sequence in UTF-8 on line 2', results: {errors: 1, updated: 1, created: 0, failures: 1, unchanged: 0, deleted: 0}}.to_json}
       allow(@client).to receive(:sleep)
     end
 
@@ -307,7 +306,10 @@ describe Itrp::Client do
 
     it 'should wait for the import to complete' do
       stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
-      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response, @import_done_response)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x'])
+                        .to_return(@import_queued_response, @import_processing_response)
+                        .then.to_raise(StandardError.new('network error'))
+                        .then.to_return(@import_done_response)
 
       # verify the correct log statement are made
       expect_log('Sending POST request to api.itrp.com:443/v1/import', :debug)
@@ -320,12 +322,14 @@ describe Itrp::Client do
       expect_log("Response:\n{\n  \"state\": \"processing\"\n}", :debug)
       expect_log("Import of '#{@fixture_dir}/people.csv' is processing. Checking again in 30 seconds.", :debug)
       expect_log('Sending GET request to api.itrp.com:443/v1/import/68ef5ef0f64c0', :debug)
+      expect_log("Request failed: 500: No Response from Server - network error for 'api.itrp.com:443/v1/import/68ef5ef0f64c0'", :error)
+      expect_log('Sending GET request to api.itrp.com:443/v1/import/68ef5ef0f64c0', :debug)
       expect_log("Response:\n{\n  \"state\": \"done\",\n  \"results\": {\n    \"errors\": 0,\n    \"updated\": 1,\n    \"created\": 1,\n    \"failures\": 0,\n    \"unchanged\": 0,\n    \"deleted\": 0\n  }\n}", :debug)
 
       response = @client.import("#{@fixture_dir}/people.csv", 'people', true)
       expect(response[:state]).to eq('done')
       expect(response[:results][:updated]).to eq(1)
-      expect(progress_stub).to have_been_requested.times(3)
+      expect(progress_stub).to have_been_requested.times(4)
     end
 
     it 'should wait for the import to fail' do
@@ -333,15 +337,17 @@ describe Itrp::Client do
       progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response, @import_failed_response)
 
       expect{ @client.import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for people import. Invalid byte sequence in UTF-8 on line 2")
-      expect(progress_stub).to have_been_requested.times(3)
+      expect(progress_stub).to have_been_requested.times(4)
     end
 
     it 'should not continue when there is an error connecting to ITRP' do
       stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
-      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response).then.to_raise(StandardError.new('network error'))
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x'])
+                        .to_return(@import_queued_response, @import_processing_response)
+                        .then.to_raise(StandardError.new('network error')) # twice
 
       expect{ @client.import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for people import. 500: No Response from Server - network error for 'api.itrp.com:443/v1/import/68ef5ef0f64c0'")
-      expect(progress_stub).to have_been_requested.times(3)
+      expect(progress_stub).to have_been_requested.times(4)
     end
 
     it 'should return an invalid response in case waiting for progress is false' do
@@ -395,7 +401,10 @@ describe Itrp::Client do
 
     it 'should wait for the export to complete' do
       stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
-      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@export_queued_response, @export_processing_response, @export_done_response)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x'])
+                        .to_return(@export_queued_response, @export_processing_response)
+                        .then.to_raise(StandardError.new('network error'))
+                        .then.to_return(@export_done_response)
 
       # verify the correct log statement are made
       expect_log('Sending POST request to api.itrp.com:443/v1/export', :debug)
@@ -408,20 +417,24 @@ describe Itrp::Client do
       expect_log(%(Response:\n{\n  "state": "processing"\n}), :debug)
       expect_log("Export of 'people' is processing. Checking again in 30 seconds.", :debug)
       expect_log('Sending GET request to api.itrp.com:443/v1/export/68ef5ef0f64c0', :debug)
+      expect_log("Request failed: 500: No Response from Server - network error for 'api.itrp.com:443/v1/export/68ef5ef0f64c0'", :error)
+      expect_log('Sending GET request to api.itrp.com:443/v1/export/68ef5ef0f64c0', :debug)
       expect_log(%(Response:\n{\n  "state": "done",\n  "url": "https://download.example.com/export.zip?AWSAccessKeyId=12345"\n}), :debug)
 
       response = @client.export('people', nil, true)
       expect(response[:state]).to eq('done')
       expect(response[:url]).to eq('https://download.example.com/export.zip?AWSAccessKeyId=12345')
-      expect(progress_stub).to have_been_requested.times(3)
+      expect(progress_stub).to have_been_requested.times(4)
     end
 
     it 'should not continue when there is an error connecting to ITRP' do
       stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
-      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@export_queued_response, @export_processing_response).then.to_raise(StandardError.new('network error'))
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x'])
+                        .to_return(@export_queued_response, @export_processing_response)
+                        .then.to_raise(StandardError.new('network error')) # twice
 
       expect{ @client.export('people', nil, true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for 'people' export. 500: No Response from Server - network error for 'api.itrp.com:443/v1/export/68ef5ef0f64c0'")
-      expect(progress_stub).to have_been_requested.times(3)
+      expect(progress_stub).to have_been_requested.times(4)
     end
 
     it 'should return an invalid response in case waiting for progress is false' do

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: itrp-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - ITRP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
   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: activesupport
   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: mime-types
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Client for accessing the ITRP REST API
@@ -156,22 +156,22 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Client for accessing the ITRP REST API