dmao_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4d4d59aea24941e21ef566967555157cd0e820d
+  data.tar.gz: fec338ce10acfb8f1640679be699534281562a0f
+SHA512:
+  metadata.gz: dc57d3df3778c501ed90865cc0cb91f2724f9e8bab8901364cee58074724d7409fb453157c8b1b845c0bf58dfdc5852c3ce6fb5cbf4c42327f561afba1db0723
+  data.tar.gz: f56542b9e1fc6acfee1579fadd007a2b6d0832f908b28fa153305fcec7029971bb074a4fec5b3d611d11720ed5433677b033bbfecc32f6678b9a30d8551b8599

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api.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,40 @@
+# DMAO-API-rb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dmao_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmao_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmao_api
+
+## Usage
+
+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-API-rb.
+
+
+## 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 "dmao_api"
+
+# 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_api.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmao/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dmao_api"
+  spec.version       = DMAO::API::VERSION
+  spec.authors       = ["Stephen Robinson"]
+  spec.email         = ["library.dit@lancaster.ac.uk"]
+
+  spec.summary       = %q{Ruby API Client for DMA Online API}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/lulibrary/DMAO-API-rb"
+  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 "rest-client", "~> 2.0.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 "vcr", "~> 3.0.3"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/dmao/api/base.rb

@@ -0,0 +1,28 @@
+require 'rest-client'
+require 'dmao/api/errors/invalid_api_base_url'
+require 'dmao/api/errors/invalid_api_token'
+
+module DMAO
+  module API
+
+    class Base
+
+      def self.api
+
+        raise Errors::InvalidApiBaseUrl.new if DMAO::API.base_url.nil? || DMAO::API.base_url.empty?
+        raise Errors::InvalidApiToken.new if DMAO::API.api_token.nil? || DMAO::API.api_token.empty?
+
+        if DMAO::API.institution_id.nil?
+          base_url = DMAO::API.base_url
+        else
+          base_url = DMAO::API.base_url + "/institutions/#{DMAO::API.institution_id}"
+        end
+
+        RestClient::Resource.new(base_url, headers: { content_type: :json, authorization: "Bearer #{DMAO::API.api_token}" })
+
+      end
+
+    end
+
+  end
+end

data/lib/dmao/api/configuration.rb

@@ -0,0 +1,13 @@
+module DMAO
+  module API
+    module Configuration
+
+      attr_accessor :base_url, :api_token, :institution_id
+
+      def configure
+        yield self
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/institution_not_found.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class InstitutionNotFound < StandardError
+
+        def initialize(msg="Invalid institution id specified, must be an existing DMA Online institution.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_api_base_url.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidApiBaseUrl < StandardError
+
+        def initialize(msg="Api base url is invalid, please check the DMAO::API.configure has been called.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_api_token.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidApiToken < StandardError
+
+        def initialize(msg="Api token is invalid, please check the DMAO::API.configure has been called.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_organisation_unit.rb

@@ -0,0 +1,21 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidOrganisationUnit < StandardError
+
+        attr_reader :errors
+
+        def initialize(msg="Invalid organisation unit details passed in, please see errors.", errors=nil)
+
+          @errors = errors
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_organisation_unit_id.rb

@@ -0,0 +1,19 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidOrganisationUnitID < StandardError
+
+        attr_reader :errors
+
+        def initialize(msg="Invalid organisation unit ID specified")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_parent_id.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidParentId < StandardError
+
+        def initialize(msg="Invalid parent id for organisation unit specified.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_response_length.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidResponseLength < StandardError
+
+        def initialize(msg="Invalid number of elements in response.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/invalid_system_uuid.rb

@@ -0,0 +1,19 @@
+module DMAO
+  module API
+    module Errors
+
+      class InvalidSystemUUID < StandardError
+
+        attr_reader :errors
+
+        def initialize(msg="Invalid system UUID specified")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/errors/organisation_unit_not_found.rb

@@ -0,0 +1,17 @@
+module DMAO
+  module API
+    module Errors
+
+      class OrganisationUnitNotFound < StandardError
+
+        def initialize(msg="Invalid organisation unit id specified, id does not exist for requesting institution.")
+
+          super(msg)
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/dmao/api/organisation_unit.rb

@@ -0,0 +1,199 @@
+require 'rest-client'
+require 'dmao/api/base'
+require 'dmao/api/errors/institution_not_found'
+require 'dmao/api/errors/invalid_parent_id'
+require 'dmao/api/errors/invalid_organisation_unit'
+require 'dmao/api/errors/organisation_unit_not_found'
+require 'dmao/api/errors/invalid_system_uuid'
+require 'dmao/api/errors/invalid_response_length'
+require 'byebug'
+
+module DMAO
+  module API
+
+    class OrganisationUnit < Base
+
+      VALID_ATTRIBUTES = [:id, :institution_id, :name, :description, :url, :system_uuid, :system_modified_at, :isni, :unit_type, :parent_id]
+      attr_reader(*VALID_ATTRIBUTES)
+
+      def initialize(attributes)
+
+        @id = attributes[:id]
+        @institution_id = attributes[:institution_id]
+        @name = attributes[:name]
+        @description = attributes[:description]
+        @url = attributes[:url]
+        @system_uuid = attributes[:system_uuid]
+        @system_modified_at = attributes[:system_modified_at]
+        @isni = attributes[:isni]
+        @unit_type = attributes[:unit_type]
+
+        if attributes[:parent_id]
+          @parent_id = attributes[:parent_id]
+        end
+
+      end
+
+      def self.all
+
+        begin
+          response = self.api['organisation_units'].get
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::InstitutionNotFound.new
+        end
+
+        org_units = []
+
+        response_data = JSON.parse(response)["data"]
+
+        return org_units if response_data.length == 0
+
+        response_data.each do |data|
+
+          org_units.push instance_from_api_data(data)
+
+        end
+
+        org_units
+
+      end
+
+      def self.get id
+
+        validate_organisation_unit_id id
+
+        begin
+          response = self.api["organisation_units/#{id}"].get
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::OrganisationUnitNotFound.new
+        end
+
+        instance_from_response response
+
+      end
+
+      def self.find_by_system_uuid system_uuid
+
+        validate_system_uuid system_uuid
+
+        response = self.api["organisation_units?system_uuid=#{system_uuid}"].get
+
+        response_data = JSON.parse(response)["data"]
+
+        raise DMAO::API::Errors::OrganisationUnitNotFound.new if response_data.length == 0
+        raise DMAO::API::Errors::InvalidResponseLength.new("Expected 1 element in response there were #{response_data.length}") if response_data.length != 1
+
+        data = response_data[0]
+
+        instance_from_api_data data
+
+      end
+
+      def self.create attributes
+
+        validate_attributes attributes
+
+        begin
+          response = self.api['organisation_units'].post attributes.to_json
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::InstitutionNotFound.new
+        rescue RestClient::UnprocessableEntity => e
+          handle_unprocessable_entity e
+        end
+
+        instance_from_response response
+
+      end
+
+      def self.update id, attributes
+
+        validate_organisation_unit_id id
+
+        validate_attributes attributes
+
+        begin
+          response = self.api["organisation_units/#{id}"].patch attributes.to_json
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::OrganisationUnitNotFound.new
+        rescue RestClient::UnprocessableEntity => e
+          handle_unprocessable_entity e
+        end
+
+        instance_from_response response
+
+      end
+
+      def self.delete id
+
+        validate_organisation_unit_id id
+
+        begin
+          self.api["organisation_units/#{id}"].delete
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::OrganisationUnitNotFound.new
+        rescue RestClient::UnprocessableEntity => e
+          handle_unprocessable_entity e
+        end
+
+        true
+
+      end
+
+      def self.instance_from_response response_body
+
+        data = JSON.parse(response_body)["data"]
+
+        instance_from_api_data data
+
+      end
+
+      def self.instance_from_api_data data
+
+        parent_id = data["relationships"]["parent"]["data"].nil? ? nil : data["relationships"]["parent"]["data"]["id"]
+
+        attributes = {
+            id: data["id"],
+            institution_id: data["relationships"]["institution"]["data"]["id"],
+            name: data["attributes"]["name"],
+            description: data["attributes"]["description"],
+            url: data["attributes"]["url"],
+            system_uuid: data["attributes"]["system-uuid"],
+            system_modified_at: data["attributes"]["system-modified-at"],
+            isni: data["attributes"]["isni"],
+            unit_type: data["attributes"]["unit-type"],
+            parent_id: parent_id
+        }
+
+        new(attributes)
+
+      end
+
+      def self.validate_attributes attributes
+        attributes.keep_if { |k, _v| VALID_ATTRIBUTES.include? k }
+      end
+
+      def self.validate_organisation_unit_id id
+        if id.nil? || id.to_s.empty?
+          raise DMAO::API::Errors::InvalidOrganisationUnitID.new
+        end
+      end
+
+      def self.validate_system_uuid system_uuid
+        if system_uuid.nil? || system_uuid.to_s.empty?
+          raise DMAO::API::Errors::InvalidSystemUUID.new
+        end
+      end
+
+      def self.handle_unprocessable_entity error_response
+
+        errors = JSON.parse(error_response.response.body)["errors"]
+
+        raise DMAO::API::Errors::InvalidParentId.new if errors.keys.include? "parent"
+        raise DMAO::API::Errors::InvalidOrganisationUnit.new("Invalid organisation unit details, please see errors.", errors)
+
+      end
+
+    end
+
+  end
+end

data/lib/dmao/api/version.rb

@@ -0,0 +1,5 @@
+module DMAO
+  module API
+    VERSION = "0.1.0"
+  end
+end

data/lib/dmao_api.rb

@@ -0,0 +1,14 @@
+require "dmao/api/version"
+require "dmao/api/configuration"
+
+module DMAO
+  module API
+
+    class << self
+
+      include Configuration
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: dmao_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Robinson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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_api.gemspec
+- lib/dmao/api/base.rb
+- lib/dmao/api/configuration.rb
+- lib/dmao/api/errors/institution_not_found.rb
+- lib/dmao/api/errors/invalid_api_base_url.rb
+- lib/dmao/api/errors/invalid_api_token.rb
+- lib/dmao/api/errors/invalid_organisation_unit.rb
+- lib/dmao/api/errors/invalid_organisation_unit_id.rb
+- lib/dmao/api/errors/invalid_parent_id.rb
+- lib/dmao/api/errors/invalid_response_length.rb
+- lib/dmao/api/errors/invalid_system_uuid.rb
+- lib/dmao/api/errors/organisation_unit_not_found.rb
+- lib/dmao/api/organisation_unit.rb
+- lib/dmao/api/version.rb
+- lib/dmao_api.rb
+homepage: https://github.com/lulibrary/DMAO-API-rb
+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: Ruby API Client for DMA Online API
+test_files: []