govuk-registers-api-client 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab771bc838779644bbd8763beea0c5a4c1138a298011af39a4ac4121068c3d40
-  data.tar.gz: ae34e34c99dc13883a2865393b54aa386fa04cf0174f835bfd60fa1dae582699
+  metadata.gz: ad44826f15da4eff3286aac98593630b0b34972a28701b6e72c6dffc8a79e1d3
+  data.tar.gz: a035133485d3f7f842dd44a542eb1c7253bb26579576fc0848ce20e61e5ef2bd
 SHA512:
-  metadata.gz: cbe860777cef29b1ad7ba40fd47dcc3b10319eff06623637ad03deb83fd8e6771dd60c694acd92642c676270b78c9cfd631e4bda8e62d415bc232d858ea998ee
-  data.tar.gz: 735d24e0805542891a4cd14a0504b40455ad8e2d77921e267775abefbf07bb4b4d284c78146ee239b608e182e5f5ce569b5b09ec9fb1eb5b697d560c142257fe
+  metadata.gz: fe46727474d9b7c8342b3cb909b2abb3423fb2b2d760cb8e957a75662fb1011492356a2e1a42d272141e4549114bcb061f79fa4fcd1351cc5b7ed53a5dc15d9e
+  data.tar.gz: bbbea01d73e999aebe657a75ccb8f1304e0913cc8fc7b12b923255f64e3b1ee798d85883843a54d1caff6b5ed49e8a36a494a9cf3e1fa56c49509bc7b5d37713

data/.version

@@ -1 +1 @@
-1.0.1
+1.1.1

data/README.md

@@ -35,6 +35,7 @@ The `RegisterClientManager` is the entry point of the Registers Ruby client:
 require 'register_client_manager'
 
 registers_client = RegistersClient::RegisterClientManager.new({
+  api_key: "YOUR API KEY HERE",
   page_size: 10
 })
 ```
@@ -42,17 +43,22 @@ registers_client = RegistersClient::RegisterClientManager.new({
 The `RegisterClientManager` maintains individual instances of [`RegisterClient`](#registerclient) for each register you access via the [`get_register`](#getregister) method.
 
 When creating a new `RegisterClientManager`, you can pass a configuration object to specify the following:
+- The `api_key` is the API key you received after signing-up your service on our product page.
 - `page_size`: number of results returned per page when using the `page` method of any of the collection classes (see below for more information) - default is `100`
 
 ## Reference
 
 ### <a id="registerclientmanager"></a>`RegisterClientManager`
 
-##### <a id="getregister"></a>`get_register(register, phase, data_store = nil)`
+##### <a id="getregister"></a>`get_register(register, phase, options = {})`
 
 Gets the `RegisterClient` instance for the given `register` name and `phase`.
 
-The `data_store` parameter specifies the data store to use accessing a particular register. You can omit this parameter, which will make it default to the `InMemoryDataStore` value. You can also create a custom data store to include the `DataStore` module and to implement the methods it defines. For example, to insert register data directly into your Postgres database.
+You can pass an optional `options` object, which can include the following properties:
+
+- data_store
+
+The `data_store` specifies the data store to use accessing a particular register. You can omit this parameter, which will make it default to the `InMemoryDataStore` value. You can also create a custom data store to include the `DataStore` module and to implement the methods it defines. For example, to insert register data directly into your Postgres database.
 
 <details>
 <summary>
@@ -61,7 +67,10 @@ Example use (click here to expand):
 
 ```
 
-registers_client.get_register('country', 'beta', nil)
+options = {
+  data_store: nil
+}
+registers_client.get_register('country', 'beta', options)
 
 ```
 </details>
@@ -802,4 +811,3 @@ ull}}]],
 
 ```
 </details>
-

data/govuk-registers-api-client.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: govuk-registers-api-client 1.0.1 ruby lib
+# stub: govuk-registers-api-client 1.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "govuk-registers-api-client".freeze

data/lib/register_client.rb

@@ -5,10 +5,11 @@ require 'exceptions/invalid_hash_value_error'
 
 module RegistersClient
   class RegisterClient
-    def initialize(register_url, data_store, page_size)
+    def initialize(register_url, data_store, page_size, options = {})
       @register_url = register_url
       @data_store = data_store
       @page_size = page_size
+      @options = options
 
       refresh_data
     end
@@ -149,11 +150,11 @@ module RegistersClient
           if params[1] == 'user'
             user_entry_number += 1
 
-            entry = Entry.new(line, user_entry_number, params[1])
+            entry = RegistersClient::Entry.new(line, user_entry_number, params[1])
           else
             system_entry_number += 1
 
-            entry = Entry.new(line, system_entry_number, params[1])
+            entry = RegistersClient::Entry.new(line, system_entry_number, params[1])
           end
 
           data_store.append_entry(entry)
@@ -167,7 +168,13 @@ module RegistersClient
     end
 
     def register_http_request(path)
-      RestClient.get(@register_url.merge(path).to_s)
+      headers = {}
+
+      unless @options[:api_key] == nil
+        headers[:Authorization] = @options[:api_key]
+      end
+
+      RestClient.get(@register_url.merge(path).to_s, headers)
     end
 
     def is_valid_hash_value(hash_value)

data/lib/register_client_manager.rb

@@ -2,27 +2,25 @@ require 'register_client'
 require 'in_memory_data_store'
 
 module RegistersClient
-    VERSION = '1.0.1'
+    VERSION = '1.1.1'
     class RegisterClientManager
       def initialize(config_options = {})
         @config_options = defaults.merge(config_options)
         @register_clients = {}
       end
   
-      def get_register(register, phase, data_store = nil)
+      def get_register(register, phase, options = {})
         environment_url = get_environment_url_from_phase(phase)
-        get_register_from_environment(register, environment_url, data_store)
+        get_register_from_environment(register, environment_url, options)
       end
 
-      def get_register_from_environment(register, environment_url, data_store = nil) 
+      def get_register_from_environment(register, environment_url, options = {})
         key = register + ':' + environment_url.to_s
 
         if !@register_clients.key?(key)
-          if (data_store.nil?)
-            data_store = RegistersClient::InMemoryDataStore.new(@config_options)
-          end
-
+          data_store = options.has_key?(:data_store) ? options[:data_store] : RegistersClient::InMemoryDataStore.new(@config_options)
           register_url = get_register_url(register, environment_url)
+
           @register_clients[key] = create_register_client(register_url, data_store, @config_options.fetch(:page_size))
         end
   
@@ -33,12 +31,17 @@ module RegistersClient
   
       def defaults
         {
+            api_key: nil,
             page_size: 100
         }
       end
 
       def create_register_client(register_url, data_store, page_size)
-        RegistersClient::RegisterClient.new(register_url, data_store, page_size)
+        register_options = {
+            api_key: @config_options[:api_key]
+        }
+
+        RegistersClient::RegisterClient.new(register_url, data_store, page_size, register_options)
       end
 
       def get_register_url(register, environment_url)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk-registers-api-client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - GOV.UK Registers Team (Government Digital Service)