dmao-generic-ingesters 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87171d6bcbe3868e05ea4647c3eedffb8ac005d7
-  data.tar.gz: c29e683001b5c4230e72aa6b5472b56b7638c65f
+  metadata.gz: fa13700de7ef18ea8b374489d9d6f06cb85abe15
+  data.tar.gz: 2f68f9cc43db01df86153247ea61ee79983e7477
 SHA512:
-  metadata.gz: 50c9b0ebdbc4cea9480afebea72e54dd850e7a4053d2a20f84abb20818cd977e8feef443fd957224bfe79d68b05bbdef74e14529da6b6d1c4d71efda8915af27
-  data.tar.gz: f0b4f78421d1f34f6bcb52b9de7aee60bc942bacd4c3a89c9f2d05297659e247ae8b1628f2a1c725f4dde9451af960069d579cc0b5afa9bde8ee15f18c9c8a72
+  metadata.gz: 1de03f96656da38f7566a4b681eb2390b6b1661e7ff8e1d93753d6c7841968f54cecb8dfc569b8f373d5b602cb39596e32cd0e952520102bd73999a421eada81
+  data.tar.gz: 435f9ab0ba13bd7e9ddbecd8161343285a90459886059de36bd744e2023ed05bf826a74db1ccf5e8237bbcca1cf99d91001cb25b0cb4e92cc39cc89368e7b39d

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.rbenv-gemsets
+.rbenv-gemsets
+.byebug_history

data/dmao-generic-ingesters.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dmao_api", "~> 0.2.1"
+  spec.add_dependency "dmao_api", "~> 0.5.0"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/dmao/ingesters/errors/ingest_person_error.rb

@@ -0,0 +1,15 @@
+module DMAO
+  module Ingesters
+    module Errors
+
+      class IngestPersonError < StandardError
+
+        def initialize(msg="Error ingesting person.")
+          super(msg)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/ingesters/generic/ingester.rb

@@ -0,0 +1,81 @@
+require 'time'
+require 'dmao_api'
+require 'dmao/ingesters/errors/generic_ingester'
+require 'dmao/ingesters/errors/empty_attributes'
+
+module DMAO
+  module Ingesters
+    module Generic
+
+      class Ingester
+
+        ENTITY = nil
+        ENTITY_ERROR = nil
+        ENTITY_ERROR_MESSAGE = nil
+
+        def initialize(api_url=nil, api_token=nil, institution_id=nil)
+          DMAO::API.configure do |config|
+            config.base_url = api_url
+            config.api_token = api_token
+            config.institution_id = institution_id
+          end
+        end
+
+        def ingest
+          raise DMAO::Ingesters::Errors::GenericIngester.new("Calling ingest on generic ingester is not allowed.")
+        end
+
+        def ingest_entity attributes = {}
+
+          entity_name = self.class::ENTITY.to_s.split('::')[-1].gsub(/[A-Z]/, " \\0").strip.downcase
+
+          raise DMAO::Ingesters::Errors::EmptyAttributes.new("Cannot ingest #{entity_name} without attributes.") if attributes.nil? || attributes.empty?
+
+          begin
+
+            entity = self.class::ENTITY.find_by_system_uuid attributes[:system_uuid]
+
+            current_modified_at = Time.parse(entity.system_modified_at)
+            new_modified_at = Time.parse(attributes[:system_modified_at])
+
+            return false if current_modified_at >= new_modified_at
+
+            update_entity entity.id, attributes
+
+          rescue DMAO::API::Errors::EntityNotFound
+            add_entity attributes
+          rescue DMAO::API::Errors::InvalidResponseLength
+            raise self.class::ENTITY_ERROR.new("More than one #{entity_name} returned for system uuid #{attributes[:system_uuid]}.")
+          end
+
+        end
+
+        def parse_unprocessable_errors errors
+
+          error_messages = ""
+
+          errors.each_with_index do |(k, v), index|
+            v.each_with_index do |msg, msg_index|
+              error_messages += "#{k} - #{msg}"
+              error_messages += ", " unless msg_index == v.size - 1
+            end
+            error_messages += ", " unless index == errors.size - 1
+          end
+
+          raise self.class::ENTITY_ERROR.new("#{self.class::ENTITY_ERROR_MESSAGE}, #{error_messages}")
+
+        end
+
+        def add_entity _attributes={}
+          raise NotImplementedError
+        end
+
+        def update_entity _entity_id, _attributes={}
+          raise NotImplementedError
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/ingesters/generic/organisation_ingester.rb

@@ -2,6 +2,7 @@ require 'dmao/ingesters/errors/generic_ingester'
 require 'dmao/ingesters/errors/empty_attributes'
 require 'dmao/ingesters/errors/ingest_organisation_unit_error'
 require 'dmao/ingesters/errors/link_organisation_unit_error'
+require 'dmao/ingesters/generic/ingester'
 require 'dmao_api'
 require 'time'
 
@@ -9,41 +10,14 @@ module DMAO
   module Ingesters
     module Generic
 
-      class OrganisationIngester
+      class OrganisationIngester < Ingester
 
