notifications-ruby-client 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d53d8e24813e67e7e4b7f6c2c19e8c3c41bfa505
-  data.tar.gz: e4e49ee5cd4006383706611122b84dc62746ca93
+  metadata.gz: 942f912e7dce40facdd4d15a7554c34366efbbfb
+  data.tar.gz: 7804cd65bf20d992f480e1f576cd9cab44e6b69c
 SHA512:
-  metadata.gz: f57075249e7ea6b1518bde9d4ba7fa7def7521f6fe436a244b40b005bfe08528e248a6d9c9ceea6259e41f3417a4b0de50b6ede642ef05afd7d33720d5d78cf0
-  data.tar.gz: 68d31589b31fb9dcb2a6fcc6fd3dfe4171387e416abfc8cb558a541efe2a5508053283531726cd9a293b16172e745166d039361cbe63ebcb6935424e2d9e0a42
+  metadata.gz: e1a019e8ff6e295d6f781aa956aadffdf89e2e116e1cd51dd7739427955d97949122f5d4252b538f03afb50101ad9b151a914efe3848d25933c4123a0cc20968
+  data.tar.gz: a75e8a79f6cda877bda9f6bf4b4d7f783c14e9d7d7a43e3f305718407e4690cb0a9e162adae3124ca0dac3dd711a74115c84a479416ab857c93c5ed678165fd5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.6.0
+
+### Changed
+* The client now validates that UUIDs derived from the API key are valid and raises a helpful error message if they are not.
+
 ## 2.5.0
 
 ### Changed

data/lib/notifications/client.rb

@@ -8,6 +8,7 @@ require_relative "client/received_text_collection"
 require_relative "client/response_template"
 require_relative "client/template_collection"
 require_relative "client/template_preview"
+require_relative "client/uuid_validator"
 require "forwardable"
 
 module Notifications

data/lib/notifications/client/speaker.rb

@@ -21,6 +21,8 @@ module Notifications
         @service_id = secret_token[secret_token.length - 73..secret_token.length - 38]
         @secret_token = secret_token[secret_token.length - 36..secret_token.length]
         @base_url = base_url || PRODUCTION_BASE_URL
+
+        validate_uuids!
       end
 
       ##
@@ -130,6 +132,17 @@ module Notifications
         }
         JWT.encode payload, @secret_token, "HS256"
       end
+
+      def validate_uuids!
+        contextual_message = [
+          "This error is probably caused by initializing the Notifications client with an invalid API key.",
+          "You can generate a new API key by logging into Notify and visiting the 'API integration' page:",
+          "https://www.notifications.service.gov.uk",
+        ].join("\n")
+
+        UuidValidator.validate!(@service_id, contextual_message)
+        UuidValidator.validate!(@secret_token, contextual_message)
+      end
     end
   end
 end

data/lib/notifications/client/uuid_validator.rb

@@ -0,0 +1,26 @@
+module Notifications
+  class UuidValidator
+    HEX = /[0-9a-f]/
+    REGEX = /^#{HEX}{8}-#{HEX}{4}-#{HEX}{4}-#{HEX}{4}-#{HEX}{12}$/
+
+    attr_accessor :uuid
+
+    def initialize(uuid)
+      self.uuid = uuid
+    end
+
+    def valid?
+      !!(uuid && uuid.match(REGEX))
+    end
+
+    def self.validate!(uuid, contextual_message = nil)
+      return if new(uuid).valid?
+
+      message = "#{uuid.inspect} is not a valid uuid"
+      message += "\n#{contextual_message}" if contextual_message
+
+      raise ArgumentError, message
+    end
+  end
+end
+

data/lib/notifications/client/version.rb

@@ -9,6 +9,6 @@
 
 module Notifications
   class Client
-    VERSION = "2.5.1".freeze
+    VERSION = "2.6.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -148,6 +148,7 @@ files:
 - lib/notifications/client/speaker.rb
 - lib/notifications/client/template_collection.rb
 - lib/notifications/client/template_preview.rb
+- lib/notifications/client/uuid_validator.rb
 - lib/notifications/client/version.rb
 - notifications-ruby-client.gemspec
 homepage: https://github.com/alphagov/notifications-ruby-client