alma 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3bcedc3a4e5136aa43268412c062c91dc2d905dd
-  data.tar.gz: 37f3892ff4a0fc27e8c6a79a540ea52f0f5199d4
+SHA256:
+  metadata.gz: 9f8f97556fd38ab3e4b03c42ee739d1a8a878f997e1d2ee54fb5dd5017b3cd51
+  data.tar.gz: 1e5d6362f38d31fe538afe713b9b5ec87469f0364ddfde258e29a1c3b076cf88
 SHA512:
-  metadata.gz: 120bef80c621c53709475f2c54dd2a7b3379fe307ac0f1227adb1f0a8627e064ea19f87260432a5a45ad65d342623fbc314e5079aea7fae930a0ac719bbf5f7c
-  data.tar.gz: 2e190810b76aa0b0041b021364d5879cff6a6122ee9f0c17be212cc69bb1d1c2af63059c801752754f6b711ec4e948777d2a1285ef428b1838a7ce1c6fc5eb80
+  metadata.gz: 2e9e26c6789cf81b7d8390c56a42f6c422dffda52befa4b629873bfa7edc0a7974c20ed51c485f861809743e9fa9db988af4d4cbe4f63ee8b15b4371ee27f38c
+  data.tar.gz: ad6e0abc8e573bb1c02b34047eab1847e21ca858c6baa385b969c1faf45033151679201543f13ddc74d696035e234387e75eba7bfe4e046ff60231fc1e795b3b

data/.travis.yml

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

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in alma.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test
+

data/lib/alma.rb

@@ -15,7 +15,8 @@ require 'alma/bib_set'
 require 'alma/request_set'
 require 'alma/renewal_response'
 require 'alma/availability_response'
-require 'alma/bib_items'
+require 'alma/bib_item'
+require 'alma/request_options'
 
 module Alma
 

data/lib/alma/bib_item.rb

@@ -0,0 +1,174 @@
+require 'alma/bib_item_set'
+module Alma
+  class BibItem
+    extend Forwardable
+
+    attr_reader :item
+    def_delegators :item, :[], :has_key?, :keys, :to_json
+
+    PERMITTED_ARGS  = [
+      :limit, :offset, :expand, :user_id, :current_library,
+      :current_location, :q, :order_by, :direction
+    ]
+
+    def self.find(mms_id, options={})
+      holding_id = options.delete(:holding_id) || "ALL"
+      options.select! {|k,_| PERMITTED_ARGS.include? k }
+      url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items"
+      response = HTTParty.get(url, headers: headers, query: options)
+      BibItemSet.new(response)
+    end
+
+    def initialize(item)
+      @item = item
+    end
+
+    def holding_data
+      @item.fetch("holding_data", {})
+    end
+
+    def item_data
+      @item.fetch("item_data", {})
+    end
+
+    def in_temp_location?
+      holding_data.fetch("in_temp_location", false)
+    end
+
+    def library
+      in_temp_location? ? temp_library : holding_library
+    end
+
+    def library_name
+      in_temp_location? ? temp_library_name : holding_library_name
+    end
+
+    def location
+      in_temp_location? ? temp_location : holding_location
+    end
+
+    def location_name
+      in_temp_location? ? temp_location_name : holding_location_name
+    end
+
+
+    def holding_library
+      item_data.dig("library", "value")
+    end
+
+    def holding_library_name
+      item_data.dig("library", "desc")
+    end
+
+    def holding_location
+      item_data.dig("location", "value")
+    end
+
+    def holding_location_name
+      item_data.dig("location", "desc")
+    end
+
+    def temp_library
+      holding_data.dig("temp_library", "value")
+    end
+
+    def temp_library_name
+      holding_data.dig("temp_library", "desc")
+    end
+
+    def temp_location
+      holding_data.dig("temp_location", "value")
+    end
+
+    def temp_location_name
+      holding_data.dig("temp_location", "desc")
+    end
+
+    def temp_call_number
+      holding_data.fetch("temp_call_number","")
+    end
+
+    def has_temp_call_number?
+      !temp_call_number.empty?
+    end
+
+    def call_number
+        if has_temp_call_number?
+          holding_data.fetch("temp_call_number")
+        elsif has_alt_call_number?
+          alt_call_number
+        else
+          holding_data.fetch("call_number","")
+        end
+    end
+
+    def has_alt_call_number?
+      !alt_call_number.empty?
+    end
+
+    def alt_call_number
+      item_data.fetch("alternative_call_number","")
+    end
+
+    def has_process_type?
+      !process_type.empty?
+    end
+
+    def process_type
+      item_data.dig("process_type", "value") || ""
+    end
+
+    def missing_or_lost?
+      !!process_type.match(/MISSING|LOST_LOAN/)
+    end
+
+    def base_status
+      item_data.dig("base_status","value")|| ""
+    end
+
+    def in_place?
+      base_status == "1"
+    end
+
+    def circulation_policy
+      item_data.dig("policy", "desc") || ""
+    end
+
+    def non_circulating?
+      circulation_policy.include?("Non-circulating")
+    end
+
+    def description
+      item_data.fetch("description", "")
+    end
+
+    def physical_material_type
+      item_data.fetch("physical_material_type", "")
+    end
+
+    def public_note
+      item_data.fetch("public_note", "")
+    end
+
+    private
+
+    def self.region
+      Alma.configuration.region
+    end
+
+    def self.bibs_base_path
+      "#{region}/almaws/v1/bibs"
+    end
+
+    def self.headers
+      { "Authorization": "apikey #{apikey}",
+       "Accept": "application/json",
+       "Content-Type": "application/json" }
+    end
+
+    def self.apikey
+      Alma.configuration.apikey
+    end
+  end
+
+end

