gds-api-adapters 39.2.0 → 40.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 39.2.0
+  version: 40.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -363,8 +363,6 @@ files:
 - lib/gds_api/need_api.rb
 - lib/gds_api/null_cache.rb
 - lib/gds_api/organisations.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/performance_platform/data_in.rb
 - lib/gds_api/performance_platform/data_out.rb
 - lib/gds_api/publishing_api.rb
@@ -394,7 +392,6 @@ files:
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/need_api.rb
 - lib/gds_api/test_helpers/organisations.rb
-- lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/performance_platform/data_in.rb
 - lib/gds_api/test_helpers/performance_platform/data_out.rb
 - lib/gds_api/test_helpers/publishing_api.rb
@@ -407,6 +404,14 @@ files:
 - lib/gds_api/test_helpers/worldwide.rb
 - lib/gds_api/version.rb
 - lib/gds_api/worldwide.rb
+- test/fixtures/finder_api/cma-case-schema.json
+- test/fixtures/hello.txt
+- test/fixtures/new_policies_for_dwp.json
+- test/fixtures/no_services_and_info_data_found_fixture.json
+- test/fixtures/old_policies_for_dwp.json
+- test/fixtures/services_and_info_fixture.json
+- test/fixtures/sub_sector_organisations.json
+- test/fixtures/world_organisations_australia.json
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 metadata: {}
@@ -431,4 +436,3 @@ signing_key:
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files: []
-has_rdoc: 

data/lib/gds_api/panopticon.rb

@@ -1,80 +0,0 @@
-require_relative 'base'
-require_relative 'panopticon/registerer'
-require_relative 'exceptions'
-
-class GdsApi::Panopticon < GdsApi::Base
-  include GdsApi::ExceptionHandling
-
-  def all
-    url = base_url + '.json'
-    json = get_json url
-    to_ostruct json
-  end
-
-  def artefact_for_slug(slug, _opts = {})
-    return nil if slug.nil? || slug == ''
-    get_json(url_for_slug(slug))
-  end
-
-  def create_artefact(artefact)
-    ignoring GdsApi::HTTPErrorResponse do
-      create_artefact! artefact
-    end
-  end
-
-  def create_artefact!(artefact)
-    post_json(base_url + ".json", artefact)
-  end
-
-  def put_artefact(id_or_slug, artefact)
-    ignoring GdsApi::HTTPErrorResponse do
-      put_artefact! id_or_slug, artefact
-    end
-  end
-
-  def put_artefact!(id_or_slug, artefact)
-    put_json("#{base_url}/#{id_or_slug}.json", artefact)
-  end
-
-  def update_artefact(id_or_slug, artefact)
-    self.class.logger.warn(
-      "The update_artefact method is deprecated and may be removed in a " +
-      "future release. You should use put_artefact instead."
-    )
-    put_artefact(id_or_slug, artefact)
-  end
-
-  def delete_artefact!(id_or_slug)
-    delete_json("#{base_url}/#{id_or_slug}.json")
-  end
-
-  def create_tag(attributes)
-    post_json("#{endpoint}/tags.json", attributes)
-  end
-
-  def put_tag(tag_type, tag_id, attributes)
-    put_json(
-      tag_url(tag_type, tag_id),
-      attributes
-    )
-  end
-
-  def publish_tag(tag_type, tag_id)
-    post_json(
-      tag_url(tag_type, tag_id, '/publish'),
-      # we don't need to send any more data along with the publish request,
-      # but a body is still required, so sending an empty JSON hash instead
-      {}
-    )
-  end
-
-private
-
-  def base_url
-    "#{endpoint}/artefacts"
-  end
-
-  def tag_url(tag_type, tag_id, action = '')
-    "#{endpoint}/tags/#{tag_type}/#{tag_id}#{action}.json"
-  end
-end

data/lib/gds_api/panopticon/registerer.rb

