alma 0.2.4 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a61f0bfe79181cdb4d99e0eca51ba16b1be6550f
-  data.tar.gz: 8f024c368175b3a8ac0fe2e6eb836f436516a566
+SHA256:
+  metadata.gz: f162f9bb1a3b0eee2af44a379b1d094141b6cc9c06767d17acb39d909eb27ed1
+  data.tar.gz: 98eb300d6c0ab62ae07790fa64449c65839f89bd3903b3c0e010e911bf4d3ce0
 SHA512:
-  metadata.gz: 58b8bcfbe9b5c4f6ccd688df845bfb86e3fe8115199b06862c03b6faeaf31e08e4f9a33cca5209c082fa69f8416461dc9c45bef34a9c57179a48d4f29f7b2397
-  data.tar.gz: 60e8ea0221d2dce2001e53afd41d0f046cb822e56c74f2e07ecffcacc7fa9e94ce9c4730572f79cd0463d12c09506e64a4af9b52ed871cefa2be625a650e6cbb
+  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.3.3
+ruby-2.7.2

data/Gemfile

@@ -1,4 +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

data/Guardfile

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+
+  # Specific files when defaults don't work (for some reason):
+  watch("lib/alma.rb") { "spec/alma_spec.rb" }
+end

data/README.md

@@ -26,10 +26,16 @@ You'll need to configure the Alma gem to ensure you query the appropriate data.
 
 ```ruby
 Alma.configure do |config|
-  # You have to set te apikey 
+  # You have to set the apikey
   config.apikey     = 'EXAMPLE_EL_DEV_NETWORK_APPLICATION_KEY'
-  # Alma gem defaults to querying Ex Libris's North American  Api servers. You can override that here.
-  config.region   = "https://api-eu.hosted.exlibrisgroup.com
+  # Alma gem defaults to querying Ex Libris's North American API servers. You can override that here.
+  config.region   = "https://api-eu.hosted.exlibrisgroup.com"
+
+  # By default enable_loggable is set to false
+  config.enable_loggable = false
+
+  # By default timeout is set to 5 seconds; can only provide integers
+  config.timeout = 10
 end
 ```
 
@@ -37,99 +43,78 @@ Now you can access those configuration attributes with `Alma.configuration.apike
 
 ### Making Requests
 
-#### Get a list of Users
-```ruby
- users = Alma::User.find
- 
- users.total count
- > 402
- 
- users.list.first.id 
- > 123456789
-```
- 
 #### Get a Single user
 ```ruby
- user = Alma::User.find({:user_id => 123456789})
- 
+ user = Alma::User.find(123456789)
+
  user.first_name
  > Chad
- 
+
  user.email
  > chad.nelson@fictional.edu
+
+ user.keys
+ >{first_name: "Chad",
+ ...}
 ```
- 
+
 #### Get details on a users fines
- 
+
 ```ruby
  fines = user.fines
  fines.sum
  > "20.0"
- 
+
  fines.total_record_count
  > "2"
- 
- fines.list
+
+ fines
  > [#<Alma::AlmaRecord:0x000000038b7b50
     ...>,
     #<Alma::AlmaRecord:0x000000038b7b28
      ...>]
- 
- fines.list.first.title
+
+ fines.first.title
  > "Practical Object Oriented Design with Ruby"
- 
+
 ```
 
-Each fine object reflects the available fields in the returned XML,[as documented on the Ex Libris Api docs](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_fees.xsd?tags=GET)
+Each fine object reflects the available fields in the returned JSON,[as documented on the Ex Libris Api docs](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_fees.xsd?tags=GET)
 
 #### Get details on a users loans
- 
+
 ```ruby
 loans = user.loans
 
 loans.total_record_count
 > "2"
- 
-loans.list
+
+loans
 > [#<Alma::Loan:0x000000038c6b79
   ...>,
   #<Alma::Loan:0x000000038c6b34
    ...>]
- 
-loans.list.first.title
- > "Javascript: The Good Parts"
- 
-loans.list.first.due_date
-"2016-12-26z
- 
-```
-Each loan object reflects the available fields in the returned XML,[as documented on the Ex Libris Api docs](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_item_loans.xsd?tags=GET)
 
-To renew an item you can can call the Loan objects renew method
-
-```ruby
-renewal = loans.list.first.renew
-
-renewal.renewed?
-> True
+loans.first.title
+ > "Javascript: The Good Parts"
 
