alma 0.3.1 → 0.3.2

data/lib/alma/library.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Alma
+  class Library < AlmaRecord
+    extend Alma::ApiDefaults
+
+    def self.all(args: {})
+      response = HTTParty.get("#{configuration_base_path}/libraries", query: args, headers: headers, timeout: timeout)
+      if response.code == 200
+        LibrarySet.new(response)
+      else
+        raise StandardError, get_body_from(response)
+      end
+    end
+
+    def self.find(library_code:, args: {})
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}", query: args, headers: headers, timeout: timeout)
+      if response.code == 200
+        AlmaRecord.new(response)
+      else
+        raise StandardError, get_body_from(response)
+      end
+    end
+
+    def self.get_body_from(response)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/alma/library_set.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Alma
+  class LibrarySet < ResultSet
+    def_delegators :results, :[], :empty?
+
+    def each(&block)
+      results.each(&block)
+    end
+
+    def results
+      @results ||= @response.fetch(key, [])
+         .map { |item| single_record_class.new(item) }
+    end
+
+    protected
+      def key
+        "library"
+      end
+  end
+end

data/lib/alma/loan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alma
   class Loan < AlmaRecord
     extend Alma::ApiDefaults
@@ -16,10 +18,10 @@ module Alma
     end
 
     def renew
-      Alma::User.renew_loan({user_id: user_id, loan_id: loan_id})
+      Alma::User.renew_loan({ user_id: user_id, loan_id: loan_id })
     end
 
-    def self.where_user(user_id, args={})
+    def self.where_user(user_id, args = {})
       # Always expand renewable unless you really don't want to
       args[:expand] ||= "renewable"
       # Default to upper limit

data/lib/alma/loan_set.rb

@@ -11,7 +11,7 @@ module Alma
     attr_reader :results, :raw_response
     def_delegators :results, :empty?
 
-    def initialize(raw_response, search_args={})
+    def initialize(raw_response, search_args = {})
       @raw_response = raw_response
       @response = raw_response.parsed_response
       @search_args = search_args
@@ -40,7 +40,7 @@ module Alma
       Enumerator.new do |yielder|
         offset = 0
         loop do
-          extra_args = @search_args.merge({limit: 100, offset: offset})
+          extra_args = @search_args.merge({ limit: 100, offset: offset })
           r = (offset == 0) ? self : single_record_class.where_user(user_id, extra_args)
           unless r.empty?
             r.map { |item| yielder << item }
@@ -53,7 +53,7 @@ module Alma
     end
 
     def each(&block)
-       @results.each(&block)
+      @results.each(&block)
     end
 
     def success?

data/lib/alma/location.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Alma
+  class Location < AlmaRecord
+    extend Alma::ApiDefaults
+
+    def self.all(library_code:, args: {})
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations", query: args, headers: headers, timeout: timeout)
+      if response.code == 200
+        LocationSet.new(response)
+      else
+        raise StandardError, get_body_from(response)
+      end
+    end
+
+    def self.find(library_code:, location_code:, args: {})
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations/#{location_code}", query: args, headers: headers, timeout: timeout)
+      if response.code == 200
+        AlmaRecord.new(response)
+      else
+        raise StandardError, get_body_from(response)
+      end
+    end
+
+    def self.get_body_from(response)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/alma/location_set.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Alma
+  class LocationSet < ResultSet
+    def_delegators :results, :[], :empty?
+
+    def each(&block)
+      results.each(&block)
+    end
+
+    def results
+      @results ||= @response.fetch(key, [])
+        .map { |item| single_record_class.new(item) }
+    end
+
+    protected
+      def key
+        "location"
+      end
+  end
+end

data/lib/alma/renewal_response.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Alma
   class RenewalResponse
-
     def initialize(response)
       @raw_response = response
       @response = response.parsed_response
-      @success  = response.has_key?('loan_id')
+      @success  = response.has_key?("loan_id")
     end
 
     def loggable
@@ -21,19 +22,19 @@ module Alma
     end
 
     def due_date
-      @response.fetch('due_date', '')
+      @response.fetch("due_date", "")
     end
 
 
     def due_date_pretty
-      Time.parse(due_date).strftime('%m-%e-%y %H:%M')
+      Time.parse(due_date).strftime("%m-%e-%y %H:%M")
     end
 
     def item_title
       if renewed?
