gds-api-adapters 37.5.1 → 38.0.0

data/lib/gds_api/config.rb

@@ -1,76 +0,0 @@
-module GdsApi
-  def self.configure
-    yield(config)
-  end
-
-  def self.config
-    @config ||= Config.new
-  end
-
-  class Config
-    # Always raise an `HTTPNotFound` exception when the server returns 404 or an
-    # `HTTPGone` when the server returns 410. This avoids nil-errors in your
-    # code and makes debugging easier.
-    #
-    # Currently defaults to true.
-    #
-    # This configuration will be removed on December 1st, 2016. Please make sure
-    # you upgrade gds-api-adapters to the latest version and avoid configuring
-    # it on your client application.
-    def always_raise_for_not_found
-      return true if @always_raise_for_not_found.nil?
-
-      @always_raise_for_not_found
-    end
-
-    def always_raise_for_not_found=(value)
-      warn <<-doc
-
-DEPRECATION NOTICE: Please delete any instances of
-`GdsApi.config.always_raise_for_not_found=` from your codebase to make
-sure all 404 or 410 responses raise an exception.
-
-This configuration option will be be removed. Raising exceptions is now
-the default behaviour and it won't be possible to opt-out from December
-1st, 2016.
-
-Called from: #{caller[2]}
-
-      doc
-
-      @always_raise_for_not_found = value
-    end
-
-    # Set to true to make `GdsApi::Response` behave like a simple hash, instead
-    # of an OpenStruct. This will prevent nil-errors.
-    #
-    # Currently defaults to true.
-    #
-    # This configuration will be removed on December 1st, 2016. Please make sure
-    # you upgrade gds-api-adapters to the latest version and avoid configuring
-    # it on your client application.
-    def hash_response_for_requests
-      return true if @hash_response_for_requests.nil?
-
-      @hash_response_for_requests
-    end
-
-    def hash_response_for_requests=(value)
-      warn <<-doc
-
-DEPRECATION NOTICE: Please delete any instances of
-`GdsApi.config.hash_response_for_requests=` from your codebase to make
-sure responses behave like a Hash instead of an OpenStruct.
-
-This configuration option will be be removed. Returning responses that
-behave like a Hash is the default behaviour and it won't be possible to
-opt-out from December 1st, 2016.
-
-Called from: #{caller[2]}
-
-      doc
-
-      @hash_response_for_requests = value
-    end
-  end
-end

data/lib/gds_api/external_link_tracker.rb

@@ -1,7 +0,0 @@
-require_relative 'base'
-
-class GdsApi::ExternalLinkTracker < GdsApi::Base
-  def add_external_link(url)
-    put_json!("#{endpoint}/url?url=#{CGI.escape(url)}", {})
-  end
-end

data/lib/gds_api/needotron.rb

@@ -1,19 +0,0 @@
-require_relative 'base'
-
-class GdsApi::Needotron < GdsApi::Base
-  def need_by_id(id, opts = {})
-    response = get_json("#{base_url}/#{id}.json")
-    return nil if response.nil? or response['need'].nil?
-
-    if opts[:as_hash]
-      response.to_hash
-    else
-      response.to_ostruct.need
-    end
-  end
-
-private
-  def base_url
-    "#{@endpoint}/needs"
-  end
-end

data/lib/gds_api/part_methods.rb

@@ -1,44 +0,0 @@
-module GdsApi::PartMethods
-
-  def part_index(slug)
-    parsed_content['parts'].index { |p| p['slug'] == slug }
-  end
-
-  def find_part(slug)
-    return nil unless index = part_index(slug)
-    parsed_content['parts'][index]
-  end
-
-  def has_parts?(part)
-    !! (has_previous_part?(part) || has_next_part?(part))
-  end
-
-  def has_previous_part?(part)
-    index = part_index(part['slug'])
-    !! (index && index > 0)
-  end
-
-  def has_next_part?(part)
-    index = part_index(part['slug'])
-    !! (index && (index + 1) < parsed_content['parts'].length)
-  end
-
-  def part_after(part)
-    part_at(part, 1)
-  end
-
-  def part_before(part)
-    part_at(part, -1)
-  end
-
-private
-  def part_at(part, relative_offset)
-    current_index = part_index(part['slug'])
-    return nil unless current_index
-
-    other_index = current_index + relative_offset
-    return nil unless (0...parsed_content['parts'].length).cover?(other_index)
-
-    parsed_content['parts'][other_index]
-  end
-end

