4me-sdk 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da996ddd9ef66ae1e2b296bcf8ae34406163bbcbe157c1dc9ce8809e253468c4
-  data.tar.gz: 9c4aa5c40c50d5dc9365cb27c89851914d9a3361e6c1df113aa241d00599d522
+  metadata.gz: 0fb02daf6964d0f17c4f084d8035b50497e218830a823f8b2f8a40c7af26b659
+  data.tar.gz: fa1a5f86490b2cc33ba9221ba2a0fd79968116b9e66988f2f25345a4dea40128
 SHA512:
-  metadata.gz: d338d9c4069d1a6d643f04dae0f6e98afe6059f2fa9f5c61f77cdb8869096a468cb369c47d702bec1caf2fff9c7e7d454dd67bc80b89c66dc4ebce8fcaf9b543
-  data.tar.gz: 7262b78d780457b9569c7143e39e8fbc2e1d13e5fa9d971ce263a1d666327ee7517952c428d20de1e1c851a8f082a7a45508f3abd60cf556950108a1a175d570
+  metadata.gz: 4826f9e6545ac80ac3fc674ede10c53f20d87a27d286bfe2814ebd13c526ec80d743af7320947d5e6a1dafbfe2c8f1e501f388e9f4022e5f4cabfc889440ccf1
+  data.tar.gz: 8a80bccaf9cd74342aea7505c35395032c118dbe36fb119c785b9c1b8f435db2c18f9302192bbf4cb58e590379c01c76c24708577da0acbd36ec07f8abbb8e0d

data/4me-sdk.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mime-types', '>= 3.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'json', '>= 2.6'
   spec.add_development_dependency 'rake', '~> 12'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'rubocop', '>= 0.49.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    4me-sdk (2.0.2)
+    4me-sdk (2.0.4)
       activesupport (>= 4.2)
       gem_config (>= 0.3)
       mime-types (>= 3.0)
