et_ccd_client 0.3.1

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "et_ccd_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/et_ccd_client.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "et_ccd_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "et_ccd_client"
+  spec.version       = EtCcdClient::VERSION
+  spec.authors       = ["Gary Taylor"]
+  spec.email         = ["gary.taylor@hmcts.net"]
+
+  spec.summary       = %q{A client to communicate with the employment tribunals CCD system}
+  spec.description   = %q{This client implements methods to call the relevant CCD endpoints for the employment tribunals CCD system}
+  spec.homepage      = "https://github.com/hmcts/et-ccd-client-ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'addressable', '~> 2.6'
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency 'webmock', '~> 3.6'
+  spec.add_dependency 'rotp', '~> 6.0'
+  spec.add_dependency 'connection_pool', '~> 2.2', '>= 2.2.2'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
+  spec.add_development_dependency 'rack', '~> 2.0', '>= 2.0.7'
+end

data/lib/et_ccd_client.rb

@@ -0,0 +1,18 @@
+require "et_ccd_client/version"
+require 'et_ccd_client/null_logger'
+require 'et_ccd_client/config'
+require 'et_ccd_client/idam_client'
+require 'et_ccd_client/tidam_client'
+require 'et_ccd_client/client'
+require 'et_ccd_client/ui_client'
+require 'et_ccd_client/exceptions'
+require 'et_ccd_client/uploaded_file'
+
+module EtCcdClient
+  class Error < StandardError; end
+
+  def self.config
+    yield Config.instance if block_given?
+    Config.instance
+  end
+end

data/lib/et_ccd_client/client.rb

