gds-api-adapters 3.4.1 → 4.0.0

data/lib/gds_api/base.rb

@@ -3,6 +3,9 @@ require 'cgi'
 require 'null_logger'
 
 class GdsApi::Base
+  class InvalidAPIURL < StandardError
+  end
+
   extend Forwardable
 
   def client
@@ -30,16 +33,12 @@ class GdsApi::Base
     @logger ||= NullLogger.instance
   end
 
-  def initialize(platform, options_or_endpoint_url=nil, maybe_options=nil)
-    if options_or_endpoint_url.is_a?(String)
-      options = maybe_options || {}
-      options[:endpoint_url] = options_or_endpoint_url
-    else
-      options = options_or_endpoint_url || {}
-    end
+  def initialize(endpoint_url, options={})
+    options[:endpoint_url] = endpoint_url
+    raise InvalidAPIURL unless endpoint_url =~ URI::regexp
     default_options = GdsApi::Base.default_options || {}
     @options = default_options.merge(options)
-    self.endpoint = options[:endpoint_url] || endpoint_for_platform(adapter_name, platform)
+    self.endpoint = options[:endpoint_url]
   end
 
   def adapter_name
@@ -53,15 +52,6 @@ class GdsApi::Base
 private
   attr_accessor :endpoint
 
-  # This should get simpler if we can be more consistent with our domain names
-  def endpoint_for_platform(adapter_name, platform)
-    if platform == 'development'
-      "http://#{adapter_name}.dev.gov.uk"
-    else
-      "https://#{adapter_name}.#{platform}.alphagov.co.uk"
-    end
-  end
-
   def query_string(params)
     return "" if params.empty?
 

data/lib/gds_api/helpers.rb

@@ -7,23 +7,23 @@ require 'gds_api/licence_application'
 module GdsApi
   module Helpers
     def content_api
-      @content_api ||= GdsApi::ContentApi.new(Plek.current.environment)
+      @content_api ||= GdsApi::ContentApi.new(Plek.current.find("contentapi"))
     end
 
     def publisher_api
-      @api ||= GdsApi::Publisher.new(Plek.current.environment)
+      @api ||= GdsApi::Publisher.new(Plek.current.find("publisher"))
     end
 
     def imminence_api
-      @imminence_api ||= GdsApi::Imminence.new(Plek.current.environment)
+      @imminence_api ||= GdsApi::Imminence.new(Plek.current.find("imminence"))
     end
 
     def licence_application_api
-      @licence_application_api ||= GdsApi::LicenceApplication.new(Plek.current.environment)
+      @licence_application_api ||= GdsApi::LicenceApplication.new(Plek.current.find("licensify"))
     end
 
     def panopticon_api
-      @panopticon_api ||= GdsApi::Panopticon.new(Plek.current.environment, panopticon_api_credentials)
+      @panopticon_api ||= GdsApi::Panopticon.new(Plek.current.find("panopticon"), panopticon_api_credentials)
     end
 
     def panopticon_api_credentials

data/lib/gds_api/panopticon/registerer.rb

@@ -11,7 +11,7 @@ module GdsApi
         @rendering_app = options[:rendering_app]
         @kind = options[:kind] || 'custom-application'
         @panopticon = options[:panopticon]
-        @platform = options[:platform] || Plek.current.environment
+        @endpoint_url = options[:endpoint_url] || Plek.current.find("panopticon")
         @timeout = options[:timeout] || 10
       end
 
@@ -62,7 +62,7 @@ module GdsApi
         options = {
           timeout: @timeout
         }
-        @panopticon ||= GdsApi::Panopticon.new(@platform, options.merge(panopticon_api_credentials))
+        @panopticon ||= GdsApi::Panopticon.new(@endpoint_url, options.merge(panopticon_api_credentials))
       end
 
       def panopticon_api_credentials

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '3.4.1'
+  VERSION = '4.0.0'
 end

data/test/content_api_test.rb

@@ -7,7 +7,7 @@ describe GdsApi::ContentApi do
 
   before do
     @base_api_url = "https://contentapi.test.alphagov.co.uk"
-    @api = GdsApi::ContentApi.new('test')
+    @api = GdsApi::ContentApi.new(@base_api_url)
   end
 
   describe "sections" do
@@ -27,7 +27,7 @@ describe GdsApi::ContentApi do
     end
 
     it "should be able to fetch unpublished editions when authenticated" do