-        @response['title']
+        @response["title"]
       else
-        'This Item'
+        "This Item"
       end
     end
 
@@ -46,8 +47,7 @@ module Alma
     end
 
     def error_message
-        @response unless renewed?
+      @response unless renewed?
     end
-
   end
 end

data/lib/alma/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alma
   class BibRequest
     class  ItemAlreadyExists < Alma::StandardError
@@ -11,11 +13,11 @@ module Alma
       request = new(args)
       response = HTTParty.post(
         "#{bibs_base_path}/#{request.mms_id}/requests",
-        query: {user_id: request.user_id},
+        query: { user_id: request.user_id },
         headers: headers,
         body: request.body.to_json
         )
-        Alma::Response.new(response)
+      Alma::Response.new(response)
     end
 
     attr_reader :mms_id, :user_id, :body, :request_type
@@ -69,18 +71,18 @@ module Alma
     def digitization_validation(args)
       args.fetch(:target_destination) do
         raise ArgumentError.new(
-        ":target_destination option must be specified when request_type is DIGITIZATION"
+          ":target_destination option must be specified when request_type is DIGITIZATION"
         )
       end
       pd = args.fetch(:partial_digitization) do
         raise ArgumentError.new(
-        ":partial_digitization option must be specified when request_type is DIGITIZATION"
+          ":partial_digitization option must be specified when request_type is DIGITIZATION"
         )
       end
       if pd == true
         args.fetch(:comment) do
           raise ArgumentError.new(
-          ":comment option must be specified when :request_type is DIGITIZATION and :partial_digitization is true"
+            ":comment option must be specified when :request_type is DIGITIZATION and :partial_digitization is true"
           )
         end
       end
@@ -95,22 +97,22 @@ module Alma
     def booking_validation(args)
       args.fetch(:booking_start_date) do
         raise ArgumentError.new(
-        ":booking_start_date option must be specified when request_type is BOOKING"
+          ":booking_start_date option must be specified when request_type is BOOKING"
         )
       end
       args.fetch(:booking_end_date) do
         raise ArgumentError.new(
-        ":booking_end_date option must be specified when request_type is BOOKING"
+          ":booking_end_date option must be specified when request_type is BOOKING"
         )
       end
       args.fetch(:pickup_location_type) do
         raise ArgumentError.new(
-        ":pickup_location_type option must be specified when request_type is BOOKING"
+          ":pickup_location_type option must be specified when request_type is BOOKING"
         )
       end
       args.fetch(:pickup_location_library) do
         raise ArgumentError.new(
-        ":pickup_location_library option must be specified when request_type is BOOKING"
+          ":pickup_location_library option must be specified when request_type is BOOKING"
         )
       end
     end
@@ -124,12 +126,12 @@ module Alma
     def hold_validation(args)
       args.fetch(:pickup_location_type) do
         raise ArgumentError.new(
-        ":pickup_location_type option must be specified when request_type is HOLD"
+          ":pickup_location_type option must be specified when request_type is HOLD"
         )
       end
       args.fetch(:pickup_location_library) do
         raise ArgumentError.new(
-        ":pickup_location_library option must be specified when request_type is HOLD"
+          ":pickup_location_library option must be specified when request_type is HOLD"
         )
       end
     end
@@ -140,11 +142,11 @@ module Alma
       request = new(args)
       response = HTTParty.post(
         "#{bibs_base_path}/#{request.mms_id}/holdings/#{request.holding_id}/items/#{request.item_pid}/requests",
-        query: {user_id: request.user_id},
+        query: { user_id: request.user_id },
         headers: headers,
         body: request.body.to_json
         )
-        Alma::Response.new(response)
+      Alma::Response.new(response)
     end
 
     attr_reader :holding_id, :item_pid
@@ -157,7 +159,7 @@ module Alma
     def additional_validation!(args)
       args.fetch(:description) do
         raise ArgumentError.new(
-        ":description option must be specified when request_type is DIGITIZATION"
+          ":description option must be specified when request_type is DIGITIZATION"
         )
       end
     end

data/lib/alma/request_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alma
   class RequestOptions
     class ResponseError < Alma::StandardError