@@ -0,0 +1,291 @@
+require "addressable/template"
+require 'rest_client'
+require 'et_ccd_client/idam_client'
+require 'et_ccd_client/config'
+require 'et_ccd_client/exceptions'
+require 'et_ccd_client/common_rest_client'
+require 'et_ccd_client/common_rest_client_with_login'
+require 'json'
+require 'forwardable'
+require 'connection_pool'
+module EtCcdClient
+  # A client to interact with the CCD API (backend)
+  class Client
+    extend Forwardable
+    include CommonRestClient
+    include CommonRestClientWithLogin
+
+
+    def initialize(idam_client: nil, config: ::EtCcdClient.config)
+      self.idam_client = idam_client || (config.use_sidam ? IdamClient.new : TidamClient.new)
+      self.config = config
+      self.logger = config.logger
+    end
+
+    def self.use(&block)
+      connection_pool.with(&block)
+    end
+
+    def self.connection_pool(config: ::EtCcdClient.config)
+      @connection_pool ||= ConnectionPool.new(size: config.pool_size, timeout: config.pool_timeout) do
+        new.tap do |client|
+          client.login
+        end
+      end
+    end
+
+    delegate login: :idam_client
+
+    # Initiate the case ready for creation
+    # @param [String] case_type_id
+    #
+    # @return [Hash] The json response
+    def caseworker_start_case_creation(case_type_id:)
+      logger.tagged('EtCcdClient::Client') do
+        url = initiate_case_url(case_type_id, config.initiate_claim_event_id)
+        get_request_with_login(url, log_subject: 'Start case creation', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Initiate a bulk action case ready for creation
+    # @param [String] case_type_id
+    #
+    # @return [Hash] The json response
+    def caseworker_start_bulk_creation(case_type_id:)
+      logger.tagged('EtCcdClient::Client') do
+        url = initiate_case_url(case_type_id, config.initiate_bulk_event_id)
+        get_request_with_login(url, log_subject: 'Start bulk creation', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Initiate a document upload
+    # @param [String] ctid
+    # @param [String] cid
+    #
+    # @return [Hash] The json response
+    def caseworker_start_upload_document(ctid:, cid:)
+      url = initiate_document_upload_url(ctid, cid)
+      get_request_with_login(url, log_subject: 'Start upload document', extra_headers: headers_from_idam_client)
+    end
+
+    # @param [Hash] data
+    # @param [String] case_type_id
+    #
+    # @return [Hash] The json response
+    def caseworker_case_create(data, case_type_id:)
+      logger.tagged('EtCcdClient::Client') do
+        tpl = Addressable::Template.new(config.create_case_url)
+        url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id).to_s
+        post_request_with_login(url, data, log_subject: 'Case worker create case', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Search for cases by reference - useful for testing
+    # @param [String] reference The reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @param [Integer] page - The page number to fetch
+    # @param [String] sort_direction (defaults to 'desc') - Change to 'asc' to do oldest first
+    #
+    # @return [Array<Hash>] The json response from the server
+    def caseworker_search_by_reference(reference, case_type_id:, page: 1, sort_direction: 'desc')
+      logger.tagged('EtCcdClient::Client') do
+        tpl = Addressable::Template.new(config.cases_url)
+        url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.feeGroupReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        get_request_with_login(url, log_subject: 'Caseworker search by reference', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Search for the latest case matching the reference.  Useful for testing
+    # @param [String] reference The reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @return [Hash] The case object returned from the server
+    def caseworker_search_latest_by_reference(reference, case_type_id:)
+      results = caseworker_search_by_reference(reference, case_type_id: case_type_id, page: 1, sort_direction: 'desc')
+      results.first
+    end
+
+    # Search for cases by multiple reference - useful for testing
+    # @param [String] reference The multiples reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @param [Integer] page - The page number to fetch
+    # @param [String] sort_direction (defaults to 'desc') - Change to 'asc' to do oldest first
+    #
+    # @return [Array<Hash>] The json response from the server
+    def caseworker_search_by_multiple_reference(reference, case_type_id:, page: 1, sort_direction: 'desc')
+      logger.tagged('EtCcdClient::Client') do
+        tpl = Addressable::Template.new(config.cases_url)
+        url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.multipleReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        get_request_with_login(url, log_subject: 'Caseworker search by multiple reference', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Search for the latest case matching the multiples reference.  Useful for testing
+    # @param [String] reference The multiples reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @return [Hash] The case object returned from the server
+    def caseworker_search_latest_by_multiple_reference(reference, case_type_id:)
+      results = caseworker_search_by_multiple_reference(reference, case_type_id: case_type_id, page: 1, sort_direction: 'desc')
+      results.first
+    end
+
+    # @param [String] case_type_id
+    # @param [Integer] quantity
+    # @return [Hash] The json response from the server
+    def start_multiple(case_type_id:, quantity:)
+      logger.tagged('EtCcdClient::Client') do
+        url = config.start_multiple_url
+        payload = {
+          case_details: {
+            case_data: {
+              caseRefNumberCount: quantity.to_s
+            },
+            case_type_id: case_type_id
+          }
+        }
+        post_request_with_login(url, payload.to_json, log_subject: 'Start multiple', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # Search for cases by ethos case reference - useful for testing
+    # @param [String] reference The ethos case reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @param [Integer] page - The page number to fetch
+    # @param [String] sort_direction (defaults to 'desc') - Change to 'asc' to do oldest first
+    #
+    # @return [Array<Hash>] The json response from the server
+    def caseworker_search_by_ethos_case_reference(reference, case_type_id:, page: 1, sort_direction: 'desc')
+      logger.tagged('EtCcdClient::Client') do
+        tpl = Addressable::Template.new(config.cases_url)
+        url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.ethosCaseReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        resp = get_request_with_login(url, log_subject: 'Caseworker search by ethos case reference', extra_headers: headers_from_idam_client)
+        unless config.document_store_url_rewrite == false
+          resp = reverse_rewrite_document_store_urls(resp)
+        end
+        resp
+      end
+    end
+
+    # Search for the latest case matching the ethos case reference.  Useful for testing
+    # @param [String] reference The ethos case reference number to search for
+    # @param [String] case_type_id The case type ID to set the search scope to
+    # @return [Hash] The case object returned from the server
+    def caseworker_search_latest_by_ethos_case_reference(reference, case_type_id:)
+      results = caseworker_search_by_ethos_case_reference(reference, case_type_id: case_type_id, page: 1, sort_direction: 'desc')
+      results.first
+    end
+
+
+    def caseworker_cases_pagination_metadata(case_type_id:, query: {})
+      logger.tagged('EtCcdClient::Client') do
+        tpl = Addressable::Template.new(config.cases_pagination_metadata_url)
+        url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: query).to_s
+        get_request_with_login(url, log_subject: 'Caseworker cases pagination metadata', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    def caseworker_update_case_documents(event_token:, files:, case_id:, case_type_id:)
+      tpl = Addressable::Template.new(config.case_events_url)
+      url = tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, cid: case_id).to_s
+      logger.tagged('EtCcdClient::Client') do
+        payload = {
+          data: {
+            documentCollection: files
+          },
+          event: {
+            id: 'uploadDocument',
+            summary: '',
+            description: ''
+          },
+          event_token: event_token,
+          ignore_warning: false
+        }.to_json
+        post_request_with_login(url, payload, log_subject: 'Caseworker update documents', extra_headers: headers_from_idam_client)
+      end
+    end
+
+    # @param [String] filename The full path to the file to upload
+    # @return [Hash] The object returned by the server
+    def upload_file_from_filename(filename, content_type:)
+      login_on_denial do
+        upload_file_from_source(filename, content_type: content_type, source_name: :filename, source: filename)
+      end
+    end
+
+    # @param [String] url The url of the file to upload
+    # @return [Hash] The object returned by the server
+    def upload_file_from_url(url, content_type:, original_filename: File.basename(url))
+      resp = download_from_remote_source(url)
+      login_on_denial do
+        upload_file_from_source(resp.file.path, content_type: content_type, source_name: :url, source: url, original_filename: original_filename)
+      end
+    end
+
+    private
+
+    def download_from_remote_source(url)
+      logger.tagged('EtCcdClient::Client') do
+        logger.debug("ET > Download from remote source (#{url})")
+        request = RestClient::Request.new(method: :get, url: url, raw_response: true, verify_ssl: config.verify_ssl)
+        resp = request.execute
+        logger.debug("ET < Download from remote source (#{url}) complete.  Data not shown as very likely to be binary")
+        resp
+      rescue RestClient::Exception => e
+        logger.debug "ET < Download from remote source (ERROR) - #{e.response}"
+        Exceptions::Base.raise_exception(e, url: url, request: request)
+      end
+    end
+
+    def upload_file_from_source(filename, content_type:, source_name:, source:, original_filename: filename)
+      logger.tagged('EtCcdClient::Client') do
+        url = config.upload_file_url
+        logger.debug("ET > Upload file from #{source_name} (#{url})")
+        uploaded_file = UploadedFile.new(filename, content_type: content_type, binary: true, original_filename: original_filename)
+        data = {
+          multipart: true,
+          files: uploaded_file,
+          classification: 'PUBLIC'
+        }
+        request = RestClient::Request.new(method: :post, url: url, payload: data, headers: { 'ServiceAuthorization' => "Bearer #{idam_client.service_token}", :authorization => "Bearer #{idam_client.user_token}" }, verify_ssl: config.verify_ssl)
+        resp = request.execute
+        resp_body = resp.body
+        logger.debug "ET < Upload file from #{source_name} - #{resp_body}"
+        unless config.document_store_url_rewrite == false
+          resp_body = rewrite_document_store_urls(resp_body)
+        end
+        JSON.parse(resp_body)
+      rescue RestClient::Exception => e
+        logger.debug "ET < Upload file from #{source_name} (ERROR) - #{e.response.body}"
+        Exceptions::Base.raise_exception(e, url: url, request: request)
+      end
+    end
+
+    def initiate_case_url(case_type_id, event_id)
+      tpl = Addressable::Template.new(config.initiate_case_url)
+      tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, etid: event_id).to_s
+    end
+
+    def initiate_document_upload_url(case_type_id, cid)
+      tpl = Addressable::Template.new(config.initiate_document_upload_url)
+      tpl.expand(uid: idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, cid: cid).to_s
+    end
+
+    def rewrite_document_store_urls(body)
+      source_host, source_port, dest_host, dest_port = config.document_store_url_rewrite
+      body.gsub(/(https?):\/\/#{Regexp.quote source_host}:#{Regexp.quote source_port}/, "\\1://#{dest_host}:#{dest_port}")
+    end
+
+    def headers_from_idam_client
+      {'ServiceAuthorization' => "Bearer #{idam_client.service_token}", :authorization => "Bearer #{idam_client.user_token}", 'user-id' => idam_client.user_details['id'], 'user-roles' => idam_client.user_details['roles'].join(',')}
+    end
+
+    def reverse_rewrite_document_store_urls(json)
+      source_host, source_port, dest_host, dest_port = config.document_store_url_rewrite
+      JSON.parse(JSON.generate(json).gsub(/(https?):\/\/#{Regexp.quote dest_host}:#{Regexp.quote dest_port}/, "\\1://#{source_host}:#{source_port}"))
+    end
+
+    attr_accessor :idam_client, :logger
+
+    # @return [EtCcdClient::Config] The configuration
+    attr_accessor :config
+  end
+end

data/lib/et_ccd_client/common_rest_client.rb

@@ -0,0 +1,27 @@
+module EtCcdClient
+  module CommonRestClient
+    def get_request(url, log_subject:, extra_headers: {}, decode: true, cookies: {})
+      logger.debug("ET > #{log_subject} (#{url})")
+      proxy = config.proxy == false || config.proxy.blank? ? nil : "http://#{config.proxy}"
+      req = RestClient::Request.new(method: :get, url: url, headers: { content_type: 'application/json' }.merge(extra_headers), cookies: cookies, verify_ssl: config.verify_ssl, proxy: proxy)
+      resp = req.execute
+      logger.debug "ET < #{log_subject} - #{resp.body}"
+      decode ? JSON.parse(resp.body) : resp.body
+    rescue RestClient::Exception => e
+      logger.debug "ET < #{log_subject} (ERROR) - #{e.response&.body}"
+      Exceptions::Base.raise_exception(e, url: url, request: req)
+    end
+
+    def post_request(url, data, log_subject:, extra_headers: {}, decode: true, cookies: {})
+      logger.debug("ET > #{log_subject} (#{url}) - #{data.to_json}")
+      proxy = config.proxy == false || config.proxy.blank? ? nil : "http://#{config.proxy}"
+      req = RestClient::Request.new(method: :post, url: url, payload: data, headers: { content_type: 'application/json' }.merge(extra_headers), cookies: cookies, verify_ssl: config.verify_ssl, proxy: proxy)
+      resp = req.execute
+      logger.debug "ET < #{log_subject} - #{resp.body}"
+      decode ? JSON.parse(resp.body) : resp.body
+    rescue RestClient::Exception => e
+      logger.debug "ET < #{log_subject} (ERROR) - #{e.response&.body}"
+      Exceptions::Base.raise_exception(e, url: url, request: req)
+    end
+  end
+end

data/lib/et_ccd_client/common_rest_client_with_login.rb

@@ -0,0 +1,33 @@
+module EtCcdClient
+  module CommonRestClientWithLogin
+
+    private
+
+    def get_request_with_login(*args)
+      login_on_denial do
+        get_request(*args)
+      end
+    end
+
+    def post_request_with_login(*args)
+      login_on_denial do
+        post_request(*args)
+      end
+    end
+
+    def login_on_denial
+      retried = false
+      begin
+        yield
+      rescue EtCcdClient::Exceptions::Forbidden, EtCcdClient::Exceptions::Unauthorized => e
+        raise if retried
+
+        retried = true
+        logger.tagged('Re logging in') do
+          login
+        end
+        retry
+      end
+    end
+  end
+end

data/lib/et_ccd_client/config.rb

@@ -0,0 +1,108 @@
+require 'singleton'
+require 'et_ccd_client/null_logger'
+require 'addressable/template'
+module EtCcdClient
+  class Config
+    include Singleton
+
+    attr_accessor :auth_base_url, :idam_base_url, :data_store_base_url, :ecm_base_url, :case_management_ui_base_url, :document_store_base_url, :gateway_api_url, :document_store_url_rewrite
+    attr_accessor :user_role, :user_id
+    attr_accessor :jurisdiction_id, :microservice, :microservice_secret
+    attr_accessor :logger
+    attr_accessor :verify_ssl, :use_sidam, :sidam_username, :sidam_password
+    attr_accessor :case_management_ui_redirect_url
+    attr_accessor :pool_size, :pool_timeout
+    attr_accessor :proxy
+
+    def idam_service_token_exchange_url
+      "#{auth_base_url}/lease"
+    end
+
+    def idam_user_token_exchange_url
+      use_sidam ? "#{idam_base_url}/loginUser" : "#{idam_base_url}/testing-support/lease"
+    end
+
+    def create_case_url
+      "#{data_store_base_url}/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases"
+    end
+
+    def cases_url
+      "#{data_store_base_url}#{cases_path}"
+    end
+
+    def cases_pagination_metadata_url
+      "#{data_store_base_url}/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata{?query*}"
+    end
+
+    def initiate_case_url
+      "#{data_store_base_url}/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token"
+    end
+
+    def initiate_document_upload_url
+      "#{data_store_base_url}/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/uploadDocument/token"
+    end
+
+    def case_events_url
+      "#{data_store_base_url}/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events"
+    end
+
+    def upload_file_url
+      "#{document_store_base_url}/documents"
+    end
+
+    def start_multiple_url
+      "#{ecm_base_url}/generateCaseRefNumbers"
+    end
+
+    def initiate_claim_event_id
+      'initiateCase'
+    end
+
+    def initiate_bulk_event_id
+      'createMultiple'
+    end
+
+    def initiate_document_upload_event_id
+      'uploadDocument'
+    end
+
+    def case_management_ui_config_url
+      "#{case_management_ui_base_url}/config"
+    end
+
+    def cases_path
+      "/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases{?query*}"
+    end
+
+    def user_details_url
+      "#{idam_base_url}/details"
+    end
+
+    private
+
+    def initialize
+      self.auth_base_url = 'http://localhost:4502'
+      self.idam_base_url =  'http://localhost:4501'
+      self.data_store_base_url = 'http://localhost:4452'
+      self.document_store_base_url = 'http://localhost:4506'
+      self.ecm_base_url = 'http://unknown:4506'
+      self.document_store_url_rewrite = 'localhost:4506:dm-store:8080'
+      self.case_management_ui_redirect_url = 'http://localhost:3451/oauth2redirect'
+      self.case_management_ui_base_url = 'http://localhost:3451'
+      self.gateway_api_url = 'http://localhost:3453'
+      self.user_id = 22
+      self.user_role = 'caseworker,caseworker-test,caseworker-employment-tribunal-manchester,caseworker-employment,caseworker-employment-tribunal-manchester-caseofficer,caseworker-publiclaw-localAuthority'
+      self.jurisdiction_id = 'EMPLOYMENT'
+      self.microservice = 'ccd_gw'
+      self.microservice_secret = 'AAAAAAAAAAAAAAAC'
+      self.logger = NullLogger.new
+      self.verify_ssl = true
+      self.use_sidam = true
+      self.sidam_username = 'm@m.com'
+      self.sidam_password = 'Pa55word11'
+      self.pool_size = 5
+      self.pool_timeout = 30
+      self.proxy = false
+    end
+  end
+end