symgate 0.2.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff7740ff5f9152bd4f3cb84514f5eef0321dcd83
-  data.tar.gz: c448385487c3563ec1c8ca38c8ed9f24ccd48caf
+SHA256:
+  metadata.gz: efc49ad2189b8c02639f72b0332ddcebf27ca7485616a29e89e9e2656ab7f543
+  data.tar.gz: 1eef068e585c5fbc94ee1c7818003a4f94b2381a4d67f85ab3711b4332620449
 SHA512:
-  metadata.gz: cf1198a9ffa373baf1c06c9ab1dfbb331919124d85fc223534add2b758178224363688d6cb58e90e6c66bf6b4164048e2e6a8db94cadd4705068433234b71f69
-  data.tar.gz: 672fac7436ee70a62e0587e8be9aec6c3e9d51ff17105a18a24402192111abba7a41ea30ecbdd63bdacd79eb283eb114c838c6479020160d1eec4f98ea9a4fae
+  metadata.gz: e8b6e1c64b6b74e7e46a6c6064686eeaa9084fd8bf12d5cca0bf11d4742495376bf01fd326e9c143a50f35f3dcf4f507d88443a9cae62acbceaf59139e0493cb
+  data.tar.gz: '058bbc6730fc610343a5242decf25a0e5f69c66df8be15247cf63597b161d68bcfeff3eebfcc79a45b4ecb597c8ab3e1b2cff99c3f69a7cfb1f8bc03c3b41fac'

data/.gitignore

@@ -17,3 +17,4 @@
 /vendor/
 /coverage/
 /coverage.zip
+/test/config/local.yml

data/.rubocop.yml

@@ -6,20 +6,47 @@ AllCops:
     - 'local-mode-cache/**/*'
     - 'symboliser-vagrant/**/*'
 
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 Metrics/MethodLength:
-  Max: 12
-
-Style/NumericLiterals:
-  MinDigits: 6
+  Max: 20
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 2000
 
 Metrics/BlockLength:
-  Max: 1000
+  Max: 2000
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Metrics/ParameterLists:
+  Max: 9
 
 Naming/UncommunicativeMethodParamName:
   MinNameLength: 2
+
+Naming/AccessorMethodName:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.2.1
+3.0.2

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.1.10
   - 2.2.5
   - 2.3.1
+  - 3.0.2
 
 git:
   submodules: false

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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
+work correctly with the latest symboliser
+
 ## 0.2.3 (2018-10-23)
 
 Fix for invalid SOAP XML due to duplicate attributes (issue #3) 

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
 
@@ -131,6 +132,10 @@ To shut down and destroy the VM completely, run `rake vagrant:destroy`
 
 Note that you need access to the Widgit CI server for this to work.
 
+Alternatively, in the highly unlikely event that the Vagrant stuff doesn't work, you can run the tests against some
+other running symboliser by copying `test/config/local.example.yml` to `test/config/local.yml` and editing `local.yml`
+to include the particulars of your symboliser endpoint, database and WSDL.
+
 ## License
 
 This project is licensed under the Apache License 2.0.

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/metadata/client.rb

@@ -2,8 +2,6 @@ require 'symgate/client'
 require 'symgate/error'
 require 'symgate/metadata/data_item'
 
-# rubocop:disable Naming/AccessorMethodName
-
 module Symgate
   module Metadata
     # client for the Symgate metadata system
@@ -70,5 +68,3 @@ module Symgate
     end
   end
 end
-
-# rubocop:enable Naming/AccessorMethodName

data/lib/symgate/version.rb

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

data/lib/symgate/wordlist/client.rb

@@ -27,18 +27,18 @@ module Symgate
 
       # creates a wordlist with the specified name, context and scope (see auth:scope).
       # optionally, supply a list of entries to form the wordlist's initial content
-      def create_wordlist(name, context, entries = [])
+      def create_wordlist(name, context, entries = [], readonly: false)
         tries ||= 3 # TODO: Find out if we still need to do this!
 
         Symgate::Wordlist::Info.from_soap(
           savon_request(:create_wordlist) do |soap|
-            soap.message(soap_params_for_create_wordlist(name, context, entries))
+            soap.message(soap_params_for_create_wordlist(name, context, readonly, entries))
           end.body[:create_wordlist_response][:wordlistinfo]
         )
       rescue Symgate::Error => e
         # Handle SOS-105 (sometimes the wordlist is created but the symboliser claims it can't
-        # find it and sends a SOAP error back) by extract the wordlist UUID from the error message.
-        # Yes, this is not nice.
+        # find it and sends a SOAP error back) by extracting the wordlist UUID from the error
+        # message. Yes, this is not nice.
         match = /^No wordlist found for ID: ({[0-9a-f-]{36}})$/.match(e.detail)
 
         return get_wordlist_info(match[1]) if match
@@ -67,6 +67,28 @@ module Symgate
         )
       end
 
