gds_zendesk 2.3.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9868cd71f7e7f7db163baebab52b2a1a78eb3c21
-  data.tar.gz: bbb1d2436fccc42943c5d32ef8c5cdde477e5c19
+SHA256:
+  metadata.gz: c2ce09664299a6802632a0dc10966d37c4adf67d53efbf2368240a4d96401139
+  data.tar.gz: fe832fb5483d5d9363614b984f2d89903742be31175b5839ab9bf515a7164b62
 SHA512:
-  metadata.gz: 111f1600d6434633aaf532d60814bb59a9b735f0a0a81fb3f0e83168a10b5ca62013d16eef8ba9dcf8b9f57befba5362aeee40b5be15bef5234a179a8d79f4d7
-  data.tar.gz: 9deb85d0d021845a89f7bad383fa77a0dcd68ad8b208e07e6679fe7d66e6a9fd4ab856ccf054f16935064eb4d376be9e5070eca813762c242548e8ceba616900
+  metadata.gz: 20a8002750b0376ba9ec27ed501cf91f84372259918cb3aff80571e375bb8a1a81121d303da41cbd6f2ad5f175006871cbda40e43b5d332ff50cf64239fee619
+  data.tar.gz: 3d68d792fa0e783e96761d04ca23c17d9b4b96ac71bb5d72e6f2a5a57177eef8fe3ed8466b572feca0dc2383b0163813a13146c331bee3269e77be19b322c49d

data/.ruby-version

@@ -1 +1 @@
-2.2
+2.6.6

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# 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
+2.4.2
+* Update the `test_helpers` to be compatible with `webmock` v2.3.2
+
+# 2.4.0
+
+* Update the `zendesk_api` library to v1.14.4 to silence warnings from
+Hashie about setting a key called `class`.
+
+# 2.3.1
+
+* Patch release as the previous upgrade didn't include the required
+  feature due to rapid successive merges.
+
+# 2.3.0
+
+* Add a test helper to stub Zendesk returning a 302
+
 # 2.2.0
 
 * Allow the zendesk URL to be specified in the configuration

data/Jenkinsfile

