dmao_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86fbfebf03c55721de45759213ac525070534b45
-  data.tar.gz: 62d993aa9ae429585fd91b69fa6a630cc48c3741
+  metadata.gz: 8e7257d738325683b5729c978624513908db362c
+  data.tar.gz: ddf6f8f8e95bb525f749ab6000659560079673a3
 SHA512:
-  metadata.gz: 8a630788fba8c1c44d36220d32a04ca3414ebc5bb71841f7ef9b01a0e9aad2f262aba3b1e55897cfaccd5c7c086f7c53fd38ac42addf648a1444b3e178b57f4e
-  data.tar.gz: df765da27d14c6c0b531261add761170ab6d98598edc54e3c8ad104b97b07feb258f509ec4be48ad3ed8a13d5fb642d306495758b366fac0a71e6363755e0580
+  metadata.gz: 8c5765835fb5a8f277ccc48bd093878b82d5a6b477cd77e5a4a8ec0219cfbb3aca471fde00d29dfdde3bacfa74b2faaf1f44d52534b9b6e3beea81612efbc8e8
+  data.tar.gz: 19656c8cbdb4ccf1f731b8d3ff22688d273cf62d0f4083fb3f0dac935ae572e1ab18f015b64af20d9533329ac5c37d83b0572005b3b86f515a41f2034b428b52

data/lib/dmao/api/entity.rb

@@ -0,0 +1,163 @@
+require 'dmao/api/base'
+
+require 'dmao/api/errors/institution_not_found'
+require 'dmao/api/errors/invalid_system_uuid'
+require 'dmao/api/errors/invalid_response_length'
+
+module DMAO
+  module API
+
+    class Entity < Base
+
+      ENDPOINT = ''
+      NOT_FOUND_ERROR = nil
+      INVALID_ID_ERROR = nil
+      INVALID_ENTITY_CLASS = nil
+      INVALID_ENTITY_ERROR_MESSAGE = ""
+      VALID_ATTRIBUTES = []
+
+      def self.find_by_system_uuid system_uuid
+
+        validate_system_uuid system_uuid
+
+        response = self.api["#{self::ENDPOINT}?system_uuid=#{system_uuid}"].get
+
+        response_data = JSON.parse(response)["data"]
+
+        raise self::NOT_FOUND_ERROR.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.all
+
+        begin
+          response = self.api[self::ENDPOINT].get
+        rescue RestClient::NotFound
+          raise DMAO::API::Errors::InstitutionNotFound.new
+        end
+
+        entities = []
+
+        response_data = JSON.parse(response)["data"]
+
+        return entities if response_data.length == 0
+
+        response_data.each do |data|
+
+          entities.push instance_from_api_data(data)
+
+        end
+
+        entities
+
+      end
+
+      def self.get id
+
+        validate_id id
+
+        begin
+          response = self.api["#{self::ENDPOINT}/#{id}"].get
+        rescue RestClient::NotFound
+          raise self::NOT_FOUND_ERROR.new
+        end
+
+        instance_from_response response
+
+      end
+
+      def self.create attributes
+
+        validate_attributes attributes
+
+        begin
+          response = self.api[self::ENDPOINT].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_id id
+
+        validate_attributes attributes
+
+        begin
+          response = self.api["#{self::ENDPOINT}/#{id}"].patch attributes.to_json
+        rescue RestClient::NotFound
+          raise self::NOT_FOUND_ERROR.new
+        rescue RestClient::UnprocessableEntity => e
+          handle_unprocessable_entity e
+        end
+
+        instance_from_response response
+
+      end
+
+      def self.delete id
+
+        validate_id id
+
+        begin
+          self.api["#{self::ENDPOINT}/#{id}"].delete
+        rescue RestClient::NotFound
+          raise self::NOT_FOUND_ERROR.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.handle_unprocessable_entity error_response
+
+        errors = JSON.parse(error_response.response.body)["errors"]
+
+        raise self::INVALID_ENTITY_CLASS.new(self::INVALID_ENTITY_ERROR_MESSAGE, errors)
+
+      end
+
+      def self.validate_id id
+        if id.nil? || id.to_s.empty?
+          raise self::INVALID_ID_ERROR.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.validate_attributes attributes
+        attributes.keep_if { |k, _v| self::VALID_ATTRIBUTES.include? k }
+      end
+
+      def self.instance_from_api_data _data
+        raise "Should be overridden in extending class"
+      end
+
+    end
+
+  end
+end

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

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

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

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

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

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

