alma 0.2.8 → 0.3.1

data/lib/alma/response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Alma
+  class Response
+    class StandardError < Alma::StandardError
+    end
+
+    extend ::Forwardable
+
+    attr_reader :raw_response
+    def_delegators :raw_response, :body, :success?, :response, :request
+
+    def initialize(response)
+      @raw_response = response
+      # We could validate and throw an error here but currently a
+      validate(response)
+    end
+
+    def loggable
+      { uri: @raw_response&.request&.uri.to_s
+      }.select { |k, v| !(v.nil? || v.empty?) }
+    end
+
+    def validate(response)
+      if errors.first&.dig("errorCode") == "401136"
+        message = "The requested item already exists."
+        log = loggable.merge(response.parsed_response)
+
+        raise Alma::BibRequest::ItemAlreadyExists.new(message, log)
+      end
+
+      if response.code != 200
+        log = loggable.merge(response.parsed_response)
+        raise StandardError.new("Invalid Response.", log)
+      end
+    end
+
+    # Returns an array of errors
+    def errors
+      @raw_response.parsed_response&.dig("errorList", "error") || []
+    end
+  end
+end

data/lib/alma/result_set.rb

@@ -1,50 +1,42 @@
-module Alma
-  class ResultSet
-    extend Forwardable
+# frozen_string_literal: true
 
-		include Enumerable
-    include Alma::Error
+require "forwardable"
 
-    def_delegators :list, :each, :size
+class Alma::ResultSet
+  extend ::Forwardable
+  include Enumerable
+  include Alma::Error
 
-    def initialize(ws_response)
-      @response = ws_response
-    end
+  attr_reader :response
 
-    def total_record_count
-      @response[top_level_key].fetch('total_record_count', 0).to_i
-    end
+  def_delegators :response, :[], :fetch
+  def_delegators :each, :each_with_index, :size
 
-    def list
-      @list ||= list_results
-    end
+  def initialize(response_body_hash)
+    @response = response_body_hash
+  end
 
+  def loggable
+    { uri: @response&.request&.uri&.to_s }
+      .select { |k, v| !(v.nil? || v.empty?) }
+  end
 
-    def top_level_key
-      raise NotImplementedError 'Subclasses of ResultSet Need to define the top level key'
-    end
+  def each
+    @results ||= @response.fetch(key, [])
+      .map { |item| single_record_class.new(item) }
+  end
 
-    def response_records_key
-      raise NotImplementedError 'Subclasses of ResultSet Need to define the key for response records'
-    end
+  def total_record_count
+    fetch("total_record_count", 0).to_i
+  end
+  alias :total_records :total_record_count
 
-    private
-    def response_records
-      @response[top_level_key].fetch(response_records_key,[])
+  protected
+    def key
+      raise NotImplementedError "Subclasses of ResultSet need to define a response key"
     end
 
-    # Subclasses Can override this to use a Custom Class for single record objects.
     def single_record_class
       Alma::AlmaRecord
     end
-
-    def list_results
-      #If there is only one record in the response, HTTParty returns as a hash, not
-      # an array of hashes, so wrap in array to normalize.
-      response_array = (response_records.is_a? Array) ? response_records : [response_records]
-      response_array.map do |record|
-        single_record_class.new(record)
-      end
-    end
-  end
 end

data/lib/alma/user.rb

@@ -1,14 +1,15 @@
 module Alma
   class  User
+    class ResponseError < Alma::StandardError
+    end
     extend Forwardable
+    extend Alma::ApiDefaults
+
+      def self.find(user_id, args={})
+        args[:expand] ||= "fees,requests,loans"
+        response = HTTParty.get("#{self.users_base_path}/#{user_id}", query: args, headers: headers, timeout: timeout)
 
-      def self.find(user_id)
-        response = HTTParty.get("#{self.users_base_path}/#{user_id}", headers: headers)
-        if response.code == 200
-          Alma::User.new JSON.parse(response.body)
-        else
-          raise StandardError, parse(response.body)
-        end
+        Alma::User.new response
       end
 
       # Authenticates a Alma user with their Alma Password
