gds_zendesk 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a447e6d572e8bf6c8dfdbd79c40906c05f896cc1
-  data.tar.gz: 86e0ee3c122ad0104ec7d578f6b07b2c67742c81
+SHA256:
+  metadata.gz: 212f75df35d4fbe686de231d98ea2bf37e38e135e58d80c92e1a650b4f393327
+  data.tar.gz: ab77b135f4a7e10107eef99fff1d221409902ca8458d73caedd3b760e553221d
 SHA512:
-  metadata.gz: bc2777822bf5fefa9ce46d98c95f8bad9bdc441fa72976c5418acc59768757286e29b1bbbeac88061d4b51e8dc4c5d0c3018247a440feeec137a4f1559a8575c
-  data.tar.gz: 9d1140b369c2147d9ee51d06506a8818c8ff6d2b7727acb0c248ba8f36002278c14c9753edf76d4edf06bdf90a42e0e419ebd47e57c60ae53ffe4420f34d2124
+  metadata.gz: fdaf04d4cdf2fa3fd2b5d7cc48f93130008a4cf134372e97bf622d38872d6d56655dfa7f232f3a52c0474e673b9dbd04c9571a72a2d04c7fbc139afb3284879b
+  data.tar.gz: 94112efde5839d160cdac16d10aa50cc60e665d1e33ee5ddf219fca4bf3ec837e2c7d3f36c44b930910e4932a25836816510e839021f7c003cbebf9508a58afe

data/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.6.6

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 3.3.0
+
+* Allow access to Zendesk::Client from GDSZendesk::Client
+
+# 3.2.0
+
+* Allow use of a token instead of password
+
+# 3.1.0
+
+* Update `zendesk_api` library to v1.27
+
 # 3.0.0
 
 * Update the `webmock` library to version v2.3.2 to be compatible with Ruby

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Jenkinsfile

@@ -1,6 +1,7 @@
 #!/usr/bin/env groovy
 
+library("govuk")
+
 node {
-  def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
   govuk.buildProject()
 }

data/README.md

@@ -32,7 +32,7 @@ This generates an initializer at `config/initializers/gds_zendesk.rb`.
 
 #### Mandatory settings
 
-This gem needs to be configured with a Zendesk username and password before it can be used.
+This gem needs to be configured with a Zendesk username and password (or token)  before it can be used.
 These are set in `config/initializers/gds_zendesk.rb`
 
 #### Enabling development mode
