alma 0.2.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3079955feac35f5665cae0f49298159c6739f8e
-  data.tar.gz: ada299082a4b7c0a15e8126b3417e4d8264d66f4
+SHA256:
+  metadata.gz: ed295d076116c3da468f65bfb17ba476b171e60565adddec420a2328f9b88fa6
+  data.tar.gz: 146c04496209f27833a0d0881e5f21a2fe7d55c9aa2886e5c2833efd05a80fc1
 SHA512:
-  metadata.gz: 267aa00bed5ba01ab29862986d549fc637ebe3ea26fefd7236728fe49c4a90c2f607608c8c44f52cbfcb8e4098403ee4d18f1094d51421ae289e81e41af46fb8
-  data.tar.gz: 9babb4fda07c15927e659af938c3038f261082f70db8a7d102004dd323620f33565d3b5d5d19b9497987608d7acbd8651cefcac3ed6786da47952b02c7a531ce
+  metadata.gz: bd111915aa21143de049c78f1ccd51f91db677b228c304ffddbd8820349e10525aec2a7fd7b423ab6cab8154b8322ab899a7472c84b09c0518ea28cc1d6ad0c9
+  data.tar.gz: fdc24540723c168bfd8779a53dc233e353b564ab1a6f6eeaa7b053675a18aecfc28f1a324a905281dc0e8d9efe998d0167d3012164889ab9c9169d3fd5952d31

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.1
+ruby-2.6.5

data/.travis.yml

@@ -1,5 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.13.7
+- 2.6.5
+before_install: gem install bundler
+deploy:
+  provider: rubygems
+  api_key:
+    secure: CX0/qWERXa4W5agrNZGQVsqIguRCKvaenqZvmW+fMJZdvMaK1ZzRN+IYUhCiBSBJ8mh3Dz1/L5D77HVsjz3ylDa+B9d/FFzq9ZsKTGbjbLXnconAH/tzVAtygN/5zyIPPgDLp83gVYBnJQr1AdXMhC0cpllixB2KiqbNahl750klYiOzjQDbJ6puuzT4plGOlQ56X0zVrNCBllIqTvFdcDslnes8I/BnU3HTqulIK9Ey9dUkYSqdn18UUn0R+kHs7VKkGQeIy2G7Gk9GV93y1sQi6Kdotz3B2wM4mPO+qovTLIZzr4mElpqm7RKHsXF8zmVzgQJi5JaeT/Y5GGjI3erc4CYqWcWX4/N3aogKYra+oVX9eQTg1H58cH0bjL655IY5mQ38eW4C3YuHBIdXcr9wsL7Mu6Pl4VetOs2N7dDSW7ZU868o7evBBebKQEI9Y0rDH5oGEqWYWxEiIb7anJ/kQYTADKWmpNdsTS8NpGdhtNU7qQq188Ektar7NIRrZTwIN9lSKQRCY9jYSkUv84xlaRFMvT2x4/cx00nLmVYJF+xN43JaEGOIgeZ2cyOxqVRDoDTu6UEU5KMXLSicACEijg4qWnJvbK06hfOc74ZB5zQ55Dk2xwP+aHexw3XxZbnhweu46ZvG6RdIAPNmrH1lQtE42qKEKBvfL6cTYZs=
+  gem: alma
+  on:
+    tags: true
+    repo: tulibraries/alma_rb

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,75 +26,81 @@ 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
 ```
 
 Now you can access those configuration attributes with `Alma.configuration.apikey`
 
 ### Making Requests
- 
+
 #### Get a Single user
 ```ruby
  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
  > [#<Alma::AlmaRecord:0x000000038b7b50
     ...>,
     #<Alma::AlmaRecord:0x000000038b7b28
      ...>]
- 
+
  fines.first.title
  > "Practical Object Oriented Design with Ruby"
- 
+
 ```
 
 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
 > [#<Alma::Loan:0x000000038c6b79
   ...>,
   #<Alma::Loan:0x000000038c6b34
    ...>]
- 
+
 loans.first.title
  > "Javascript: The Good Parts"
- 
+
 loans.first.due_date
-"2016-12-26z
- 
+"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)
 
@@ -105,10 +111,10 @@ requests = user.requests
 
 requests.total_record_count
 > "1"
- 
+
 requests.list
 > [#<Alma::AlmaRecord:0x000000038c6b79...>]
- 
+
 requests.list.first.title
 > "Food in history / Reay Tannahill."
 
@@ -117,26 +123,131 @@ 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/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.
@@ -145,4 +256,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/tulibr
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/alma.gemspec

@@ -23,14 +23,19 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'ezwadl'
   spec.add_dependency 'httparty'
-  spec.add_dependency 'xml-simple'  
+  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 'byebug'
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
 end

data/lib/alma.rb

@@ -1,8 +1,9 @@
 require 'alma/version'
 require 'alma/config'
-require 'alma/api'
+require 'alma/api_defaults'
 require 'alma/error'
 require 'alma/alma_record'
+require 'alma/response'
 require 'alma/user'
 require 'alma/bib'
 require 'alma/loan'
@@ -10,6 +11,7 @@ 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'
@@ -17,11 +19,13 @@ 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'
 
 module Alma
+  require 'httparty'
 
   ROOT = File.dirname __dir__
-  WADL_DIR = File.join(Alma::ROOT, 'lib','alma','wadl')
-
-
 end

data/lib/alma/api_defaults.rb

@@ -0,0 +1,30 @@
+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 timeout
+      Alma.configuration.timeout
+    end
+  end
+end