4me-sdk 2.0.0 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32cfcbac334dbc605b6488e54db56eb8c7db3dfca80724b08114affc264d4d59
-  data.tar.gz: ed44080e2df04693b32d62bd0a0086511af32301ba6e5d4a4e401ba0ab4d70f1
+  metadata.gz: 0fb02daf6964d0f17c4f084d8035b50497e218830a823f8b2f8a40c7af26b659
+  data.tar.gz: fa1a5f86490b2cc33ba9221ba2a0fd79968116b9e66988f2f25345a4dea40128
 SHA512:
-  metadata.gz: 0b4d62a29b08e73e7afce649acbccf27f3192f46d50b533e02429e0da45f3f1c99ccd5201343da550c3a7f2561d27e732a39c22794fb78f8f182831ec42a97f7
-  data.tar.gz: '08c618e5b35ec1a7bc3a47e5800b64da25a992475ccc7fa5f99d8e781b4b724a3caf32dbf0936d8ca79d244fac2a4c5ddb9facd5be06893c867f7d97a8dbc6fd'
+  metadata.gz: 4826f9e6545ac80ac3fc674ede10c53f20d87a27d286bfe2814ebd13c526ec80d743af7320947d5e6a1dafbfe2c8f1e501f388e9f4022e5f4cabfc889440ccf1
+  data.tar.gz: 8a80bccaf9cd74342aea7505c35395032c118dbe36fb119c785b9c1b8f435db2c18f9302192bbf4cb58e590379c01c76c24708577da0acbd36ec07f8abbb8e0d

data/4me-sdk.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'gem_config', '>=0.3'
   spec.add_runtime_dependency 'mime-types', '>= 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1'
+  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.0.pre.rc.2)
+    4me-sdk (2.0.4)
       activesupport (>= 4.2)
       gem_config (>= 0.3)
       mime-types (>= 3.0)
@@ -9,80 +9,80 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
     crack (0.4.4)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
     gem_config (0.3.2)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    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.2020.1104)