@@ -53,3 +53,11 @@ GDSZendesk::Client.new(config_options)
 ```
 
 to create a new client.
+
+## Running tests locally
+
+To run the tests, use the follow:
+
+```
+bundle exec rake default
+```

data/Rakefile

@@ -1,7 +1,13 @@
 require "rake"
+require "rubocop/rake_task"
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Linting for Ruby"
+task lint: %i[rubocop] do
+end
+
+task default: %i[lint spec]

data/gds_zendesk.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gds_zendesk/version'
+require "gds_zendesk/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "gds_zendesk"
   gem.version       = GDSZendesk::VERSION
-  gem.authors       = ["Jake Benilov"]
-  gem.email         = ["benilov@gmail.com"]
-  gem.description   = %q{Client and models for communicating with Zendesk}
-  gem.summary       = %q{Client and models for communicating with Zendesk}
+  gem.authors       = ["GOV.UK Dev"]
+  gem.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
+  gem.description   = "Client and models for communicating with Zendesk"
+  gem.summary       = "Client and models for communicating with Zendesk"
   gem.homepage      = "https://github.com/alphagov/gds_zendesk"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  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 = ["lib"]
+  gem.require_paths = %w[lib]
 
-  gem.add_dependency 'null_logger', '0.0.1'
-  gem.add_dependency 'zendesk_api', '1.14.4'
+  gem.add_dependency "null_logger", "~> 0"
+  gem.add_dependency "zendesk_api", "~> 1.27"
 
-  gem.add_development_dependency 'rake', '10.0.3'
-  gem.add_development_dependency 'rspec', '3.1.0'
-  gem.add_development_dependency "webmock", '~> 2.3.0'
+  gem.add_development_dependency "rake", "~> 10"
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "rubocop-govuk", "~> 3"
+  gem.add_development_dependency "webmock", "~> 2"
 end

data/lib/gds_zendesk/client.rb

@@ -1,8 +1,8 @@
-require 'forwardable'
-require 'null_logger'
-require 'zendesk_api'
+require "forwardable"
+require "null_logger"
+require "zendesk_api"
 
-require 'gds_zendesk/users'
+require "gds_zendesk/users"
 
 module GDSZendesk
   class Client
@@ -10,6 +10,7 @@ module GDSZendesk
     def_delegators :@zendesk_client, :ticket
 
     attr_accessor :config_options
+    attr_reader :zendesk_client
 
     def initialize(config_options)
       @config_options = defaults.merge(config_options)
@@ -23,28 +24,35 @@ module GDSZendesk
     def build
       check_that_username_and_password_are_provided
 
-      ZendeskAPI::Client.new { |config|
+      ZendeskAPI::Client.new do |config|
         config.url = url
         config.username = username
-        config.password = password
+        config.token = token if token
+        config.password = password if password
         config.logger = logger
-      }
+      end
     end
 
-    protected
+  protected
+
     def logger
       @config_options[:logger] || @config_options["logger"]
     end
 
     def check_that_username_and_password_are_provided
       raise ArgumentError, "Zendesk username not provided" if username.nil?
-      raise ArgumentError, "Zendesk password not provided" if password.nil?
+      raise ArgumentError, "Zendesk password or token not provided" if password.nil? && token.nil?
+      raise ArgumentError, "Provide only one of token or password" unless password.nil? || token.nil?
     end
 
     def username
       @config_options[:username] || @config_options["username"]
     end
 
+    def token
+      @config_options[:token] || @config_options["token"]
+    end
+
     def password
       @config_options[:password] || @config_options["password"]
     end
@@ -55,9 +63,9 @@ module GDSZendesk
 
     def defaults
       {
-          logger: NullLogger.instance,
-          url: "https://govuk.zendesk.com/api/v2/"
+        logger: NullLogger.instance,
+        url: "https://govuk.zendesk.com/api/v2/",
       }
     end
   end
-end
+end

data/lib/gds_zendesk/dummy_client.rb

@@ -1,5 +1,5 @@
-require 'null_logger'
-require 'zendesk_api/error'
+require "null_logger"
+require "zendesk_api/error"
 
 module GDSZendesk
   class DummyClient
@@ -23,13 +23,14 @@ module GDSZendesk
       @options = options
       if should_raise_error?
         @logger.info("Simulating Zendesk ticket creation failure: #{options.inspect}")
-        raise ZendeskAPI::Error::RecordInvalid.new(body: {"details" => "sample error message from Zendesk"})
+        raise ZendeskAPI::Error::RecordInvalid.new(body: { "details" => "sample error message from Zendesk" })
       else
         @logger.info("Zendesk ticket created: #{options.inspect}")
       end
     end
 
-    protected
+  protected
+
     def should_raise_error?
       description =~ /break_zendesk/ or comment =~ /break_zendesk/
     end
@@ -48,11 +49,11 @@ module GDSZendesk
       @logger = logger
     end
 
-    def search(attributes)
+    def search(_attributes)
       []
     end
 
-    def suspended?(user_email)
+    def suspended?(_user_email)
       false
     end
 

data/lib/gds_zendesk/test_helpers.rb

@@ -1,55 +1,55 @@
-require 'json'
+require "json"
 
 module GDSZendesk
   module TestHelpers
     def zendesk_has_no_user_with_email(email)
-      stub_request(:get, "#{zendesk_endpoint}/users/search?query=#{email}").
-        with(basic_auth: basic_auth_credentials).
-        to_return(body: {users: [], previous_page: nil, next_page: nil, count: 0}.to_json,
-                  headers: {'Content-Type' => 'application/json'})
+      stub_request(:get, "#{zendesk_endpoint}/users/search?query=#{email}")
+        .with(basic_auth: basic_auth_credentials)
+        .to_return(body: { users: [], previous_page: nil, next_page: nil, count: 0 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
     end
 
     def zendesk_has_user(user_details)
-      stub_request(:get, "#{zendesk_endpoint}/users/search?query=#{user_details[:email]}").
-        with(basic_auth: basic_auth_credentials).
-        to_return(body: {users: [user_details], previous_page: nil, next_page: nil, count: 1}.to_json,
-                  headers: {'Content-Type' => 'application/json'})
+      stub_request(:get, "#{zendesk_endpoint}/users/search?query=#{user_details[:email]}")
+        .with(basic_auth: basic_auth_credentials)
+        .to_return(body: { users: [user_details], previous_page: nil, next_page: nil, count: 1 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
     end
 
     def stub_zendesk_user_creation(user_properties = nil)
       stub = stub_request(:post, "#{zendesk_endpoint}/users")
-      stub.with(body: {user: user_properties}) unless user_properties.nil?
+      stub.with(body: { user: user_properties }) unless user_properties.nil?
       stub.with(basic_auth: basic_auth_credentials)
-      stub.to_return(status: 201, body: { user: { id: 12345, name: "abc" }}.to_json,
-                     headers: {'Content-Type' => 'application/json'})
+      stub.to_return(status: 201, body: { user: { id: 12_345, name: "abc" } }.to_json,
+                     headers: { "Content-Type" => "application/json" })
     end
 
     def stub_zendesk_ticket_creation(ticket_properties = nil)
       stub = stub_request(:post, "#{zendesk_endpoint}/tickets")
-      stub.with(body: {ticket: ticket_properties}) unless ticket_properties.nil?
+      stub.with(body: { ticket: ticket_properties }) unless ticket_properties.nil?
       stub.with(basic_auth: basic_auth_credentials)
-      stub.to_return(status: 201, body: { ticket: { id: 12345 }}.to_json,
-                     headers: {'Content-Type' => 'application/json'})
+      stub.to_return(status: 201, body: { ticket: { id: 12_345 } }.to_json,
+                     headers: { "Content-Type" => "application/json" })
     end
 
     def stub_zendesk_ticket_creation_with_body(body)
-      stub_request(:post, "#{zendesk_endpoint}/tickets").
-        with(body: body).
-        with(basic_auth: basic_auth_credentials).
-        to_return(status: 201, body: { ticket: { id: 12345 }}.to_json,
-                  headers: {'Content-Type' => 'application/json'})
+      stub_request(:post, "#{zendesk_endpoint}/tickets")
+        .with(body: body)
+        .with(basic_auth: basic_auth_credentials)
+        .to_return(status: 201, body: { ticket: { id: 12_345 } }.to_json,
+                   headers: { "Content-Type" => "application/json" })
     end
 
     def stub_zendesk_user_update(user_id, user_properties)
-      stub_request(:put, "#{zendesk_endpoint}/users/#{user_id}").
-        with(body: {user: user_properties}).
-        with(basic_auth: basic_auth_credentials).
-        to_return(status: 201, body: { user: { id: 12345, name: "abc" }}.to_json,
-                  headers: {'Content-Type' => 'application/json'})
+      stub_request(:put, "#{zendesk_endpoint}/users/#{user_id}")
+        .with(body: { user: user_properties })
+        .with(basic_auth: basic_auth_credentials)
+        .to_return(status: 201, body: { user: { id: 12_345, name: "abc" } }.to_json,
+                   headers: { "Content-Type" => "application/json" })
     end
 
     def basic_auth_credentials
-      [valid_zendesk_credentials['username'], valid_zendesk_credentials['password']]
+      [valid_zendesk_credentials["username"], valid_zendesk_credentials["password"]]
     end
 
     def zendesk_is_unavailable
@@ -78,12 +78,12 @@ module GDSZendesk
 
     def assert_created_ticket_has(ticket_options)
       assert_requested :post, %r{/api/v2/tickets},
-        body: { ticket: hash_including(ticket_options) }, times: 1
+                       body: { ticket: hash_including(ticket_options) }, times: 1
     end
 
     def assert_created_ticket_has_requester(requester_options)
       assert_requested :post, %r{/api/v2/tickets},
-        body: { ticket: hash_including(requester: hash_including(requester_options)) }, times: 1
+                       body: { ticket: hash_including(requester: hash_including(requester_options)) }, times: 1
     end
   end
 end

data/lib/gds_zendesk/users.rb

@@ -24,7 +24,8 @@ module GDSZendesk
       end
     end
 
-    protected
+  protected
+
     def find_by_email(email)
       @client.users.search(query: email).to_a
     end
@@ -46,4 +47,4 @@ module GDSZendesk
       existing_user_in_zendesk
     end
   end
-end
+end

data/lib/gds_zendesk/version.rb

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

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

@@ -1,19 +1,19 @@
-INITIALIZER = <<END
-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
-  config_yaml_file = File.join(Rails.root, 'config', 'zendesk.yml')
-  config = YAML.load_file(config_yaml_file)[Rails.env]
-  GDSZendesk::Client.new(username: config['username'], password: config['password'], logger: Rails.logger)
-end
-END
+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
+    config_yaml_file = File.join(Rails.root, 'config', 'zendesk.yml')
+    config = YAML.load_file(config_yaml_file)[Rails.env]
+    GDSZendesk::Client.new(username: config['username'], password: config['password'], token: config['token'], logger: Rails.logger)
+  end
+RUBY
 
 # This module name is slightly differently capitalised to the main library module
-# The reason for this is that the module name is used by Rails within the 
+# The reason for this is that the module name is used by Rails within the
 # generator CLI tools, and the tools get confused if the module is called GDSZendesk
 module GdsZendesk
   class InstallGenerator < Rails::Generators::Base

data/spec/gds_zendesk/client_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
-require 'gds_zendesk/test_helpers'
-require 'gds_zendesk/client'
-require 'null_logger'
+require "spec_helper"
+require "gds_zendesk/test_helpers"
+require "gds_zendesk/client"
+require "null_logger"
 
 module GDSZendesk
   describe Client do
@@ -17,12 +17,27 @@ module GDSZendesk
 
     it "should raise an error if no username is provided" do
       expect { Client.new(password: "abc") }.to raise_error(ArgumentError,
-        /username not provided/)
+                                                            /username not provided/)
     end
 
-    it "should raise an error if no password is provided" do
+    it "should raise an error if no password or token is provided" do
       expect { Client.new(username: "abc") }.to raise_error(ArgumentError,
-        /password not provided/)
+                                                            /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/)
+    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/)
+    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/)
     end
 
     it "should use a null logger if no logger has been provided" do
@@ -39,6 +54,14 @@ module GDSZendesk
       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"
+    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"
+    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"
     end

data/spec/gds_zendesk/dummy_client_spec.rb

@@ -1,4 +1,4 @@
-require 'gds_zendesk/dummy_client'
+require "gds_zendesk/dummy_client"
 
 module GDSZendesk
   describe DummyClient do

data/spec/gds_zendesk/users_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
-require 'gds_zendesk/client'
-require 'gds_zendesk/users'
-require 'gds_zendesk/test_helpers'
+require "gds_zendesk/client"
+require "gds_zendesk/users"
+require "gds_zendesk/test_helpers"
 
 module GDSZendesk
   describe Users do
@@ -46,10 +46,10 @@ module GDSZendesk
             name: "Abc",
             email: "test@test.com",
             phone: "12345",
-            details: "Job title: Developer"
+            details: "Job title: Developer",
           )
           user_being_requested = double("requested user",
-            name: "Abc", email: "test@test.com", phone: "12345", job: "Developer")
+                                        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

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
-require 'webmock/rspec'
+require "webmock/rspec"
 
-WebMock.disable_net_connect!(:allow_localhost => true)
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -1,93 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: gds_zendesk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
-- Jake Benilov
+- GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: null_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zendesk_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.4
+        version: '1.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.4
+        version: '1.27'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2'
 description: Client and models for communicating with Zendesk
 email:
-- benilov@gmail.com
+- govuk-dev@digital.cabinet-office.gov.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -125,8 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Client and models for communicating with Zendesk