@@ -1,100 +0,0 @@
-require 'plek'
-
-module GdsApi
-  class Panopticon < GdsApi::Base
-    class Registerer
-      attr_accessor :logger, :owning_app, :rendering_app, :kind
-
-      def initialize(options)
-        @logger = options[:logger] || GdsApi::Base.logger
-        @owning_app = options[:owning_app]
-        @rendering_app = options[:rendering_app]
-        @kind = options[:kind] || 'custom-application'
-        @panopticon = options[:panopticon]
-        @endpoint_url = options[:endpoint_url] || Plek.current.find("panopticon")
-        @timeout = options[:timeout] || 10
-      end
-
-      def record_to_artefact(record)
-        hash = {
-          slug: record.slug,
-          owning_app: owning_app,
-          kind: kind,
-          name: record.title,
-          description: record.description,
-          state: record.state
-        }
-
-        if rendering_app
-          hash[:rendering_app] = rendering_app
-        end
-
-        optional_params = [
-          :need_id,
-          :need_ids,
-
-          :paths,
-          :prefixes,
-
-          :public_timestamp,
-          :latest_change_note,
-
-          :content_id,
-        ]
-
-        deprecated_params = {
-          section: [:primary_section, :sections]
-        }
-
-        deprecated_params.each do |attr_name, replacements|
-          if record.respond_to?(attr_name)
-            replacements = Array(replacements)
-            logger.warn "#{attr_name} has been deprecated in favour of #{replacements.join(' and ')}"
-          end
-        end
-
-        optional_params.each do |attr_name|
-          if record.respond_to? attr_name
-            hash[attr_name] = record.public_send(attr_name)
-          end
-        end
-
-        hash
-      end
-
-      # record should respond to #slug and #title, or override #record_to_artefact
-      def register(record)
-        register_artefact(record_to_artefact(record))
-      end
-
-    protected
-
-      def register_artefact(artefact)
-        logger.info "Putting #{artefact[:slug]}"
-
-        # Error responses here are pretty fatal, so propagate them
-        response = panopticon.put_artefact!(artefact[:slug], artefact)
-        case response.code
-        when 200
-          logger.info "Updated #{artefact[:slug]}"
-        when 201
-          logger.info "Created #{artefact[:slug]}"
-        else
-          # Only expect 200 or 201 success codes, but best to have a fallback
-          logger.info "Registered #{artefact[:slug]} (code #{response.code})"
-        end
-      end
-
-      def panopticon
-        options = {
-          timeout: @timeout
-        }
-        @panopticon ||= GdsApi::Panopticon.new(@endpoint_url, options.merge(panopticon_api_credentials))
-      end
-
-      def panopticon_api_credentials
-        Object::const_defined?(:PANOPTICON_API_CREDENTIALS) ? PANOPTICON_API_CREDENTIALS : {}
-      end
-    end
-  end
-end

data/lib/gds_api/test_helpers/panopticon.rb

@@ -1,76 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-
-module GdsApi
-  module TestHelpers
-    module Panopticon
-      # Generally true. If you are initializing the client differently,
-      # you could redefine/override the constant or stub directly.
-      PANOPTICON_ENDPOINT = Plek.current.find('panopticon')
-
-      def stringify_hash_keys(input_hash)
-        input_hash.inject({}) do |options, (key, value)|
-          options[key.to_s] = value
-          options
-        end
-      end
-
-      def panopticon_has_metadata(metadata)
-        metadata = stringify_hash_keys(metadata)
-
-        json = JSON.dump(metadata)
-
-        urls = []
-        urls << "#{PANOPTICON_ENDPOINT}/artefacts/#{metadata['id']}.json" if metadata['id']
-        urls << "#{PANOPTICON_ENDPOINT}/artefacts/#{metadata['slug']}.json" if metadata['slug']
-
-        urls.each { |url| stub_request(:get, url).to_return(status: 200, body: json, headers: {}) }
-
-        urls.first
-      end
-
-      def panopticon_has_no_metadata_for(slug)
-        url = "#{PANOPTICON_ENDPOINT}/artefacts/#{slug}.json"
-        stub_request(:get, url).to_return(status: 404, body: "", headers: {})
-      end
-
-      def stub_panopticon_default_artefact
-        stub_request(:get, %r{\A#{PANOPTICON_ENDPOINT}/artefacts}).to_return { |request|
-          # return a response with only a slug, and set that slug to match the requested artefact slug
-          { body: JSON.dump("slug" => request.uri.path.split('/').last.chomp('.json')) }
-        }
-      end
-
-      def stub_artefact_registration(slug, request_details = nil, custom_matcher = false)
-        stub = stub_http_request(:put, "#{PANOPTICON_ENDPOINT}/artefacts/#{slug}.json")
-
-        if request_details
-          request_details = request_details.to_json unless custom_matcher
-          stub.with(body: request_details)
-        end
-
-        stub.to_return(status: 201)
-      end
-
-      def stub_panopticon_tag_creation(attributes)
-        url = "#{PANOPTICON_ENDPOINT}/tags.json"
-        stub_request(:post, url)
-                .with(body: attributes.to_json)
-                .to_return(status: 201, body: attributes.to_json)
-      end
-
-      def stub_panopticon_tag_update(tag_type, tag_id, attributes)
-        url = "#{PANOPTICON_ENDPOINT}/tags/#{tag_type}/#{tag_id}.json"
-        stub_request(:put, url)
-                .with(body: attributes.to_json)
-                .to_return(status: 200)
-      end
-
-      def stub_panopticon_tag_publish(tag_type, tag_id)
-        url = "#{PANOPTICON_ENDPOINT}/tags/#{tag_type}/#{tag_id}/publish.json"
-        stub_request(:post, url)
-                .with(body: {}.to_json)
-                .to_return(status: 200)
-      end
-    end
-  end
-end