dmao-generic-ingesters 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa13700de7ef18ea8b374489d9d6f06cb85abe15
-  data.tar.gz: 2f68f9cc43db01df86153247ea61ee79983e7477
+  metadata.gz: 8a71389705fcf4841e99d08ff0095a27663f0502
+  data.tar.gz: 998ac6edd53d0b9cb88d634825e33d6540221789
 SHA512:
-  metadata.gz: 1de03f96656da38f7566a4b681eb2390b6b1661e7ff8e1d93753d6c7841968f54cecb8dfc569b8f373d5b602cb39596e32cd0e952520102bd73999a421eada81
-  data.tar.gz: 435f9ab0ba13bd7e9ddbecd8161343285a90459886059de36bd744e2023ed05bf826a74db1ccf5e8237bbcca1cf99d91001cb25b0cb4e92cc39cc89368e7b39d
+  metadata.gz: b2f670e91b1df80c0fbbf1ecae5f0e1ee3f89cc834b91eb8ab6cda7cd0b8d8da5f543151af1bf25358b6f420125001a5aabf16adbba2c016bddf942db2ff9c79
+  data.tar.gz: 35a6f05547877fd292b65af83ba9e1ca2a63f8f09338e5243bc0d7d5ca236cd51a9f9c6bbf55f0e0f32f4517cc64a8b0e6c94927ba102ab99b06b06639cb5231

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

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

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

@@ -0,0 +1,17 @@
+require 'dmao/ingesters/errors/ingest_entity_error'
+
+module DMAO
+  module Ingesters
+    module Errors
+
+      class IngestFunderError < IngestEntityError
+
+        def initialize(msg="Error ingesting funder.")
+          super(msg)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -1,8 +1,10 @@
+require 'dmao/ingesters/errors/ingest_entity_error'
+
 module DMAO
   module Ingesters
     module Errors
 
-      class IngestOrganisationUnitError < StandardError
+      class IngestOrganisationUnitError < IngestEntityError
 
         def initialize(msg="Error ingesting organisation unit.")
           super(msg)

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

@@ -1,8 +1,10 @@
+require 'dmao/ingesters/errors/ingest_entity_error'
+
 module DMAO
   module Ingesters
     module Errors
 
-      class IngestPersonError < StandardError
+      class IngestPersonError < IngestEntityError
 
         def initialize(msg="Error ingesting person.")
           super(msg)

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

@@ -0,0 +1,34 @@
+require 'dmao_api'
+require 'dmao/ingesters/generic/ingester'
+require 'dmao/ingesters/errors/ingest_funder_error'
+
+module DMAO
+  module Ingesters
+    module Generic
+
+      class FundersIngester< Ingester
+
+        ENTITY = DMAO::API::Funder
+        ENTITY_ERROR = DMAO::Ingesters::Errors::IngestFunderError
+        INVALID_ENTITY_ERROR = DMAO::API::Errors::InvalidFunder
+        ENTITY_ERROR_MESSAGE = "Invalid funder details"
+
+        def ingest_funder attributes={}
+          ingest_entity attributes
+        end
+
+        private
+
+        def add_funder attributes
+          add_entity attributes
+        end
+
+        def update_funder id, attributes
+          update_entity id, attributes
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -2,6 +2,7 @@ require 'time'
 require 'dmao_api'
 require 'dmao/ingesters/errors/generic_ingester'
 require 'dmao/ingesters/errors/empty_attributes'
+require 'dmao/ingesters/errors/ingest_entity_error'
 
 module DMAO
   module Ingesters
@@ -11,6 +12,7 @@ module DMAO
 
         ENTITY = nil
         ENTITY_ERROR = nil
+        INVALID_ENTITY_ERROR = nil
         ENTITY_ERROR_MESSAGE = nil
 
         def initialize(api_url=nil, api_token=nil, institution_id=nil)
@@ -27,8 +29,6 @@ module DMAO
 
         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
@@ -66,12 +66,32 @@ module DMAO
 
         end
 
-        def add_entity _attributes={}
-          raise NotImplementedError
+        def add_entity attributes={}
+
+          begin
+            self.class::ENTITY.create attributes
+          rescue DMAO::API::Errors::InstitutionNotFound
+            raise self.class::ENTITY_ERROR.new("Institution not found, cannot ingest #{entity_name} to non-existent institution")
+          rescue self.class::INVALID_ENTITY_ERROR => e
+            parse_unprocessable_errors(e.errors)
+          end
+
+        end
+
+        def update_entity entity_id, attributes={}
+
+          begin
+            self.class::ENTITY.update entity_id, attributes
+          rescue DMAO::API::Errors::EntityNotFound
+            raise self.class::ENTITY_ERROR.new("#{entity_name.capitalize} not found, cannot update #{entity_name} that does not exist")
+          rescue self.class::INVALID_ENTITY_ERROR => e
+            parse_unprocessable_errors(e.errors)
+          end
+
         end
 
-        def update_entity _entity_id, _attributes={}
-          raise NotImplementedError
+        def entity_name
+          self.class::ENTITY.to_s.split('::')[-1].gsub(/[A-Z]/, " \\0").strip.downcase
         end
 
       end

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

@@ -14,6 +14,7 @@ module DMAO
 
         ENTITY = DMAO::API::Person
         ENTITY_ERROR = DMAO::Ingesters::Errors::IngestPersonError
+        INVALID_ENTITY_ERROR = DMAO::API::Errors::InvalidPerson
         ENTITY_ERROR_MESSAGE = "Invalid person details"
 
         def ingest_person attributes={}
@@ -22,36 +23,12 @@ module DMAO
 
         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
-
+          add_entity attributes
         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
-
+          update_entity id, attributes
         end
 
       end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmao-generic-ingesters
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Robinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dmao_api
@@ -125,10 +125,13 @@ files:
 - dmao-generic-ingesters.gemspec
 - lib/dmao/ingesters/errors/empty_attributes.rb
 - lib/dmao/ingesters/errors/generic_ingester.rb
+- lib/dmao/ingesters/errors/ingest_entity_error.rb
+- lib/dmao/ingesters/errors/ingest_funder_error.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/funders_ingester.rb
 - lib/dmao/ingesters/generic/ingester.rb
 - lib/dmao/ingesters/generic/organisation_ingester.rb
 - lib/dmao/ingesters/generic/people_ingester.rb