gds_zendesk 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 212f75df35d4fbe686de231d98ea2bf37e38e135e58d80c92e1a650b4f393327
-  data.tar.gz: ab77b135f4a7e10107eef99fff1d221409902ca8458d73caedd3b760e553221d
+  metadata.gz: 1806a756294d190c9e4d338680319a62d49b1f6df2cf0baa0ea889b798fd0eaf
+  data.tar.gz: b2e7543717d7211fc9f84b8805b9c78c135a984668c64ea11ace577190f99012
 SHA512:
-  metadata.gz: fdaf04d4cdf2fa3fd2b5d7cc48f93130008a4cf134372e97bf622d38872d6d56655dfa7f232f3a52c0474e673b9dbd04c9571a72a2d04c7fbc139afb3284879b
-  data.tar.gz: 94112efde5839d160cdac16d10aa50cc60e665d1e33ee5ddf219fca4bf3ec837e2c7d3f36c44b930910e4932a25836816510e839021f7c003cbebf9508a58afe
+  metadata.gz: 3720fe9f23d27c3213b2999454aa734bece0bb255dd0d5adb9685f042b3809b0e65a4cc1b402d497e55f9f02201317f91e2dae49d29573de2a09e3990d97f991
+  data.tar.gz: da36985b5c8ebdcb65ab3864b85af2d3190f944176c09cda0bf6c280e3c94a7b0424601bf4cfa85c9ab10f72eb09a6e4dd4d888a65cd4ba45c340f50bc9825df

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+on: [push, pull_request]
+
+jobs:
+  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]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -1,17 +1,2 @@
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_gem:
   rubocop-govuk:
     - config/default.yml
+    - config/rspec.yml
 
 inherit_mode:
   merge:

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.0.5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 3.4.0
+
+* Drop support for Ruby 2.7 and below.
+* Require a `zendesk_api` of ">= 1.37", "< 3.0"
+
 # 3.3.0
 
 * Allow access to Zendesk::Client from GDSZendesk::Client

data/README.md

@@ -61,3 +61,6 @@ To run the tests, use the follow:
 ```
 bundle exec rake default
 ```
+# Licence
+
+[MIT License](LICENCE)

data/Rakefile

@@ -6,8 +6,4 @@ require "rspec/core/rake_task"
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Linting for Ruby"
-task lint: %i[rubocop] do
-end
-
-task default: %i[lint spec]
+task default: %i[rubocop spec]

data/gds_zendesk.gemspec

@@ -11,16 +11,18 @@ 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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = %w[lib]
 
   gem.add_dependency "null_logger", "~> 0"
-  gem.add_dependency "zendesk_api", "~> 1.27"
+  gem.add_dependency "zendesk_api", ">= 1.37", "< 3.0"
 
-  gem.add_development_dependency "rake", "~> 10"
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 3"
-  gem.add_development_dependency "rubocop-govuk", "~> 3"
-  gem.add_development_dependency "webmock", "~> 2"
+  gem.add_development_dependency "rubocop-govuk", "4.10.0"
+  gem.add_development_dependency "webmock", ">= 2"
 end

data/lib/gds_zendesk/client.rb

@@ -6,9 +6,6 @@ require "gds_zendesk/users"
 
 module GDSZendesk
   class Client
-    extend Forwardable
-    def_delegators :@zendesk_client, :ticket
-
     attr_accessor :config_options
     attr_reader :zendesk_client
 
@@ -33,6 +30,10 @@ module GDSZendesk
       end
     end
 
+    def ticket
+      @zendesk_client.ticket
+    end
+
   protected
 
     def logger

data/lib/gds_zendesk/version.rb

@@ -1,3 +1,3 @@
 module GDSZendesk
-  VERSION = "3.3.0".freeze
+  VERSION = "3.4.0".freeze
 end

data/lib/generators/gds_zendesk/install/install_generator.rb

@@ -2,7 +2,7 @@ INITIALIZER = <<~RUBY.freeze
   require 'yaml'
   require 'gds_zendesk/client'
   require 'gds_zendesk/dummy_client'
-  
+
   GDS_ZENDESK_CLIENT = if Rails.env.development? || Rails.env.test?
     GDSZendesk::DummyClient.new(logger: Rails.logger)
   else

data/spec/gds_zendesk/client_spec.rb

