alma 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 210d45982a6c339d9b8c170a73077be4f56bcf4eaa989debe95d2f9d97897c0e
-  data.tar.gz: 1b988140c47bc0974e617cc1131aee0b82dfbcd50ce20d408fbd2a969cf180c7
+  metadata.gz: 55ea295ada19c46e1c3c157ded8cdf0997d62e744913b513a288c45f2239cdce
+  data.tar.gz: 213034074451c8d5388abdf9a6ee6385b56432adab463fa3e9a5d39b8e3dd953
 SHA512:
-  metadata.gz: 1667314072be96beb05c3f389c5240142ff5e0f44be0eed44d2240653ad4dd38f07a221b2ab3235921e37e7620e4518128e1b8806880daadffc9f570bbccd773
-  data.tar.gz: b98783202cf24c6a33c0c249f70d9f55a715b611c89a3249d4cf14a1352f2dca476123315649f9d3f624b1533fa0547d285605af309cfab8c537a1b6d81db85b
+  metadata.gz: 3c9d95eb4c80778b3d132ed790a7a615c775a7c650e38936cc588782efabaa1a2e393b39ef94ea90acecee05e514c625b0bace832cbbf6aa9e885ecff77c32bf
+  data.tar.gz: 55060edf008d1ee5c78a5d598daaa03666b3a423960e03fdea668aa7976e839b31385d1f4d2577f945cd4a66d1f40f6a20ca7fd19e0883fb5ced62a8c0fca420

data/lib/alma/bib_item_set.rb

@@ -21,7 +21,8 @@ module Alma
       @mms_id = @options.delete(:mms_id)
 
       validate(response)
-      @items = parsed.fetch(key, []).map { |item| single_record_class.new(item) }
+      @items = (parsed.fetch(key, []) || [])
+        .map { |item| single_record_class.new(item) }
     end
 
     def loggable

data/lib/alma/error.rb

@@ -10,7 +10,7 @@ module Alma::Error
   end
 
   def error
-    @response.fetch("web_service_result", {})
+    @response.fetch("web_service_result", {}) || {}
   end
 end
 

data/lib/alma/fine_set.rb

@@ -12,7 +12,7 @@ module Alma
       @raw_response = raw_response
       @response = raw_response.parsed_response
       validate(raw_response)
-      @results = @response.fetch(key, [])
+      @results = (@response.fetch(key, []) || [])
         .map { |item| single_record_class.new(item) }
     end
 

data/lib/alma/library_set.rb

@@ -9,7 +9,7 @@ module Alma
     end
 
     def results
-      @results ||= @response.fetch(key, [])
+      @results ||= (@response.fetch(key, []) || [])
          .map { |item| single_record_class.new(item) }
     end
 

data/lib/alma/loan_set.rb

@@ -16,8 +16,8 @@ module Alma
       @response = raw_response.parsed_response
       @search_args = search_args
       validate(raw_response)
-      @results = @response.fetch(key, [])
-        .map { |item| single_record_class.new(item) }
+      @results = @response.fetch(key, []) || []
+      @results.map! { |item| single_record_class.new(item) }
       # args passed to the search that returned this set
       # such as limit, expand, order_by, etc
     end

data/lib/alma/payment_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Alma
+  class PaymentResponse
+    def initialize(response)
+      @raw_response = response
+      @response = response.parsed_response
+      @success  = response["total_sum"] == 0.0
+    end
+
+    def loggable
+      { uri: @raw_response&.request&.uri.to_s
+      }.select { |k, v| !(v.nil? || v.empty?) }
+    end
+
+    def paid?
+      @success
+    end
+
+    def has_payment_error?
+      !paid?
+    end
+
+    def payment_message
+      if paid?
+        "Your balance has been paid."
+      else
+        "There was a problem processing your payment. Please contact the library for assistance."
+      end
+    end
+
+    def error_message
+      @response unless paid?
+    end
+  end
+end

data/lib/alma/request_set.rb