@@ -0,0 +1,7 @@
+#!/usr/bin/env groovy
+
+library("govuk")
+
+node {
+  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

data/Rakefile

@@ -1,14 +1,7 @@
 require "rake"
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-require "gem_publisher"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-desc "Publish the gem"
-task :publish_gem do |t|
-  gem = GemPublisher.publish_if_updated("gds_zendesk.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end

data/gds_zendesk.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ["GOV.UK Dev"]
+  gem.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
   gem.description   = %q{Client and models for communicating with Zendesk}
   gem.summary       = %q{Client and models for communicating with Zendesk}
   gem.homepage      = "https://github.com/alphagov/gds_zendesk"
@@ -17,11 +17,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'null_logger', '0.0.1'
-  gem.add_dependency 'zendesk_api', '1.8.0'
+  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 'gem_publisher', '1.2.0'
-  gem.add_development_dependency "webmock", '1.18.0'
+  gem.add_development_dependency 'rake', '~> 10'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'webmock', '~> 2'
 end

data/lib/gds_zendesk/client.rb

@@ -26,7 +26,8 @@ module GDSZendesk
       ZendeskAPI::Client.new { |config|
         config.url = url
         config.username = username
-        config.password = password
+        config.token = token if token
+        config.password = password if password
         config.logger = logger
       }
     end
@@ -38,13 +39,18 @@ module GDSZendesk
 
     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

data/lib/gds_zendesk/test_helpers.rb

@@ -4,44 +4,54 @@ 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'})
     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'})
     end
 
     def stub_zendesk_user_creation(user_properties = nil)
-      stub = stub_http_request(:post, "#{zendesk_endpoint}/users")
+      stub = stub_request(:post, "#{zendesk_endpoint}/users")
       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'})
     end
 
     def stub_zendesk_ticket_creation(ticket_properties = nil)
-      stub = stub_http_request(:post, "#{zendesk_endpoint}/tickets")
+      stub = stub_request(:post, "#{zendesk_endpoint}/tickets")
       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'})
     end
 
     def stub_zendesk_ticket_creation_with_body(body)
-      stub_http_request(:post, "#{zendesk_endpoint}/tickets").
+      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'})
     end
 
     def stub_zendesk_user_update(user_id, user_properties)
-      stub_http_request(:put, "#{zendesk_endpoint}/users/#{user_id}").
+      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'})
     end
 
+    def basic_auth_credentials
+      [valid_zendesk_credentials['username'], valid_zendesk_credentials['password']]
+    end
+
     def zendesk_is_unavailable
       stub_request(:any, /#{zendesk_endpoint}\/.*/).to_return(status: 503)
     end
@@ -50,8 +60,12 @@ module GDSZendesk
       stub_request(:any, /#{zendesk_endpoint}\/.*/).to_return(status: 409)
     end
 
+    def zendesk_returns_redirect
+      stub_request(:any, /#{zendesk_endpoint}\/.*/).to_return(status: 302)
+    end
+
     def zendesk_endpoint
-      "https://#{valid_zendesk_credentials["username"]}:#{valid_zendesk_credentials["password"]}@govuk.zendesk.com/api/v2"
+      "https://govuk.zendesk.com/api/v2"
     end
 
     def valid_zendesk_credentials=(credentials)

data/lib/gds_zendesk/version.rb

@@ -1,3 +1,3 @@
 module GDSZendesk
-  VERSION = "2.3.0"
+  VERSION = "3.2.0"
 end

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

@@ -8,7 +8,7 @@ GDS_ZENDESK_CLIENT = if Rails.env.development? || Rails.env.test?
 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)
+  GDSZendesk::Client.new(username: config['username'], password: config['password'], token: config['token'], logger: Rails.logger)
 end
 END
 

data/spec/gds_zendesk/client_spec.rb

@@ -20,9 +20,24 @@ module GDSZendesk
         /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
@@ -54,7 +77,7 @@ module GDSZendesk
 
     it "raises an exception if the ticket creation wasn't successful" do
       self.valid_zendesk_credentials = valid_credentials
-      post_stub = stub_http_request(:post, "#{zendesk_endpoint}/tickets").to_return(status: 302)
+      post_stub = stub_request(:post, "#{zendesk_endpoint}/tickets").to_return(status: 302)
 
       expect { client.ticket.create!(some: "data") }.to raise_error
       expect(post_stub).to have_been_requested

metadata

@@ -1,102 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: gds_zendesk
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.2.0
 platform: ruby
 authors:
-- Jake Benilov
+- GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2020-09-29 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.8.0
+        version: '1.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        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.1.0
-- !ruby/object:Gem::Dependency
-  name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.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: []
@@ -105,12 +91,11 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Jenkinsfile
 - LICENCE.txt
 - README.md
 - Rakefile
 - gds_zendesk.gemspec
-- jenkins.sh
-- jenkins_branches.sh
 - lib/gds_zendesk.rb
 - lib/gds_zendesk/client.rb
 - lib/gds_zendesk/dummy_client.rb
@@ -140,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client and models for communicating with Zendesk

data/jenkins.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-set -e
-rm -f Gemfile.lock
-bundle install --path "${HOME}/bundles/${JOB_NAME}"
-bundle exec rake
-bundle exec rake publish_gem

data/jenkins_branches.sh

@@ -1,20 +0,0 @@
-#!/bin/bash
-set -e
-
-VENV_PATH="${HOME}/venv/${JOB_NAME}"
-
-[ -x ${VENV_PATH}/bin/pip ] || virtualenv ${VENV_PATH}
-. ${VENV_PATH}/bin/activate
-
-pip install -q ghtools
-
-REPO="alphagov/gds_zendesk"
-gh-status "$REPO" "$GIT_COMMIT" pending -d "\"Build #${BUILD_NUMBER} is running on Jenkins\"" -u "$BUILD_URL" >/dev/null
-
-if ./jenkins.sh; then
-  gh-status "$REPO" "$GIT_COMMIT" success -d "\"Build #${BUILD_NUMBER} succeeded on Jenkins\"" -u "$BUILD_URL" >/dev/null
-  exit 0
-else
-  gh-status "$REPO" "$GIT_COMMIT" failure -d "\"Build #${BUILD_NUMBER} failed on Jenkins\"" -u "$BUILD_URL" >/dev/null
-  exit 1
-fi