-      api = GdsApi::ContentApi.new('test', { bearer_token: 'MY_BEARER_TOKEN' })
+      api = GdsApi::ContentApi.new(@base_api_url, { bearer_token: 'MY_BEARER_TOKEN' })
       content_api_has_unpublished_artefact("devolution-uk", 3)
       response = api.artefact("devolution-uk", edition: 3)
       assert_equal "https://contentapi.test.alphagov.co.uk/devolution-uk.json", response["id"]
@@ -102,7 +102,7 @@ describe GdsApi::ContentApi do
       url = "#{@base_api_url}/licence-example.json?snac=1234&edition=1"
       stub_request(:get, url).to_return(status: 200, body: body.to_json)
 
-      api = GdsApi::ContentApi.new('test', { bearer_token: 'MY_BEARER_TOKEN' })
+      api = GdsApi::ContentApi.new(@base_api_url, { bearer_token: 'MY_BEARER_TOKEN' })
       response = api.artefact('licence-example', snac: '1234', edition: '1')
 
       assert_equal "Licence example", response["title"]

data/test/gds_api_base_test.rb

@@ -12,7 +12,6 @@ class GdsApiBaseTest < MiniTest::Unit::TestCase
 
   def setup
     @orig_cache = GdsApi::JsonClient.cache
-    @api = ConcreteApi.new('test')
   end
 
   def teardown
@@ -20,69 +19,46 @@ class GdsApiBaseTest < MiniTest::Unit::TestCase
   end
 
   def test_should_construct_escaped_query_string
-    api = ConcreteApi.new('test')
+    api = ConcreteApi.new('http://foo')
     url = api.url_for_slug("slug", "a" => " ", "b" => "/")
     u = URI.parse(url)
     assert_equal "a=+&b=%2F", u.query
   end
 
   def test_should_not_add_a_question_mark_if_there_are_no_parameters
-    api = ConcreteApi.new('test')
+    api = ConcreteApi.new('http://foo')
     url = api.url_for_slug("slug")
     refute_match /\?/, url
   end
 
-  def test_should_use_platform_in_url
-    api = ConcreteApi.new("test")
+  def test_should_use_endpoint_in_url
+    api = ConcreteApi.new("http://foobarbaz")
     url = api.url_for_slug("slug")
     u = URI.parse(url)
-    assert_match /test\.alphagov\.co\.uk$/, u.host
-  end
-
-  def test_should_override_platform_with_endpoint_url
-    api = ConcreteApi.new("test", "http://foo.bar")
-    url = api.url_for_slug("slug")
-    u = URI.parse(url)
-    assert_equal "foo.bar", u.host
-  end
-
-  def test_should_use_dev_for_development_platform
-    api = ConcreteApi.new("development")
-    url = api.url_for_slug("slug")
-    u = URI.parse(url)
-    assert_match /dev\.gov\.uk$/, u.host
-  end
-
-  def test_should_derive_adapter_name_from_class
-    api = ConcreteApi.new("test")
-    url = api.url_for_slug("slug")
-    u = URI.parse(url)
-    assert_match /^concreteapi\.test/, u.host
-  end
-
-  def test_should_treat_second_positional_arg_as_endpoint_url_if_string
-    api = ConcreteApi.new("test", "endpoint")
-    assert_equal "endpoint", api.options[:endpoint_url]
+    assert_match /foobarbaz$/, u.host
   end
 
   def test_should_accept_options_as_second_arg
-    api = ConcreteApi.new("test", {endpoint_url: "endpoint", foo: "bar"})
-    assert_equal "endpoint", api.options[:endpoint_url]
+    api = ConcreteApi.new("http://foo", {foo: "bar"})
     assert_equal "bar", api.options[:foo]
   end
 
   def test_setting_cache_size_from_options
     GdsApi::JsonClient.cache = false
-    api = ConcreteApi.new("test", {endpoint_url: "endpoint", cache_size: 2})
+    api = ConcreteApi.new("https://foo", {cache_size: 2})
     assert_equal 2, api.client.cache.max_size
   end
 
   def test_setting_cache_size_from_default_options
     GdsApi::JsonClient.cache = false
     GdsApi::Base.default_options = {cache_size: 4}
-    api = ConcreteApi.new("test", {endpoint_url: "endpoint"})
+    api = ConcreteApi.new("http://bar")
     assert_equal 4, api.client.cache.max_size
   end
 
-
+  def test_should_barf_if_not_given_valid_URL
+    proc do
+      ConcreteApi.new('invalid-url')
+    end.must_raise GdsApi::Base::InvalidAPIURL
+  end
 end

data/test/imminence_api_test.rb

