easy_compliance 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b54b25d1b74022e38061b4efdf13e80bd60e0e5d6fef95175f00fc04c781d2
-  data.tar.gz: afb3c1aa893049af9cad6caa269383ee65ac1446bac94ba040674dd59ca6c6d1
+  metadata.gz: a18dc5645db8718da9f22831fcf6f458d74763536dfe8edaccf3f4439ae91b95
+  data.tar.gz: 9db9644054a7c647e2e0801bb958b6208943088d9012bf6e3f9be8600da7ef46
 SHA512:
-  metadata.gz: 7dfc566c12036ae5c3881f46894b031b8f7f08a34ca140c6ee89196ab2b41f3af22311af4915ff030bc7cc845d89a4a2a9086547a1bfa4b20829a945fc0a1c8e
-  data.tar.gz: da496a845d76caa9910097ad9d349ac9164f0ba1f98a3462701f4c3c59e8b96f51d4ba04c118d3584a333374845785d0929696c3ee1db004be6dd93aab7498ce
+  metadata.gz: 795a143c9b365c3f38d1794fb41f200ce0c6b9f5e5722061d31a6b27b7e9b577fb2bb747e9c8c03f26b21f68cde42ebc94ba4a3151c7c443734701c1c0a56286
+  data.tar.gz: c687ec1583a5ba413e09072adb60f206326921ce6ade5bb32a3e361aa7e5ba4fcb24bb96f786a57544b7419923ffb332526ac45dbe02e17555fc0c482fcf3cf0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_compliance (1.0.1)
+    easy_compliance (1.0.2)
       excon
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     byebug (11.1.3)
     diff-lcs (1.4.4)
