symgate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b8844223c94a355ea8ad0d294d75bfa31127a27
-  data.tar.gz: 822d5a227b81ac8e4e22c6a62b07d5c813b40640
+  metadata.gz: 12436506bf7e48ebfa25ea79387998a601865c19
+  data.tar.gz: fff6e307bd114d356a4b0f3ad032313ecaa86e97
 SHA512:
-  metadata.gz: d1e6978cf81fb2f10922d9fdb3eb13c86163cc5e95a5b75e428363ecd4fe6435bbd02809c66074a8fa8df5849b82f627af7f03a87caa54286105dff6ad8a1a9b
-  data.tar.gz: a4f344a61d6cd9d6c08a7e7f3d2bc0b82a4641dc26a1cc7a2da28504e5e45b5075093e1b11ce1d632ae4c08da238e61276ab9632e586a8461b5db835e6e7af61
+  metadata.gz: ce0b1024bc72b857cab52ae2895949b050016cbf1f9d0d00d1f61c2757ae83f46e958a3307f3e7643e721fe2e21fb42dd0a149a0bec0d21e8fbde97afd2e94b1
+  data.tar.gz: 40a7d276dda83fe6407fde8855a80736177b0217a2b72460d2a7007edd91781811ef6167f60f0533559bfb8c343b5eddfd9dac8923ade5e09a7e2793e68aedc0

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.1
   Exclude:
     - 'vendor/**/*'
     - '.chef/**/*'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+
+git:
+  submodules: false
+
+before_install:
+  - gem install bundler
+
+script:
+  - bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.2.0 (2016-09-13)
+
+Updated hash syntax to be compatible with Ruby 2.1
+
+## 0.1.0 (2016-09-09)
+
+Initial release

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Symbols Worldwide Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,15 +1,33 @@
-# Symgate::Gem
+# Symgate - Ruby client for the Widgit symbolisation service
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/symgate/gem`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/symbols-worldwide/symgate-gem.svg?branch=master)](https://travis-ci.org/symbols-worldwide/symgate-gem)
+[![Code Climate](https://codeclimate.com/github/symbols-worldwide/symgate-gem.svg)](https://codeclimate.com/github/symbols-worldwide/symgate-gem)
+[![codecov.io](http://codecov.io/github/symbols-worldwide/symgate-gem/coverage.svg?branch=master)](http://codecov.io/github/symbols-worldwide/symgate-gem?branch=master)
+[![Dependency Status](https://gemnasium.com/badges/github.com/symbols-worldwide/symgate-gem.svg)](https://gemnasium.com/github.com/symbols-worldwide/symgate-gem)
+[![Gem Version](https://badge.fury.io/rb/symgate.svg)](https://badge.fury.io/rb/symgate)
+[![Apache License](https://img.shields.io/github/license/symbols-worldwide/symgate-gem.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides a wrapper around the [Symgate SOAP API](https://ws.widgitonline.com/schema/symboliser.wsdl),
+providing a simple Ruby interface that matches the remote API as much as possible.
+
+The API provides a client for each of the sections of API functionality. These are:
+
+* `Symgate::Auth::Client` for authentication, user and group management
+* `Symgate::Wordlist::Client` for per-user/group metadata storage
+* `Symgate::Metadata::Client` for per-user/group wordlist management
+
+Please note that a symbolisation client is scheduled for a future release.
+
+## Prerequisites
+
+This gem works with Ruby 2.1 and above
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'symgate-gem'
+gem 'symgate'
 ```
 
 And then execute:
