et_ccd_client 0.3.1

data/lib/et_ccd_client/exceptions.rb

@@ -0,0 +1,2 @@
+require 'et_ccd_client/exceptions/base'
+Dir.glob(File.absolute_path(File.join('.', 'exceptions', '**', "*.rb"), __dir__)).each { |f| require f }

data/lib/et_ccd_client/exceptions/base.rb

@@ -0,0 +1,52 @@
+module EtCcdClient
+  module Exceptions
+    class Base < ::StandardError
+      attr_reader :original_exception, :url, :request
+
+      def self.raise_exception(original_exception, **kw_args)
+        expected_error_class = original_exception.class.name.split('::').last
+        if EtCcdClient::Exceptions.const_defined?(expected_error_class)
+          raise EtCcdClient::Exceptions.const_get(expected_error_class).new original_exception, **kw_args
+        else
+          raise new(original_exception, **kw_args)
+        end
+      end
+
+      def self.exception(*args, **kw_args)
+        new(*args, **kw_args)
+      end
+
+      def initialize(original_exception, url: nil, request: nil)
+        self.original_exception = original_exception
+        self.url = url
+        self.request = request
+      end
+
+      def response
+        original_exception.response
+      end
+
+      def to_s
+        json = JSON.parse(response.body) rescue JSON::JSONError
+        message = if json.nil? || json == JSON::JSONError
+          ''
+        else
+          json['message'] || json['error'] || ''
+        end
+        if url
+          "#{original_exception.message} - #{message} ('#{url}')"
+        else
+          "#{original_exception.message} - #{message}"
+        end
+      end
+
+      private
+
+      attr_writer :original_exception, :url
+
+      def request=(request)
+        @request = request&.args
+      end
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/forbidden.rb

@@ -0,0 +1,6 @@
+module EtCcdClient
+  module Exceptions
+    class Forbidden < Base
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/gateway_timeout.rb

@@ -0,0 +1,6 @@
+module EtCcdClient
+  module Exceptions
+    class GatewayTimeout < Base
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/internal_server_error.rb

@@ -0,0 +1,6 @@
+module EtCcdClient
+  module Exceptions
+    class InternalServerError < Base
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/not_found.rb

@@ -0,0 +1,13 @@
+module EtCcdClient
+  module Exceptions
+    class NotFound < Base
+      def to_s
+        json = JSON.parse(response.body) rescue JSON::JSONError
+        return "Not Found" if json.nil?
+
+        super
+      end
+
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/unauthorized.rb

@@ -0,0 +1,6 @@
+module EtCcdClient
+  module Exceptions
+    class Unauthorized < Base
+    end
+  end
+end

data/lib/et_ccd_client/exceptions/unprocessable_entity.rb

@@ -0,0 +1,18 @@
+module EtCcdClient
+  module Exceptions
+    class UnprocessableEntity < Base
+      def to_s
+        json = JSON.parse(response.body) rescue JSON::JSONError
+        return super if json.nil? || json == JSON::JSONError
+
+        field_errors = json.dig('details', 'field_errors')&.map do |field_error|
+          "#{field_error['id']} => #{field_error['message']}"
+        end
+        return super if field_errors.nil?
+
+        "#{super} - #{field_errors.join(', ')}"
+      end
+
+    end
+  end
+end

data/lib/et_ccd_client/idam_client.rb

@@ -0,0 +1,57 @@
+require "addressable/template"
+require 'rest_client'
+require 'et_ccd_client/config'
+require 'et_ccd_client/common_rest_client'
+require 'rotp'
+module EtCcdClient
+  class IdamClient
+    include CommonRestClient
+    attr_reader :service_token, :user_token, :user_details
+
+    def initialize(config: ::EtCcdClient.config)
+      self.config = config
+      self.logger = config.logger
+      self.service_token = nil
+      self.user_token = nil
+      self.user_details = nil
+    end
+
+    def login(username: config.sidam_username, password: config.sidam_password)
+      logger.tagged('EtCcdClient::IdamClient') do
+        self.service_token = exchange_service_token
+        self.user_token = exchange_sidam_user_token(username, password)
+        self.user_details = fetch_user_details
+      end
+    end
+
+    private
+
+    attr_writer :service_token, :user_token, :user_details
+    attr_accessor :config, :logger
+
+    def exchange_service_token
+      url = config.idam_service_token_exchange_url
+      data = { microservice: config.microservice, oneTimePassword: otp }.to_json
+      post_request(url, data, log_subject: 'Idam service token exchange', decode: false)
+    end
+
+    def exchange_sidam_user_token(username, password)
+      url = config.idam_user_token_exchange_url
+      resp = post_request(url, { username: username, password: password }, log_subject: 'Idam user token exchange')
+      resp['access_token']
+    end
+
+    def fetch_user_details
+      url = config.user_details_url
+      get_request(url, extra_headers: {'Accept' => 'application/json', 'Authorization' => user_token}, log_subject: 'Idam get user details')
+    end
+
+    def otp
+      totp.now
+    end
+
+    def totp
+      @totp ||= ROTP::TOTP.new(config.microservice_secret)
+    end
+  end
+end

