alma 0.2.4 → 0.3.2

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/alma.gemspec

@@ -1,16 +1,18 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'alma/version'
+require "alma/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "alma"
   spec.version       = Alma::VERSION
-  spec.authors       = ["Chad Nelson"]
-  spec.email         = ["chad.nelson@temple.edu"]
+  spec.authors       = ["Jennifer Anton", "David Kinzer", "Chad Nelson"]
+  spec.email         = ["jennifer.anton@temple.edu", "david.kinzer@temple.edu", "chad.nelson@temple.edu"]
 
-  spec.summary       = %q{Client for Ex Libris Alma Web Services}
-  spec.description   = %q{Client for Ex Libris Alma Web Services}
+  spec.summary       = "Client for Ex Libris Alma Web Services"
+  spec.description   = "Client for Ex Libris Alma Web Services"
   spec.homepage      = "https://github.com/tulibraries/alma_rb"
   spec.license       = "MIT"
 
@@ -21,12 +23,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'ezwadl'
-
+  spec.add_dependency "ezwadl"
+  spec.add_dependency "httparty"
+  spec.add_dependency "xml-simple"
+  spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
 end

data/lib/alma.rb

@@ -1,59 +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'
+# 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')
-
-  INVENTORY_TO_SUBFIELD_TO_FIELDNAME =
-   {
-      'AVA' => {
-          'INVENTORY_TYPE' => 'physical',
-          'a' => 'institution',
-          'b' => 'library_code',
-          'c' => 'location',
-          'd' => 'call_number',
-          'e' => 'availability',
-          'f' => 'total_items',
-          'g' => 'non_available_items',
-          'j' => 'location_code',
-          'k' => 'call_number_type',
-          'p' => 'priority',
-          'q' => 'library',
-      },
-      'AVD' => {
-          'INVENTORY_TYPE' => 'digital',
-          'a' => 'institution',
-          'b' => 'representations_id',
-          'c' => 'representation',
-          'd' => 'repository_name',
-          'e' => 'label',
-      },
-      'AVE' => {
-          'INVENTORY_TYPE' => 'electronic',
-          'l' => 'library_code',
-          'm' => 'collection',
-          'n' => 'public_note',
-          's' => 'coverage_statement',
-          't' => 'interface_name',
-          'u' => 'link_to_service_page',
-      }
-  }
-
 end

data/lib/alma/alma_record.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Alma
   class AlmaRecord
-
     def initialize(record)
       @raw_record = record
       post_initialize()
@@ -23,6 +24,5 @@ module Alma
       # Subclasses can define this method to perform extra initialization
       # after the super class init.
     end
-
   end
-end
+end

data/lib/alma/api_defaults.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Alma
+  module ApiDefaults
+    def apikey
+      Alma.configuration.apikey
+    end
+
+    def region
+      Alma.configuration.region
+    end
+
+    def headers
+      { "Authorization": "apikey #{self.apikey}",
+      "Accept": "application/json",
+      "Content-Type": "application/json" }
+    end
+
+    def bibs_base_path
+      "#{self.region}/almaws/v1/bibs"
+    end
+
+    def users_base_path
+      "#{self.region}/almaws/v1/users"
+    end
+
+    def items_base_path
+      "#{self.region}/almaws/v1/items"
+    end
+
+    def configuration_base_path
+      "#{self.region}/almaws/v1/conf"
+    end
+
+    def timeout
+      Alma.configuration.timeout
+    end
+  end
+end

data/lib/alma/availability_response.rb

@@ -1,50 +1,88 @@
-module Alma
-  class AvailabilityResponse
+# frozen_string_literal: true
 
+require "xmlsimple"
 
+module Alma
+  class AvailabilityResponse
     attr_accessor :availability
 
     def initialize(response)
-      @availability = parse_bibs_data(response.list)
-
+      @availability = parse_bibs_data(response.each)
     end
 
+    # Data structure for holdings information of bib records.
+    # A hash with mms ids as keys, with values of an array of
+    # one or more hashes of holdings info
     def parse_bibs_data(bibs)
-
-      bibs.map do |bib|
-        record = Hash.new
-
-        record['mms_id'] = bib.id
-        record['holdings'] = build_holdings_for(bib)
-
-        record
-      end.reduce(Hash.new) do |acc, avail|
-        acc[avail['mms_id']] = avail.select { |k, v| k != 'mms_id' }
-        acc
-      end
+      bibs.reduce(Hash.new) { |acc, bib|
+        acc.merge({ "#{bib.id}" => { holdings: build_holdings_for(bib) } })
+      }
     end
 
-
     def build_holdings_for(bib)
-
       get_inventory_fields_for(bib).map do |inventory_field|
-        subfield_codes_to_fieldnames = Alma::INVENTORY_TO_SUBFIELD_TO_FIELDNAME[inventory_field['tag']]
-
-        # make sure subfields is always an Array (which isn't the case if there's only one subfield element)
-        subfields = [inventory_field.fetch('subfield', [])].flatten(1)
-
-        holding = subfields.reduce(Hash.new) do |acc, subfield|
-          fieldname = subfield_codes_to_fieldnames[subfield['code']]
-          acc[fieldname] = subfield['__content__']
-          acc
-        end
-        holding['inventory_type'] = subfield_codes_to_fieldnames['INVENTORY_TYPE']
-        holding
+        # Use the mapping for this inventory type
+        subfield_codes = Alma::INVENTORY_SUBFIELD_MAPPING[inventory_field["tag"]]
+
+        inventory_field.
+          # Get all the subfields for this inventory field
+          fetch("subfield", []).
+          # Limit to only subfields codes for which we have a mapping
+          select { |sf| subfield_codes.key? sf["code"] }.
+          # Transform the array of subfields into a hash with mapped code as key
+          reduce(Hash.new) { |acc, subfield|
+             acc.merge({ "#{subfield_codes[subfield['code']]}" => subfield["content"] })
+           }.
+          # Include the inventory type
+          merge({ "inventory_type" => subfield_codes["INVENTORY_TYPE"] })
       end
     end
 
     def get_inventory_fields_for(bib)