@@ -14,8 +14,8 @@ module Alma
       @raw_response = raw_response
       @response = raw_response.parsed_response
       validate(raw_response)
-      @results = @response.fetch(key, [])
-                   .map { |item| single_record_class.new(item) }
+      @results = @response.fetch(key, []) || []
+      @results.map! { |item| single_record_class.new(item) }
     end
 
     def loggable

data/lib/alma/result_set.rb

@@ -22,7 +22,7 @@ class Alma::ResultSet
   end
 
   def each
-    @results ||= @response.fetch(key, [])
+    @results ||= (@response.fetch(key, []) || [])
       .map { |item| single_record_class.new(item) }
   end
 

data/lib/alma/user.rb

@@ -26,7 +26,6 @@ module Alma
       response.code == 204
     end
 
-
     # The User object can respond directly to Hash like access of attributes
     def_delegators :response, :[], :[]=, :has_key?, :keys, :to_json
 
@@ -58,7 +57,7 @@ module Alma
     end
 
     def total_fines
-      response.dig("fees", "value") || "0"
+      response.dig("fees", "value") || 0.0
     end
 
     def total_requests
@@ -69,7 +68,6 @@ module Alma
       response.dig("loans", "value") || "0"
     end
 
-
     # Access the top level JSON attributes as object methods
     def method_missing(name)
       return response[name.to_s] if has_key?(name.to_s)
@@ -80,14 +78,12 @@ module Alma
       has_key?(name.to_s) || super
     end
 
-
     # Persist the user in it's current state back to Alma
     def save!
       response = HTTParty.put("#{users_base_path}/#{id}", timeout: timeout, headers: headers, body: to_json)
       get_body_from(response)
     end
 
-
     def fines
       Alma::Fine.where_user(id)
     end
@@ -96,7 +92,6 @@ module Alma
       Alma::UserRequest.where_user(id)
     end
 
-
     def loans(args = {})
       @loans ||= Alma::Loan.where_user(id, args)
     end
@@ -108,7 +103,6 @@ module Alma
       end
     end
 
-
     def renew_multiple_loans(loan_ids)
       loan_ids.map { |id| renew_loan(id) }
     end
@@ -148,8 +142,6 @@ module Alma
       "#{preferred_first_name} #{preferred_middle_name} #{preferred_last_name} #{preferred_suffix}"
     end
 
-
-
     private
 
       # Attempts to renew a single item for a user
@@ -177,11 +169,20 @@ module Alma
         loan_ids.map { |id| Alma::User.send_loan_renewal_request(args.merge(loan_id: id)) }
       end
 
+      # Attempts to pay total fines for a user
+      # @param [Hash] args
+      # @option args [String] :user_id The unique id of the user
+      def self.send_payment(args)
+        user_id = args.delete(:user_id) { raise ArgumentError }
+        params = { op: "pay", amount: "ALL", method: "ONLINE" }
+        response = HTTParty.post("#{users_base_path}/#{user_id}/fees/all", query: params, headers: headers)
+        PaymentResponse.new(response)
+      end
+
       def get_body_from(response)
         JSON.parse(response.body)
       end
 
-
       def self.users_base_path
         "https://api-na.hosted.exlibrisgroup.com/almaws/v1/users"
       end

data/lib/alma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alma
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/alma.rb

@@ -17,6 +17,7 @@ require "alma/fine"
 require "alma/bib_set"
 require "alma/request_set"
 require "alma/renewal_response"
+require "alma/payment_response"
 require "alma/availability_response"
 require "alma/bib_item"
 require "alma/request_options"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Jennifer Anton
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ezwadl
@@ -260,6 +260,7 @@ files:
 - lib/alma/loan_set.rb
 - lib/alma/location.rb
 - lib/alma/location_set.rb
+- lib/alma/payment_response.rb
 - lib/alma/renewal_response.rb
 - lib/alma/request.rb
 - lib/alma/request_options.rb