-        def initialize(api_url=nil, api_token=nil, institution_id=nil)
-          DMAO::API.configure do |config|
-            config.base_url = api_url
-            config.api_token = api_token
-            config.institution_id = institution_id
-          end
-        end
-
-        def ingest
-          raise DMAO::Ingesters::Errors::GenericIngester.new("Calling ingest on generic organisation ingester is not allowed.")
-        end
+        ENTITY = DMAO::API::OrganisationUnit
+        ENTITY_ERROR = DMAO::Ingesters::Errors::IngestOrganisationUnitError
+        ENTITY_ERROR_MESSAGE = "Invalid organisation unit details"
 
         def ingest_organisation_unit attributes={}
-
-          raise DMAO::Ingesters::Errors::EmptyAttributes.new("Cannot ingest organisation unit without attributes.") if attributes.nil? || attributes.empty?
-
-          begin
-
-            org_unit = DMAO::API::OrganisationUnit.find_by_system_uuid attributes[:system_uuid]
-
-            current_modified_at = Time.parse(org_unit.system_modified_at)
-            new_modified_at = Time.parse(attributes[:system_modified_at])
-
-            return false if current_modified_at >= new_modified_at
-
-            update_organisation_unit org_unit.id, attributes
-
-          rescue DMAO::API::Errors::OrganisationUnitNotFound
-            add_organisation_unit attributes
-          rescue DMAO::API::Errors::InvalidResponseLength
-            raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Multiple organisation units returned for system uuid #{attributes[:system_uuid]}.")
-          end
-
+          ingest_entity attributes
         end
 
         def link_child_to_parent child_system_uuid, parent_system_uuid
@@ -61,6 +35,14 @@ module DMAO
 
         private
 
+        def add_entity attributes
+          add_organisation_unit attributes
+        end
+
+        def update_entity id, attributes
+          update_organisation_unit id, attributes
+        end
+
         def add_organisation_unit attributes
 
           begin
@@ -91,22 +73,6 @@ module DMAO
 
         end
 
-        def parse_unprocessable_errors errors
-
-          error_messages = ""
-
-          errors.each_with_index do |(k, v), index|
-            v.each_with_index do |msg, msg_index|
-              error_messages += "#{k} - #{msg}"
-              error_messages += ", " unless msg_index == v.size - 1
-            end
-            error_messages += ", " unless index == errors.size - 1
-          end
-
-          raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Invalid organisation unit details, #{error_messages}")
-
-        end
-
         def find_unit_or_raise_link_error unit_system_uuid, error_message
 
           begin

data/lib/dmao/ingesters/generic/people_ingester.rb

@@ -0,0 +1,61 @@
+require 'dmao_api'
+require 'dmao/api/person'
+require 'time'
+require 'dmao/ingesters/generic/ingester'
+require 'dmao/ingesters/errors/generic_ingester'
+require 'dmao/ingesters/errors/empty_attributes'
+require 'dmao/ingesters/errors/ingest_person_error'
+
+module DMAO
+  module Ingesters
+    module Generic
+
+      class PeopleIngester < Ingester
+
+        ENTITY = DMAO::API::Person
+        ENTITY_ERROR = DMAO::Ingesters::Errors::IngestPersonError
+        ENTITY_ERROR_MESSAGE = "Invalid person details"
+
+        def ingest_person attributes={}
+          ingest_entity attributes
+        end
+
+        private
+
+        def add_entity attributes
+          add_person attributes
+        end
+
+        def update_entity id, attributes
+          update_person id, attributes
+        end
+
+        def add_person attributes
+
+          begin
+            DMAO::API::Person.create attributes
+          rescue DMAO::API::Errors::InstitutionNotFound
+            raise DMAO::Ingesters::Errors::IngestPersonError.new("Institution not found, cannot ingest person to non-existent institution")
+          rescue DMAO::API::Errors::InvalidPerson => e
+            parse_unprocessable_errors(e.errors)
+          end
+
+        end
+
+        def update_person id, attributes
+
+          begin
+            DMAO::API::Person.update id, attributes
+          rescue DMAO::API::Errors::PersonNotFound
+            raise DMAO::Ingesters::Errors::IngestPersonError.new("Person not found, cannot update person that does not exist")
+          rescue DMAO::API::Errors::InvalidPerson => e
+            parse_unprocessable_errors(e.errors)
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/ingesters/generic/version.rb

@@ -1,7 +1,7 @@
 module DMAO
   module Ingesters
     module Generic
-      VERSION = "0.2.1"
+      VERSION = "0.3.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmao-generic-ingesters
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Robinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dmao_api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,9 +126,12 @@ files:
 - lib/dmao/ingesters/errors/empty_attributes.rb
 - lib/dmao/ingesters/errors/generic_ingester.rb
 - lib/dmao/ingesters/errors/ingest_organisation_unit_error.rb
+- lib/dmao/ingesters/errors/ingest_person_error.rb
 - lib/dmao/ingesters/errors/link_organisation_unit_error.rb
 - lib/dmao/ingesters/generic.rb
+- lib/dmao/ingesters/generic/ingester.rb
 - lib/dmao/ingesters/generic/organisation_ingester.rb
+- lib/dmao/ingesters/generic/people_ingester.rb
 - lib/dmao/ingesters/generic/version.rb
 homepage: https://github.com/lulibrary/DMAO-Generic-Ingesters
 licenses: