defra_ruby_storm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad0b971a9d91168670b5ac477ba3cbf7e61e1f963524cbc6a3a709fd57c45d2b
+  data.tar.gz: eeead0895c42b10efdb8f2be806163efff6e3431ed7ef91b4239ff50e0d23064
+SHA512:
+  metadata.gz: '090b13c85ec48593bfa9b62a82ee63c79ca25ee8df199532d6e20efdc85ea4d2f03ac5bdb1f57d9e495c5ed467e7a2f70aa1bfbfaa87c2e6962cfa561b8d8cd2'
+  data.tar.gz: 48e799563c26871b7a9be8541509adc5cc9adbe865783c086414973d8047d010be5cfe29ca8a0af410b9b30ad159819536cf57ef337bf081931d9811fd3900f5

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  versioning-strategy: lockfile-only

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on: push
+
+jobs:
+  build:
+    # You must use a Linux environment when using service containers or container jobs
+    runs-on: ubuntu-latest
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of sonarcloud analysis
+
+      # We don't have to specify the ruby version, or grab it from .ruby-verion. This action supports reading the
+      # version from .ruby-verion itself
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      # Run linting first. No point running the tests if there is a linting issue
+      - name: Run lint check
+        run: |
+          bundle exec rubocop --format progress --format json --out rubocop-result.json
+
+      # This includes an extra run step. The sonarcloud analysis will be run in a docker container with the current
+      # folder mounted as `/github/workspace`. The problem is when the coverage.json file is generated it will
+      # reference the code in the current folder. So to enable sonarcloud to matchup code coverage with the files we use
+      # sed to update the references in coverage.json
+      # https://community.sonarsource.com/t/code-coverage-doesnt-work-with-github-action/16747/6
+      - name: Run unit tests
+        run: |
+          bundle exec rspec
+          sed -i 's/\/home\/runner\/work\/defra-ruby-storm\/defra-ruby-storm\//\/github\/workspace\//g' coverage/coverage.json
+
+      - name: Analyze with SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This is provided automatically by GitHub
+          SONAR_TOKEN: ${{ secrets.RUBY_SONAR_TOKEN }} # This needs to be set in your repo; settings -> secrets

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# simplecov https://github.com/colszowka/simplecov
+coverage
+
+.env
+.env.local

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  defra_ruby_style:
+    - default.yml

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in defra_ruby_storm.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "rubocop-rspec"
+
+gem "rubocop", "~> 1.21"
+
+gem "webmock", "~> 3.4"
+
+gem "defra_ruby_style", "~> 0.4.0"
+
+gem "simplecov", "~> 0.22.0", require: false

data/Gemfile.lock

