gds_zendesk 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa67dd4263a0871478498235472781ed6cdcd7542ec8e4706cab92e00a2e9d13
-  data.tar.gz: 61563e3f57a552f46d1834da3190fbc594d08eef23bcd82c8d6e6165ed0d2bcc
+  metadata.gz: c2ce09664299a6802632a0dc10966d37c4adf67d53efbf2368240a4d96401139
+  data.tar.gz: fe832fb5483d5d9363614b984f2d89903742be31175b5839ab9bf515a7164b62
 SHA512:
-  metadata.gz: f8cae830c9fbd5df42e35bd91a4bf34176a157285cc99c7a6df435272a224de0ba106613f2fc3dd1235c0f2b75631e5e037240ddb9f534b791b6294c111e3c9e
-  data.tar.gz: 19db1a96ee36e0beeac2fcbf407a785a2cbda80956325cec9fa4f3b6bb69f4492fc79151d532062219e7a9e8d7984664c125a404de97035a789b66a1c421d634
+  metadata.gz: 20a8002750b0376ba9ec27ed501cf91f84372259918cb3aff80571e375bb8a1a81121d303da41cbd6f2ad5f175006871cbda40e43b5d332ff50cf64239fee619
+  data.tar.gz: 3d68d792fa0e783e96761d04ca23c17d9b4b96ac71bb5d72e6f2a5a57177eef8fe3ed8466b572feca0dc2383b0163813a13146c331bee3269e77be19b322c49d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.2.0
+
+* Allow use of a token instead of password
+
 # 3.1.0
 
 * Update `zendesk_api` library to v1.27

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/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/version.rb

@@ -1,3 +1,3 @@
 module GDSZendesk
-  VERSION = "3.1.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds_zendesk
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: null_logger
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client and models for communicating with Zendesk