gds-api-adapters 0.0.29 → 0.0.30

data/lib/gds_api/panopticon.rb

@@ -1,4 +1,5 @@
 require_relative 'base'
+require_relative 'panopticon/registerer'
 
 class GdsApi::Panopticon < GdsApi::Base
   def all

data/lib/gds_api/panopticon/registerer.rb

@@ -0,0 +1,51 @@
+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]
+        @kind = options[:kind] || 'custom-application'
+        @panopticon = options[:panopticon]
+      end
+  
+      def record_to_artefact(record)
+        {slug: record.slug, owning_app: owning_app, kind: kind, name: record.title}
+      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)
+        else
+          raise "Slug #{artefact[:slug]} already registered to application '#{existing.owning_app}'"
+        end
+      end
+
+      def panopticon
+        options = {
+          timeout: 5
+        }
+        platform = ENV['FACTER_govuk_platform'] || 'development'
+        @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
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.0.29'
+  VERSION = '0.0.30'
 end

data/test/panopticon_api_test.rb

@@ -93,4 +93,15 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
 
     api.update_artefact(1, basic_artefact)
   end
+  
+  def test_can_register_artefacts_en_masse
+    panopticon = stub_everything('Panopticon api client')
+    r = GdsApi::Panopticon::Registerer.new(owning_app: 'my-app', panopticon: panopticon)
+    record = OpenStruct.new(slug: '/foo', title: 'MyFoo')
+    
+    panopticon.stubs(:artefact_for_slug).returns(nil)
+    panopticon.expects(:create_artefact).with({slug: '/foo', owning_app: 'my-app', kind: 'custom-application', name: 'MyFoo'})
+    
+    r.register(record)
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.29
+  version: 0.0.30
 platform: ruby
 authors: 
 - James Stewart
@@ -130,6 +130,7 @@ files:
 - lib/gds_api/json_client.rb
 - lib/gds_api/needotron.rb
 - lib/gds_api/oauth2_client.rb
+- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/panopticon.rb
 - lib/gds_api/part_methods.rb
 - lib/gds_api/publisher.rb
@@ -160,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2837227603408355889
+      hash: -1184344581881622705
       segments: 
       - 0
       version: "0"
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2837227603408355889
+      hash: -1184344581881622705
       segments: 
       - 0
       version: "0"