@@ -0,0 +1,144 @@
+PATH
+  remote: .
+  specs:
+    defra_ruby_storm (0.1.0)
+      savon (~> 2.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.4.2)
+    builder (3.2.4)
+    crack (0.4.5)
+      rexml
+    date (3.3.3)
+    defra_ruby_style (0.4.0)
+      rubocop (>= 1.0, < 2.0)
+      rubocop-factory_bot
+      rubocop-rake
+      rubocop-rspec
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    gyoku (1.4.0)
+      builder (>= 2.1.2)
+      rexml (~> 3.0)
+    hashdiff (1.0.1)
+    httpi (3.0.1)
+      rack
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    mini_mime (1.1.5)
+    net-imap (0.4.3)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    nori (2.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.2)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    savon (2.13.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (>= 2.4.5)
+      mail (~> 2.5)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timeout (0.4.0)
+    unicode-display_width (2.5.0)
+    wasabi (3.8.0)
+      addressable
+      httpi (~> 3.0)
+      nokogiri (>= 1.4.2)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  defra_ruby_storm!
+  defra_ruby_style (~> 0.4.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rspec
+  simplecov (~> 0.22.0)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2023 Defra
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,125 @@
+# DefraRuby::Storm
+
+![Build Status](https://github.com/DEFRA/defra-ruby-storm/workflows/CI/badge.svg)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-storm&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-storm)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-storm&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-storm)
+[![Gem Version](https://badge.fury.io/rb/defra_ruby_storm.svg)](https://badge.fury.io/rb/defra_ruby_storm)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+
+Ruby client for Storm Web Services API
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Usage](#usage)
+4. [Error Handling](#error-handling)
+5. [Testing](#testing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'defra-ruby-storm'
+```
+And then execute
+```sh
+bundle install
+```
+
+Or install it yourself as:
+```sh
+gem install defra-ruby-storm
+```
+
+## Configuration
+
+You just need to let the gem know the STORM_API_USERNAME AND STORM_API_PASSWORD for the Api access.
+
+```ruby
+# config/initializers/defra_ruby_storm.rb
+require "defra_ruby/storm"
+
+DefraRuby::Storm.configure do |config|
+  config.storm_api_username = "STORM_API_USERNAME"
+  config.storm_api_password = "STORM_API_PASSWORD"
+end
+```
+
+## Usage
+
+The gem provides 3 separate services a host app can use:
+
+- DefraRuby::Storm::UserDetailsService
+- DefraRuby::Storm::PauseCallRecordingService
+- DefraRuby::Storm::ResumeCallRecordingService
+
+
+### User Details Service
+
+```ruby
+DefraRuby::Storm::UserDetailsService.run(username: 'TestAgentUsername')
+
+#<DefraRuby::Storm::GetUserDetailsResponse:0x00007f6b9a3c5160
+ @alternative_number=nil,                        
+ @code="0",
+ @first_name="First Name",
+ @home_tel=nil,
+ @last_name="Last Name",
+ @mobile=nil,
+ @personal_email=nil,
+ @user_id="123",
+ @user_name="TestAgentUsername",
+ @work_email=nil,
+ @work_tel=nil>
+```
+code "0" in api response suggests that the request has been handled successfully
+
+### Pause Call Recording Service
+
+```ruby
+DefraRuby::Storm::PauseCallRecordingService.run(username: 'TestAgentUsername')
+
+#<DefraRuby::Storm::RecordingResponse:0x00007f6b99c0f9e8 @result="0">
+```
+result code "0" in api response suggests that the request has been handled successfully
+
+Knowing the agent's user ID, we can pass that into the service, eliminating the need for an additional API call and making request much faster.
+
+```ruby
+DefraRuby::Storm::PauseCallRecordingService.run(agent_user_id: 123)
+```
+
+### Resume Call Recording Service
+
+```ruby
+DefraRuby::Storm::ResumeCallRecordingService.run(username: 'TestAgentUsername')
+
+#<DefraRuby::Storm::RecordingResponse:0x00007f6b99c0f9e8 @result="0">
+```
+result code "0" in api response suggests that the request has been handled successfully
+
+Knowing the agent's user ID, we can pass that into the service, eliminating the need for an additional API call and making request much faster.
+
+```ruby
+DefraRuby::Storm::ResumeCallRecordingService.run(agent_user_id: 123)
+```
+
+## Error Handling
+
+Errors are handled through the DefraRuby::Storm::ApiError class. Here's an example of how you can handle errors:
+```ruby
+begin
+  # some code that might raise an error
+rescue DefraRuby::Storm::ApiError => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+## Testing
+
+```
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "defra_ruby/storm"
+
+# 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.
+
+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/defra_ruby_storm.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/defra_ruby/storm/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "defra_ruby_storm"
+  spec.version = DefraRuby::Storm::VERSION
+  spec.authors = ["Defra"]
+  spec.email = ["leonid.brujev@defra.gov.uk"]
+
+  spec.summary = "Ruby client for Storm Web Services API"
+  spec.homepage = "https://github.com/DEFRA/defra-ruby-storm"
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DEFRA/defra-ruby-storm"
+  spec.metadata["changelog_uri"] = "https://github.com/DEFRA/defra-ruby-storm/CHANGELOG.md"
+
+  # SOAP client
+  spec.add_dependency "savon", "~> 2.13.0"
+
+  spec.require_paths = ["lib"]
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/defra_ruby/storm/api.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class API
+      def initialize(config = DefraRuby::Storm::Configuration.call_recording_service_configuration)
+        @client = ::Savon.client(config)
+      end
+
+      def get_user_details(username)
+        response = @client.call(:get_user_details, message: { "ngw:UserName": username },
+                                                   message_tag: :getUserDetailsRequest)
+        unless response.http.code == 200 && response.body[:get_user_details_response][:code] == "0"
+          handle_error "Failed to get user details for username: #{username}"
+        end
+
+        DefraRuby::Storm::GetUserDetailsResponse.new(response.body[:get_user_details_response])
+      end
+
+      def pause_call_recording(agent_user_id)
+        response = @client.call("RedCentrexCalls/Recording",
+                                message: { "cal:UserID": agent_user_id, "cal:Record": "pause", "cal:Muted": "0" },
+                                message_tag: :RecordingRequest)
+        unless response.http.code == 200 && response.body[:recording_response][:result] == "0"
+          handle_error "Failed to pause call recording for agent_user_id: #{agent_user_id}"
+        end
+
+        DefraRuby::Storm::RecordingResponse.new(response.body[:recording_response])
+      end
+
+      def resume_call_recording(agent_user_id)
+        response = @client.call("RedCentrexCalls/Recording",
+                                message: { "cal:UserID": agent_user_id, "cal:Record": "resume" },
+                                message_tag: :RecordingRequest)
+        unless response.http.code == 200 && response.body[:recording_response][:result] == "0"
+          handle_error "Failed to resume call recording for agent_user_id: #{agent_user_id}"
+        end
+
+        DefraRuby::Storm::RecordingResponse.new(response.body[:recording_response])
+      end
+
+      def handle_error(error_message)
+        raise ApiError, error_message
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/api_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    # Custom error class to handle Storm API errors
+    class ApiError < StandardError
+      def initialize(msg = "Storm API error")
+        super
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class Configuration
+      attr_accessor :storm_api_username, :storm_api_password,
+                    :wsdl, :wsse_auth, :soap_version, :pretty_print_xml, :use_wsa_headers, :env_namespace,
+                    :namespace_identifier, :namespaces, :log
+
+      def self.user_details_service_configuration
+        {
+          wsdl: "https://www.timeforstorm.com/serviceportalapi/service.svc?singleWsdl",
+          wsse_auth: [DefraRuby::Storm.configuration.storm_api_username,
+                      DefraRuby::Storm.configuration.storm_api_password],
+          soap_version: 2,
+          pretty_print_xml: true,
+          use_wsa_headers: true,
+          env_namespace: :soap,
+          namespace_identifier: :ngw,
+          namespaces: {
+            "xmlns:soap" => "http://www.w3.org/2003/05/soap-envelope",
+            "xmlns:ngw" => "http://redwoodtech.com/ws/NGware/NGwareTypes"
+          },
+          log: false
+        }
+      end
+
+      def self.call_recording_service_configuration
+        {
+          endpoint: "https://www.timeforstorm.com/RedCentrexWebservices/Service.svc", namespace: "http://redcentrex.redwoodtech.com/calls",
+          wsse_auth: [DefraRuby::Storm.configuration.storm_api_username,
+                      DefraRuby::Storm.configuration.storm_api_password],
+          soap_version: 2,
+          pretty_print_xml: true,
+          use_wsa_headers: true,
+          env_namespace: :soap,
+          namespace_identifier: :cal,
+          namespaces: {
+            "xmlns:soap" => "http://www.w3.org/2003/05/soap-envelope",
+            "xmlns:cal" => "http://redcentrex.redwoodtech.com/calls"
+          },
+          log: false
+        }
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/responses/base_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module DefraRuby
+  module Storm
+    class BaseResponse
+      def initialize(args)
+        args.each do |key, value|
+          next if key == :@xmlns
+
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/responses/get_user_details_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class GetUserDetailsResponse < BaseResponse
+      attr_accessor :code, :user_id, :user_name, :first_name, :last_name, :home_tel, :work_tel, :work_email, :mobile,
+                    :alternative_number, :personal_emai
+    end
+  end
+end

data/lib/defra_ruby/storm/responses/recording_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class RecordingResponse < BaseResponse
+      attr_accessor :result
+    end
+  end
+end

data/lib/defra_ruby/storm/services/base_service.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class BaseService
+      def self.run(attrs = {})
+        new.run(**attrs)
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/services/pause_call_recording_service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class PauseCallRecordingService < BaseService
+      def run(username: nil, agent_user_id: nil)
+        if agent_user_id.nil? && !username.nil?
+          user_details = DefraRuby::Storm::UserDetailsService.run(username: username)
+          agent_user_id = user_details&.user_id
+        end
+
+        raise ArgumentError, "You must provide either a username or a agent_user_id" if agent_user_id.nil?
+
+        api_client = DefraRuby::Storm::API.new(DefraRuby::Storm::Configuration.call_recording_service_configuration)
+        api_client.pause_call_recording(agent_user_id)
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/services/resume_call_recording_service.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class ResumeCallRecordingService < BaseService
+      def run(username: nil, agent_user_id: nil)
+        if agent_user_id.nil? && !username.nil?
+          user_details = DefraRuby::Storm::UserDetailsService.run(username: username)
+          agent_user_id = user_details&.user_id
+        end
+        raise ArgumentError, "You must provide either a username or a agent_user_id" if agent_user_id.nil?
+
+        api_client = DefraRuby::Storm::API.new(DefraRuby::Storm::Configuration.call_recording_service_configuration)
+        api_client.resume_call_recording(agent_user_id)
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/services/user_details_service.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    class UserDetailsService < BaseService
+      def run(username:)
+        api_client = DefraRuby::Storm::API.new(DefraRuby::Storm::Configuration.user_details_service_configuration)
+        api_client.get_user_details(username)
+      end
+    end
+  end
+end

data/lib/defra_ruby/storm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Storm
+    VERSION = "0.1.0"
+  end
+end

data/lib/defra_ruby/storm.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "savon"
+
+require_relative "storm/version"
+require_relative "storm/configuration"
+require_relative "storm/api"
+require_relative "storm/api_error"
+
+require_relative "storm/services/base_service"
+require_relative "storm/services/user_details_service"
+require_relative "storm/services/pause_call_recording_service"
+require_relative "storm/services/resume_call_recording_service"
+
+require_relative "storm/responses/base_response"
+require_relative "storm/responses/get_user_details_response"
+require_relative "storm/responses/recording_response"
+
+module DefraRuby
+  module Storm
+    class << self
+      # attr_accessor :configuration
+
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+        @configuration
+      end
+    end
+  end
+end

data/lib/defra_ruby.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "defra_ruby/address"
+
+module DefraRuby
+  # The Defra Ruby packages namespace
+end

data/sig/defra_ruby/storm.rbs

@@ -0,0 +1,6 @@
+module DefraRuby
+  module Storm
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/sonar-project.properties

@@ -0,0 +1,29 @@
+# Project key is required. You'll find it in the SonarCloud UI
+sonar.projectKey=DEFRA_defra-ruby-storm
+sonar.organization=defra
+
+# This is the name and version displayed in the SonarCloud UI
+sonar.projectName=defra-ruby-storm
+
+# This will add the same links in the SonarCloud UI
+sonar.links.homepage=https://github.com/DEFRA/defra-ruby-storm
+sonar.links.ci=https://github.com/DEFRA/defra-ruby-storm/actions
+sonar.links.scm=https://github.com/DEFRA/defra-ruby-storm
+sonar.links.issue=https://github.com/DEFRA/ruby-services-team/issues
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on
+# Windows.
+# Because rails generates a number of files, and SonarCloud has no rails and
+# ruby intelligence we have found we have to specify what should be covered.
+# If we don't SonarCloud will do things like take the raw coverage data from
+# simplecov, compare that to all files ion the repo, and score 0 for all the
+# files we don't actually need to test. This severly deflates our scores and
+# means it is not consistent with our previous reporting tool CodeClimate.
+sonar.sources=./lib
+sonar.tests=./spec
+
+# Encoding of the source code. Default is default system encoding
+sonar.sourceEncoding=UTF-8
+
+sonar.ruby.coverage.reportPaths=coverage/coverage.json
+sonar.ruby.rubocop.reportPaths=rubocop-result.json

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_storm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Defra
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description:
+email:
+- leonid.brujev@defra.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- defra_ruby_storm.gemspec
+- lib/defra_ruby.rb
+- lib/defra_ruby/storm.rb
+- lib/defra_ruby/storm/api.rb
+- lib/defra_ruby/storm/api_error.rb
+- lib/defra_ruby/storm/configuration.rb
+- lib/defra_ruby/storm/responses/base_response.rb
+- lib/defra_ruby/storm/responses/get_user_details_response.rb
+- lib/defra_ruby/storm/responses/recording_response.rb
+- lib/defra_ruby/storm/services/base_service.rb
+- lib/defra_ruby/storm/services/pause_call_recording_service.rb
+- lib/defra_ruby/storm/services/resume_call_recording_service.rb
+- lib/defra_ruby/storm/services/user_details_service.rb
+- lib/defra_ruby/storm/version.rb
+- sig/defra_ruby/storm.rbs
+- sonar-project.properties
+homepage: https://github.com/DEFRA/defra-ruby-storm
+licenses: []
+metadata:
+  homepage_uri: https://github.com/DEFRA/defra-ruby-storm
+  source_code_uri: https://github.com/DEFRA/defra-ruby-storm
+  changelog_uri: https://github.com/DEFRA/defra-ruby-storm/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby client for Storm Web Services API
+test_files: []