symgate 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23804f86b9de8e1bab9c0384217f0e5f5a3a853d01ddf26acb07d1377bb3c8ba
-  data.tar.gz: 8cb335b86699f2bcf0c32cad06354a1e48aa12a3cfe80a745a369d3e366cc046
+  metadata.gz: efc49ad2189b8c02639f72b0332ddcebf27ca7485616a29e89e9e2656ab7f543
+  data.tar.gz: 1eef068e585c5fbc94ee1c7818003a4f94b2381a4d67f85ab3711b4332620449
 SHA512:
-  metadata.gz: ad8da67d0ea94083948a155660f3904c31b19546c243bad8bf3debf64df813ced13f8951bf8c9e7b1310a73ac276ef3fde3f69b4830c78bd99a9931a08b94359
-  data.tar.gz: 8c5da32f7c9105d5d5fa4922dd97c866702d460f43fe97b7446b288fb4d4d76b726fbe57fc3524a03f26dd4e8184dd65e2c6ae46127857a942235b688d8ffd33
+  metadata.gz: e8b6e1c64b6b74e7e46a6c6064686eeaa9084fd8bf12d5cca0bf11d4742495376bf01fd326e9c143a50f35f3dcf4f507d88443a9cae62acbceaf59139e0493cb
+  data.tar.gz: '058bbc6730fc610343a5242decf25a0e5f69c66df8be15247cf63597b161d68bcfeff3eebfcc79a45b4ecb597c8ab3e1b2cff99c3f69a7cfb1f8bc03c3b41fac'

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.0.2

data/.travis.yml

@@ -3,12 +3,13 @@ rvm:
   - 2.1.10
   - 2.2.5
   - 2.3.1
+  - 3.0.2
 
 git:
   submodules: false
 
 before_install:
-  - gem install bundler -v '< 2'
+  - gem install bundler
 
 script:
   - bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.4.1 (2021-09-06)
+
+Allow a configurable number of retries for a 'Data required for operation' error
+
+## 0.4.0 (2019-12-13)
+
+Add support for copy-on-write wordlists for symboliser builds that support this
+
+## 0.3.0 (2019-07-19)
+
+Add support for read-only wordlists
+
 ## 0.2.4 (2018-10-25)
 
 Make attachments option in get_wordlist_entries truly optional and update integration tests to

data/README.md

@@ -94,8 +94,9 @@ You can also initialise a client with the following options:
 
 | Option      |     |
 | ----------- | --- |
-| :endpoint   | Specifies the symbolisation SOAP endpoint to use, if not the public symbolisation server. |
-| :savon_opts | Specifies options to pass to the underlying savon engine. e.g. `{ log_level: :debug }` |
+| :endpoint                    | Specifies the symbolisation SOAP endpoint to use, if not the public symbolisation server. |
+| :savon_opts                  | Specifies options to pass to the underlying savon engine. e.g. `{ log_level: :debug }` |
+| :data_required_error_retries | Specifies the number of times to attempt a request when the response is 'Data required for operation'. |
 
 ### Errors
 

data/lib/symgate/client.rb

@@ -6,7 +6,8 @@ module Symgate
   # A generic client for the Symgate API.
   # See the WSDL for full documentation
   class Client
-    attr_accessor :wsdl, :endpoint, :user, :password, :token, :account, :key, :savon_opts
+    attr_accessor :wsdl, :endpoint, :user, :password, :token, :account, :key, :savon_opts,
+                  :data_required_error_retries
     attr_reader :savon_client
 
     # Constructs a new client with the provided options
@@ -14,6 +15,7 @@ module Symgate
       @wsdl = 'https://ws.widgitonline.com/schema/symboliser.wsdl'
       @endpoint = 'https://ws.widgitonline.com/'
       @savon_opts = {}
+      @data_required_error_retries = 3
       opts.each { |k, v| instance_variable_set("@#{k}", v) }
 
       validate_client_options
@@ -83,16 +85,30 @@ module Symgate
     # sends a request to the server and yields a soap block for defining the
     # message body
     def savon_request(method, opts = {})
-      r = @savon_client.call(method) do |soap|
-        yield soap if block_given?
-        soap.message({}) if soap[:message].nil?
-        soap[:message].merge!(savon_creds)
-      end
+      attempts = 0
+
+      begin
+        attempts += 1
+
+        r = @savon_client.call(method) do |soap|
+          yield soap if block_given?
+          soap.message({}) if soap[:message].nil?
+          soap[:message].merge!(savon_creds)
+        end
 
-      raise_error_on_string_response(r, "#{method}_response".to_sym) if opts[:returns_error_string]
-      r
-    rescue Savon::SOAPFault => e
-      raise Symgate::Error.from_savon(e)
+        raise_error_on_string_response(r, "#{method}_response".to_sym) if opts[:returns_error_string]
+
+        r
+      rescue Savon::SOAPFault => e
+        # Allow a configurable number of retries for a 'Data required for operation' error. This is because the
+        # symboliser occasionally throw this error when it shouldn't and succeeds on retry. It's not ideal that we have
+        # to rely on the fault string, however.
+        if attempts < @data_required_error_retries && e.to_hash[:fault][:faultstring] == 'Data required for operation'
+          retry
+        end
+
+        raise Symgate::Error.from_savon(e)
+      end
     end
 
     def raise_error_on_string_response(response, response_type)

data/lib/symgate/error.rb

@@ -5,7 +5,7 @@ module Symgate
   class Error < StandardError
     attr_reader :original_error, :detail
 
-    # Initialises a symgate error from either a string or a savon error
+    # Initialises a symgate error from either a string or a Savon error
     def initialize(message)
       super(message)
     end

data/lib/symgate/version.rb

@@ -1,3 +1,3 @@
 module Symgate
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/symgate-gem.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Simon Detheridge', 'Tim Down', 'Stu Wright']
   spec.email         = ['tim@widgit.com']
   spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.1'
 
   spec.summary       = "Wrapper around Widgit's Symgate SOAP symboliser"
   spec.homepage      = 'https://github.com/symbols-worldwide/symgate-gem'
@@ -18,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'codecov', '~> 0.1.16'
   spec.add_development_dependency 'mysql2', '~> 0.5.3'
-  spec.add_development_dependency 'rack', '~> 1.6.11'
+  spec.add_development_dependency 'rack', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symgate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Simon Detheridge
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.11
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.11
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -244,14 +244,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Wrapper around Widgit's Symgate SOAP symboliser