-renewal.message 
-> "Javascript: The Good Parts is now due 02-20-17"
+loans.first.due_date
+"2016-12-26z"
 
 ```
+Each loan object reflects the available fields in the returned XML,[as documented on the Ex Libris Api docs](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_item_loans.xsd?tags=GET)
 
 
-
-#### Get details on a users requests
+#### Get details on a users requests - WIP
 ```ruby
 requests = user.requests
 
 requests.total_record_count
 > "1"
- 
+
 requests.list
 > [#<Alma::AlmaRecord:0x000000038c6b79...>]
- 
+
 requests.list.first.title
 > "Food in history / Reay Tannahill."
 
@@ -138,32 +123,136 @@ requests.list.first.pickup_location
 
 requests.list.first.request_status
 > "In Process"
- 
+
 ```
 Each request object reflects the available fields in the returned XML,[as documented on the Ex Libris Api docs](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_user_requests.xsd?tags=GET)
 
  Loans, fines and Requests can also be accessed statically
-  
+
 ```ruby
 Alma::User.get_fines({:user_id => 123456789})
- 
+
 Alma::User.get_loans({:user_id => 123456789})
 
 Alma::User.get_requests({:user_id => 123456789})
- 
+
+```
+
+### Bib Records
+Wrappings for some of the API endpoints described by the [Bibliographic Records and Inventory
+](https://developers.exlibrisgroup.com/alma/apis/bibs) section of the Ex Libris Developers Network
+
+### All the items for a Bib Records
+Corresponds to the [Retrieve Items list](https://developers.exlibrisgroup.com/alma/apis/bibs/GET/gwPcGly021om4RTvtjbPleCklCGxeYAfEqJOcQOaLEvNcHQT0/ozqu3DGTurs/XxIP4LrexQUdc=/af2fb69d-64f4-42bc-bb05-d8a0ae56936e) api endpoint
+
+To get the list of items for all holdings of a bib record.
+`items = Alma::BibItem.find("EXAMPLE_MMS_ID")`
+
+You can also pass a holding ID as an option, if you only want that holdings items.
+`items = Alma::BibItem.find("EXAMPLE_MMS_ID", holding_id: EXAMPLE_HOLDING_ID)`
+
+
+The response is a BibItemSet which can be iterated over to access items:
+
+```ruby
+items.each { ... }
+
+items.total_record_count
+> 4
+```
+
+You can remove items that are missing or lost from the result set
+` avail_items = items.filter_missing_and_lost
+`
+
+Items can be grouped by the library they are held at, which returns a hash with library codes as the keys and an array of items as the values.
+
+```ruby
+items.grouped_by_library
+{ "MAIN" =>
+  [#<Alma::BibItem:0x000000038c6b79...>],
+  "NOT_MAIN" =>
+  [#<Alma::BibItem:0x000000038c6b88...>, #<Alma::BibItem:0x000000038c6b94...>,],
+}
+```
+
+The data for each item can be accessed via hash representation of the [item structure](https://developers.exlibrisgroup.com/alma/apis/xsd/rest_item.xsd), e.g.:
+
+```ruby
+item = items.first
+
+item["holding_data"]["call_number"]
+"T385 .F79 2008"
+
+item["item_data"]["location"]["value"]
+"STACKS"
+
+```
+
+There are also numerous convenience methods
+
+```ruby
+# Boolean checks
+item.in_temp_location?
+item.in_place? # Basically, On Shelf or Not
+item.non_circulating?
+item.missing_or_lost?
+item.has_temp_call_number?
+item.has_alt_call_number?
+item.has_process_type?
+
+
+# Opinionated Accessors - return the value, or an empty string
+
+# Returns temp library/location if appropriate, else normal library/location
+item.library
+item.library_name
+item.location
+item.location_name
+
+# which use these methods under the hood
+item.holding_library
+item.holding_location
+
+item.temp_library
+item.temp_location
+
+
+# Looks for Temp call number, then alternate call number, then normal call number
+item.call_number
+
+# and which use
+item.temp_call_number
+item.alt_call_number
+
+
+# standard accessors
+item.process_type
+item.base_status
+item.circulation_policy
+item.description
+item.public_note
+
 ```
+
+### Logging
+This gem exposes a loggable interface to responses.  Thus a response will respond to `loggable` and return a hash with state values that may be of use to log.
+
+As a bonus, when we enable this feature using the `enable_loggable` configuration, error messages will contain the loggable values and be formatted as JSON.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Use `bundle exec guard` to continuously run specs while developing.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/alma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tulibraries/alma_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-