data/lib/et_ccd_client/null_logger.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module EtCcdClient
+# Null logger class. This is essentially the same as sending data down the
+# `/dev/null` black hole.
+#
+# @example Basic Usage
+#
+#   logger = NullLogger.new
+#   Rails.logger = logger
+#
+#
+# @example Basic Pattern Usage
+#   class SomeService
+#     def initialize(options = {})
+#       @logger = options[:logger] || NullLogger.new
+#     end
+#
+#     def perform
+#       @logger.debug -> { "do some work here" }
+#       # .. ..
+#       @logger.info -> { "finished working" }
+#     end
+#   end
+#
+#   service = SomeService.new(logger: Logger.new(STDOUT))
+#   service.perform
+#
+#   silent = SomeService.new(logger: NullLogger.new
+#   silent.perform
+#
+  class NullLogger
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def tagged(*)
+      yield if block_given?
+    end
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def unknown(*_args)
+      nil
+    end
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def fatal(*_args)
+      nil
+    end
+    
+    # @return [FALSE]
+    def fatal?
+      false
+    end
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def error(*_args)
+      nil
+    end
+    
+    # @return [FALSE]
+    def error?
+      false
+    end
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def warn(*_args)
+      nil
+    end
+    
+    # @return [FALSE]
+    def warn?
+      false
+    end
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def info(*_args)
+      nil
+    end
+    
+    # @return [FALSE]
+    def info?
+      false
+    end
+    
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def debug(*_args)
+      nil
+    end
+    
+    # @return [FALSE]
+    def debug?
+      false
+    end
+  end
+end

data/lib/et_ccd_client/tidam_client.rb

@@ -0,0 +1,64 @@
+require "addressable/template"
+require 'rest_client'
+require 'et_ccd_client/config'
+require 'rotp'
+module EtCcdClient
+  class TidamClient
+    attr_reader :service_token, :user_token, :user_details
+
+    def initialize(config: ::EtCcdClient.config)
+      self.config = config
+      self.logger = config.logger
+      self.service_token = nil
+      self.user_token = nil
+      self.user_details = nil
+    end
+
+    def login(user_id: config.user_id, role: config.user_role)
+      logger.tagged('EtCcdClient::IdamClient') do
+        self.service_token = exchange_service_token
+        self.user_token = exchange_tidam_user_token(user_id, role)
+        self.user_details = get_user_details(user_id, role)
+      end
+    end
+
+    private
+
+    attr_writer :service_token, :user_token, :user_details
+    attr_accessor :config, :logger
+
+    def exchange_service_token
+      url = config.idam_service_token_exchange_url
+      data = { microservice: config.microservice, oneTimePassword: otp }.to_json
+      logger.debug("ET > Idam service token exchange (#{url}) - #{data}")
+      resp = RestClient::Request.execute(method: :post, url: url, payload: data, headers: { content_type: 'application/json' }, verify_ssl: config.verify_ssl)
+      resp.body.tap do |resp_body|
+        logger.debug "ET < Idam service token exchange - #{resp_body}"
+      end
+    end
+
+    def exchange_tidam_user_token(user_id, user_role)
+      url = config.idam_user_token_exchange_url
+      logger.debug("ET > Idam user token exchange (#{url}) - id: #{user_id} role: #{user_role}")
+      resp = RestClient::Request.execute(method: :post, url: url, payload: { id: user_id, role: user_role }, verify_ssl: config.verify_ssl)
+      resp.body.tap do |resp_body|
+        logger.debug "ET < Idam user token exchange - #{resp_body}"
+      end
+    end
+
+    def get_user_details(user_id, role)
+      {
+        'id' => user_id,
+        'roles' => role.split(',').map(&:strip)
+      }
+    end
+
+    def otp
+      totp.now
+    end
+
+    def totp
+      @totp ||= ROTP::TOTP.new(config.microservice_secret)
+    end
+  end
+end

data/lib/et_ccd_client/ui_client.rb

