alma 0.2.6 → 0.3.3

data/lib/alma/user.rb

@@ -1,35 +1,52 @@
+# frozen_string_literal: true
+
 module Alma
   class  User
+    class ResponseError < Alma::StandardError
+    end
     extend Forwardable
+    extend Alma::ApiDefaults
 
-      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
-      end
+    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)
 
-      # Authenticates a Alma user with their Alma Password
-      # @param [Hash] args
-      # @option args [String] :user_id The unique id of the user
-      # @option args [String] :password The users local alma password
-      # @return [Boolean] Whether or not the user Successfully authenticated
-      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.code == 204
-      end
+      Alma::User.new response
+    end
+
+    # Authenticates a Alma user with their Alma Password
+    # @param [Hash] args
+    # @option args [String] :user_id The unique id of the user
+    # @option args [String] :password The users local alma password
+    # @return [Boolean] Whether or not the user Successfully authenticated
+    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, timeout: timeout)
+      response.code == 204
+    end
 
 
     # 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
@@ -37,7 +54,19 @@ module Alma
     end
 
     def id
-      self['primary_id']
+      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
 
 
@@ -54,43 +83,29 @@ 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
+    def loans(args = {})
+      @loans ||= Alma::Loan.where_user(id, args)
     end
 
     def renew_loan(loan_id)
-      response = send_loan_renewal_request({user_id: id, loan_id: loan_id})
+      response = self.class.send_loan_renewal_request({ user_id: id, loan_id: loan_id })
       if response.renewed?
         @recheck_loans ||= true
       end
-      get_body_from response
     end
 
 
@@ -98,81 +113,85 @@ 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 send_loans_request(args={})
-      #TODO Handle looping through all results
-
-      # 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_middle_name
+      pref_middle = self["pref_middle_name"] unless self["pref_middle_name"] == ""
+      pref_middle || self["middle_name"] || ""
     end
 
-    # Attempts to renew a single item for a user
-    # @param [Hash] args
-    # @option args [String] :user_id The unique id of the user
-    # @option args [String] :loan_id The unique id of the loan
-    # @option args [String] :user_id_type Type of identifier being used to search. OPTIONAL
-    # @return [RenewalResponse] Object indicating the renewal message
-    def send_loan_renewal_request(args)
-      user_id = args.delete(:user_id) { raise ArgumentError }
-      loan_id = args.delete(:loan_id) { raise ArgumentError }
-      params = {op: 'renew'}
-      response = HTTParty.post("#{users_base_path}/#{id}/loans/#{loan_id}", query: params, headers: headers)
-      RenewalResponse.new(get_body_from(response))
+    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
 
-    def get_body_from(response)
-      JSON.parse(response.body)
+    def preferred_name
+      "#{preferred_first_name} #{preferred_middle_name} #{preferred_last_name} #{preferred_suffix}"
     end
 
 
-    def self.users_base_path
-      "https://api-na.hosted.exlibrisgroup.com/almaws/v1/users"
-    end
 
-    def users_base_path
-      self.class.users_base_path
-    end
+    private
 
-    def self.headers
-      { "Authorization": "apikey #{self.apikey}",
-      "Accept": "application/json",
-      "Content-Type": "application/json" }
-    end
+      # Attempts to renew a single item for a user
+      # @param [Hash] args
+      # @option args [String] :user_id The unique id of the user
+      # @option args [String] :loan_id The unique id of the loan
+      # @option args [String] :user_id_type Type of identifier being used to search. OPTIONAL
+      # @return [RenewalResponse] Object indicating the renewal message
+      def self.send_loan_renewal_request(args)
+        loan_id = args.delete(:loan_id) { raise ArgumentError }
+        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(response)
+      end
 
+      # Attempts to renew multiple items for a user
+      # @param [Hash] args
+      # @option args [String] :user_id The unique id of the user
+      # @option args [Array<String>] :loan_ids The unique ids of the loans
+      # @option args [String] :user_id_type Type of identifier being used to search. OPTIONAL
+      # @return [Array<RenewalResponse>] Array of Objects indicating the renewal messages
+      def self.send_multiple_loan_renewal_requests(args)
+        loan_ids = args.delete(:loan_ids) { raise ArgumentError }
+        loan_ids.map { |id| Alma::User.send_loan_renewal_request(args.merge(loan_id: id)) }
+      end
 
