et_ccd_client 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ebbc707aa7e9d8494b95b0edc2fccadc0d8eeede960ba14667b61748460c82f
+  data.tar.gz: 1f4cb0b5b8bc1ad802ec1e0cc40f355a7de2485f05efd65ca0bc74da4c3e81a2
+SHA512:
+  metadata.gz: 96b6494ebfebeb8216301ae2e2b1f7b89c2ae81719636f1e287eaa9fe8c4e5973fa26a4a3995e0a2240f673f98b400f938bb7d4b660cc9941835e933118e02e6
+  data.tar.gz: 6ad953780cc779046731514478a7e4dbcf5779f5f4185389f7365e03b9d6d7f1da3906dde39dedfc76e7ef574e771c96cfb86618c6f716e4be29665d8feb05a1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,200 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  # Exclude anything that isn't really part of our code.
+  # rails_helper is excluded because it's full of solecisms, but it's mostly
+  # generated code and copy-and-pasted snipets from READMEs.
+  Exclude:
+    - 'bin/**/*'
+    - '**/*.gemspec'
+    - '**/Rakefile'
+    - 'Gemfile'
+
+# Allow long lines in specs, as it's almost impossible to fit RSpec's
+# expectations into 80 characters.
+Metrics/LineLength:
+  Max: 180
+  Exclude:
+    - 'spec/**/*'
+    - 'Gemfile'
+Metrics/ModuleLength:
+  Max: 120
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/**/*'
+
+# Allow expect {}.to blocks in specs
+# but not in the code
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+Layout/TrailingBlankLines:
+  Enabled: true
+# Don't worry about long methods in specs.
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+    - 'spec/**/*'
+
+# No need to check for describe class param in support files.
+RSpec/DescribeClass:
+  Enabled: true
+
+# private/protected/public
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+
+# Just indent parameters by two spaces. It's less volatile if methods change,
+# and there's less busy work lining things up.
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    each_with_object: 'inject'
+    inject: 'inject'
+    reduce: 'inject'
+    detect: 'find'
+    find_all: 'select'
+
+# Chain methods with trailing dots.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# No, we don't prefer each_with_object
+Style/EachWithObject:
+  Enabled: false
+
+# Prefer blank line after class/module start.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# We have a mixture at the moment, so don't enforce anything.
+Style/FormatString:
+  Enabled: false
+
+# It's not really clearer to replace every if with a return if.
+Style/GuardClause:
+  Enabled: false
+
+# Groups of three is not always the right thing for numeric literals
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Percent-formatting and hash interpolation both have their place. Don't
+# enforce any particular one.
+Style/StringLiterals:
+  Enabled: false
+
+# I'm happy with raise, thanks.
+Style/SignalException:
+  Enabled: false
+
+# Let us use foo? methods
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/MixinUsage:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+
+# Prefer sensible naming to comments everywhere.
+Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+
+# Would enforce do_y if x over if x / do y / end. As with GuardClause above,
+# this enforces code organisation that doesn't necesarily make things clearer.
+IfUnlessModifier:
+  Enabled: false
+
+# Allow safe assignment in conditions.
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# Just a preference to use %w[] over %w()
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+    '%i': '[]'
+
+# %w doesn't always make for clearer test data
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+RSpec/NestedGroups:
+  Max: 10
+
+RSpec/ExpectActual:
+  Exclude:
+    - 'spec/routing/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'test_common/**/*'
+    - 'config/**/*'
+    - 'lib/tasks/**/*'
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# ---------------
+# HttpPositionalArguments is rails 5 only
+# https://github.com/bbatsov/rubocop/issues/3629
+# ---------------
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/features/**/*'
+
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+
+Rails/OutputSafety:
+  Exclude:
+    - 'app/helpers/yaml_helper.rb'
+Capybara/FeatureMethods:
+  Exclude:
+    - 'spec/features/**/*'
+
+Naming/PredicateName:
+  Exclude:
+    - 'test_common/**/*'
+
+require: rubocop-rspec

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-01-23 14:18:18 +0000 using RuboCop version 0.47.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install:
+  - gem uninstall bundler
+  - gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in et_ccd_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    et_ccd_client (0.3.1)
+      addressable (~> 2.6)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rest-client (~> 2.0, >= 2.0.2)
+      rotp (~> 6.0)
+      webmock (~> 3.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    connection_pool (2.2.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    jaro_winkler (1.5.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    netrc (0.11.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    public_suffix (4.0.6)
+    rack (2.0.7)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    rotp (6.2.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.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.6.0)
+    webmock (3.11.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  et_ccd_client!
+  rack (~> 2.0, >= 2.0.7)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.71.0)
+  rubocop-rspec (~> 1.33)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Gary Taylor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# EtCcdClient
+
+The ET CCD Client is a ruby interface to the CCD API and the CCD UI API specifically for employment
+tribunals.
+
+Note that this is general purpose CCD stuff, but this gem cannot claim to be a full CCD client
+as it only has methods specific to employment tribunal.
+
+In general, the EtApiClient::Client is used for the main CCD API where the secret is known and the
+EtApiClient::UiClient is used to access the UI (front end) API where a username and password is known (generally
+ in a test environment)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'et_ccd_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install et_ccd_client
+
+## Usage (Main CCD API)
+
+```
+
+client = EtApiClient::Client.new
+client.login
+
+client.caseworker_search_latest_by_reference('222000000100', case_type_id: 'EmpTrib_MVP_1.0_Manc')
+
+```
+
+## Usage (UI API)
+
+```
+client = EtApiClient::UiClient.new
+client.login
+
+client.search_latest_by_reference('222000000100', case_type_id: 'EmpTrib_MVP_1.0_Manc')
+
+```
+## Configuration
+
+To configure the client, use a block like this :-
+
+```
+EtCcdClient.config do |c|
+    c.auth_base_url = <value>
+    c.idam_base_url = <value>
+    c.data_store_base_url = <value>
+    c.document_store_base_url = <value>
+    c.document_store_url_rewrite = <false OR 4 element array containing source_host, source_port, dest_host, dest_port for rewriting - used in docker environment only>
+    c.ecm_base_url = <value> (This is the ECM service known as docmosis but it is much more than that)
+    c.jurisdiction_id = <value>
+    c.microservice = <value>
+    c.microservice_secret = <value>
+    c.idam_ui_base_url = <value> (Only needed if using UI API)
+    c.idam_ui_redirect_url = <value> (Only needed if using UI API)
+    c.use_sidam = <value> (If true uses sidam - else tidam)
+    c.sidam_username = <value> (Only needed if use_sidam is true)
+    c.sidam_password = value (Only needed if use_sidam is true)
+    c.user_id = <value> (Only needed if use_sidam is false)
+    c.user_role = <value> (Only needed if use_sidam is false)
+    c.pool_size = <value> The size of the connection pool (do not set lower than number of sidekiq threads)
+    c.pool_timeout = <value) The time in seconds where we give up waiting for someone to release a client to the pool
+    c.logger = Rails.logger (or any instance of an active support logger if you dont have rails)
+end
+
+```
+
+If you don't set any of these, the defaults should work with local ccd-docker
+
+If you don't set the logger, no logging output will be sent.
+If you share your rails logger or configure a new one, only debug output is set generally.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hmcts/et_ccd_client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).