gds_zendesk 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295c904eb9989c554f38965497034a3bde4198704a877c5cee12bcbdeb9ebe0f
-  data.tar.gz: 81eed2876f42175f4340ccf711183e56f90855af12ba5082d991121442fabf12
+  metadata.gz: e3b8b924b6a29f163773d9819d104880ff877ae25e331b2e3b027fda6e96cc26
+  data.tar.gz: 80a3824095e067b5abe96db1be6b543bb8ce519c836774a8142a2f715dad10f0
 SHA512:
-  metadata.gz: fe800f77bdccf1620913dc2f9b0b599eb6f733ab73211846ece1db93246eaa700373cc8d266f77728e3a53bcc0297b40e6c1033b1b4a8b718fe6ef0b89bebacb
-  data.tar.gz: c6c3086942dce3330f55e61b96175359d102ef6fab1cf7b8787c328fd95d6646e0fea38c69ac75ea2ef26aa034d866d52cdb9a42ef26c44517568d9c7c5e501e
+  metadata.gz: 0a12ce9526eed49142cb3ada8b86304e2bb3e3c1223cb94d41b4acff728cfd5e447071e77cc78b3d2a1b14feada7c1c0800bf1953d7d5d4d6d52baa872ca7d88
+  data.tar.gz: fe80758c0da541e7e0a17cf0f6df4629a1d73f75b728787d964b509ff0249246bc8175c35792455cc3829750b0a89bd3f55aab64e0ff1b9a336b8f62ccc31ed8