@@ -15,60 +15,59 @@ module GDSZendesk
       Client.new(valid_credentials.merge(options))
     end
 
-    it "should raise an error if no username is provided" do
-      expect { Client.new(password: "abc") }.to raise_error(ArgumentError,
-                                                            /username not provided/)
+    it "raises an error if no username is provided" do
+      expect { described_class.new(password: "abc") }
+        .to raise_error(ArgumentError, /username not provided/)
     end
 
-    it "should raise an error if no password or token is provided" do
-      expect { Client.new(username: "abc") }.to raise_error(ArgumentError,
-                                                            /password or token not provided/)
+    it "raises an error if no password or token is provided" do
+      expect { described_class.new(username: "abc") }
+        .to raise_error(ArgumentError, /password or token not provided/)
     end
 
-    it "should raise an error if token and password are provided" do
-      expect { Client.new(username: "abc", token: "def", password: "ghi") }.to raise_error(ArgumentError,
-                                                                                           /Provide only one of token or password/)
+    it "raises an error if token and password are provided" do
+      expect { described_class.new(username: "abc", token: "def", password: "ghi") }
+        .to raise_error(ArgumentError, /Provide only one of token or password/)
     end
 
-    it "should not raise an error if token is provided without password" do
-      expect { Client.new(username: "abc", token: "def") }.not_to raise_error(ArgumentError,
-                                                                              /password or token not provided/)
+    it "does not raise an error if token is provided without password" do
+      expect { described_class.new(username: "abc", token: "def") }.not_to raise_error
     end
 
-    it "should not raise an error if password is provided without token" do
-      expect { Client.new(username: "abc", password: "def") }.not_to raise_error(ArgumentError,
-                                                                                 /password or token not provided/)
+    it "does not raise an error if password is provided without token" do
+      expect { described_class.new(username: "abc", password: "def") }.not_to raise_error
     end
 
-    it "should use a null logger if no logger has been provided" do
+    it "uses a null logger if no logger has been provided" do
       expect(client.config_options[:logger]).to be_an_instance_of(NullLogger::Logger)
     end
 
-    it "should use the passed logger if one has been provided" do
-      custom_logger = double("logger")
+    it "uses the passed logger if one has been provided" do
+      custom_logger = instance_double("Logger")
 
       expect(client(logger: custom_logger).config_options[:logger]).to eq(custom_logger)
     end
 
-    it "should use the default url if no url is provided" do
+    it "uses the default url if no url is provided" do
       expect(client.config_options[:url]).to eq "https://govuk.zendesk.com/api/v2/"
     end
 
-    it "should use the token if provided" do
-      expect(Client.new(username: "test_user", token: "test_token").config_options[:token]).to eq "test_token"
+    it "uses the token if provided" do
+      expect(described_class.new(username: "test_user", token: "test_token").config_options[:token]).to eq "test_token"
     end
 
-    it "should use the password if provided" do
-      expect(Client.new(username: "test_user", password: "test_password").config_options[:password]).to eq "test_password"
+    it "uses the password if provided" do
+      expect(described_class.new(username: "test_user", password: "test_password").config_options[:password]).to eq "test_password"
     end
 
-    it "should use the configured url if provided" do
-      expect(Client.new(username: "test_user", password: "test_pass", url: "https://example.com").config_options[:url]).to eq "https://example.com"
+    it "uses the configured url if provided" do
+      instance = described_class.new(username: "test_user", password: "test_pass", url: "https://example.com")
+      expect(instance.config_options[:url]).to eq "https://example.com"
     end
 
-    it "should raise tickets in Zendesk" do
+    it "raises tickets in Zendesk" do
       self.valid_zendesk_credentials = valid_credentials
-      post_stub = stub_zendesk_ticket_creation(some: "data")
+      post_stub = stub_zendesk_ticket_creation(some: "data", comment: nil)
 
       client.ticket.create(some: "data")
 
@@ -79,7 +78,7 @@ module GDSZendesk
       self.valid_zendesk_credentials = valid_credentials
       post_stub = stub_request(:post, "#{zendesk_endpoint}/tickets").to_return(status: 302)
 
-      expect { client.ticket.create!(some: "data") }.to raise_error
+      expect { client.ticket.create!(some: "data") }.to raise_error(ZendeskAPI::Error::NetworkError)
       expect(post_stub).to have_been_requested
     end
   end