@@ -19,7 +20,7 @@ module Alma
       def self.authenticate(args)
         user_id = args.delete(:user_id) { raise ArgumentError }
         args.merge!({op: 'auth'})
-        response = HTTParty.post("#{users_base_path}/#{user_id}", query: args, headers: headers)
+        response = HTTParty.post("#{users_base_path}/#{user_id}", query: args, headers: headers, timeout: timeout)
         response.code == 204
       end
 
@@ -27,9 +28,23 @@ module Alma
     # The User object can respond directly to Hash like access of attributes
     def_delegators :response, :[], :[]=, :has_key?, :keys, :to_json
 
-    def initialize(response_body)
-      @response = response_body
-      @recheck_loans = true
+    def initialize(response)
+      @raw_response = response
+      @response = response.parsed_response
+      validate(response)
+    end
+
+    def loggable
+      { uri: @raw_response&.request&.uri.to_s
+      }.select { |k, v| !(v.nil? || v.empty?) }
+    end
+
+    def validate(response)
+      if response.code != 200
+        log = loggable.merge(response.parsed_response)
+        error = "The user was not found."
+        raise ResponseError.new(error, log)
+      end
     end
 
     def response
@@ -40,6 +55,18 @@ module Alma
       self['primary_id']
     end
 
+    def total_fines
+      response.dig('fees','value') || "0"
+    end
+
+    def total_requests
+      response.dig('requests','value') || "0"
+    end
+
+    def total_loans
+      response.dig('loans','value') || "0"
+    end
+
 
     # Access the top level JSON attributes as object methods
     def method_missing(name)
@@ -54,35 +81,22 @@ module Alma
 
     # Persist the user in it's current state back to Alma
     def save!
-      response = HTTParty.put("#{users_base_path}/#{id}", headers: headers, body: to_json)
+      response = HTTParty.put("#{users_base_path}/#{id}", timeout: timeout, headers: headers, body: to_json)
       get_body_from(response)
     end
 
 
     def fines
-      response = HTTParty.get("#{users_base_path}/#{id}/fees", headers: headers)
-      if response.code == 200
-        Alma::FineSet.new get_body_from(response)
-      else
-        raise StandardError, get_body_from(response)
-      end
+      Alma::Fine.where_user(id)
     end
 
     def requests
-      #TODO Handle Additional Parameters
-      #TODO Handle Pagination
-      #TODO Handle looping through all results
-      response = HTTParty.get("#{users_base_path}/#{id}/requests", headers: headers)
-      Alma::RequestSet.new(get_body_from(response))
+      Alma::UserRequest.where_user(id)
     end
 
 
     def loans(args={})
-      unless @loans && !recheck_loans?
-        @loans = send_loans_request(args)
-        @recheck_loans = false
-      end
-      @loans
+        @loans ||= Alma::Loan.where_user(id, args)
     end
 
     def renew_loan(loan_id)
@@ -97,38 +111,45 @@ module Alma
       loan_ids.map { |id| renew_loan(id) }
     end
 
-
     def renew_all_loans
       renew_multiple_loans(loans.map(&:loan_id))
     end
 
-
-    def recheck_loans?
-      @recheck_loans
-    end
-
-
     def preferred_email
       self["contact_info"]["email"].select { |k, v| k["preferred"] }.first["email_address"]
     end
 
-
     def email
       self["contact_info"]["email"].map { |e| e["email_address"] }
     end
 
+    def preferred_first_name
+      pref_first = self["pref_first_name"] unless self["pref_first_name"] == ""
+      pref_first || self["first_name"] || ""
+    end
 
-    private
+    def preferred_middle_name
+      pref_middle = self["pref_middle_name"] unless self["pref_middle_name"] == ""
+      pref_middle  || self["middle_name"] || ""
+    end
 
-    def send_loans_request(args={})
-      #TODO Handle looping through all results
+    def preferred_last_name
+      pref_last = self["pref_last_name"] unless self["pref_last_name"] == ""
+      pref_last || self["last_name"]
+    end
+
+    def preferred_suffix
+      self["pref_name_suffix"] || ""
+    end
 