@@ -8,7 +8,7 @@ class ImminenceApiTest < MiniTest::Unit::TestCase
   LONGITUDE = -0.4702813074674147
 
   def api_client
-    GdsApi::Imminence.new('test')
+    GdsApi::Imminence.new(ROOT)
   end
 
   def dummy_place

data/test/licence_application_api_test.rb

@@ -10,7 +10,7 @@ class LicenceApplicationApiTest < MiniTest::Unit::TestCase
   end
 
   def api
-    GdsApi::LicenceApplication.new "test"
+    GdsApi::LicenceApplication.new LICENCE_APPLICATION_ENDPOINT
   end
 
   def test_should_not_be_nil

data/test/panopticon_api_test.rb

@@ -35,7 +35,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
   end
 
   def api
-    GdsApi::Panopticon.new('test')
+    GdsApi::Panopticon.new(PANOPTICON_ENDPOINT)
   end
 
   def test_given_a_slug__should_fetch_artefact_from_panopticon
@@ -106,7 +106,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
 
   def test_can_use_basic_auth
     credentials = {user: 'fred', password: 'secret'}
-    api = GdsApi::Panopticon.new('test', endpoint_url: 'http://some.url', basic_auth: credentials)
+    api = GdsApi::Panopticon.new('http://some.url', basic_auth: credentials)
     url = "http://#{credentials[:user]}:#{credentials[:password]}@some.url/artefacts/1.json"
     stub_request(:put, url)
       .to_return(status: 200, body: '{}')
@@ -115,7 +115,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
   end
 
   def test_can_register_new_artefacts_en_masse
-    r = GdsApi::Panopticon::Registerer.new(platform: "test", owning_app: 'my-app')
+    r = GdsApi::Panopticon::Registerer.new(endpoint_url: PANOPTICON_ENDPOINT, owning_app: 'my-app')
     artefact = registerable_artefact()
     panopticon_has_no_metadata_for('foo')
 
@@ -134,7 +134,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
 
   def test_can_register_existing_artefacts_en_masse
     artefact = registerable_artefact()
-    r = GdsApi::Panopticon::Registerer.new(platform: "test", owning_app: 'my-app')
+    r = GdsApi::Panopticon::Registerer.new(endpoint_url: PANOPTICON_ENDPOINT, owning_app: 'my-app')
 
     panopticon_has_metadata(artefact)
     url = "#{PANOPTICON_ENDPOINT}/artefacts/foo.json"
@@ -146,31 +146,6 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     r.register(record)
   end
 
-  def test_registerer_should_use_plek_env_by_default
-    # Plek.current returns a different object each time it's called.
-    plek_current = Plek.current
-    plek_current.stubs(:environment).returns("foo")
-    Plek.stubs(:current).returns(plek_current)
-
-    expected_endpoint = PANOPTICON_ENDPOINT.sub(/\.test\./, '.foo.')
-
-    r = GdsApi::Panopticon::Registerer.new(owning_app: 'my-app')
-    artefact = registerable_artefact()
-    panopticon_has_no_metadata_for('foo')
-
-    stub_request(:put, "#{expected_endpoint}/artefacts/foo.json")
-      .with(body: artefact.to_json)
-      .to_return(body: artefact.merge(id: 1).to_json)
-
-    url = "#{expected_endpoint}/artefacts.json"
-    stub_request(:post, url)
-      .with(body: artefact.to_json)
-      .to_return(body: artefact.merge(id: 1).to_json)
-
-    record = OpenStruct.new(artefact.merge(title: artefact[:name]))
-    r.register(record)
-  end
-
   def test_should_be_able_to_fetch_curated_lists
     stub_request(:get, "#{PANOPTICON_ENDPOINT}/curated_lists.json").
       with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).

data/test/panopticon_registerer_test.rb

@@ -7,18 +7,18 @@ describe GdsApi::Panopticon::Registerer do
   describe "creating an instance of the panopticon client" do
     describe "setting the platform" do
       it "should create an instance using the current Plek environment as the platform by default" do
-        Plek.stubs(:current).returns(stub(environment: "Something"))
+        Plek.stubs(:current).returns(stub(find: "http://thisplace"))
 
-        GdsApi::Panopticon.expects(:new).with("Something", anything()).returns(:panopticon_instance)
+        GdsApi::Panopticon.expects(:new).with("http://thisplace", anything()).returns(:panopticon_instance)
         r = GdsApi::Panopticon::Registerer.new({})
         assert_equal :panopticon_instance, r.send(:panopticon)
       end
 