data/lib/dmao/api/organisation_unit.rb

@@ -1,16 +1,20 @@
 require 'rest-client'
-require 'dmao/api/base'
-require 'dmao/api/errors/institution_not_found'
+require 'dmao/api/entity'
 require 'dmao/api/errors/invalid_parent_id'
 require 'dmao/api/errors/invalid_organisation_unit'
+require 'dmao/api/errors/invalid_organisation_unit_id'
 require 'dmao/api/errors/organisation_unit_not_found'
-require 'dmao/api/errors/invalid_system_uuid'
-require 'dmao/api/errors/invalid_response_length'
 
 module DMAO
   module API
 
-    class OrganisationUnit < Base
+    class OrganisationUnit < Entity
+
+      ENDPOINT = 'organisation_units'
+      NOT_FOUND_ERROR = DMAO::API::Errors::OrganisationUnitNotFound
+      INVALID_ID_ERROR = DMAO::API::Errors::InvalidOrganisationUnitID
+      INVALID_ENTITY_CLASS = DMAO::API::Errors::InvalidOrganisationUnit
+      INVALID_ENTITY_ERROR_MESSAGE = "Invalid person details, please see errors."
 
       VALID_ATTRIBUTES = [:id, :institution_id, :name, :description, :url, :system_uuid, :system_modified_at, :isni, :unit_type, :parent_id]
       attr_reader(*VALID_ATTRIBUTES)
@@ -33,119 +37,6 @@ module DMAO
 
       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"]
@@ -167,22 +58,6 @@ module DMAO
 
       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"]

data/lib/dmao/api/person.rb

@@ -0,0 +1,56 @@
+require 'dmao/api/entity'
+require 'dmao/api/errors/invalid_person'
+require 'dmao/api/errors/invalid_person_id'
+require 'dmao/api/errors/person_not_found'
+
+module DMAO
+  module API
+
+    class Person < Entity
+
+      ENDPOINT = 'people'
+      NOT_FOUND_ERROR = DMAO::API::Errors::PersonNotFound
+      INVALID_ID_ERROR = DMAO::API::Errors::InvalidPersonID
+      INVALID_ENTITY_CLASS = DMAO::API::Errors::InvalidPerson
+      INVALID_ENTITY_ERROR_MESSAGE = "Invalid person details, please see errors."
+
+      VALID_ATTRIBUTES = [:id, :institution_id, :first_name, :last_name, :email, :image_link, :orcid, :system_uuid, :system_modified_at]
+
+      attr_reader(*VALID_ATTRIBUTES)
+
+      def initialize(attributes)
+
+        @id = attributes[:id]
+        @institution_id = attributes[:institution_id]
+        @first_name = attributes[:first_name]
+        @last_name = attributes[:last_name]
+        @email = attributes[:email]
+        @image_link = attributes[:image_link]
+        @orcid = attributes[:orcid]
+        @system_uuid = attributes[:system_uuid]
+        @system_modified_at = attributes[:system_modified_at]
+
+      end
+
+      def self.instance_from_api_data data
+
+        attributes = {
+            id: data["id"],
+            institution_id: data["relationships"]["institution"]["data"]["id"],
+            first_name: data["attributes"]["first-name"],
+            last_name: data["attributes"]["last-name"],
+            email: data["attributes"]["email"],
+            image_link: data["attributes"]["image-link"],
+            orcid: data["attributes"]["orcid"],
+            system_uuid: data["attributes"]["system-uuid"],
+            system_modified_at: data["attributes"]["system-modified-at"]
+        }
+
+        new(attributes)
+
+      end
+
+    end
+
+  end
+end

data/lib/dmao/api/version.rb

@@ -1,5 +1,5 @@
 module DMAO
   module API
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmao_api
 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-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -153,16 +153,21 @@ files:
 - dmao_api.gemspec
 - lib/dmao/api/base.rb
 - lib/dmao/api/configuration.rb
+- lib/dmao/api/entity.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_person.rb
+- lib/dmao/api/errors/invalid_person_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/errors/person_not_found.rb
 - lib/dmao/api/organisation_unit.rb
+- lib/dmao/api/person.rb
 - lib/dmao/api/version.rb
 - lib/dmao_api.rb
 homepage: https://github.com/lulibrary/DMAO-API-rb