@@ -18,21 +36,108 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install symgate-gem
+    $ gem install symgate
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialisation
+
+To call any Symgate methods you must create a client of the relevant type. These can
+be instantiated in the following ways:
+
+#### Account/key
+
+```ruby
+require 'symgate/auth'
+
+auth_client = Symgate::Auth::Client.new(account: 'my_account', key: 'secret')
+```
+
+#### User/password
+
+```ruby
+require 'symgate/wordlist'
+
+wordlist_client = Symgate::Wordlist::Client.new(account: 'my_account', 
+                                                user: 'group/user',
+                                                password: 'secret')
+```
+
+#### User/token
+
+You need to call the `authenticate` method in order to obtain a token:
+
+```ruby
+require 'symgate/auth'
+require 'symgate/metadata'
+
+# obtain a token from the authentication client
+
+auth_client = Symgate::Auth::Client.new(account: 'my_account', 
+                                        user: 'group/user',
+                                        password: 'secret')
+
+begin
+  token = auth_client.authenticate
+rescue Symgate::Error => e
+  puts "Authentication failed with the following error: #{e.message}"
+end
+
+metadata_client = Symgate::Metadata::Client.new(account: 'my_account',
+                                                user: 'group/user',
+                                                token: token)
+```
+
+#### Other initialisation options
+
+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 }` |
+
+### Errors
+
+If any method call fails, it will raise a `Symgate::Error` exception. Examine the exception for further information
+on what went wrong.
+
+### Further documentation
+
+For more information, see the documentation at:
+
+<http://www.rubydoc.info/github/symbols-worldwide/symgate-gem/>
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repository, run `bundle install` to obtain the necessary development gems.
+
+Run `rake test` to run the tests, which consist of
+* rubocop
+* rspec (with coverage)
+
+Successful PRs require 100% code coverage and all tests and cops passing. 
+
+### Integration tests
+
+If you want to run the integration tests (test the gem against a running server):
+1. Install Vagrant 1.8 or later, if not already installed
+2. Run `rake vagrant:up` to set up a local VM running the latest symboliser.
+3. Run `rake spec:integration` to run the integration tests.
+
+To pause testing until later, run `rake vagrant:halt` which will suspend your virtual machine. To resume testing run `rake vagrant:up` again.
+
+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.
+
+## License
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This project is licensed under the Apache License 2.0.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/symgate-gem/fork )
+1. Fork it ( https://github.com/symbols-worldwide/symgate-gem/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/symgate/auth/client.rb

@@ -5,7 +5,15 @@ module Symgate
   module Auth
     # client for the Symgate authentication system
     class Client < Symgate::Client
-      # returns a list of groups for the current symgate account
+      # Returns a list of groups for the current symgate account
+      #
+      # ==== Returns
+      #
+      # An array of group ids, as strings
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def enumerate_groups
         Symgate::Client.savon_array(
           savon_request(:enumerate_groups).body[:enumerate_groups_response],
@@ -13,28 +21,77 @@ module Symgate
         )
       end
 
-      # creates a new group
+      # Creates a new group.
+      #
+      # Raises a Symgate::Error on failure
+      #
+      # ==== Attributes
+      #
+      # * +group_id+ - The ID of the new group to create (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def create_group(group_id)
         savon_request(:create_group, returns_error_string: true) do |soap|
           soap.message(groupid: group_id)
         end
       end
 
-      # destroys an existing group
+      # Destroys an existing group
+      #
+      # *IMPORTANT*: This will permanently delete the group, along with all
+      # associated users, wordlists and metadata. Can't be undone.
+      #
+      # Raises a Symgate::Error on failure
+      #
+      # ==== Attributes
+      #
+      # * +group_id+ - The ID of the new group to create (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def destroy_group(group_id)
         savon_request(:destroy_group, returns_error_string: true) do |soap|
           soap.message(groupid: group_id)
         end
       end
 
-      # renames a group
+      # Renames a group
+      #
+      # This will require all users to use the new group_id as part of their
+      # login username in future.
+      #
+      # Raises a Symgate::Error on failure (e.g. the +new_group_id+ is invalid)
+      #
+      # ==== Attributes
+      #
+      # * +old_group_id+ - The ID of the group to rename (String)
+      # * +new_group_id+ - The new ID for the renamed group (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def rename_group(old_group_id, new_group_id)
         savon_request(:rename_group, returns_error_string: true) do |soap|
           soap.message(old_groupid: old_group_id, new_groupid: new_group_id)
         end
       end
 
-      # returns a list of users for the specified group
+      # Returns a list of users for the specified group)
+      #
+      # ==== Attributes
+      #
+      # * +group_id+ - The ID of the group (String)
+      #
+      # ==== Returns
+      #
+      # An array of Symgate::Auth::User objects
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def enumerate_users(group_id)
         resp = savon_request(:enumerate_users) { |soap| soap.message(groupid: group_id) }
 
@@ -45,7 +102,20 @@ module Symgate
         )
       end
 
-      # creates a new user from a Symgate::Auth::User, with the specified password
+      # Creates a new user
+      #
+      # Raises a Symgate::Error on failure (e.g. the +user+ is invalid, or the group
+      # specified in the User object does not exist)
+      #
+      # ==== Attributes
+      #
+      # * +user+ - A Symgate::Auth::User describing the new user
+      # * +password+ - The password for the new user (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
+      # * user (with +is_group_admin+)
       def create_user(user, password)
         savon_request(:create_user, returns_error_string: true) do |soap|
           soap.message(password: password)
@@ -53,7 +123,19 @@ module Symgate
         end
       end
 
-      # updates a user (sets the is_group_admin member)
+      # Updates a user
+      #
+      # Currently this can only be used to set the +is_group_admin+ member of
+      # the +user+ object
+      #
+      # ==== Attributes
+      #
+      # * +user+ - The updated Symgate::Auth::User object
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
+      # * user (with +is_group_admin+)
       def update_user(user)
         savon_request(:update_user, returns_error_string: true) do |soap|
           soap.message({})
@@ -61,35 +143,113 @@ module Symgate
         end
       end
 
-      # renames a user (must be within the same group)
+      # Renames a user
+      #
+      # The user cannot be renamed from one group to another - the group part of
+      # the user id should remain the same.
+      #
+      # Raises a Symgate::Error on failure (e.g. the +new_user_id+ is already taken
+      # or the user with +old_user_id+ does not exist)
+      #
+      # ==== Attributes
+      #
+      # * +old_user_id+ - The ID of the user to rename, in 'group_id/username' format (String)
+      # * +new_user_id+ - The new ID of the renamed user (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
+      # * user (with +is_group_admin+)
       def rename_user(old_user_id, new_user_id)
         savon_request(:rename_user, returns_error_string: true) do |soap|
           soap.message(old_user_id: old_user_id, new_user_id: new_user_id)
         end
       end
 
-      # moves a user between groups
+      # Moves a user between groups
+      #
+      # Moves a user from one group to another. The group part of the user ID should
+      # be changed.
+      #
+      # Raises a Symgate::Error on failure (e.g. the +new_user_id+ is already taken
+      # or the user with +old_user_id+ does not exist)
+      #
+      # ==== Attributes
+      #
+      # * +old_user_id+ - The ID of the user to move, in 'group_id/username' format (String)
+      # * +new_user_id+ - The new ID of the renamed user (String)
+      #
+      # ==== Example
+      #
+      #     auth_client.move_user('group_1/username', 'group_2/username')
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def move_user(old_user_id, new_user_id)
         savon_request(:move_user, returns_error_string: true) do |soap|
           soap.message(old_user_id: old_user_id, new_user_id: new_user_id)
         end
       end
 
-      # sets the password for a user
+      # Sets the password for a user
+      #
+      # Note that when authenticating as a user without the +is_group_admin+ permission
+      # you can only change the password for yourself.
+      #
+      # Raises a Symgate::Error on failure (e.g. the user identified by +user_id+
+      # does not exist, or you do not have sufficient permissions to update the password.)
+      #
+      # ==== Attributes
+      #
+      # * +user_id+ - The ID of the user for whom the password is to be changed
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
+      # * user
       def set_user_password(user_id, password)
         savon_request(:set_user_password, returns_error_string: true) do |soap|
           soap.message(userid: user_id, password: password)
         end
       end
 
-      # destroys a user
+      # Destroys a user
+      #
+      # *IMPORTANT*: This will irreversibly destroy all wordlists and metadata
+      # belonging to the user
+      #
+      # ==== Attributes
+      #
+      # * +user_id+ - The ID of the user for whom the password is to be changed
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
+      # * user (with +is_group_admin+)
       def destroy_user(user_id)
         savon_request(:destroy_user, returns_error_string: true) do |soap|
           soap.message(userid: user_id)
         end
       end
 
-      # authenticates a user and returns a token, optionally with a user to impersonate
+      # Authenticates a user and returns a token
+      #
+      # This optionally provides a token which allows you to 'impersonate' a user
+      # (i.e. use the API as if you were logged on as that user)
+      #
+      # Raises a Symgate::Error on error (e.g. authentication fails)
+      #
+      # ==== Attributes
+      #
+      # * +user_to_impersonate+ (optional) - The ID (String) of the user to impersonate
+      #
+      # ==== Returns
+      #
+      # A token, used for further calls to the client (String)
+      #
+      # * account/key (requires +user_to_impersonate+)
+      # * user (cannot use +user_to_impersonate+)
       def authenticate(user_to_impersonate = nil)
         r = savon_request(:authenticate) do |soap|
           soap.message(userid: user_to_impersonate) if user_to_impersonate
@@ -98,23 +258,65 @@ module Symgate
         r ? r[:authtoken] : nil
       end
 
-      # adds a language to the specified group and returns 'OK' if successful or
-      # 'Exists' if the language is already assigned to the account
+      # Adds a language to the specified group
+      #
+      # This enables users within the group to use the Symboliser in that language.
+      #
+      # ==== Attributes
+      #
+      # * +group+ - The ID of the group to add the language to (String)
+      # * +language+ - The cml language to enable (String)
+      #
+      # ==== Returns
+      #
+      # Returns 'OK' if successful or 'Exists' if the language is already assigned
+      # to the account (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def add_group_language(group, language)
         savon_request(:add_group_language) do |soap|
           soap.message(groupid: group, language: language)
         end.body[:add_group_language_response]
       end
 
-      # removes a language from the specified group and returns 'OK' if successful or
-      # 'NotExist' if the language is not assigned to the account
+      # Removes a language from the specified group
+      #
+      # This prevents users within the group to use the Symboliser in that language.
+      #
+      # ==== Attributes
+      #
+      # * +group+ - The ID of the group to remove the language from(String)
+      # * +language+ - The cml language to disable (String)
+      #
+      # ==== Returns
+      #
+      # Returns 'OK' if successful or 'NotExist' if the language is not assigned
+      # to the account (String)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def remove_group_language(group, language)
         savon_request(:remove_group_language) do |soap|
           soap.message(groupid: group, language: language)
         end.body[:remove_group_language_response]
       end
 
-      # lists the languages assigned to a group
+      # Lists the allowed languages for the specified group
+      #
+      # ==== Attributes
+      #
+      # * +group_id+ - The ID of the group (String)
+      #
+      # ==== Returns
+      #
+      # Returns an array of cml languages as strings
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def enumerate_group_languages(group_id)
         resp = savon_request(:enumerate_group_languages) { |soap| soap.message(groupid: group_id) }
 
@@ -124,14 +326,35 @@ module Symgate
         )
       end
 
-      # queries whether a language is available for a group
+      # Queries whether a language is assigned to a group
+      #
+      # ==== Attributes
+      #
+      # * +group+ - The ID of the group  (String)
+      # * +language+ - The cml language to query (String)
+      #
+      # ==== Returns
+      #
+      # Returns true if the user has the language assigned, otherwise false (Boolean)
+      #
+      # ==== Supported authentication types
+      #
+      # * account/key
       def query_group_language(group_id, language)
         savon_request(:query_group_language) do |soap|
           soap.message(groupid: group_id, language: language)
         end.body[:query_group_language_response]
       end
 
-      # lists the language for the currently authenticated user
+      # Lists the allowed languages for the currently authenticated user
+      #
+      # ==== Returns
+      #
+      # Returns an array of cml languages as strings
+      #
+      # ==== Supported authentication types
+      #
+      # * user
       def enumerate_languages
         resp = savon_request(:enumerate_languages)
 
@@ -141,7 +364,19 @@ module Symgate
         )
       end
 
-      # queries whether a language is available for the currently authenticated user
+      # Queries whether a language is assigned to the currently authenticated user
+      #
+      # ==== Attributes
+      #
+      # * +language+ - The cml language to query (String)
+      #
+      # ==== Returns
+      #
+      # Returns true if the user has the language assigned, otherwise false (Boolean)
+      #
+      # ==== Supported authentication types
+      #
+      # * user
       def query_language(language)
         savon_request(:query_language) { |soap| soap.message(language: language) }
           .body[:query_language_response]

data/lib/symgate/client.rb

@@ -66,15 +66,15 @@ module Symgate
 
     # builds a credentials object - required for all requests
     def savon_creds
-      creds = { 'auth:account': @account }
+      creds = { %s(auth:account) => @account }
       creds[:'auth:key'] = @key if @key
       creds[:'auth:user'] = savon_user if @user
 
-      { 'auth:creds': creds }
+      { %s(auth:creds) => creds }
     end
 
     def savon_user
-      user = { 'auth:id': @user }
+      user = { %s(auth:id) => @user }
       user[:'auth:password'] = @password if @password
       user[:'auth:authtoken'] = @token if @token
 

data/lib/symgate/cml/symbol.rb

@@ -21,16 +21,16 @@ module Symgate
 
       def to_soap
         {
-          'cml:symset': symset,
-          'cml:main': main,
-          'cml:top_left': top_left,
-          'cml:top_right': top_right,
-          'cml:bottom_left': bottom_left,
-          'cml:bottom_right': bottom_right,
-          'cml:full_left': full_left,
-          'cml:full_right': full_right,
-          'cml:top': top,
-          'cml:extra': extra
+          %s(cml:symset) => symset,
+          %s(cml:main) => main,
+          %s(cml:top_left) => top_left,
+          %s(cml:top_right) => top_right,
+          %s(cml:bottom_left) => bottom_left,
+          %s(cml:bottom_right) => bottom_right,
+          %s(cml:full_left) => full_left,
+          %s(cml:full_right) => full_right,
+          %s(cml:top) => top,
+          %s(cml:extra) => extra
         }.delete_if { |_, v| v.nil? }
       end
 

data/lib/symgate/metadata/client.rb

@@ -43,7 +43,7 @@ module Symgate
         raise Symgate::Error, 'No items supplied' if i.empty?
 
         savon_request(:set_metadata, returns_error_string: true) do |soap|
-          soap.message('auth:data_item': i.map(&:to_soap))
+          soap.message(%s(auth:data_item) => i.map(&:to_soap))
         end
       end
 

data/lib/symgate/metadata/data_item.rb

@@ -14,9 +14,9 @@ module Symgate
 
       def to_soap
         {
-          '@key': key,
-          '@scope': scope,
-          'auth:value': value
+          %s(@key) => key,
+          %s(@scope) => scope,
+          %s(auth:value) => value
         }
       end
 

data/lib/symgate/namespaces.rb

@@ -1,9 +1,9 @@
 module Symgate
   NAMESPACES = {
-    'xmlns:auth': 'http://ws.widgit.com/schema/auth/1.2',
-    'xmlns:wl': 'http://ws.widgit.com/schema/wordlist/1.2',
-    'xmlns:cml': 'http://ws.widgit.com/schema/cml/2.0',
-    'xmlns:gt': 'http://ws.widgit.com/schema/globaltypes/1.2',
-    'xmlns:symboliser': 'http://ws.widgit.com/schema/symboliser/1.2'
+    %s(xmlns:auth) => 'http://ws.widgit.com/schema/auth/1.2',
+    %s(xmlns:wl) => 'http://ws.widgit.com/schema/wordlist/1.2',
+    %s(xmlns:cml) => 'http://ws.widgit.com/schema/cml/2.0',
+    %s(xmlns:gt) => 'http://ws.widgit.com/schema/globaltypes/1.2',
+    %s(xmlns:symboliser) => 'http://ws.widgit.com/schema/symboliser/1.2'
   }.freeze
 end

data/lib/symgate/version.rb

@@ -1,3 +1,3 @@
 module Symgate
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/symgate/wordlist/client.rb

@@ -93,7 +93,7 @@ module Symgate
         end
 
         savon_request(:insert_wordlist_entry, returns_error_string: true) do |soap|
-          soap.message(wordlistid: uuid, 'wl:wordlistentry': entry.to_soap)
+          soap.message(wordlistid: uuid, %s(wl:wordlistentry) => entry.to_soap)
         end
       end
 
@@ -102,7 +102,7 @@ module Symgate
         check_array_for_type(entries, Symgate::Wordlist::Entry)
 
         savon_request(:overwrite_wordlist, returns_error_string: true) do |soap|
-          soap.message(wordlistid: uuid, 'wl:wordlistentry': entries.map(&:to_soap))
+          soap.message(wordlistid: uuid, %s(wl:wordlistentry) => entries.map(&:to_soap))
         end
       end
 
@@ -158,7 +158,7 @@ module Symgate
           context: context,
           scope: scope_for_context(context)
         }.merge(
-          entries ? { 'wl:wordlistentry': entries.map(&:to_soap) } : {}
+          entries ? { %s(wl:wordlistentry) => entries.map(&:to_soap) } : {}
         )
       end
     end

data/lib/symgate/wordlist/entry.rb

@@ -24,13 +24,13 @@ module Symgate
 
       def to_soap
         {
-          'wl:word': word,
-          'wl:uuid': uuid,
-          'wl:priority': priority,
-          'wl:conceptcode': value_or_nil(concept_code),
-          'cml:symbol': @symbols.tryit { map(&:to_soap) },
-          'wl:customgraphic': @custom_graphics.tryit { map(&:to_soap) },
-          'wl:lastchange': last_change.to_s
+          %s(wl:word) => word,
+          %s(wl:uuid) => uuid,
+          %s(wl:priority) => priority,
+          %s(wl:conceptcode) => value_or_nil(concept_code),
+          %s(cml:symbol) => @symbols.tryit { map(&:to_soap) },
+          %s(wl:customgraphic) => @custom_graphics.tryit { map(&:to_soap) },
+          %s(wl:lastchange) => last_change.to_s
         }.delete_if { |_, v| v.nil? }
       end
 

data/lib/symgate/wordlist/graphic_attachment.rb

@@ -17,9 +17,9 @@ module Symgate
 
       def to_soap
         {
-          'wl:type': @type,
-          'wl:uuid': @uuid,
-          'wl:data': @data ? Base64.encode64(@data) : nil
+          %s(wl:type) => @type,
+          %s(wl:uuid) => @uuid,
+          %s(wl:data) => @data ? Base64.encode64(@data) : nil
         }
       end
 

data/symgate-gem.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'mysql2', '~> 0.4.1'
   spec.add_development_dependency 'simplecov', '~> 0.12.0'
   spec.add_development_dependency 'simplecov-teamcity-summary', '~> 0.1.2'
+  spec.add_development_dependency 'codecov'
 
   spec.add_dependency 'savon', '~> 2.11.0'
   spec.add_dependency 'tryit', '~> 0.0.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symgate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Detheridge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -190,7 +204,10 @@ files:
 - ".junit/.git-keep"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/symgate.rb