@@ -18,9 +20,9 @@ module Alma
     end
 
 
-    def self.get(mms_id, options={})
+    def self.get(mms_id, options = {})
       url = "#{bibs_base_path}/#{mms_id}/request-options"
-      options.select! {|k,_|  REQUEST_OPTIONS_PERMITTED_ARGS.include? k }
+      options.select! { |k, _|  REQUEST_OPTIONS_PERMITTED_ARGS.include? k }
       response = HTTParty.get(url, headers: headers, query: options, timeout: timeout)
       new(response)
     end
@@ -38,26 +40,26 @@ module Alma
 
     def hold_allowed?
       !request_options.nil? &&
-        !request_options.select {|option| option["type"]["value"] == "HOLD" }.empty?
+        !request_options.select { |option| option["type"]["value"] == "HOLD" }.empty?
     end
 
     def digitization_allowed?
       !request_options.nil? &&
-        !request_options.select {|option| option["type"]["value"] == "DIGITIZATION" }.empty?
+        !request_options.select { |option| option["type"]["value"] == "DIGITIZATION" }.empty?
     end
 
     def booking_allowed?
       !request_options.nil? &&
-        !request_options.select {|option| option["type"]["value"] == "BOOKING" }.empty?
+        !request_options.select { |option| option["type"]["value"] == "BOOKING" }.empty?
     end
 
     def resource_sharing_broker_allowed?
       !request_options.nil? &&
-        !request_options.select {|option| option["type"]["value"] == "RS_BROKER" }.empty?
+        !request_options.select { |option| option["type"]["value"] == "RS_BROKER" }.empty?
     end
 
     def ez_borrow_link
-      broker = request_options.select {|option| option["type"]["value"] == "RS_BROKER" }
+      broker = request_options.select { |option| option["type"]["value"] == "RS_BROKER" }
       broker.collect { |opt| opt["request_url"] }.first
     end
   end

data/lib/alma/request_set.rb

@@ -35,7 +35,7 @@ module Alma
       Enumerator.new do |yielder|
         offset = 0
         loop do
-          r = (offset == 0) ? self : single_record_class.where_user(user_id, {limit: 100, offset: offset})
+          r = (offset == 0) ? self : single_record_class.where_user(user_id, { limit: 100, offset: offset })
           unless r.empty?
             r.map { |item| yielder << item }
             offset += 100

data/lib/alma/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alma
   class  User
     class ResponseError < Alma::StandardError
@@ -5,24 +7,24 @@ module Alma
     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, args = {})
+      args[:expand] ||= "fees,requests,loans"
+      response = HTTParty.get("#{self.users_base_path}/#{user_id}", query: args, headers: headers, timeout: timeout)
 
-        Alma::User.new response
-      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
+    # 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
@@ -52,19 +54,19 @@ module Alma
     end
 
     def id
-      self['primary_id']
+      self["primary_id"]
     end
 
     def total_fines
-      response.dig('fees','value') || "0"
+      response.dig("fees", "value") || "0"
     end
 
     def total_requests
-      response.dig('requests','value') || "0"
+      response.dig("requests", "value") || "0"
     end
 
     def total_loans
-      response.dig('loans','value') || "0"
+      response.dig("loans", "value") || "0"
     end
 
 
@@ -95,12 +97,12 @@ module Alma
     end
 
 
-    def loans(args={})
-        @loans ||= Alma::Loan.where_user(id, args)
+    def loans(args = {})
+      @loans ||= Alma::Loan.where_user(id, args)
     end
 
     def renew_loan(loan_id)
-      response = self.class.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
@@ -130,7 +132,7 @@ module Alma
 
     def preferred_middle_name
       pref_middle = self["pref_middle_name"] unless self["pref_middle_name"] == ""
-      pref_middle  || self["middle_name"] || ""
+      pref_middle || self["middle_name"] || ""
     end
 
     def preferred_last_name
@@ -150,46 +152,46 @@ module Alma
 
     private
 
-    # 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 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
+      # 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 get_body_from(response)
-      JSON.parse(response.body)
-    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
+      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
+      def users_base_path
+        self.class.users_base_path
+      end
 
-    def headers
-      self.class.headers
-    end
+      def headers
+        self.class.headers
+      end
   end
 end