-    def headers
-      self.class.headers
-    end
+      def get_body_from(response)
+        JSON.parse(response.body)
+      end
 
 
-    def self.apikey
-      Alma.configuration.apikey
-    end
+      def self.users_base_path
+        "https://api-na.hosted.exlibrisgroup.com/almaws/v1/users"
+      end
 
-    end
+      def users_base_path
+        self.class.users_base_path
+      end
+
+      def headers
+        self.class.headers
+      end
   end
+end

data/lib/alma/user_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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,5 @@
+# frozen_string_literal: true
+
 module Alma
-  VERSION = "0.2.6"
+  VERSION = "0.3.3"
 end

data/lib/alma.rb

@@ -1,27 +1,39 @@
-require 'alma/version'
-require 'alma/config'
-require 'alma/api'
-require 'alma/error'
-require 'alma/alma_record'
-require 'alma/user'
-require 'alma/bib'
-require 'alma/loan'
-require 'alma/result_set'
-require 'alma/loan_set'
-require 'alma/user_set'
-require 'alma/fine_set'
-require 'alma/user_set'
-require 'alma/bib_set'
-require 'alma/request_set'
-require 'alma/renewal_response'
-require 'alma/availability_response'
-require 'alma/bib_item'
-require 'alma/request_options'
+# frozen_string_literal: true
+
+require "alma/version"
+require "alma/config"
+require "alma/api_defaults"
+require "alma/error"
+require "alma/alma_record"
+require "alma/response"
+require "alma/user"
+require "alma/bib"
+require "alma/loan"
+require "alma/result_set"
+require "alma/loan_set"
+require "alma/user_set"
+require "alma/fine_set"
+require "alma/fine"
+require "alma/bib_set"
+require "alma/request_set"
+require "alma/renewal_response"
+require "alma/availability_response"
+require "alma/bib_item"
+require "alma/request_options"
+require "alma/item_request_options"
+require "alma/request"
+require "alma/user_request"
+require "alma/electronic"
+require "alma/bib_holding"
+require "alma/library"
+require "alma/library_set"
+require "alma/location"
+require "alma/location_set"
+require "alma/course_set"
+require "alma/course"
 
 module Alma
+  require "httparty"
 
   ROOT = File.dirname __dir__
-  WADL_DIR = File.join(Alma::ROOT, 'lib','alma','wadl')
-
-
 end

data/log/.gitignore

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

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.3
 platform: ruby
 authors:
+- Jennifer Anton
+- David Kinzer
 - Chad Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ezwadl
@@ -52,34 +54,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,20 +138,96 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rails
+  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: 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:
+- jennifer.anton@temple.edu
+- david.kinzer@temple.edu
 - chad.nelson@temple.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -144,26 +236,43 @@ 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_holding.rb
 - lib/alma/bib_item.rb
 - lib/alma/bib_item_set.rb
 - lib/alma/bib_set.rb
 - lib/alma/config.rb
+- lib/alma/course.rb
+- lib/alma/course_set.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/library.rb
+- lib/alma/library_set.rb
 - lib/alma/loan.rb
 - lib/alma/loan_set.rb
+- lib/alma/location.rb
+- lib/alma/location_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
@@ -183,8 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Client for Ex Libris Alma Web Services

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.13.7

data/lib/alma/api.rb

@@ -1,33 +0,0 @@
-require 'ezwadl'
-
-module Alma
-  module Api
-
-
-    def default_params
-      { :query => { :apikey => Alma.configuration.apikey } }
-    end
-
-    def query_merge(hash)
-      {:query => default_params[:query].merge(hash)}
-    end
-
-    def resources
-      @resources ||= load_wadl
-    end
-
-    def load_wadl(wadl_filename = nil)
-      wadl_filename ||= set_wadl_filename
-      parsed_wadl = EzWadl::Parser.parse(File.join(Alma::WADL_DIR, wadl_filename)) do |rs|
-        rs.first.path = Alma.configuration.region
-      end
-      parsed_wadl.first
-    end
-
-    def set_wadl_filename
-      # Each class including this module should define this
-      raise NotImplementedError 'You must define the wadl_filename method'
-    end
-
-  end
-end