data/lib/gds_api/publisher.rb

@@ -1,51 +0,0 @@
-require_relative 'base'
-require_relative 'part_methods'
-
-class GdsApi::Publisher < GdsApi::Base
-  def publication_for_slug(slug, options = {})
-    return nil if slug.nil? or slug == ''
-
-    response = get_json(url_for_slug(slug, options))
-    if response
-      container = response.dup
-      container.extend(GdsApi::PartMethods) if container['parts']
-      convert_updated_date(container)
-      container
-    else
-      nil
-    end
-  end
-
-  def council_for_slug(slug, snac_codes)
-    json = post_json(
-      "#{@endpoint}/local_transactions/#{slug}/verify_snac.json",
-      {'snac_codes' => snac_codes}
-    )
-    json['snac'] if json
-  end
-
-  def council_for_snac_code(snac)
-    json = get_json("#{@endpoint}/local_transactions/find_by_snac?snac=#{snac}")
-    json.to_hash if json
-  end
-
-  def council_for_name(name)
-    name = URI.escape(name)
-    json = get_json(
-      "#{@endpoint}/local_transactions/find_by_council_name?name=#{name}"
-    )
-    json.to_hash if json
-  end
-
-private
-  def convert_updated_date(container)
-    if container['updated_at'] && container['updated_at'].is_a?(String)
-      container.parsed_content['updated_at'] =
-        Time.parse(container['updated_at'])
-    end
-  end
-
-  def base_url
-    "#{@endpoint}/publications"
-  end
-end

data/lib/gds_api/test_helpers/publisher.rb

@@ -1,60 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-
-module GdsApi
-  module TestHelpers
-    module Publisher
-      # Generally true. If you are initializing the client differently,
-      # you could redefine/override the constant or stub directly.
-      PUBLISHER_ENDPOINT = Plek.current.find("publisher")
-
-      def stub_all_publisher_api_requests
-        stub_request(:any, %r|^#{PUBLISHER_ENDPOINT}/api|)
-      end
-
-      def assert_publisher_received_reindex_request_for(slug)
-        assert_requested(
-          :post,
-          "#{PUBLISHER_ENDPOINT}/api/reindex-topic-editions/#{slug}"
-        )
-      end
-
-      def publication_exists(details, options = {})
-        json = JSON.dump(details)
-        uri = "#{PUBLISHER_ENDPOINT}/publications/#{details['slug']}.json"
-        if options[:edition]
-          uri += "?edition=#{options[:edition]}"
-        end
-        stub_request(:get, uri).to_return(:body => json, :status => 200)
-        return uri
-      end
-
-      def publication_exists_for_snac(snac, details)
-        json = JSON.dump(details)
-        uri = "#{PUBLISHER_ENDPOINT}/publications/#{details['slug']}.json"
-        stub_request(:get, uri).to_return(:body => json, :status => 200)
-        stub_request(:get, uri).with(:query => {:snac => snac.to_s}).to_return(:body => json, :status => 200)
-        return uri
-      end
-
-      def publication_does_not_exist(details)
-        uri = "#{PUBLISHER_ENDPOINT}/publications/#{details['slug']}.json"
-        stub_request(:get, uri).to_return(:body => 'Not Found', :status => 404)
-        return uri
-      end
-
-      def council_exists_for_slug(input_details, output_details)
-        json = JSON.dump(output_details)
-        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.default_request_headers).
-          to_return(:body => json, :status => 200)
-      end
-
-      def no_council_for_slug(slug)
-        uri = "#{PUBLISHER_ENDPOINT}/local_transactions/#{slug}.json"
-        stub_request(:post, uri).to_return(:body => "", :status => 404)
-      end
-    end
-  end
-end

data/test/external_link_tracker_test.rb

