alma 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed295d076116c3da468f65bfb17ba476b171e60565adddec420a2328f9b88fa6
-  data.tar.gz: 146c04496209f27833a0d0881e5f21a2fe7d55c9aa2886e5c2833efd05a80fc1
+  metadata.gz: f162f9bb1a3b0eee2af44a379b1d094141b6cc9c06767d17acb39d909eb27ed1
+  data.tar.gz: 98eb300d6c0ab62ae07790fa64449c65839f89bd3903b3c0e010e911bf4d3ce0
 SHA512:
-  metadata.gz: bd111915aa21143de049c78f1ccd51f91db677b228c304ffddbd8820349e10525aec2a7fd7b423ab6cab8154b8322ab899a7472c84b09c0518ea28cc1d6ad0c9
-  data.tar.gz: fdc24540723c168bfd8779a53dc233e353b564ab1a6f6eeaa7b053675a18aecfc28f1a324a905281dc0e8d9efe998d0167d3012164889ab9c9169d3fd5952d31
+  metadata.gz: bff5a50e3f546962f71c3ce2fbfe2ed553b63fc4698df62b1ce2828e53c86c62c018716a476005759ed8b94102d371911e9b3ef69f6b03752b96fe85bcbf7f97
+  data.tar.gz: 8159b943d247e6bd34f3efcd09325191806ca26471252d39d3f54be4182a5b45bc875b2eb7c5bc432b492b70e932cbac8c12054ba0b64883ac14e974933c215f

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+workflows:
+  version: 2
+  test-deploy:
+    jobs:
+      - build
+      - deploy:
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/
+
+jobs:
+  build:
+    docker:
+      - image: cimg/ruby:2.7.2-node
+        auth:
+          username: $DOCKERHUB_USER
+          password: $DOCKERHUB_PASSWORD
+
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: lint
+          command: bundle exec rubocop
+      - run:
+          name: test
+          command: bundle exec rake
+  deploy:
+    docker:
+      - image: circleci/ruby:2.7.2-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      - run:
+          name: Publish to Rubygems
+          command: |
+            gem build alma.gemspec
+            gem push "$(ls alma-*.gem)"

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $ALMA_RUBYGEMS" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history
+.DS_Store
+spec/.DS_Store

data/.rubocop.yml

@@ -0,0 +1,134 @@
+require:
+  - rubocop-rails
+
+AllCops:
+  TargetRubyVersion: 2.7
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - 'node_modules/**/*'
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+    - 'bin/*'
+    - 'solr/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'app/models/traject_indexer.rb'
+    - 'db/schema.rb'
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.5
+ruby-2.7.2

data/Gemfile

@@ -1,7 +1,8 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in alma.gemspec
 gemspec
 
-gem 'simplecov', require: false, group: :test
-
+gem "simplecov", require: false, group: :test

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,21 +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 'httparty'
-  spec.add_dependency 'xml-simple'
-  spec.add_dependency 'activesupport'
-
-
-
+  spec.add_dependency "ezwadl"
+  spec.add_dependency "httparty"
+  spec.add_dependency "xml-simple"
+  spec.add_dependency "activesupport"
 
   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 'byebug'
+  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,31 +1,39 @@
-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/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'
-require 'alma/item_request_options'
-require 'alma/request'
-require 'alma/user_request'
-require 'alma/electronic'
+# 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'
+  require "httparty"
 
   ROOT = File.dirname __dir__
 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

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Alma
   module ApiDefaults
-
     def apikey
       Alma.configuration.apikey
     end
@@ -23,6 +24,14 @@ module Alma
       "#{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

data/lib/alma/availability_response.rb

@@ -1,91 +1,88 @@
-require 'xmlsimple'
+# frozen_string_literal: true
+
+require "xmlsimple"
 
 module Alma
   class AvailabilityResponse
-
-
     attr_accessor :availability
 
     def initialize(response)
       @availability = parse_bibs_data(response.each)
     end
 
-    # Data structure for holdings information of bib records.    
+    # 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.reduce(Hash.new) { |acc, bib|
-        acc.merge({"#{bib.id}" => {holdings: build_holdings_for(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|
         # Use the mapping for this inventory type
-        subfield_codes = Alma::INVENTORY_SUBFIELD_MAPPING[inventory_field['tag']]
-         
+        subfield_codes = Alma::INVENTORY_SUBFIELD_MAPPING[inventory_field["tag"]]
+
         inventory_field.
           # Get all the subfields for this inventory field
-          fetch('subfield', []).
+          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']})
+          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']})
+          merge({ "inventory_type" => subfield_codes["INVENTORY_TYPE"] })
       end
     end
 
     def get_inventory_fields_for(bib)
-      # Return only the datafields with tags AVA, AVD, or AVE  
+      # Return only the datafields with tags AVA, AVD, or AVE
       bib.record
-        .fetch('datafield', [])
-        .select { |df| Alma::INVENTORY_SUBFIELD_MAPPING.key?(df['tag']) }
+        .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',  
+     "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',
+     "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',
+     "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