data/spec/gds_zendesk/dummy_client_spec.rb

@@ -5,17 +5,17 @@ module GDSZendesk
     context "when a ticket has been raised" do
       let(:ticket_options) { { opt1: "val1" } }
 
-      it "should log the ticket details" do
-        logger = double("logger")
+      it "logs the ticket details" do
+        logger = instance_double("Logger")
         expect(logger).to receive(:info).with("Zendesk ticket created: #{ticket_options.inspect}")
 
-        client = DummyClient.new(logger: logger)
+        client = described_class.new(logger: logger)
         client.ticket.create!(ticket_options)
       end
 
       it "can simulate failures, triggered by a specific description or comment" do
-        logger = double("logger")
-        client = DummyClient.new(logger: logger)
+        logger = instance_double("Logger")
+        client = described_class.new(logger: logger)
         expect(logger).to receive(:info).with(/Simulating Zendesk ticket creation failure/).twice
 
         expect {
@@ -31,11 +31,11 @@ module GDSZendesk
     context "when a user has been created" do
       let(:options) { { email: "a@b.com" } }
 
-      it "should log the user details" do
-        logger = double("logger")
+      it "logs the user details" do
+        logger = instance_double("Logger")
         expect(logger).to receive(:info).with("Zendesk user created or updated: #{options.inspect}")
 
-        client = DummyClient.new(logger: logger)
+        client = described_class.new(logger: logger)
         client.users.create_or_update_user(options)
       end
     end

data/spec/gds_zendesk/users_spec.rb

@@ -4,57 +4,55 @@ require "gds_zendesk/client"
 require "gds_zendesk/users"
 require "gds_zendesk/test_helpers"
 
+# rubocop:disable RSpec/VerifiedDoubles -- It's unclear that the user classes can be verified doubles
 module GDSZendesk
   describe Users do
     include GDSZendesk::TestHelpers
 
     let(:users) { Client.new(valid_zendesk_credentials).users }
 
-    context "existing users" do
+    context "when there is an existing user" do
       before do
         zendesk_has_user(email: "test@test.com", id: 123)
       end
 
-      context "creating/updating a user" do
-        it "should update the phone and job title if those are set" do
-          stub_post = stub_zendesk_user_update(123, phone: "12345", details: "Job title: Developer")
-          users.create_or_update_user(double("requested user", email: "test@test.com", phone: "12345", job: "Developer"))
+      it "can update the user" do
+        stub_post = stub_zendesk_user_update(123, phone: "12345", details: "Job title: Developer")
+        users.create_or_update_user(double("requested user", email: "test@test.com", phone: "12345", job: "Developer"))
 
-          expect(stub_post).to have_been_requested
-        end
+        expect(stub_post).to have_been_requested
       end
 
-      it "should know whether the user is suspended or not" do
+      it "knows whether the user is suspended or not" do
         zendesk_has_user(email: "test@test.com", id: 123, suspended: "true")
-        expect(users.suspended?("test@test.com")).to be_truthy
+        expect(users).to be_suspended("test@test.com")
       end
     end
 
-    context "non-existent users" do
+    context "when a user doesn't exist" do
       before do
         zendesk_has_no_user_with_email("test@test.com")
       end
 
-      it "should not be suspended" do
-        expect(users).to_not be_suspended("test@test.com")
+      it "doesn't have any suspended users" do
+        expect(users).not_to be_suspended("test@test.com")
       end
 
-      context "creating/updating" do
-        it "should 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")
-
-          users.create_or_update_user(user_being_requested)
-          expect(stub_post).to have_been_requested
-        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")
+
+        users.create_or_update_user(user_being_requested)
+        expect(stub_post).to have_been_requested
       end
     end
   end
 end
+# rubocop:enable RSpec/VerifiedDoubles

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds_zendesk
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: null_logger
@@ -28,30 +28,36 @@ dependencies:
   name: zendesk_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.37'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.37'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,28 +76,28 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 description: Client and models for communicating with Zendesk
@@ -101,13 +107,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
-- LICENCE.txt
+- LICENCE
 - README.md
 - Rakefile
 - gds_zendesk.gemspec
@@ -125,7 +132,7 @@ files:
 homepage: https://github.com/alphagov/gds_zendesk
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,15 +140,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Client and models for communicating with Zendesk
 test_files:

data/Jenkinsfile

@@ -1,7 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject()
-}