gds-api-adapters 1.7.1 → 1.8.0

data/README.md

@@ -29,6 +29,20 @@ something that actually logs:
 
     GdsApi::Base.logger = Logger.new("/path/to/file.log")
 
+## Authorization
+
+The API Adapters currently support either HTTP Basic authentication or OAuth2
+(bearer token) authorization. This is only used for Panopticon registration at
+present. The GdsApi::Panopticon::Registerer adapter expects a constant called
+PANOPTICON_API_CREDENTIALS to be defined and will use that to pass the relevant
+options to the HTTP client.
+
+To use bearer token authorization the format that constant should be a hash of
+the form:
+
+    PANOPTICON_API_CREDENTIALS = { bearer_token: 'MY_BEARER_TOKEN' }
+
+
 ## Test Helpers
 
 There are also test helpers for stubbing various requests in other apps.

data/lib/gds_api/base.rb

@@ -10,11 +10,7 @@ class GdsApi::Base
   end
 
   def create_client
-    if options[:access_key]
-      GdsApi::OAuth2Client.new(options)
-    else
-      GdsApi::JsonClient.new(options)
-    end
+    GdsApi::JsonClient.new(options)
   end
 
   def_delegators :client, :get_json, :get_json!,

data/lib/gds_api/json_client.rb

@@ -26,7 +26,7 @@ module GdsApi
       @options = options
     end
 