-      bib.record.fetch('datafield', []).select { |df| Alma::INVENTORY_TO_SUBFIELD_TO_FIELDNAME.key?(df['tag']) } || []
+      # Return only the datafields with tags AVA, AVD, or AVE
+      bib.record
+        .fetch("datafield", [])
+        .select { |df| Alma::INVENTORY_SUBFIELD_MAPPING.key?(df["tag"]) }
     end
   end
+
+  INVENTORY_SUBFIELD_MAPPING =
+  {
+     "AVA" => {
+         "INVENTORY_TYPE" => "physical",
+         "a" => "institution",
+         "b" => "library_code",
+         "c" => "location",
+         "d" => "call_number",
+         "e" => "availability",
+         "f" => "total_items",
+         "g" => "non_available_items",
+         "j" => "location_code",
+         "k" => "call_number_type",
+         "p" => "priority",
+         "q" => "library",
+         "t" => "holding_info",
+         "8" => "holding_id",
+     },
+     "AVD" => {
+         "INVENTORY_TYPE" => "digital",
+         "a" => "institution",
+         "b" => "representations_id",
+         "c" => "representation",
+         "d" => "repository_name",
+         "e" => "label",
+     },
+     "AVE" => {
+         "INVENTORY_TYPE" => "electronic",
+         "c" => "collection_id",
+         "e" => "activation_status",
+         "l" => "library_code",
+         "m" => "collection",
+         "n" => "public_note",
+         "s" => "coverage_statement",
+         "t" => "interface_name",
+         "u" => "link_to_service_page",
+         "8" => "portfolio_pid",
+     }
+ }
 end

data/lib/alma/bib.rb

@@ -1,46 +1,71 @@
+# frozen_string_literal: true
+
 module Alma
-  class  Bib < AlmaRecord
-    extend Alma::Api
+  class  Bib
+    extend Alma::ApiDefaults
+    extend Forwardable
+
+    def self.find(ids, args)
+      get_bibs(ids, args)
+    end
 
-    attr_accessor :id, :record
+    def self.get_bibs(ids, args = {})
+      response = HTTParty.get(
+        self.bibs_base_path,
+        query: { mms_id: ids_from_array(ids) }.merge(args),
+        headers: headers,
+        timeout: timeout
+        )
 
-    def post_initialize
-      @id = response['mms_id'].to_s
-      @record = response.fetch('record', {})
+      if response.code == 200
+        Alma::BibSet.new(get_body_from(response))
+      else
+        raise StandardError, get_body_from(response)
+      end
     end
 
-    class << self
 
-      def get_availability(ids, args={})
-        args.merge!({expand: 'p_avail,e_avail,d_avail'})
-        bibs = get_bibs(ids, args)
+    def self.get_availability(ids, args = {})
+      args.merge!({ expand: "p_avail,e_avail,d_avail" })
+      bibs = get_bibs(ids, args)
 
-        return bibs if bibs.has_error?
-        Alma::AvailabilityResponse.new(bibs)
-      end
+      Alma::AvailabilityResponse.new(bibs)
+    end
 
-      def find(ids, args)
-        get_bibs(ids, args)
-      end
 
-      def get_bibs(ids, args={})
-        args[:mms_id] = ids_from_array(ids)
-        params = query_merge(args)
-        response = resources.almaws_v1_bibs.get(params)
 
-        Alma::BibSet.new(response)
-      end
+    attr_accessor :id, :response
+
+    # The User object can respond directly to Hash like access of attributes
+    def_delegators :response, :[], :[]=, :has_key?, :keys, :to_json, :each
+
+    def initialize(response_body)
+      @response = response_body
+      @id = @response["mms_id"].to_s
+    end
+
+    # The raw MARCXML record, converted to a Hash
+    def record
+      @record ||= XmlSimple.xml_in(response["anies"].first)
+    end
+
 
       private
 
-      def ids_from_array(ids)
-        ids.map(&:to_s).map(&:strip).join(',')
-      end
+        def bibs_base_path
+          self.class.bibs_base_path
+        end
 
-      def set_wadl_filename
-        'bib.wadl'
-      end
+        def headers
+          self.class.headers
+        end
 
-    end
+        def self.get_body_from(response)
+          JSON.parse(response.body)
+        end
+
+        def self.ids_from_array(ids)
+          ids.map(&:to_s).map(&:strip).join(",")
+        end
   end
 end

data/lib/alma/bib_holding.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Alma
+  class BibHolding
+    extend Alma::ApiDefaults
+    extend Forwardable
+
+    def self.find(mms_id:, holding_id:)
+      url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}"
+      response = HTTParty.get(url, headers: headers, timeout: timeout)
+      new(response)
+    end
+
+    attr_reader :holding
+    def_delegators :holding, :[], :[]=, :has_key?, :keys, :to_json, :each
+
+    def initialize(holding)
+      @holding = holding
+    end
+
+    def holding_id
+      holding["holding_id"]
+    end
+  end
+end