data/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+⚠️ Make sure you [release a new version of this gem](https://github.com/alphagov/gds_zendesk/pull/67/files) after merging your changes. ⚠️
+
+Refer to the [existing docs](https://docs.publishing.service.gov.uk/manual/publishing-a-ruby-gem.html#ruby-version-compatibility) if you are making changes to the supported Ruby versions.

data/.github/workflows/autorelease.yml

@@ -0,0 +1,10 @@
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: '30 10 * * 1-5' # 10:30am UTC, Mon-Fri.
+
+jobs:
+  autorelease:
+    uses: alphagov/govuk-infrastructure/.github/workflows/autorelease-rubygem.yml@main
+    secrets:
+      GH_TOKEN: ${{ secrets.GOVUK_CI_GITHUB_API_TOKEN }}

data/.github/workflows/ci.yml

@@ -1,12 +1,21 @@
 on: [push, pull_request]
 
 jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+  
   test_matrix:
     strategy:
       fail-fast: false
       matrix:
-        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['3.0', 3.1, 3.2]
+        ruby: [3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

data/.gitignore

@@ -1,2 +1,5 @@
 *.gem
 Gemfile.lock
+
+# simplecov
+coverage/

data/.govuk_dependabot_merger.yml

@@ -0,0 +1,4 @@
+api_version: 2
+defaults:
+  auto_merge: true
+  update_external_dependencies: true

data/.ruby-version

@@ -1 +1 @@
-3.0.6
+3.1.5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 3.7.0
+
+* Drop support for Ruby 3.0.
+
+# 3.6.0
+
+* Don't require requested user object to respond to `#job` or `#phone` in calls to `Users#create_or_update_user`
+
 # 3.5.0
 
 * Add support for `zendesk_api` v3.x

data/gds_zendesk.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "Client and models for communicating with Zendesk"
   gem.homepage      = "https://github.com/alphagov/gds_zendesk"
 
-  gem.required_ruby_version = ">= 3.0"
+  gem.required_ruby_version = ">= 3.1"
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 3"
-  gem.add_development_dependency "rubocop-govuk", "4.12.0"
+  gem.add_development_dependency "rubocop-govuk", "4.17.1"
+  gem.add_development_dependency "simplecov"
   gem.add_development_dependency "webmock", ">= 2"
 end

data/lib/gds_zendesk/test_helpers.rb

@@ -34,7 +34,7 @@ module GDSZendesk
 
     def stub_zendesk_ticket_creation_with_body(body)
       stub_request(:post, "#{zendesk_endpoint}/tickets")
-        .with(body: body)
+        .with(body:)
         .with(basic_auth: basic_auth_credentials)
         .to_return(status: 201, body: { ticket: { id: 12_345 } }.to_json,
                    headers: { "Content-Type" => "application/json" })

data/lib/gds_zendesk/users.rb

@@ -31,18 +31,19 @@ module GDSZendesk
     end
 
     def create(requested_user)
-      @client.users.create!(email: requested_user.email,
-                            name: requested_user.name,
-                            details: "Job title: #{requested_user.job}",
-                            phone: requested_user.phone,
-                            verified: true)
+      attributes = { email: requested_user.email, name: requested_user.name, verified: true }
+      attributes[:details] = "Job title: #{requested_user.job}" if requested_user.respond_to?(:job)
+      attributes[:phone] = requested_user.phone if requested_user.respond_to?(:phone)
+      @client.users.create!(attributes)
     end
 
     def update(existing_user_in_zendesk, requested_user)
-      existing_user_in_zendesk.update(details: "Job title: #{requested_user.job}")
-      if !requested_user.phone.nil? && !requested_user.phone.empty?
-        existing_user_in_zendesk.update(phone: requested_user.phone)
+      attributes = {}
+      attributes[:details] = "Job title: #{requested_user.job}" if requested_user.respond_to?(:job)
+      if requested_user.respond_to?(:phone) && !requested_user.phone.nil? && !requested_user.phone.empty?
+        attributes[:phone] = requested_user.phone
       end
+      existing_user_in_zendesk.update(attributes)
       existing_user_in_zendesk.save
       existing_user_in_zendesk
     end

data/lib/gds_zendesk/version.rb

@@ -1,3 +1,3 @@
 module GDSZendesk
-  VERSION = "3.5.0".freeze
+  VERSION = "3.7.0".freeze
 end

data/spec/gds_zendesk/dummy_client_spec.rb

@@ -9,13 +9,13 @@ module GDSZendesk
         logger = instance_double("Logger")
         expect(logger).to receive(:info).with("Zendesk ticket created: #{ticket_options.inspect}")
 
-        client = described_class.new(logger: logger)
+        client = described_class.new(logger:)
         client.ticket.create!(ticket_options)
       end
 
       it "can simulate failures, triggered by a specific description or comment" do
         logger = instance_double("Logger")
-        client = described_class.new(logger: logger)
+        client = described_class.new(logger:)
         expect(logger).to receive(:info).with(/Simulating Zendesk ticket creation failure/).twice
 
         expect {
@@ -35,7 +35,7 @@ module GDSZendesk
         logger = instance_double("Logger")
         expect(logger).to receive(:info).with("Zendesk user created or updated: #{options.inspect}")
 
-        client = described_class.new(logger: logger)
+        client = described_class.new(logger:)
         client.users.create_or_update_user(options)
       end
     end

data/spec/gds_zendesk/users_spec.rb

@@ -23,6 +23,20 @@ module GDSZendesk
         expect(stub_post).to have_been_requested
       end
 
+      it "can update a user which doesn't respond to #job" do
+        stub_post = stub_zendesk_user_update(123, phone: "12345")
+        users.create_or_update_user(double("requested user", email: "test@test.com", phone: "12345"))
+
+        expect(stub_post).to have_been_requested
+      end
+
+      it "can update a user which doesn't respond to #phone" do
+        stub_post = stub_zendesk_user_update(123, details: "Job title: Developer")
+        users.create_or_update_user(double("requested user", email: "test@test.com", job: "Developer"))
+
+        expect(stub_post).to have_been_requested
+      end
+
       it "knows whether the user is suspended or not" do
         zendesk_has_user(email: "test@test.com", id: 123, suspended: "true")
         expect(users).to be_suspended("test@test.com")
@@ -30,6 +44,16 @@ module GDSZendesk
     end
 
     context "when a user doesn't exist" do
+      let(:expected_attributes) do
+        {
+          verified: true,
+          name: "Abc",
+          email: "test@test.com",
+          phone: "12345",
+          details: "Job title: Developer",
+        }
+      end
+
       before do
         zendesk_has_no_user_with_email("test@test.com")
       end
@@ -39,15 +63,30 @@ module GDSZendesk
       end
 
       it "can create that user" do
-        stub_post = stub_zendesk_user_creation(
-          verified: true,
-          name: "Abc",
-          email: "test@test.com",
-          phone: "12345",
-          details: "Job title: Developer",
-        )
-        user_being_requested = double("requested user",
-                                      name: "Abc", email: "test@test.com", phone: "12345", job: "Developer")
+        stub_post = stub_zendesk_user_creation(expected_attributes)
+        user_being_requested = double("requested user", {
+          name: "Abc", email: "test@test.com", phone: "12345", job: "Developer"
+        })
+
+        users.create_or_update_user(user_being_requested)
+        expect(stub_post).to have_been_requested
+      end
+
+      it "can create that user which doesn't respond to #job" do
+        stub_post = stub_zendesk_user_creation(expected_attributes.except(:details))
+        user_being_requested = double("requested user", {
+          name: "Abc", email: "test@test.com", phone: "12345"
+        })
+
+        users.create_or_update_user(user_being_requested)
+        expect(stub_post).to have_been_requested
+      end
+
+      it "can create that user which doesn't respond to #phone" do
+        stub_post = stub_zendesk_user_creation(expected_attributes.except(:phone))
+        user_being_requested = double("requested user", {
+          name: "Abc", email: "test@test.com", job: "Developer"
+        })
 
         users.create_or_update_user(user_being_requested)
         expect(stub_post).to have_been_requested

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
 require "webmock/rspec"
+require "simplecov"
+SimpleCov.start
 
 WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds_zendesk
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: null_logger
@@ -78,14 +78,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.17.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +122,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/autorelease.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".govuk_dependabot_merger.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
@@ -140,14 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Client and models for communicating with Zendesk