@@ -9,50 +9,49 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.8)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    docile (1.3.5)
+    concurrent-ruby (1.1.9)
+    crack (0.4.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.9)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    mime-types (3.3.1)
+    json (2.6.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    minitest (5.14.4)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (2.1.1)
+    rake (12.3.1)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.11.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (1.8.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -64,27 +63,26 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.16.1)
       docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    webmock (3.12.1)
+    webmock (3.9.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  x86_64-darwin-19
+  ruby
 
 DEPENDENCIES
   4me-sdk!
   bundler
+  json (>= 2.6)
   rake (~> 12)
   rspec (~> 3.3)
   rubocop (>= 0.49.0)
@@ -92,4 +90,4 @@ DEPENDENCIES
   webmock (~> 3)
 
 BUNDLED WITH
-   2.2.14
+   1.17.3

data/README.md

@@ -263,7 +263,10 @@ begin
   response = Sdk4me::Client.new.import('\tmp\people.csv', 'people', true)
   puts response[:state]
   puts response[:results]
-  puts response[:message]
+  puts response[:logfile]
+  unless response.valid?
+    puts "Import completed with errors: #{response[:message]}"
+  end
 catch Sdk4me::UploadFailed => ex
   puts "Could not upload the people import file: #{ex.message}"
 catch Sdk4me::Exception => ex
@@ -299,8 +302,13 @@ require 'open-uri'
 begin
   response = Sdk4me::Client.new.export(['people', 'people_contact_details'], nil, true)
   puts response[:state]
-  # write the export file to disk
-  File.open('/tmp/export.zip', 'wb') { |f| f.write(open(response[:url]).read) }
+  if response.valid?
+    # write the export file to disk
+    File.open('/tmp/export.zip', 'wb') { |f| f.write(open(response[:url]).read) }
+  else
+    puts "Export failed with errors: #{response[:message]}"
+    puts response[:logfile]
+  end
 catch Sdk4me::UploadFailed => ex
   puts "Could not queue the people export: #{ex.message}"
 catch Sdk4me::Exception => ex
@@ -353,4 +361,4 @@ The changelog is available [here](CHANGELOG.md).
 
 ## Copyright
 
-Copyright (c) 2020 4me, Inc. See [LICENSE](LICENSE) for further details.
+Copyright (c) 2022 4me, Inc. See [LICENSE](LICENSE) for further details.

data/lib/sdk4me/client/response.rb

@@ -103,9 +103,9 @@ module Sdk4me
     def pagination_link(relation)
       # split on ',' select the [url] in '<[url]>; rel="[relation]"', compact to all url's found (at most one) and take the first
       (@pagination_links ||= {})[relation] ||= @response.header['Link'] &&
-        @response.header['Link']
-          .split(/,\s*(?:<|$)/)
-          .map { |link| link[/^\s*<?(.*?)>?;\s*rel="#{relation}"\s*$/, 1] }.compact.first
+                                               @response.header['Link']
+                                                        .split(/,\s*(?:<|$)/)
+                                                        .map { |link| link[/^\s*<?(.*?)>?;\s*rel="#{relation}"\s*$/, 1] }.compact.first
     end
 
     # pagination urls (relative paths without server) - relations :first, :prev, :next

data/lib/sdk4me/client/version.rb

@@ -1,5 +1,5 @@
 module Sdk4me
   class Client
-    VERSION = '2.0.3'.freeze
+    VERSION = '2.0.4'.freeze
   end
 end

data/lib/sdk4me/client.rb

@@ -145,9 +145,13 @@ module Sdk4me
         token = response[:token]
         loop do
           response = get("/import/#{token}")
+          return response if response[:state] == 'error'
+
           unless response.valid?
             sleep(5)
             response = get("/import/#{token}") # single retry to recover from a network error
+            return response if response[:state] == 'error'
+
             raise ::Sdk4me::Exception, "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
@@ -186,9 +190,13 @@ module Sdk4me
         token = response[:token]
         loop do
           response = get("/export/#{token}")
+          return response if response[:state] == 'error'
+
           unless response.valid?
             sleep(5)
             response = get("/export/#{token}") # single retry to recover from a network error
+            return response if response[:state] == 'error'
+
             raise ::Sdk4me::Exception, "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

data/spec/lib/sdk4me/client_spec.rb

@@ -364,8 +364,10 @@ describe Sdk4me::Client do
         stub_request(:post, 'https://api.4me.com/v1/import').with(credentials(authentication)).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: { token: '68ef5ef0f64c0' }.to_json)
         progress_stub = stub_request(:get, 'https://api.4me.com/v1/import/68ef5ef0f64c0').with(credentials(authentication)).to_return(@import_queued_response, @import_processing_response, @import_failed_response)
 
-        expect { client(authentication).import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Sdk4me::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(4)
+        response = client(authentication).import("#{@fixture_dir}/people.csv", 'people', true)
+        expect(response.valid?).to be_falsey
+        expect(response[:message]).to eq('Invalid byte sequence in UTF-8 on line 2')
+        expect(progress_stub).to have_been_requested.times(3)
       end
 
       it 'should not continue when there is an error connecting to 4me' do
@@ -389,6 +391,16 @@ describe Sdk4me::Client do
         stub_request(:post, 'https://api.4me.com/v1/import').with(credentials(authentication)).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: { message: 'oops!' }.to_json)
         expect { client(authentication).import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Sdk4me::UploadFailed, 'Failed to queue people import. oops!')
       end
+
+      it 'should return the error response when the import state is set to error' do
+        stub_request(:post, 'https://api.4me.com/v1/import').with(credentials(authentication)).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: { token: '68ef5ef0f64c0' }.to_json)
+        stub_request(:get, 'https://api.4me.com/v1/import/68ef5ef0f64c0').with(credentials(authentication)).to_return(body: { state: 'error', message: 'Too many import failures', logfile: 'foo' }.to_json)
+
+        response = client(authentication).import("#{@fixture_dir}/people.csv", 'people', true)
+        expect(response.valid?).to be_falsey
+        expect(response[:message]).to eq('Too many import failures')
+        expect(response[:logfile]).to eq('foo')
+      end
     end
 
     context 'export' do
@@ -480,6 +492,16 @@ describe Sdk4me::Client do
         stub_request(:post, 'https://api.4me.com/v1/export').with(credentials(authentication)).with(body: { type: 'people' }).to_return(body: { message: 'oops!' }.to_json)
         expect { client(authentication).export('people', nil, true) }.to raise_error(Sdk4me::UploadFailed, "Failed to queue 'people' export. oops!")
       end
+
+      it 'should return the error response when the export state is set to error' do
+        stub_request(:post, 'https://api.4me.com/v1/export').with(credentials(authentication)).with(body: { type: 'people' }).to_return(body: { token: '68ef5ef0f64c0' }.to_json)
+        stub_request(:get, 'https://api.4me.com/v1/export/68ef5ef0f64c0').with(credentials(authentication)).to_return(body: { state: 'error', message: 'Too many export failures', logfile: 'foo' }.to_json)
+
+        response = client(authentication).export('people', nil, true)
+        expect(response.valid?).to be_falsey
+        expect(response[:message]).to eq('Too many export failures')
+        expect(response[:logfile]).to eq('foo')
+      end
     end
 
     context 'retry' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 4me-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - 4me
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: The official 4me SDK for Ruby. Provides easy access to the REST APIs found