+      # Copies a wordlist with the specified UUID with optional parameters to specify the destination wordlist UUID, the
+      # context, name and readonlyness of the destination wordlist, source and destination group and/or user
+      def copy_wordlist(src_uuid, dest_uuid: nil, context: nil, name: nil, readonly: nil,
+                        src_group: nil, src_user: nil, dest_group: nil, dest_user: nil)
+        response = savon_request(:copy_wordlist) do |soap|
+          params = { srcwordlistuuid: src_uuid }
+          params[:dstwordlistuuid] = dest_uuid unless dest_uuid.nil?
+          params[:context] = context unless context.nil?
+          params[:name] = name unless name.nil?
+          params[:readonly] = readonly unless readonly.nil?
+          params[:srcgroup] = src_group unless src_group.nil?
+          params[:srcusername] = src_user unless src_user.nil?
+          params[:dstgroup] = dest_group unless dest_group.nil?
+          params[:dstusername] = dest_user unless dest_user.nil?
+          soap.message(params)
+        end
+
+        Symgate::Wordlist::Info.from_soap(
+          response.body[:copy_wordlist_response][:wordlistinfo]
+        )
+      end
+
       # returns all wordlist entries for the wordlist specified by uuid.
       # accepts the following optional parameters:
       #   attachments (boolean) - fetch custom graphics for the entries (default: false)
@@ -77,7 +99,7 @@ module Symgate
         check_for_multiple_opts(%i[match entry], opts)
 
         response = savon_request(:get_wordlist_entries) do |soap|
-          soap.message(wordlistid: uuid, getattachments: opts[:attachments])
+          soap.message(wordlistid: uuid, getattachments: !!opts[:attachments])
           soap[:message][:match] = { matchstring: opts[:match] } if opts.include? :match
           soap[:message][:match] = { entryid: opts[:entry] } if opts.include? :entry
         end
@@ -132,11 +154,12 @@ module Symgate
 
       # creates a wordlist from the supplied cfwl data, in the requested context
       # if 'preserve_uuid' is true, the new wordlist will have the same uuid as the file
-      def create_wordlist_from_cfwl_data(raw_cfwl_data, context, preserve_uuid)
+      def create_wordlist_from_cfwl_data(raw_cfwl_data, context, preserve_uuid, readonly: false)
         savon_request(:create_wordlist_from_cfwl_data) do |soap|
           soap.message(cfwl: Base64.encode64(raw_cfwl_data),
                        context: context,
-                       preserve_uuid: preserve_uuid)
+                       preserve_uuid: preserve_uuid,
+                       readonly: readonly)
         end.body[:create_wordlist_from_cfwl_data_response][:uuid]
       end
 
@@ -153,11 +176,12 @@ module Symgate
         end
       end
 
-      def soap_params_for_create_wordlist(name, context, entries)
+      def soap_params_for_create_wordlist(name, context, readonly, entries)
         {
           name: name,
           context: context,
-          scope: scope_for_context(context)
+          scope: scope_for_context(context),
+          readonly: readonly
         }.merge(
           entries ? { %s(wl:wordlistentry) => entries.map(&:to_soap) } : {}
         )

data/lib/symgate/wordlist/info.rb

@@ -11,6 +11,7 @@ module Symgate
           uuid: hash_value_with_optional_namespace(:wl, :uuid, hash),
           engine: hash_value_with_optional_namespace(:wl, :engine, hash),
           scope: hash_value_with_optional_namespace(:wl, :scope, hash),
+          readonly: hash_value_with_optional_namespace(:wl, :readonly, hash),
           entry_count: hash_value_with_optional_namespace(:wl, :entrycount, hash).to_i,
           last_change: hash_value_with_optional_namespace(:wl, :lastchange, hash)
         )
@@ -23,7 +24,7 @@ module Symgate
       protected
 
       def attributes
-        %i[name context uuid entry_count last_change engine scope]
+        %i[name context uuid entry_count last_change engine scope readonly]
       end
     end
   end

data/symgate-gem.gemspec

@@ -5,8 +5,10 @@ require 'symgate'
 Gem::Specification.new do |spec|
   spec.name          = 'symgate'
   spec.version       = Symgate::VERSION
-  spec.authors       = ['Simon Detheridge']
-  spec.email         = ['simon@widgit.com']
+  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'
@@ -17,18 +19,18 @@ 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 'codecov'
-  spec.add_development_dependency 'mysql2', '~> 0.4.1'
-  spec.add_development_dependency 'rack', '~> 1.6.4'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
-  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2.3'
+  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', '~> 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'
   spec.add_development_dependency 'rubocop', '~> 0.57.0'
-  spec.add_development_dependency 'rubocop-junit-formatter', '~> 0.1.3'
-  spec.add_development_dependency 'simplecov', '~> 0.12.0'
-  spec.add_development_dependency 'simplecov-teamcity-summary', '~> 0.1.2'
+  spec.add_development_dependency 'rubocop-junit-formatter', '~> 0.1.4'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
+  spec.add_development_dependency 'simplecov-teamcity-summary', '~> 1.0.0'
 
-  spec.add_dependency 'savon', '~> 2.11.0'
+  spec.add_dependency 'savon', '~> 2.12.0'
   spec.add_dependency 'tryit', '~> 0.0.1'
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: symgate
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Simon Detheridge
+- Tim Down
+- Stu Wright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,98 +18,98 @@ 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
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.16
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -128,56 +130,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: simplecov-teamcity-summary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: tryit
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +196,7 @@ dependencies:
         version: 0.0.1
 description: 
 email:
-- simon@widgit.com
+- tim@widgit.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -231,7 +233,8 @@ files:
 - lib/symgate/wordlist/info.rb
 - symgate-gem.gemspec
 homepage: https://github.com/symbols-worldwide/symgate-gem
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -241,15 +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: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Wrapper around Widgit's Symgate SOAP symboliser