gds-api-adapters 0.0.52 → 0.1.0

data/lib/gds_api/base.rb

@@ -17,7 +17,8 @@ class GdsApi::Base
     end
   end
 
-  def_delegators :client, :get_json, :post_json, :put_json, :get_raw
+  def_delegators :client, :get_json, :post_json, :post_json!,
+                          :put_json, :put_json!, :get_raw
 
   attr_reader :options
 

data/lib/gds_api/exceptions.rb

@@ -4,4 +4,20 @@ module GdsApi
 
   class TimedOutException < Exception
   end
+
+  class HTTPErrorResponse < StandardError
+    attr_accessor :code
+
+    def initialize(code)
+      @code = code
+    end
+  end
+
+  module ExceptionHandling
+    def ignoring(exception, &block)
+      yield
+    rescue exception
+      # Discard the exception
+    end
+  end
 end

data/lib/gds_api/json_client.rb

@@ -6,6 +6,8 @@ require 'lrucache'
 module GdsApi
   class JsonClient
 
+    include GdsApi::ExceptionHandling
+
     def self.cache(size=DEFAULT_CACHE_SIZE)
       @cache ||= LRUCache.new(max_size: size)
     end
@@ -36,14 +38,32 @@ module GdsApi
     end
 
     def get_json(url)
+      ignoring GdsApi::HTTPErrorResponse do
+        get_json! url
+      end
+    end
+
+    def get_json!(url)
       @cache[url] ||= do_json_request(Net::HTTP::Get, url)
     end
 
     def post_json(url, params)
+      ignoring GdsApi::HTTPErrorResponse do
+        post_json! url, params
+      end
+    end
+
+    def post_json!(url, params)
       do_json_request(Net::HTTP::Post, url, params)
     end
 
     def put_json(url, params)
+      ignoring GdsApi::HTTPErrorResponse do
+        put_json! url, params
+      end
+    end
+
+    def put_json!(url, params)
       do_json_request(Net::HTTP::Put, url, params)
     end
 
@@ -67,7 +87,7 @@ module GdsApi
         end
         loggable.merge!(status: response.code, end_time: Time.now.to_f, body: body)
         logger.warn loggable.to_json
-        nil
+        raise GdsApi::HTTPErrorResponse.new(response.code.to_i), body
       end
     end
 

data/lib/gds_api/panopticon.rb

@@ -1,7 +1,11 @@
 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
@@ -14,11 +18,31 @@ class GdsApi::Panopticon < GdsApi::Base
   end
 
   def create_artefact(artefact)
-    post_json(base_url + ".json", 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)
-    put_json("#{base_url}/#{id_or_slug}.json", 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 curated_lists

data/lib/gds_api/panopticon/registerer.rb

@@ -2,7 +2,7 @@ module GdsApi
   class Panopticon < GdsApi::Base
     class Registerer
       attr_accessor :logger, :owning_app, :kind
-  
+
       def initialize(options)
         @logger = options[:logger] || GdsApi::Base.logger
         @owning_app = options[:owning_app]
@@ -10,35 +10,43 @@ module GdsApi
         @panopticon = options[:panopticon]
         @platform = options[:platform] || ENV['FACTER_govuk_platform'] || 'development'
       end
-  
+
       def record_to_artefact(record)
-        hash = {slug: record.slug, owning_app: owning_app, kind: kind, name: record.title}
-        [:need_id, :section].each do |attr_name|
+        hash = {
+          slug: record.slug,
+          owning_app: owning_app,
+          kind: kind,
+          name: record.title,
+          live: record.live
+        }
+        [:need_id, :section, :indexable_content].each do |attr_name|
           if record.respond_to? attr_name
             hash[attr_name] = record.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 "Checking #{artefact[:slug]}"
-        existing = panopticon.artefact_for_slug(artefact[:slug])
-        if ! existing
-          logger.info "Creating #{artefact[:slug]}"
-          panopticon.create_artefact(artefact)
-        elsif existing.owning_app == artefact[:owning_app]
-          logger.info "Updating #{artefact[:slug]}"
-          panopticon.update_artefact(artefact[:slug], 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
-          raise "Slug #{artefact[:slug]} already registered to application '#{existing.owning_app}'"
+          # Only expect 200 or 201 success codes, but best to have a fallback
+          logger.info "Registered #{artefact[:slug]} (code #{response.code})"
         end
       end
 
@@ -48,7 +56,7 @@ module GdsApi
         }
         @panopticon ||= GdsApi::Panopticon.new(@platform, options.merge(panopticon_api_credentials))
       end
-  
+
       def panopticon_api_credentials
         Object::const_defined?(:PANOPTICON_API_CREDENTIALS) ? PANOPTICON_API_CREDENTIALS : {}
       end

data/lib/gds_api/publisher.rb

@@ -25,23 +25,6 @@ class GdsApi::Publisher < GdsApi::Base
     end
   end
 
-  def council_for_snac_code(snac)
-    if json = get_json("#{@endpoint}/local_transactions/find_by_snac?snac=#{snac}")
-      json.to_hash
-    else
-      nil
-    end
-  end
-
-  def council_for_name(name)
-    name = URI.escape(name)
-    if json = get_json("#{@endpoint}/local_transactions/find_by_council_name?name=#{name}")
-      json.to_hash
-    else
-      nil
-    end
-  end
-
   def licences_for_ids(ids)
     response = get_json("#{@endpoint}/licences.json?ids=#{ids.map(&:to_s).sort.join(',')}")
     if response

data/lib/gds_api/response.rb

@@ -17,6 +17,11 @@ module GdsApi
       @parsed ||= JSON.parse(@net_http_response.body)
     end
 
+    def code
+      # Return an integer code for consistency with HTTPErrorResponse
+      @net_http_response.code.to_i
+    end
+
     def to_ostruct
       self.class.build_ostruct_recursively(to_hash)
     end

data/lib/gds_api/test_helpers/panopticon.rb

@@ -31,13 +31,6 @@ module GdsApi
         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
-
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.0.52'
+  VERSION = '0.1.0'
 end

data/test/json_client_test.rb

@@ -98,14 +98,14 @@ class JsonClientTest < MiniTest::Spec
     response = @client.put_json(url, payload)
     assert_equal 2, response.a.b
   end
-  
+
   def test_accessing_non_existent_attribute_of_response_returns_nil
     url = "http://some.endpoint/some.json"
     stub_request(:put, url).to_return(:body => '{"a":1}', :status => 200)
     response = @client.put_json(url, {})
     assert_equal nil, response.does_not_exist
   end
-  
+
   def test_response_does_not_claim_to_respond_to_methods_corresponding_to_non_existent_attributes
     # This mimics the behaviour of OpenStruct
     url = "http://some.endpoint/some.json"
@@ -113,7 +113,7 @@ class JsonClientTest < MiniTest::Spec
     response = @client.put_json(url, {})
     assert ! response.respond_to?(:does_not_exist)
   end
-  
+
   def test_a_response_is_always_considered_present_and_not_blank
     url = "http://some.endpoint/some.json"
     stub_request(:put, url).to_return(:body => '{"a":1}', :status => 200)
@@ -121,7 +121,7 @@ class JsonClientTest < MiniTest::Spec
     assert ! response.blank?
     assert response.present?
   end
-  
+
   def test_client_can_use_basic_auth
     client = GdsApi::JsonClient.new(basic_auth: {user: 'user', password: 'password'})
 

data/test/panopticon_api_test.rb

@@ -23,6 +23,16 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     }
   end
 