@@ -0,0 +1,159 @@
+require "addressable/template"
+require 'rest_client'
+require 'et_ccd_client/ui_idam_client'
+require 'et_ccd_client/config'
+require 'et_ccd_client/exceptions'
+require 'et_ccd_client/common_rest_client'
+require 'json'
+require 'forwardable'
+module EtCcdClient
+  # A client to interact with the CCD UI API (front end)
+  class UiClient
+    extend Forwardable
+    include CommonRestClient
+
+    def initialize(ui_idam_client: UiIdamClient.new, config: ::EtCcdClient.config)
+      self.ui_idam_client = ui_idam_client
+      self.config = config
+      self.logger = config.logger
+    end
+
+    delegate login: :ui_idam_client
+
+    # 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::UiClient') do
+        tpl = Addressable::Template.new(config.cases_path)
+        path = tpl.expand(uid: ui_idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.feeGroupReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        url = "#{config.gateway_api_url}/aggregated#{path}"
+        resp = get_request(url, log_subject: 'Caseworker search by reference', extra_headers: { content_type: 'application/json', accept: 'application/json' }, cookies: { accessToken: ui_idam_client.user_token })
+        unless config.document_store_url_rewrite == false
+          resp = reverse_rewrite_document_store_urls(resp)
+        end
+        resp["results"]
+      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 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::UiClient') do
+        tpl = Addressable::Template.new(config.cases_path)
+        path = tpl.expand(uid: ui_idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.ethosCaseReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        url = "#{config.gateway_api_url}/aggregated#{path}"
+        resp = get_request(url, log_subject: 'Caseworker search by ethos case reference', extra_headers: { content_type: 'application/json', accept: 'application/json' }, cookies: { accessToken: ui_idam_client.user_token })
+        unless config.document_store_url_rewrite == false
+          resp = reverse_rewrite_document_store_urls(resp)
+        end
+        resp["results"]
+      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
+
+    # Search for cases by 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
+    # @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::UiClient') do
+        tpl = Addressable::Template.new(config.cases_path)
+        path = tpl.expand(uid: ui_idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.multipleReference' => reference, page: page, 'sortDirection' => sort_direction }).to_s
+        url = "#{config.gateway_api_url}/aggregated#{path}"
+        resp = get_request(url, log_subject: 'Case worker search by multiple reference', extra_headers: { content_type: 'application/json', accept: 'application/json' }, cookies: { accessToken: ui_idam_client.user_token })
+        resp["results"]
+      end
+    end
+
+    # Search for the latest case matching the 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
+    # @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
+
+    # Search for cases by bulk case title - useful for testing
+    # @param [String] case_title The bulk case title 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_bulk_case_title(case_title, case_type_id:, page: 1, sort_direction: 'desc')
+      logger.tagged('EtCcdClient::UiClient') do
+        tpl = Addressable::Template.new(config.cases_path)
+        path = tpl.expand(uid: ui_idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { 'case.multipleName' => case_title, page: page, 'sortDirection' => sort_direction }).to_s
+        url = "#{config.gateway_api_url}/aggregated#{path}"
+        resp = get_request(url, log_subject: 'Case worker search by bulk case title', extra_headers: { content_type: 'application/json', accept: 'application/json' }, cookies: { accessToken: ui_idam_client.user_token })
+        resp["results"]
+      end
+    end
+
+    # Search for the latest case matching the bulk case title.  Useful for testing
+    # @param [String] case-title The bulk case title 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_bulk_case_title(case_title, case_type_id:)
+      results = caseworker_search_by_bulk_case_title(case_title, case_type_id: case_type_id, page: 1, sort_direction: 'desc')
+      results.first
+    end
+
+    # List all cases (paginated)
+    # @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_list_cases(case_type_id:, page: 1, sort_direction: 'desc')
+      logger.tagged('EtCcdClient::UiClient') do
+        tpl = Addressable::Template.new(config.cases_path)
+        path = tpl.expand(uid: ui_idam_client.user_details['id'], jid: config.jurisdiction_id, ctid: case_type_id, query: { page: page, 'sortDirection' => sort_direction }).to_s
+        url = "#{config.gateway_api_url}/aggregated#{path}"
+        resp = get_request(url, log_subject: 'List all cases', extra_headers: { content_type: 'application/json', accept: 'application/json' }, cookies: { accessToken: ui_idam_client.user_token })
+        resp["results"]
+      end
+    end
+
+
+    private
+
+    attr_accessor :ui_idam_client, :config, :logger
+
+    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
+  end
+end