-    minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    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 (1.8.2)
+    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.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    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.0)
+      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.0)
-    rubocop (0.93.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (1.8.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    simplecov (0.19.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
       docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    webmock (3.9.4)
+      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.9.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   4me-sdk!
-  bundler (~> 1)
+  bundler
+  json (>= 2.6)
   rake (~> 12)
   rspec (~> 3.3)
   rubocop (>= 0.49.0)
@@ -90,4 +90,4 @@ DEPENDENCIES
   webmock (~> 3)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -129,18 +129,16 @@ If you really want to [paginate](https://developer.4me.com/v1/general/pagination
 
 ```
 @client = Sdk4me::Client.new
-response = @client.get('organizations', {per_page: 10, page: 2})
+response = @client.get('organizations', { per_page: 100 })
 
 puts response.json # all data in an array
 
 puts "showing page #{response.current_page}/#{response.total_pages}, with #{response.per_page} records per page"
 puts "total number of records #{response.total_entries}"
 
-# retrieve collection for other pages directly from the response
-first_page = @client.get(response.pagination_link(:first))
-prev_page  = @client.get(response.pagination_link(:prev))
-next_page  = @client.get(response.pagination_link(:next))
-last_page  = @client.get(response.pagination_link(:last))
+# retrieve collection for previous and next pages directly from the response
+prev_page = @client.get(response.pagination_relative_link(:prev))
+next_page = @client.get(response.pagination_relative_link(:next))
 ```
 
 By default this call will return all [collection fields](https://developer.4me.com/v1/organizations/#collection-fields) for each Organization.
@@ -148,7 +146,7 @@ For more fields, check out the [field selection](https://developer.4me.com/v1/ge
 
 The fields can be accessed using *symbols* and *strings*, and it is possible chain a number of keys in one go:
 ```
-response = Sdk4me::Client.new.get('organizations', {per_page: 10, page: 2, fields: 'parent'})
+response = Sdk4me::Client.new.get('organizations', { per_page: 100, fields: 'parent' })
 puts response[:parent, :name]    # an array with the parent organization names
 puts response['parent', 'name']  # strings are also accepted as keys
 ```
@@ -265,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
@@ -301,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
@@ -355,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/attachments.rb

@@ -32,7 +32,7 @@ module Sdk4me
     #      data = {
     #        note: "Hello ![](storage/abc/adjhajdhjaadf.png) and ![](storage/abc/fskdhakjfkjdssdf.png])",
     #        note_attachments: [
-    #          { key: 'storage/abc/fskdhakjfkjdssdf.png', filesize: 12345, inline: true },
+    #          { key: 'storage/abc/adjhajdhjaadf.png', filesize: 12345, inline: true },
     #          { key: 'storage/abc/fskdhakjfkjdssdf.png'], filesize: 98765, inline: true }
     #        ],
     #        ...

data/lib/sdk4me/client/multipart.rb

@@ -66,7 +66,8 @@ module Sdk4me
       def to_multipart
         # If we can tell the possible mime-type from the filename, use the first in the list; otherwise, use "application/octet-stream"
         mime_type = MIME::Types.type_for(filename)[0] || MIME::Types['application/octet-stream'][0]
-        %(Content-Disposition: form-data; name="#{CGI.escape(k.to_s)}"; filename="#{filename}"\r\nContent-Type: #{mime_type.simplified}\r\n\r\n#{content}\r\n)
+        %(Content-Disposition: form-data; name="#{CGI.escape(k.to_s)}"; filename="#{filename}"\r\n) +
+          %(Content-Type: #{mime_type.simplified}\r\n\r\n#{content.force_encoding('UTF-8')}\r\n)
       end
     end
   end

data/lib/sdk4me/client/response.rb

@@ -98,14 +98,17 @@ module Sdk4me
       @total_entries ||= @response.header['X-Pagination-Total-Entries'].to_i
     end
 
-    # pagination urls (full paths with server) - relations :first, :prev, :next, :last
+    # pagination urls (full paths with server) - relations :first, :prev
     # Link: <https://api.4me.com/v1/requests?page=1&per_page=25>; rel="first", <https://api.4me.com/v1/requests?page=2&per_page=25>; rel="prev", etc.
     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
+      (@pagination_links ||= {})[relation] ||= @response.header['Link'] &&
+                                               @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, :last
+    # pagination urls (relative paths without server) - relations :first, :prev, :next
     def pagination_relative_link(relation)
       (@pagination_relative_links ||= {})[relation] ||= pagination_link(relation) && pagination_link(relation)[%r{^https?://[^/]*(.*)}, 1]
     end

data/lib/sdk4me/client/version.rb

@@ -1,5 +1,5 @@
 module Sdk4me
   class Client
-    VERSION = '2.0.0'.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
@@ -216,9 +224,8 @@ module Sdk4me
       request
     end
 
-    URI_ESCAPE_PATTERN = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
     def uri_escape(value)
-      URI.escape(value, URI_ESCAPE_PATTERN).gsub('.', '%2E')
+      URI.encode_www_form_component(value).gsub('+', '%20').gsub('.', '%2E')
     end
 
     # Expand the given header with the default header

data/spec/lib/sdk4me/attachments_spec.rb

@@ -311,7 +311,7 @@ describe Sdk4me::Attachments do
         end
 
         it 'should upload a file from disk' do
-          Tempfile.create('4me_attachments_spec.txt') do |file|
+          Tempfile.create('4me_我attáchments_spec.txt') do |file|
             file << 'foobar'
             file.flush
 

data/spec/lib/sdk4me/certificate_spec.rb

@@ -12,7 +12,7 @@ describe 'ca-bundle.crt' do
     expect(response.valid?).to be_falsey
 
     # expecting 401 error
-    expect(response.message).to eq('401: Bad credentials')
+    expect(response.message).to start_with('401:')
   end
 
   it 'should be able to connect to the 4me REST API (access token)' do
@@ -26,7 +26,7 @@ describe 'ca-bundle.crt' do
     expect(response.valid?).to be_falsey
 
     # expecting 401 error
-    expect(response.message).to eq('401: Bad credentials')
+    expect(response.message).to start_with('401:')
   end
 
   it 'should be able to connect to S3' do

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

data/spec/lib/sdk4me/response_spec.rb

@@ -214,7 +214,7 @@ describe Sdk4me::Response do
             'X-Pagination-Current-Page' => 1,
             'X-Pagination-Total-Pages' => 2,
             'X-Pagination-Total-Entries' => 5,
-            'Link' => '<https://api.4me.com/v1/people?page=1&per_page=3>; rel="first",<https://api.4me.com/v1/people?page=2&per_page=3>; rel="next", <https://api.4me.com/v1/people?page=2&per_page=3>; rel="last"'
+            'Link' => '<https://api.4me.com/v1/people?page=1&per_page=3&fields=id,name>; rel="first",<https://api.4me.com/v1/people?fields=id%2Cname&page=2&per_page=3>; rel="next", <https://api.4me.com/v1/people?page=2&per_page=3>; rel="last"'
           }
           allow(@response_array.response).to receive('header') { @pagination_header }
         end
@@ -235,16 +235,16 @@ describe Sdk4me::Response do
           expect(@response_array.total_entries).to eq(5)
         end
 
-        { first: 'https://api.4me.com/v1/people?page=1&per_page=3',
-          next: 'https://api.4me.com/v1/people?page=2&per_page=3',
+        { first: 'https://api.4me.com/v1/people?page=1&per_page=3&fields=id,name',
+          next: 'https://api.4me.com/v1/people?fields=id%2Cname&page=2&per_page=3',
           last: 'https://api.4me.com/v1/people?page=2&per_page=3' }.each do |relation, link|
           it "should define pagination link for :#{relation}" do
             expect(@response_array.pagination_link(relation)).to eq(link)
           end
         end
 
-        { first: '/v1/people?page=1&per_page=3',
-          next: '/v1/people?page=2&per_page=3',
+        { first: '/v1/people?page=1&per_page=3&fields=id,name',
+          next: '/v1/people?fields=id%2Cname&page=2&per_page=3',
           last: '/v1/people?page=2&per_page=3' }.each do |relation, link|
           it "should define pagination relative link for :#{relation}" do
             expect(@response_array.pagination_relative_link(relation)).to eq(link)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 4me-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.4
 platform: ruby
 authors:
 - 4me
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,16 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !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: '1'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -184,8 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.9
+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