-    REQUEST_HEADERS = {
+    DEFAULT_REQUEST_HEADERS = {
         'Accept' => 'application/json',
         'Content-Type' => 'application/json',
         'User-Agent' => "GDS Api Client v. #{GdsApi::VERSION}"
@@ -96,21 +96,46 @@ module GdsApi
       end
     end
 
+    def extract_url_and_path(url)
+      url = URI.parse(url)
+      path = url.path
+      path = path + "?" + url.query if url.query
+      return url, path
+    end
+
+    def attach_auth_options(request)
+      if @options[:bearer_token]
+        request.add_field('Authorization', "Bearer #{@options[:bearer_token]}")
+      elsif @options[:basic_auth]
+        request.basic_auth(@options[:basic_auth][:user], @options[:basic_auth][:password])
+      end
+    end
+
+    def set_timeout(http)
+      unless options[:disable_timeout]
+        http.read_timeout = options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS
+      end
+    end
+
+    def ssl_options(port)
+      if port == 443
+        {use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE}
+      else
+        {}
+      end
+    end
+
     def do_request(method_class, url, params = nil)
       loggable = {request_uri: url, start_time: Time.now.to_f}
       start_logging = loggable.merge(action: 'start')
       logger.debug start_logging.to_json
 
-      url = URI.parse(url)
-      path = url.path
-      path = path + "?" + url.query if url.query
+      url, path = extract_url_and_path(url)
 
-      response = Net::HTTP.start(url.host, url.port, nil, nil, nil, nil, {use_ssl: url.port == 443, verify_mode: (OpenSSL::SSL::VERIFY_NONE if url.port == 443)}) do |http|
-        unless options[:disable_timeout]
-          http.read_timeout = options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS
-        end
-        request = method_class.new(path, REQUEST_HEADERS)
-        request.basic_auth(@options[:basic_auth][:user], @options[:basic_auth][:password]) if @options[:basic_auth]
+      response = Net::HTTP.start(url.host, url.port, nil, nil, nil, nil, ssl_options(url.port)) do |http|
+        set_timeout(http)
+        request = method_class.new(path, DEFAULT_REQUEST_HEADERS)
+        attach_auth_options(request)
         request.body = params.to_json if params
         http.request(request)
       end

data/lib/gds_api/test_helpers/publisher.rb

@@ -34,7 +34,7 @@ module GdsApi
         slug = input_details.delete('slug')
         uri = "#{PUBLISHER_ENDPOINT}/local_transactions/#{slug}/verify_snac.json"
         stub_request(:post, uri).with(:body => JSON.dump(input_details),
-          :headers => GdsApi::JsonClient::REQUEST_HEADERS).
+          :headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
           to_return(:body => json, :status => 200)
       end
 

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/test/json_client_test.rb

@@ -125,8 +125,23 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_use_basic_auth
     client = GdsApi::JsonClient.new(basic_auth: {user: 'user', password: 'password'})
 
-    stub_request(:put, "http://user:password@some.endpoint/some.json").to_return(:body => '{"a":1}', :status => 200)
+    stub_request(:put, "http://user:password@some.endpoint/some.json").
+      to_return(:body => '{"a":1}', :status => 200)
+
     response = client.put_json("http://some.endpoint/some.json", {})
     assert_equal 1, response.a
   end
+
+  def test_client_can_use_bearer_token
+    client = GdsApi::JsonClient.new(bearer_token: 'SOME_BEARER_TOKEN')
+    expected_headers = GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS.
+      merge('Authorization' => 'Bearer SOME_BEARER_TOKEN')
+
+    stub_request(:put, "http://some.other.endpoint/some.json").
+      with(:headers => expected_headers).
+      to_return(:body => '{"a":2}', :status => 200)
+
+    response = client.put_json("http://some.other.endpoint/some.json", {})
+    assert_equal 2, response.a
+  end
 end

data/test/licence_application_api_test.rb

@@ -17,7 +17,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
 
   def test_should_return_an_error_message_if_licence_is_unrecognised
     stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/bloop").
-      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\"]}")
 
     assert_equal nil, api.details_for_licence("bloop")
@@ -25,7 +25,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
 
   def test_should_provide_full_licence_details_for_canonical_id
     stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001").
-      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(status: 200, body: "{\"issuingAuthorityType\":\"non-geographical\",\"geographicalAvailability\":\"England\",\"issuingAuthorities\":[{\"authorityName\":\"Authority Name\",\"interactions\":{\"apply\":{\"url\":\"www.gov.uk\",\"usesLicensify\":true,\"description\":\"Custom description\",\"payment\":\"none\",\"paymentAmount\":0}}}]}")
 
     expected = {
@@ -48,7 +48,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
 
   def test_should_return_an_error_message_for_bad_snac_code_entry
     stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001/bleep").
-      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(status: 404, body: "{\"error\": [\"Unrecognised SNAC: bleep\"]}")
 
     assert_equal nil, api.details_for_licence("590001", "bleep")
@@ -56,7 +56,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
 
   def test_should_return_error_messages_for_bad_licence_id_and_snac_code
     stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/bloop/bleep").
-      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(status: 404, body: "{\"error\": [\"Unrecognised Licence Id: bloop\", \"Unrecognised SNAC: bleep\"]}")
 
     assert_equal nil, api.details_for_licence("bloop", "bleep")
@@ -64,7 +64,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
 
   def test_should_return_error_message_to_pick_a_relevant_snac_code_for_the_provided_licence_id
     stub_request(:get, "https://licenceapplication.test.alphagov.co.uk/api/590001/sw10").
-      with(headers: GdsApi::JsonClient::REQUEST_HEADERS).
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(status: 200, body: "{\"error\": [\"Licence not available in the provided snac area\"], \"geographicalAvailability\": [\"Scotland\", \"NI\"]}")
 
     expected = {

data/test/panopticon_api_test.rb

@@ -173,7 +173,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
 
   def test_should_be_able_to_fetch_curated_lists
     stub_request(:get, "#{PANOPTICON_ENDPOINT}/curated_lists.json").
-      with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+      with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(:status => 200, :body => '{ "crume": ["pinishment", "prosin"]}', :headers => {})
     assert_equal({ "crume" => ["pinishment", "prosin"]}, api.curated_lists)
   end

data/test/publisher_api_test.rb

@@ -5,6 +5,7 @@ require 'gds_api/test_helpers/publisher'
 
 describe GdsApi::Publisher do
   include GdsApi::TestHelpers::Publisher
+  PUBLISHER_ENDPOINT = GdsApi::TestHelpers::Publisher::PUBLISHER_ENDPOINT
 
   def basic_answer
     {
@@ -101,7 +102,7 @@ describe GdsApi::Publisher do
 
   it "should be able to retrieve local transaction details" do
     stub_request(:post, "#{PUBLISHER_ENDPOINT}/local_transactions/fake-transaction/verify_snac.json").
-      with(:body => "{\"snac_codes\":[12345]}", :headers => GdsApi::JsonClient::REQUEST_HEADERS).
+      with(:body => "{\"snac_codes\":[12345]}", :headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
       to_return(:status => 200, :body => '{"snac": "12345"}', :headers => {})
     assert_equal '12345', api.council_for_slug('fake-transaction', [12345])
   end
@@ -141,7 +142,7 @@ describe GdsApi::Publisher do
 
     it "should return nil if a council snac code is not found" do
       stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_snac?snac=bloop").
-        with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
         to_return(:status => 404, :body => " ", :headers => {})
 
       assert_equal nil, api.council_for_snac_code("bloop")
@@ -149,7 +150,7 @@ describe GdsApi::Publisher do
 
     it "should return a council hash for a snac code" do
       stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_snac?snac=AA00").
-        with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
         to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
 
       expected = {"name" => "Some Council", "snac" => "AA00"}
@@ -158,7 +159,7 @@ describe GdsApi::Publisher do
 
     it "should return nil if a council name is not found" do
       stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=bloop").
-        with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
         to_return(:status => 404, :body => " ", :headers => {})
 
       assert_equal nil, api.council_for_name("bloop")
@@ -166,7 +167,7 @@ describe GdsApi::Publisher do
 
     it "should return a council hash for a mixed case council name" do
       stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=Some%20Council").
-        with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
         to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
 
       expected = {"name" => "Some Council", "snac" => "AA00"}
@@ -175,7 +176,7 @@ describe GdsApi::Publisher do
 
     it "should return a council hash for a lowercase council name" do
       stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=some%20council").
-        with(:headers => GdsApi::JsonClient::REQUEST_HEADERS).
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
         to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
 
       expected = {"name" => "Some Council", "snac" => "AA00"}

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors: 
 - James Stewart
@@ -85,7 +85,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: 0.12.4
   type: :development
   prerelease: false
   version_requirements: *id007
@@ -96,7 +96,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.10.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: *id008
@@ -167,7 +167,6 @@ files:
 - lib/gds_api/typhoeus_client.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/contactotron.rb
-- lib/gds_api/oauth2_client.rb
 - lib/gds_api/response.rb
 - lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/publisher.rb
@@ -203,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3691164780019311001
+      hash: 2196406087180137809
       segments: 
       - 0
       version: "0"
@@ -212,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3691164780019311001
+      hash: 2196406087180137809
       segments: 
       - 0
       version: "0"

data/lib/gds_api/oauth2_client.rb

@@ -1,25 +0,0 @@
-require_relative 'response'
-require_relative 'exceptions'
-
-# TODO: This is a work in progress
-module GdsApi
-  class OAuth2Client
-    def initialize(options)
-      raise "access_token required" unless options[:access_token]
-      @oauth_client = OAuth2::Client.new(nil, nil)
-      @access_token = OAuth2::AccessToken.new(@oauth_client, options[:access_token], options[:token_options])
-    end
-
-    def get_json(url)
-      @access_token.get(url, headers: REQUEST_HEADERS)
-    end
-
-    def post_json(url, params)
-      @access_token.post(url, body: params, headers: REQUEST_HEADERS)
-    end
-
-    def put_json(url, params)
-      @access_token.put(url, body: params, headers: REQUEST_HEADERS)
-    end
-  end
-end