data/lib/alma/bib_item_set.rb

@@ -0,0 +1,33 @@
+module Alma
+  class BibItemSet
+    extend Forwardable
+
+    # Let BibItemSet respond to the Enumerable duck type
+    # by delegating responsibility for #each to items
+    include Enumerable
+    attr_accessor :items
+    def_delegators :items, :each
+
+    def_delegators :items,:[], :[]=, :empty?, :size
+
+    attr_reader :raw_response, :total_record_count
+    def_delegators :raw_response, :response, :request
+
+    def initialize(response)
+      @raw_response = response
+      parsed = JSON.parse(response.body)
+      @total_record_count = parsed["total_record_count"]
+      @items = parsed.fetch("item",[]).map {|item| BibItem.new(item)}
+    end
+
+    def grouped_by_library
+      group_by(&:library)
+    end
+
+    def filter_missing_and_lost
+      clone = dup
+      clone.items = reject(&:missing_or_lost?)
+      clone
+    end
+  end
+end

data/lib/alma/{bib_items.rb → request_options.rb}

@@ -1,31 +1,28 @@
 module Alma
-  class BibItems
+  class RequestOptions
     extend Forwardable
 
-    attr_accessor :items
-    def_delegators :items, :[], :[]=, :has_key?, :keys, :to_json
-
-    attr_reader :raw_response
+    attr_accessor :request_options, :raw_response
     def_delegators :raw_response, :response, :request
 
+    REQUEST_OPTIONS_PERMITTED_ARGS = [:user_id]
+
     def initialize(response)
       @raw_response = response
-      @items = JSON.parse(response.body)
+      @request_options = JSON.parse(response.body)["request_option"]
     end
 
-    PERMITTED_ARGS  = [
-      :limit, :offset, :expand, :user_id, :current_library,
-      :current_location, :q, :order_by, :direction
-    ]
-
-    def self.find(mms_id, options={})
-      holding_id = options.delete(:holding_id) || "ALL"
-      options.select! {|k,_| PERMITTED_ARGS.include? k }
-      url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items"
+    def self.get(mms_id, options={})
+      url = "#{bibs_base_path}/#{mms_id}/request-options"
+      options.select! {|k,_|  REQUEST_OPTIONS_PERMITTED_ARGS.include? k }
       response = HTTParty.get(url, headers: headers, query: options)
       new(response)
     end
 
+    def hold_allowed?
+      !request_options.select {|option| option["type"]["value"] == "HOLD" }.empty?
+    end
+
     private
 
     def self.region
@@ -45,5 +42,6 @@ module Alma
     def self.apikey
       Alma.configuration.apikey
     end
+
   end
 end

data/lib/alma/user.rb

@@ -77,9 +77,9 @@ module Alma
     end
 
 
-    def loans
+    def loans(args={})
       unless @loans && !recheck_loans?
-        @loans = send_loans_request
+        @loans = send_loans_request(args)
         @recheck_loans = false
       end
       @loans
@@ -121,11 +121,12 @@ module Alma
 
     private
 
-    def send_loans_request
-      #TODO Handle Additional Parameters
-      #TODO Handle Pagination
+    def send_loans_request(args={})
       #TODO Handle looping through all results
-      response = HTTParty.get("#{users_base_path}/#{id}/loans", headers: headers)
+
+      # 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))
     end
 

data/lib/alma/version.rb

@@ -1,3 +1,3 @@
 module Alma
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Chad Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ezwadl
@@ -147,7 +147,8 @@ files:
 - lib/alma/api.rb
 - lib/alma/availability_response.rb
 - lib/alma/bib.rb
-- lib/alma/bib_items.rb
+- lib/alma/bib_item.rb
+- lib/alma/bib_item_set.rb
 - lib/alma/bib_set.rb
 - lib/alma/config.rb
 - lib/alma/error.rb
@@ -155,6 +156,7 @@ files:
 - lib/alma/loan.rb
 - lib/alma/loan_set.rb
 - lib/alma/renewal_response.rb
+- lib/alma/request_options.rb
 - lib/alma/request_set.rb
 - lib/alma/result_set.rb
 - lib/alma/user.rb
@@ -182,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Client for Ex Libris Alma Web Services