-    excon (0.79.0)
+    excon (0.93.1)
     rake (13.0.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -27,6 +27,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler
@@ -36,4 +37,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.2.8
+   2.2.25

data/README.md

@@ -9,13 +9,20 @@ Ruby toolkit for https://www.easycompliance.de
 Use `EasyCompliance::Ref` to build refs for the records.
 
 ### Keeping data in sync
+When a request fails EasyCompliance will consider the request idempotent and by default retries 3 times with a delay of 5 seconds in between.
+You can adjust this to fit your needs.
 
 ```ruby
 # config/initializers/easy_compliance.rb
+# required
 EasyCompliance.api_key  = 'my_key'
 EasyCompliance.api_url  = 'https://example.com'
 EasyCompliance.app_name = 'my_app'
 
+# optional
+EasyCompliance.retry_limit     = 3 # Max number of retries (this is the default)
+EasyCompliance.retry_interval  = 5 # Delay between retries in seconds (this is the default)
+
 # app/models/my_record.rb
 class MyRecord < ActiveRecord::Base
   after_save do
@@ -26,8 +33,18 @@ end
 # app/jobs/compliance_job.rb
 class ComplianceJob
   def perform(record, value)
-    production_env? &&
-      EasyCompliance::Client.submit(record: record, value: value)
+    return unless production_env?
+
+    check = EasyCompliance::Client.submit(record: record, value: value)
+    check.hit?   # true/false
+
+    check.status # http response status e.g. 200
+    check.body   # http response body
   end
 end
 ```
+
+## License
+
+`EasyCompliance` is licensed under the [Apache 2.0 license](LICENSE.txt) and
+Copyright 2021,2022 [betterplace / gut.org gAG](https://gut.org).

data/lib/easy_compliance/client.rb

@@ -29,20 +29,37 @@ module EasyCompliance
     end
 
     HEADERS = {
-      'Content-Type': 'application/x-www-form-urlencoded',
+      'Content-Type': 'application/x-www-form-urlencoded'
     }
 
     # @return [ EasyCompliance::Result ]
     def post(**body)
-      url = EasyCompliance.api_url or raise Error, "must set api_url"
-      body[:api_key] = EasyCompliance.api_key or raise Error, "must set api_key"
-
-      res = Excon.post(url, body: URI.encode_www_form(body), headers: HEADERS)
+      body[:api_key] = EasyCompliance.api_key or raise Error, 'must set api_key'
+      res = Excon.post(
+        api_url,
+        body: URI.encode_www_form(body),
+        headers: HEADERS,
+        idempotent: true,
+        retry_limit: retry_limit,
+        retry_interval: retry_interval
+      )
       res.status < 300 or raise Error, "#{res.status}: #{res.body}"
 
       EasyCompliance::Result.new(status: res.status, body: res.body)
     rescue Excon::Error, OpenSSL::OpenSSLError => e
       raise Error, "Network error: #{e.class.name} - #{e.message}"
     end
+
+    def retry_limit
+      EasyCompliance.retry_limit || 3
+    end
+
+    def retry_interval
+      EasyCompliance.retry_interval || 5
+    end
+
+    def api_url
+      EasyCompliance.api_url || raise(Error, 'must set api_url')
+    end
   end
 end

data/lib/easy_compliance/result.rb

@@ -9,6 +9,7 @@ module EasyCompliance
     end
 
     # For methods 1-3. 204 means no hit.
+    # returns true if record was found on a sanctions lists, details in body.
     def hit?
       status == 200
     end

data/lib/easy_compliance/version.rb

@@ -1,3 +1,3 @@
 module EasyCompliance
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/easy_compliance.rb

@@ -4,7 +4,7 @@ module EasyCompliance
   class Error < StandardError; end
 
   class << self
-    attr_accessor :api_key, :api_url, :app_name
+    attr_accessor :api_key, :api_url, :app_name, :retry_limit, :retry_interval
   end
 end
 

data/spec/easy_compliance/client_spec.rb

@@ -5,12 +5,21 @@ describe EasyCompliance::Client do
   before do
     EasyCompliance.api_key = 'key'
     EasyCompliance.api_url = 'url'
+    EasyCompliance.retry_limit = nil
+    EasyCompliance.retry_interval = nil
   end
 
   describe '#post' do
     it 'posts to the API URL and returns an EasyCompliance::Result' do
       expect(Excon).to receive(:post)
-        .with('url', body: 'method=2&api_key=key', headers: anything)
+        .with(
+          'url',
+          body: 'method=2&api_key=key',
+          headers: anything,
+          idempotent: true,
+          retry_limit: 3,
+          retry_interval: 5
+        )
         .and_return(double(body: '{}', status: 200))
       result = client.post(method: 2)
       expect(result).to be_an EasyCompliance::Result
@@ -19,21 +28,42 @@ describe EasyCompliance::Client do
 
     it 'raises if the API returned a bad status code' do
       expect(Excon).to receive(:post)
-        .with('url', body: 'method=2&api_key=key', headers: anything)
+        .with(
+          'url',
+          body: 'method=2&api_key=key',
+          headers: anything,
+          idempotent: true,
+          retry_limit: 3,
+          retry_interval: 5
+        )
         .and_return(double(body: '{}', status: 500))
       expect { client.post(method: 2) }.to raise_error(client::Error, /500/)
     end
 
     it 'raises if the connection failed' do
       expect(Excon).to receive(:post)
-        .with('url', body: 'method=2&api_key=key', headers: anything)
+        .with(
+          'url',
+          body: 'method=2&api_key=key',
+          headers: anything,
+          idempotent: true,
+          retry_limit: 3,
+          retry_interval: 5
+        )
         .and_raise(Excon::Errors::SocketError.new)
       expect { client.post(method: 2) }.to raise_error(client::Error, /Socket/)
     end
 
     it 'raises if there is any OpenSSL::OpenSSLError' do
       expect(Excon).to receive(:post)
-        .with('url', body: 'method=2&api_key=key', headers: anything)
+        .with(
+          'url',
+          body: 'method=2&api_key=key',
+          headers: anything,
+          idempotent: true,
+          retry_limit: 3,
+          retry_interval: 5
+        )
         .and_raise(OpenSSL::SSL::SSLErrorWaitReadable.new)
       expect { client.post(method: 2) }.to raise_error(client::Error, /SSLError/)
     end
@@ -47,5 +77,52 @@ describe EasyCompliance::Client do
       EasyCompliance.api_url = nil
       expect { client.post(method: 2) }.to raise_error(client::Error, /api_url/)
     end
+
+    it 'uses a default value of 3 for retry_limit unless it is set' do
+      expect(Excon).to receive(:post).with(
+        'url',
+        body: 'method=2&api_key=key',
+        headers: anything,
+        idempotent: true,
+        retry_limit: 3,
+        retry_interval: 5
+      ).and_return(double(body: '{}', status: 200))
+      client.post(method: 2)
+
+      EasyCompliance.retry_limit = 0
+      expect(Excon).to receive(:post).with(
+        'url',
+        body: 'method=2&api_key=key',
+        headers: anything,
+        idempotent: true,
+        retry_limit: 0,
+        retry_interval: 5
+      ).and_return(double(body: '{}', status: 200))
+      client.post(method: 2)
+    end
+
+    it 'uses a default value of 5 for retry_interval unless it is set' do
+      EasyCompliance.retry_interval = nil
+      expect(Excon).to receive(:post).with(
+        'url',
+        body: 'method=2&api_key=key',
+        headers: anything,
+        idempotent: true,
+        retry_limit: 3,
+        retry_interval: 5
+      ).and_return(double(body: '{}', status: 200))
+      client.post(method: 2)
+
+      EasyCompliance.retry_interval = 0
+      expect(Excon).to receive(:post).with(
+        'url',
+        body: 'method=2&api_key=key',
+        headers: anything,
+        idempotent: true,
+        retry_limit: 3,
+        retry_interval: 0
+      ).and_return(double(body: '{}', status: 200))
+      client.post(method: 2)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_compliance
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - betterplace development team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.25
 signing_key:
 specification_version: 4
 summary: Ruby toolkit for https://www.easycompliance.de