@@ -1,40 +0,0 @@
-require 'test_helper'
-require 'gds_api/external_link_tracker'
-
-describe GdsApi::ExternalLinkTracker do
-
-  before do
-    @base_api_url = "http://link-tracker-api.example.com"
-    @api = GdsApi::ExternalLinkTracker.new(@base_api_url)
-  end
-
-  describe "managing links" do
-    it "should allow creating an external link" do
-      req = WebMock.stub_request(:put, "#{@base_api_url}/url?url=http%3A%2F%2Ffoo.example.com%2F").
-        to_return(:status => 201,
-                  :headers => {"Content-type" => "application/json"})
-
-      response = @api.add_external_link("http://foo.example.com/")
-      assert_equal 201, response.code
-
-      assert_requested(req)
-    end
-
-    it "should raise an error if creating an external link fails" do
-      req = WebMock.stub_request(:put, "#{@base_api_url}/url?url=invalid").
-        to_return(:status => 400, :headers => {"Content-type" => "application/json"})
-
-      e = nil
-      begin
-        @api.add_external_link("invalid")
-      rescue GdsApi::HTTPErrorResponse => ex
-        e = ex
-      end
-
-      refute_nil e
-      assert_equal 400, e.code
-
-      assert_requested(req)
-    end
-  end
-end

data/test/publisher_api_test.rb

@@ -1,109 +0,0 @@
-require 'test_helper'
-require 'gds_api/publisher'
-require 'gds_api/json_client'
-require 'gds_api/test_helpers/publisher'
-
-describe GdsApi::Publisher do
-  include GdsApi::TestHelpers::Publisher
-  PUBLISHER_ENDPOINT = GdsApi::TestHelpers::Publisher::PUBLISHER_ENDPOINT
-
-  def basic_answer
-    {
-      "audiences" => [""],
-      "slug" => "a-publication",
-      "tags" => "",
-      "updated_at" => "2011-07-28T11:53:03+00:00",
-      "type" => "answer",
-      "body" => "Something",
-      "title" => "A publication"
-    }
-  end
-
-  def publication_with_parts
-    {
-      "audiences" => [""],
-      "slug" => "a-publication",
-      "tags" => "",
-      "updated_at" => "2011-07-28T11:53:03+00:00",
-      "type" => "guide",
-      "body" => "Something",
-      "parts" => [
-        {
-          "body" => "You may be financially protected",
-          "number" => 1,
-          "slug" => "introduction",
-          "title" => "Introduction"
-        },
-        {
-          "body" => "All companies selling packag",
-          "number" => 2,
-          "slug" => "if-you-booked-a-package-holiday",
-          "title" => "If you booked a package holiday"
-        },
-        {
-          "body" => "##Know your rights when you b",
-          "number" => 3,
-          "slug" => "if-you-booked-your-trip-independently",
-          "title" => "If you booked your trip independently"
-        }
-      ],
-      "title" => "A publication"
-    }
-  end
-
-  def api
-    @api ||= GdsApi::Publisher.new(PUBLISHER_ENDPOINT)
-  end
-
-  it "should go get resource from publisher app given a slug" do
-    publication_exists(basic_answer)
-    pub = api.publication_for_slug(basic_answer['slug'])
-
-    assert_equal "Something", pub['body']
-  end
-
-  it "should optionally accept an edition id" do
-    slug = "a-publication"
-    publication = %@{"audiences":[""],
-      "slug":"#{slug}",
-      "tags":"",
-      "updated_at":"2011-07-28T11:53:03+00:00",
-      "type":"answer",
-      "body":"Something",
-      "title":"A publication"}@
-    stub_request(:get, "#{PUBLISHER_ENDPOINT}/publications/#{slug}.json?edition=678").to_return(
-      :body => publication,:status=>200)
-
-    pub = api.publication_for_slug(slug,{:edition => 678})
-  end
-
-  it "should construct correct url for a slug" do
-    assert_equal "#{PUBLISHER_ENDPOINT}/publications/slug.json", api.url_for_slug("slug")
-  end
-
-  it "should deserialise parts into whole objects" do
-    publication_exists(publication_with_parts)
-    pub = api.publication_for_slug(publication_with_parts['slug'])
-    assert_equal 3, pub['parts'].size
-    assert_equal "introduction", pub['parts'].first['slug']
-  end
-
-  it "should have part specific methods for a publication with parts" do
-    publication_exists(publication_with_parts)
-    pub = api.publication_for_slug(publication_with_parts['slug'])
-    assert_equal pub.part_index("introduction"),0
-  end
-
-  it "should deserialise updated at as a time" do
-    publication_exists(publication_with_parts)
-    pub = api.publication_for_slug(publication_with_parts['slug'])
-    assert_equal Time, pub['updated_at'].class
-  end
-
-  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.default_request_headers).
-      to_return(:status => 200, :body => '{"snac": "12345"}', :headers => {})
-    assert_equal '12345', api.council_for_slug('fake-transaction', [12345])
-  end
-end