dmao-generic-ingesters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ff720462095074f70e061c80005f6e7bb969962
+  data.tar.gz: 2c989fb7953deaa1d73c82e0ac23fa9e473acd25
+SHA512:
+  metadata.gz: eeffc66009751b507fd0985c95f9b5d7fd16d88a354fa213c5e1fed07d0d7f87645adf7217a857cb62a53c9c7cdb03eef25a6383319a31b6337bcaf6a57ceeee
+  data.tar.gz: c04021beee5c6db06d5025e0f11100c62656fa7d7d8e0752868e191f318b02ea559026fe1f0fff8f32b77552a11faeb80a239f09e0b42856267f95e443264b64

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rbenv-gemsets

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dmao-generic-ingesters.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lancaster University Library
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# DMAO Generic Ingesters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmao-generic-ingesters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmao-generic-ingesters
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lulibrary/DMAO-Generic-Ingesters.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "generic/ingesters"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dmao-generic-ingesters.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmao/ingesters/generic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dmao-generic-ingesters"
+  spec.version       = DMAO::Ingesters::Generic::VERSION
+  spec.authors       = ["Stephen Robinson"]
+  spec.email         = ["library.dit@lancaster.ac.uk"]
+
+  spec.summary       = %q{Generic ingesters for DMA Online}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/lulibrary/DMAO-Generic-Ingesters"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dmao_api", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+  spec.add_development_dependency "byebug"
+end

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

@@ -0,0 +1,15 @@
+module DMAO
+  module Ingesters
+    module Errors
+
+      class EmptyAttributes < StandardError
+
+        def initialize(msg="Attributes need to be specified.")
+          super(msg)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module DMAO
+  module Ingesters
+    module Errors
+
+      class GenericIngester < StandardError
+
+        def initialize(msg="Calling ingest in generic ingester is not allowed")
+          super(msg)
+        end
+
+      end
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+module DMAO
+  module Ingesters
+    module Errors
+
+      class LinkOrganisationUnitError < StandardError
+
+        def initialize(msg="Error linking organisation unit.")
+          super(msg)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+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_api'
+require 'time'
+
+module DMAO
+  module Ingesters
+    module Generic
+
+      class OrganisationIngester
+
+        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
+
+        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
+
+        end
+
+        def link_child_to_parent child_system_uuid, parent_system_uuid
+
+          child_unit = find_unit_or_raise_link_error child_system_uuid, "Organisation unit not found for child system uuid #{child_system_uuid}"
+          parent_unit = find_unit_or_raise_link_error parent_system_uuid, "Organisation unit not found for parent system uuid #{parent_system_uuid}"
+
+          attributes = {
+              parent_id: parent_unit.id
+          }
+
+          update_organisation_unit child_unit.id, attributes
+
+        end
+
+        private
+
+        def add_organisation_unit attributes
+
+          begin
+            DMAO::API::OrganisationUnit.create attributes
+          rescue DMAO::API::Errors::InstitutionNotFound
+            raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Institution not found, cannot ingest organisation unit to non-existent institution")
+          rescue DMAO::API::Errors::InvalidParentId
+            raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Parent ID not found in DMA Online, cannot link organisation unit to non-existent parent")
+          rescue DMAO::API::Errors::InvalidOrganisationUnit => e
+            parse_unprocessable_errors(e.errors)
+          end
+
+        end
+
+        def update_organisation_unit id, attributes
+
+          begin
+
+            DMAO::API::OrganisationUnit.update id, attributes
+
+          rescue DMAO::API::Errors::OrganisationUnitNotFound
+            raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Organisation unit not found, cannot update organisation unit that does not exist")
+          rescue DMAO::API::Errors::InvalidParentId
+            raise DMAO::Ingesters::Errors::IngestOrganisationUnitError.new("Parent ID not found in DMA Online, cannot link organisation unit to non-existent parent")
+          rescue DMAO::API::Errors::InvalidOrganisationUnit => e
+            parse_unprocessable_errors(e.errors)
+          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 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
+            DMAO::API::OrganisationUnit.find_by_system_uuid unit_system_uuid
+          rescue DMAO::API::Errors::OrganisationUnitNotFound
+            raise DMAO::Ingesters::Errors::LinkOrganisationUnitError.new(error_message)
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module DMAO
+  module Ingesters
+    module Generic
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/dmao/ingesters/generic.rb

@@ -0,0 +1,9 @@
+require "dmao/ingesters/generic/version"
+
+module DMAO
+  module Ingesters
+    module Generic
+
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dmao-generic-ingesters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Robinson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dmao_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- library.dit@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dmao-generic-ingesters.gemspec
+- 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/link_organisation_unit_error.rb
+- lib/dmao/ingesters/generic.rb
+- lib/dmao/ingesters/generic/organisation_ingester.rb
+- lib/dmao/ingesters/generic/version.rb
+homepage: https://github.com/lulibrary/DMAO-Generic-Ingesters
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generic ingesters for DMA Online
+test_files: []