-      it "should allow overriding the platform" do
-        Plek.stubs(:current).returns(stub(environment: "Something"))
+      it "should pass through the endpoint url" do
+        Plek.stubs(:current).returns(stub(find: "http://thisplace"))
 
-        GdsApi::Panopticon.expects(:new).with("Something_else", anything()).returns(:panopticon_instance)
-        r = GdsApi::Panopticon::Registerer.new({platform: "Something_else"})
+        GdsApi::Panopticon.expects(:new).with("http://otherplace", anything()).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({endpoint_url: "http://otherplace"})
         assert_equal :panopticon_instance, r.send(:panopticon)
       end
     end

data/test/publisher_api_test.rb

@@ -52,7 +52,7 @@ describe GdsApi::Publisher do
   end
 
   def api
-    GdsApi::Publisher.new("test")
+    GdsApi::Publisher.new(PUBLISHER_ENDPOINT)
   end
 
   it "should go get resource from publisher app given a slug" do

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.4.1
+  version: 4.0.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-07 00:00:00 Z
+date: 2012-11-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -166,43 +166,40 @@ extra_rdoc_files: []
 
 files: 
 - lib/gds_api/version.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/typhoeus_client.rb
-- lib/gds_api/content_api.rb
+- lib/gds_api/base.rb
+- lib/gds_api/licence_application.rb
+- lib/gds_api/panopticon/registerer.rb
+- lib/gds_api/needotron.rb
 - lib/gds_api/imminence.rb
-- lib/gds_api/contactotron.rb
-- lib/gds_api/test_helpers/publisher.rb
-- lib/gds_api/test_helpers/content_api.rb
-- lib/gds_api/test_helpers/imminence.rb
-- lib/gds_api/test_helpers/contactotron.rb
+- lib/gds_api/rummager.rb
+- lib/gds_api/content_api.rb
+- lib/gds_api/exceptions.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/response.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/licence_application.rb
-- lib/gds_api/base.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/response.rb
-- lib/gds_api/rummager.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/part_methods.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/exceptions.rb
+- lib/gds_api/panopticon.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/publisher_api_test.rb
+- test/licence_application_api_test.rb
+- test/panopticon_api_test.rb
 - test/imminence_api_test.rb
-- test/panopticon_registerer_test.rb
-- test/content_api_test.rb
 - test/json_client_test.rb
-- test/gds_api_base_test.rb
-- test/licence_application_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb
+- test/content_api_test.rb
+- test/panopticon_registerer_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -216,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1606313441068628012
+      hash: -3063781964090340583
       segments: 
       - 0
       version: "0"
@@ -225,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1606313441068628012
+      hash: -3063781964090340583
       segments: 
       - 0
       version: "0"
@@ -237,14 +234,13 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/publisher_api_test.rb
+- test/licence_application_api_test.rb
+- test/panopticon_api_test.rb
 - test/imminence_api_test.rb
-- test/panopticon_registerer_test.rb
-- test/content_api_test.rb
 - test/json_client_test.rb
-- test/gds_api_base_test.rb
-- test/licence_application_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb
+- test/content_api_test.rb
+- test/panopticon_registerer_test.rb

data/lib/gds_api/contactotron.rb

@@ -1,11 +0,0 @@
-require_relative 'base'
-
-# This adapter's a bit different from the others as it assumes we know
-# the full URI for a contact and just want to grab its json serialization
-# and convert it to an ostruct.
-class GdsApi::Contactotron < GdsApi::Base
-
-  def contact_for_uri(uri)
-    get_json(uri)
-  end
-end

data/lib/gds_api/test_helpers/contactotron.rb

@@ -1,14 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-
-module GdsApi
-  module TestHelpers
-    module Contactotron
-
-      def contactotron_has_contact(uri, details)
-        json = JSON.dump(details)
-        stub_request(:get, uri).to_return(:status => 200, :body => json, :headers => {})
-        return uri
-      end
-    end
-  end
-end

data/test/contactotron_api_test.rb

@@ -1,17 +0,0 @@
-require 'test_helper'
-require 'gds_api/contactotron'
-require 'gds_api/test_helpers/contactotron'
-
-class ContactotronApiTest < MiniTest::Unit::TestCase
-  include GdsApi::TestHelpers::Contactotron
-
-  def api
-    GdsApi::Contactotron.new "test"
-  end
-
-  def test_should_fetch_and_parse_JSON_into_ostruct
-    uri = "http://contactotron.platform/contacts/1"
-    contactotron_has_contact(uri, {details: 'value'})
-    assert_equal "value", api.contact_for_uri(uri).details
-  end
-end