-      # Always expand renewable unless you really don't want to
-      args["expand"] ||= "renewable"
-      response = HTTParty.get("#{users_base_path}/#{id}/loans", query: args, headers: headers)
-      Alma::LoanSet.new(get_body_from(response))
+    def preferred_name
+      "#{preferred_first_name} #{preferred_middle_name} #{preferred_last_name} #{preferred_suffix}"
     end
 
+
+
+    private
+
     # Attempts to renew a single item for a user
     # @param [Hash] args
     # @option args [String] :user_id The unique id of the user
@@ -140,7 +161,7 @@ module Alma
       user_id = args.delete(:user_id) { raise ArgumentError }
       params = {op: 'renew'}
       response = HTTParty.post("#{users_base_path}/#{user_id}/loans/#{loan_id}", query: params, headers: headers)
-      RenewalResponse.new(JSON.parse(response.body))
+      RenewalResponse.new(response)
     end
 
     # Attempts to renew multiple items for a user
@@ -167,21 +188,8 @@ module Alma
       self.class.users_base_path
     end
 
-    def self.headers
-      { "Authorization": "apikey #{self.apikey}",
-      "Accept": "application/json",
-      "Content-Type": "application/json" }
-    end
-
-
     def headers
       self.class.headers
     end
-
-
-    def self.apikey
-      Alma.configuration.apikey
-    end
-
   end
 end

data/lib/alma/user_request.rb

@@ -0,0 +1,17 @@
+module Alma
+  class UserRequest < AlmaRecord
+    extend Alma::ApiDefaults
+
+    def self.where_user(user_id, args={})
+      # Default to upper limit
+      args[:limit] ||= 100
+      response = HTTParty.get(
+        "#{users_base_path}/#{user_id}/requests",
+        query: args,
+        headers: headers,
+        timeout: timeout
+      )
+      Alma::RequestSet.new(response)
+    end
+  end
+end

data/lib/alma/user_set.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
+
 module Alma
   class UserSet
-
     def top_level_key
-      'users'
-
+      "users"
     end
 
     def response_records_key
-      'user'
+      "user"
     end
 
     def single_record_class
       Alma::User
     end
-
   end
-end
+end

data/lib/alma/version.rb

@@ -1,3 +1,3 @@
 module Alma
-  VERSION = "0.2.8"
+  VERSION = "0.3.1"
 end

data/log/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.1
 platform: ruby
 authors:
 - Chad Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ezwadl
@@ -52,34 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: Client for Ex Libris Alma Web Services
 email:
 - chad.nelson@temple.edu
@@ -136,6 +192,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -144,26 +201,36 @@ files:
 - bin/setup
 - lib/alma.rb
 - lib/alma/alma_record.rb
-- lib/alma/api.rb
+- lib/alma/api_defaults.rb
 - lib/alma/availability_response.rb
 - lib/alma/bib.rb
 - lib/alma/bib_item.rb
 - lib/alma/bib_item_set.rb
 - lib/alma/bib_set.rb
 - lib/alma/config.rb
+- lib/alma/electronic.rb
+- lib/alma/electronic/README.md
+- lib/alma/electronic/batch_utils.rb
+- lib/alma/electronic/business.rb
 - lib/alma/error.rb
+- lib/alma/fine.rb
 - lib/alma/fine_set.rb
+- lib/alma/item_request_options.rb
 - lib/alma/loan.rb
 - lib/alma/loan_set.rb
 - lib/alma/renewal_response.rb
+- lib/alma/request.rb
 - lib/alma/request_options.rb
 - lib/alma/request_set.rb
+- lib/alma/response.rb
 - lib/alma/result_set.rb
 - lib/alma/user.rb
+- lib/alma/user_request.rb
 - lib/alma/user_set.rb
 - lib/alma/version.rb
 - lib/alma/wadl/bib.wadl
 - lib/alma/wadl/user.wadl
+- log/.gitignore
 homepage: https://github.com/tulibraries/alma_rb
 licenses:
 - MIT
@@ -184,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Client for Ex Libris Alma Web Services