+  def registerable_artefact
+    {
+      slug: 'foo',
+      owning_app: 'my-app',
+      kind: 'custom-application',
+      name: 'MyFoo',
+      live: true
+    }
+  end
+
   def api
     GdsApi::Panopticon.new('test')
   end
@@ -93,12 +103,12 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
 
     api.update_artefact(1, basic_artefact)
   end
-  
+
   def test_can_register_new_artefacts_en_masse
-    artefact = {slug: 'foo', owning_app: 'my-app', kind: 'custom-application', name: 'MyFoo'}
     r = GdsApi::Panopticon::Registerer.new(platform: "test", owning_app: 'my-app')
+    artefact = registerable_artefact()
     panopticon_has_no_metadata_for('foo')
-    
+
     stub_request(:put, "#{PANOPTICON_ENDPOINT}/artefacts/foo.json")
       .with(body: artefact.to_json)
       .to_return(body: artefact.merge(id: 1).to_json)
@@ -107,13 +117,13 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     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_can_register_existing_artefacts_en_masse
-    artefact = {slug: 'foo', owning_app: 'my-app', kind: 'custom-application', name: 'MyFoo'}
+    artefact = registerable_artefact()
     r = GdsApi::Panopticon::Registerer.new(platform: "test", owning_app: 'my-app')
 
     panopticon_has_metadata(artefact)

data/test/publisher_api_test.rb

@@ -138,48 +138,5 @@ describe GdsApi::Publisher do
 
       assert_equal nil, api.licences_for_ids([123,124])
     end
-
-    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).
-        to_return(:status => 404, :body => " ", :headers => {})
-
-      assert_equal nil, api.council_for_snac_code("bloop")
-    end
-
-    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).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_snac_code("AA00")
-    end
-
-    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).
-        to_return(:status => 404, :body => " ", :headers => {})
-
-      assert_equal nil, api.council_for_name("bloop")
-    end
-
-    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).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_name("Some Council")
-    end
-
-    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).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_name("some council")
-    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.52
+  version: 0.1.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-18 00:00:00 Z
+date: 2012-06-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -143,35 +143,35 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/gds_api/version.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/panopticon/registerer.rb
+- lib/gds_api/helpers.rb
+- lib/gds_api/base.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/exceptions.rb
 - lib/gds_api/typhoeus_client.rb
 - lib/gds_api/imminence.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/contactotron.rb
-- lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/panopticon.rb
+- lib/gds_api/version.rb
+- lib/gds_api/oauth2_client.rb
 - lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/contactotron.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/base.rb
-- lib/gds_api/json_client.rb
 - lib/gds_api/response.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/oauth2_client.rb
-- lib/gds_api/part_methods.rb
+- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/needotron.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/helpers.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/core-ext/openstruct.rb
 - README.md
 - Rakefile
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
-- test/json_client_test.rb
 - test/gds_api_base_test.rb
+- test/json_client_test.rb
 - test/test_helper.rb
+- test/publisher_api_test.rb
+- test/panopticon_api_test.rb
+- test/contactotron_api_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2947988208479081559
+      hash: 3070109834685786037
       segments: 
       - 0
       version: "0"
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2947988208479081559
+      hash: 3070109834685786037
       segments: 
       - 0
       version: "0"
@@ -206,9 +206,9 @@ 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/json_client_test.rb
 - test/gds_api_base_test.rb
+- test/json_client_test.rb
 - test/test_helper.rb
+- test/publisher_api_test.rb
+- test/panopticon_api_test.rb
+- test/contactotron_api_test.rb