alma_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2251cc05e84f6e62b33f7138a6a29016a1d78821
-  data.tar.gz: 8df5fa4c4ae44cf958b45b0f86d42aa306a2f10f
+SHA256:
+  metadata.gz: cbcf2ac797d9d76c1d536a4eba0d084033fe3993f98f55dd02120114ad9df5eb
+  data.tar.gz: cf70240bb22810542d8ed2400e98eb656412cb1339eecb1605badd9a7019603c
 SHA512:
-  metadata.gz: ffe7b8a6ec6d0256686540beda16362ffd32fcb7bffb40eb3028c1b4f04788ac711e269ca25fee41f4e64ce6cc8ecfdb47850bc2b4252447a0bea5c0a834e0ec
-  data.tar.gz: de96d0f55d7de94861ecc0c0305b9e2e23ba2b7f3515ce0e7311558a2a06c50bd2184fd1471f5d302aa441d867cde7ddc5e4a9d513e553158bd14e2fb8af5e71
+  metadata.gz: 266823640ec75ba8962f163a80737ba9ec1f19cf70f4286ec88de278ea7ee9c4efdf9da5a0dad664ab3f918b82d690d41a9a67ccb4f4b8949db3ceb770accb6e
+  data.tar.gz: 7fdd946b9040bea59f14ce74ad2457736290b9c31baa31b3b1ed443a5391dc2bff96a66fe0d0e23b208b03597c08eca236c778cb25349a15a60a0af0c31d9586

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Universitätsbibliothek Paderborn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,62 +1,181 @@
-# alma_api
+# Alma REST API Ruby library ![Tests](https://github.com/ubpb/alma_api/actions/workflows/tests.yml/badge.svg)
 
-This is a ruby wrapper for the Alma REST api. It aims to make working with this api as pleasant as possible. Options and parameters are the same as for the original api. It also sanitizes some api quirks such as unnecessary case sensitive option values.
+This is a simple Ruby library that acts as a wrapper for the
+[Ex Libris Alma REST APIs](https://developers.exlibrisgroup.com/alma/apis/).
+
+The main purpose of this library is to abstract authentication, error handling, and response parsing.
+
+It uses [`faraday`](https://github.com/lostisland/faraday) as the underlying http client, [`nokogiri`](https://github.com/sparklemotion/nokogiri) for XML parsing, and [`oj`](https://github.com/ohler55/oj) and [`hashie`](https://github.com/hashie/hashie) for JSON processing.
+
+__Note: This is NOT an official Alma API client. It is developed at the University Library of Paderborn as an open source project.__
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this to your `Gemfile`:
 
 ```ruby
 gem "alma_api"
 ```
+and run the `bundle install` command in your terminal.
 
-And then execute:
+## Usage
 
-    $ bundle
+> You need an API key for your Alma Instance in order to use this client. Please consult the [Ex Libris developer documentation on how to use the Alma REST APIs](https://developers.exlibrisgroup.com/alma/apis/#using) for more information how to get and setup your API keys.
 
-Or install it yourself as:
+### Creating a configuration
 
-    $ gem install alma_api
+To use this library you need an `AlmaApi::Client` instance. The client requires an `AlmaApi::Configuration`.
 
-## Usage
+```ruby
+configuration = AlmaApi::Configuration.new(
+  api_key: "...",        # 1. required
+  base_url: "...",       # 2. optional
+  default_format: "...", # 3. optional
+  language: "..."        # 4. optional
+)
+```
+
+1. `api_key` Add your Alma API key here.
+2. `base_url` Add the base URL to be used for each request. Ex Libris provides different API gateways for different geographical locations. See [the documentation here](https://developers.exlibrisgroup.com/alma/apis/#calling) for more information. This parameter is optional and defaults to the Alma API Gateway for Europe: `https://api-eu.hosted.exlibrisgroup.com/almaws/v1`.
+3. `default_format` The default format to use for each request. The client supports `json` and `xml`. The default is `json`.
+4. `language` The language used by Alma for error messages and textual information. The default is English (`en`). To change this, set this parameter to any 2-letter language code that is supported and enabled in Alma (see the mapping table "Institution Languages" in Alma).
+
+### Creating a client
 
-In order to use the api client you have to provide an apikey and the host you want to connect to. Both can be provided as paramters or as environment variables named ```ALMA_APIKEY``` or ```ALMA_HOST```.
+With the configuration ready, you can create the client.
 
 ```ruby
-require "alma_api"
+client = AlmaApi::Client.new(configuration)
+```
+
+As a shortcut, you can call `AlmaApi.configure` to get the client instance. Note that each call to `AlmaApi.configure` returns a new `AlmaApi::Client` instance.
+
+```ruby
+client = AlmaApi.configure do |config|
+  api_key: "...",
+  base_url: "...",
+  default_format: "...",
+  language: "..."
+end
+```
+### Using the client
+
+The client provides the following methods: `#get`, `#post`, `#put` and `#delete` to call the Alma APIs with the corresponding HTTP methods `GET`, `POST`, `PUT` and `DELETE`.
+
+Each method expects a URL path to the resource relative to the configured `base_url` as it's first parameter. Parameters that the Alma API expects as part of the URL path must be included here.
+
+To set query string parameters, set the `params:` option and provide a Ruby `hash`. To override the `default_format` for an individual request, you can set the `format:` option to `json` or `xml`, depending on your needs. Setting the format to `xml` is preferable for Alma APIs that work with MARCXML data.
+
+To set the body of a `#post` or `#put` request, you can set the `body:` option. If the request format is `json`, the `body:` option should contain a valid json string. Otherwise, if the request format is `xml`, the option should be a valid XML string.
+
+In the case of a `json` request, the result of the call is a Ruby `hash`. For `xml`, the result is a `Nokogiri::XML::Document` instance, as this library uses [`nokogiri`](https://github.com/sparklemotion/nokogiri) under the hood for XML processing.
+
+## Examples
+
+#### `GET` requests
 
-client = AlmaApi::Client.new(apikey: "your_api_key", host: "https://alma_host")
+__Retrieve users__
+```ruby
+# Retrieve users (JSON)
+users = client.get("users", params: {limit: 2})
 
-# calling semantic resembles the api as close as possible
-client.users.get # => [...] users collection
-client.users("user_id").get # => user object
-client.users("user_id").get(view: :brief) # => user object (brief view)
-client.users("user_id").fees.get # => fees of a user
-client.users("user_id").fees("fee_id").get # => fees of a user
+# Retrieve users (XML)
+users = client.get("users", params: {limit: 2}, format: :xml)
 ```
 
-This gem uses ```mighty_struct``` for its results. This means you can navigate results with object notation like with ```OpenStruct```. If you want to get the underlaying hash/array just call `to_a` or `to_h`.
+#### `POST` and `PUT` requests
+
+__Creating a user__
+```ruby
+# Prepare the data for a new user in Alma
+user_data = {
+  record_type: {value: "PUBLIC"},
+  account_type: {value: "INTERNAL"},
+  preferred_language: {value: "de"},
+  status: {value: "ACTIVE"},
+  first_name: "FIRSTNAME",
+  last_name: "LASTNAME",
+  birth_date: "1978-07-07",
+  [...]
+  password: "SECRET PASSWORD",
+  force_password_change: true
+}
+
+# Create the user in Alma
+user = client.post(
+  "users",
+  params: {
+    source_user_id: "xxx"
+  },
+  body: user_data.to_json
+)
+```
 
+__Updating a user__
 ```ruby
-require "alma_api"
+# First, get the user
+user_id = "..." # a unique identifier for the user
+user = client.get("users/#{user_id}") # user_id is a URL parameter
+
+# Change the last name of the user
+user["last_name"] = "..."
 
-client = AlmaApi::Client.new(apikey: "your_api_key", host: "https://alma_host")
-some_user = client.users(client.users.get.first.primary_id).get
+# Update the user in Alma
+user = client.put("users/#{user_id}", body: user.to_json)
 
-# now you can investigate the user with method notation
-some_user.contact_info.email.first.email_address # => "some@email_adress.org"
 ```
 
-## Development
+#### `DELETE` requests
+
+__Deleting a user__
+```ruby
+user_id = "..." # a unique identifier for the user
+client.delete("users/#{user_id}") # user_id is a URL parameter
+```
+
+## Error handling
+
+There are three types of errors that can occur when calling the Alma APIs with this library. Each error exposes the `#message` and `#code` methods for further inspection. The message is returned in the language set in the configuration (default is English).
+
+For gateway errors, the code is a string token (e.g. REQUEST_TOO_LARGE). For logical errors, the code is usually a number (e.g. 401850). See the "Possible Error Codes" section for each resource in the [documentation](https://developers.exlibrisgroup.com/alma/apis/) for details.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+### 1. `AlmaApi::GatewayError`
 
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If the Alma API responds with a `4xx` OR `5xx` HTTP status AND one of the following error codes, an `AlmaApi::GatewayError` is thrown.
 
-## Contributing
+`GENERAL_ERROR`, `UNAUTHORIZED`, `INVALID_REQUEST`, `PER_SECOND_THRESHOLD`, `DAILY_THRESHOLD`, `REQUEST_TOO_LARGE`, `FORBIDDEN`, `ROUTING_ERROR`
 
-1. Fork it ( https://github.com/ubpb/alma_api/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Check the [the documentation here](https://developers.exlibrisgroup.com/alma/apis/#error) for more information about gateway errors.
+
+### 2. `AlmaApi::ServerError`
+
+Any `5xx` HTTP status that does not result in an `AlmaApi::GatewayError` will be thrown as an `AlmaApi::ServerError`.
+
+### 3. `AlmaApi::LogicalError`
+
+Any `4xx` HTTP status that does not result in an `AlmaApi::GatewayError` will be thrown as an `AlmaApi::LogicalError`.
+
+This is the most common error you will encounter and can be used to manage the control flow in your application.
+
+For example, if you're loading a user's details, you don't want your application to blow up if a user with the specified user ID doesn't exist. Instead, you can handle the error like this:
+
+```ruby
+def load_user(user_id)
+  client.get("users/#{user_id}")
+rescue AlmaApi::LogicalError => e
+  # log the error
+  puts "Error #{e.code}: #{e.message}"
+
+  # ... the error code could be inspected and we could perform
+  # different things based on the error code but in this case
+  # we just return nil to indicate that the user does not exists.
+  nil
+end
+
+if (user = load_user("ALMA_USER_ID"))
+  puts "Hello #{user["first_name"]} #{user["last_name"]}"
+else
+  puts "Too bad. No such user."
+end
+
+```

data/alma_api.gemspec

@@ -1,27 +1,22 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require "alma_api/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "alma_api"
   spec.version       = AlmaApi::VERSION
-  spec.authors       = ["Michael Sievers"]
-  spec.summary       = %q{A ruby wrapper for the Alma REST api}
-  spec.homepage      = "https://github.com/ubpb/alma-api"
+  spec.authors       = ["René Sprotte"]
+  spec.summary       = "A Ruby client library for the Ex Libris Alma REST APIs"
+  spec.homepage      = "http://github.com/ubpb/alma_api"
+  spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files lib README.md LICENSE alma_api.gemspec`.split($INPUT_RECORD_SEPARATOR)
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "faraday"
-  spec.add_dependency "mighty_struct", ">= 0.1.2"
-  
-  spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency "bundler",   ">= 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec",     ">= 3.0.0",  "< 4.0.0"
-  spec.add_development_dependency "simplecov", ">= 0.8.0"
+  spec.add_dependency "activesupport", "> 6", "< 8"
+  spec.add_dependency "faraday", "~> 2.7"
+  spec.add_dependency "hashie", "~> 5.0"
+  spec.add_dependency "nokogiri", "~> 1.11"
+  spec.add_dependency "oj", "~> 3.11"
 end

data/lib/alma_api/client.rb

@@ -1,35 +1,144 @@
-require "faraday"
-require_relative "../alma_api"
+module AlmaApi
+  class Client
 
-class AlmaApi::Client
-  require_relative "./client/users"
+    attr_reader :configuration,
+                :remaining_api_calls
 
-  API_ROOT_PATH="/almaws"
+    def initialize(configuration)
+      @configuration = configuration
+      @remaining_api_calls = -1
+    end
 
-  attr_accessor :apikey
-  attr_accessor :host
+    def get(url, params: {}, format: nil)
+      perform_request do
+        connection(format: format, params: params).get(url)
+      end
+    end
 
-  alias_method :api_key, :apikey
-  alias_method :api_key=, :apikey=
+    def post(url, params: {}, body: nil, format: nil)
+      perform_request do
+        connection(format: format, params: params).post(url) do |req|
+          req.body = body
+        end
+      end
+    end
 
-  def initialize(options = {})
-    options.symbolize_keys.try do |_sanitized_options|
-      @apikey = _sanitized_options[:apikey] || _sanitized_options[:api_key] || ENV["ALMA_APIKEY"] || ENV["ALMA_API_KEY"]
-      @host = (_sanitized_options[:host] || ENV["ALMA_HOST"]).try(:strip)
+    def put(url, params: {}, body: nil, format: nil)
+      perform_request do
+        connection(format: format, params: params).put(url) do |req|
+          req.body = body
+        end
+      end
     end
-  end
 
-  def users(user_id = nil)
-    Users.new(self, user_id)
-  end
+    def delete(url, params: {}, format: nil)
+      perform_request do
+        connection(format: format, params: params).delete(url)
+      end
+    end
+
+  private
+
+    def connection(format: nil, params: {})
+      format = case AlmaApi.validate_format!(format)
+               when "xml"  then "application/xml"
+               when "json" then "application/json"
+               else
+                 "application/json"
+               end
+
+      default_params = {
+        lang: configuration.language
+      }.reject do |k, v|
+        k == :lang && (v.blank? || v == "en")
+      end
+
+      Faraday.new(
+        configuration.base_url,
+        params:  default_params.reverse_merge(params),
+        headers: {
+          "Authorization": "apikey #{configuration.api_key}",
+          "Accept":        format,
+          "Content-Type":  format
+        }
+      ) do |faraday|
+        faraday.response :raise_error # raise Faraday::Error on status code 4xx or 5xx
+      end
+    end
+
+    def perform_request
+      response = yield
+      set_remaining_api_calls(response)
+      parse_response_body(response.body)
+    rescue Faraday::Error => e
+      error = parse_error_response_body(e.response[:body])
+
+      case error[:error_code]
+      when *GATEWAY_ERROR_CODES
+        raise GatewayError.new(error[:error_message], error[:error_code])
+      else
+        case e.response[:status]
+        when 400..499
+          raise LogicalError.new(error[:error_message], error[:error_code])
+        when 500..599
+          raise ServerError.new(error[:error_message], error[:error_code])
+        else # this should not happen
+          # :nocov:
+          raise ServerError.new(error[:error_message], error[:error_code])
+          # :nocov:
+        end
+      end
+    end
+
+    def set_remaining_api_calls(response)
+      rac = response.headers[:x_alma_api_remaining]
+      @remaining_api_calls = rac.to_i if rac.present?
+    end
+
+    def parse_response_body(body)
+      if body.blank?
+        nil
+      elsif is_xml_response?(body)
+        Nokogiri::XML.parse(body)
+      elsif is_json_response?(body)
+        Oj.load(body)
+      else
+        raise Error.new("Unsupported content type in response from API.", "API_CLIENT_ERROR")
+      end
+    end
+
+    def parse_error_response_body(body)
+      if is_xml_response?(body)
+        xml = Nokogiri::XML.parse(body)
+        error_message = xml.at("errorMessage")&.text
+        error_code    = xml.at("errorCode")&.text
+
+        {error_message: error_message, error_code: error_code}
+      elsif is_json_response?(body)
+        json = Oj.load(body)
+        json.extend Hashie::Extensions::DeepFind
+
+        # Sometimes the format is:
+        #   {"errorList":{"error":[{"errorCode":"xxx","errorMessage":"xxx"}]}}
+        # and sometimes the format is:
+        #   {"web_service_result":{"errorList":{"error":{"errorMessage":"xxx","errorCode":"xxx"}}}}
+        # so we use a deep find to find the first occurrence of "errorMessage" and "errorCode"
+        error_message = json.deep_find("errorMessage")
+        error_code    = json.deep_find("errorCode")
+
+        {error_message: error_message, error_code: error_code}
+      else
+        {error_message: nil, error_code: nil}
+      end
+    end
+
+    def is_xml_response?(body)
+      body&.strip&.starts_with?("<")
+    end
 
-  # inter-client api
-  def http(method, path, options = {})
-    connection = Faraday.new.tap do |_connection|
-      _connection.headers["Accept"] = "application/json"
-      _connection.params["apikey"] = apikey
+    def is_json_response?(body)
+      body&.strip&.starts_with?("{")
     end
 
-    connection.send(method, "#{host}#{API_ROOT_PATH}#{path}", options)
   end
 end

data/lib/alma_api/configuration.rb

@@ -0,0 +1,34 @@
+module AlmaApi
+  class Configuration
+
+    attr_reader :api_key,
+                :base_url,
+                :default_format,
+                :language
+
+    def initialize(api_key: nil, base_url: nil, default_format: nil, language: nil)
+      self.api_key = api_key
+      self.base_url = base_url
+      self.default_format = default_format
+      self.language = language
+    end
+
+    def api_key=(value)
+      @api_key = value.presence
+    end
+
+    def base_url=(value)
+      base_url = value.presence || "https://api-eu.hosted.exlibrisgroup.com/almaws/v1"
+      @base_url = base_url&.ends_with?("/") ? base_url[0..-2] : base_url
+    end
+
+    def default_format=(value)
+      @default_format = AlmaApi.validate_format!(value) || "json"
+    end
+
+    def language=(value)
+      @language = value.presence || "en"
+    end
+
+  end
+end

data/lib/alma_api/version.rb

@@ -1,3 +1,3 @@
 module AlmaApi
-  VERSION = "0.1.0"
+  VERSION = "1.0.0".freeze
 end

data/lib/alma_api.rb

@@ -1,11 +1,57 @@
 require "active_support"
 require "active_support/core_ext"
-require "alma_api/version"
+require "faraday"
+require "nokogiri"
+require "hashie"
+require "oj"
+
+require "alma_api/configuration"
+require "alma_api/client"
 
 module AlmaApi
-  require_relative "./alma_api/client"
+  DEFAULT_ERROR_CODE = "UNKNOWN".freeze
+  DEFAULT_ERROR_MESSAGE = "Unknown cause".freeze
+
+  class Error < StandardError
+    attr_reader :code
+
+    def initialize(message, code)
+      @code = code.presence || DEFAULT_ERROR_CODE
+      super(message.presence || DEFAULT_ERROR_MESSAGE)
+    end
+  end
+
+  class GatewayError < Error; end
+  class ServerError  < Error; end
+  class LogicalError < Error; end
+
+  GATEWAY_ERROR_CODES = [
+    "GENERAL_ERROR",
+    "UNAUTHORIZED",
+    "INVALID_REQUEST",
+    "PER_SECOND_THRESHOLD",
+    "DAILY_THRESHOLD",
+    "REQUEST_TOO_LARGE",
+    "FORBIDDEN",
+    "ROUTING_ERROR"
+  ].freeze
+
+  class << self
+
+    def configure
+      configuration = Configuration.new
+      yield(configuration) if block_given?
+      Client.new(configuration)
+    end
+
+    def validate_format!(format)
+      case format = format&.to_s
+      when "json", "xml" then format
+      when nil then nil
+      else
+        raise ArgumentError, "Unsupported format '#{format}'. Only 'json' and 'xml' is supported."
+      end
+    end
 
-  def self.debug(arg)
-    binding.pry
   end
 end

metadata

@@ -1,162 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: alma_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Michael Sievers
-autorequire: 
-bindir: exe
+- René Sprotte
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: mighty_struct
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :development
+        version: '1.11'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
+        version: '3.11'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
-description: 
-email: 
+        version: '3.11'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
-- Rakefile
 - alma_api.gemspec
-- bin/console
-- bin/setup
 - lib/alma_api.rb
 - lib/alma_api/client.rb
-- lib/alma_api/client/users.rb
-- lib/alma_api/client/users/fees.rb
-- lib/alma_api/client/users/loans.rb
-- lib/alma_api/client/users/requests.rb
-- lib/alma_api/collection.rb
-- lib/alma_api/object.rb
+- lib/alma_api/configuration.rb
 - lib/alma_api/version.rb
-homepage: https://github.com/ubpb/alma-api
-licenses: []
+homepage: http://github.com/ubpb/alma_api
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: A ruby wrapper for the Alma REST api
+summary: A Ruby client library for the Ex Libris Alma REST APIs
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,3 +0,0 @@
---color
---format documentation
---require spec_helper

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - "2.0"
-  - "2.1"
-  - "2.2"

data/Gemfile

@@ -1,19 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in your gemspec
-gemspec
-
-if !ENV["CI"]
-  group :development do
-    gem "hashdiff"
-    gem "pry",                "~> 0.9.12.6"
-    gem "pry-byebug",         "<= 1.3.2"
-    gem "pry-rescue",         "~> 1.4.1", github: "ConradIrwin/pry-rescue", branch: :master
-    gem "pry-stack_explorer", "~> 0.4.9.1"
-    gem "pry-syntax-hacks",   "~> 0.0.6"
-  end
-end
-
-group :test do
-  gem "codeclimate-test-reporter", require: nil
-end

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 Michael Sievers
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-task :benchmark do
-  require_relative "./benchmark/joffrey/mab_document"
-  require_relative "./benchmark/joffrey/mab_xml_parser"
-
-  #Benchmark::Joffrey::MabDocument.new.call
-  Benchmark::Joffrey::MabXmlParser.new.call
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "alma_api"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
-Pry.start
-
-#require "irb"
-#IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/alma_api/client/users/fees.rb

@@ -1,40 +0,0 @@
-require "alma_api/collection"
-require "json"
-require_relative "../users"
-
-class AlmaApi::Client::Users::Fees
-  def initialize(client, user_id, fee_id = nil)
-    @client = client
-    @fee_id = fee_id
-    @user_id = user_id
-  end
-
-  def get(options = {})
-    if @fee_id
-      (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-        user_id_type: :all_unique
-      })
-
-      @client.http(:get, "/v1/users/#{@user_id}/fees/#{@fee_id}", options).try do |_response|
-        if _response.status == 200
-          AlmaApi::Object.new(JSON.parse(_response.body))
-        end
-      end
-
-    else
-      (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-        user_id_type: :all_unique,
-        status: :ACTIVE
-      })
-
-      # sanitize api quirks
-      options[:status] = options[:status].to_s.upcase.to_sym
-
-      @client.http(:get, "/v1/users/#{@user_id}/fees", options).try do |_response|
-        if _response.status == 200
-          AlmaApi::Collection.new(JSON.parse(_response.body), "fee")
-        end
-      end
-    end
-  end
-end

data/lib/alma_api/client/users/loans.rb

@@ -1,30 +0,0 @@
-require "alma_api/collection"
-require "json"
-require_relative "../users"
-
-class AlmaApi::Client::Users::Loans
-  def initialize(client, user_id, loan_id = nil)
-    @client = client
-    @loan_id = loan_id
-    @user_id = user_id
-  end
-
-  def get(options = {})
-    (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-      user_id_type: :all_unique,
-      limit: 10,
-      offset: 0,
-      order_by: :id,
-      direction: :ASC
-    })
-
-    # sanitize api quirks
-    options[:direction] = options[:direction].to_s.upcase.to_sym
-
-    @client.http(:get, "/v1/users/#{@user_id}/loans", options).try do |_response|
-      if _response.status == 200
-        AlmaApi::Collection.new(JSON.parse(_response.body), "item_loan")
-      end
-    end
-  end
-end

data/lib/alma_api/client/users/requests.rb

@@ -1,30 +0,0 @@
-require "alma_api/collection"
-require "json"
-require_relative "../users"
-
-class AlmaApi::Client::Users::Requests
-  def initialize(client, user_id, request_id = nil)
-    @client = client
-    @request_id = request_id
-    @user_id = user_id
-  end
-
-  def get(options = {})
-    (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-      request_type: nil, # :HOLD, :DIGITIZATION, :BOOKING
-      limit: 10,
-      offset: 0,
-      status: :active    # :active, :history
-    })
-
-    # sanitize api quirks
-    options[:request_type] = options[:request_type].try(:to_s).try(:upcase).try(:to_sym)
-    options[:status] = options[:status].to_s.downcase.to_sym
-
-    @client.http(:get, "/v1/users/#{@user_id}/requests", options).try do |_response|
-      if _response.status == 200
-        AlmaApi::Collection.new(JSON.parse(_response.body), "user_request")
-      end
-    end
-  end
-end

data/lib/alma_api/client/users.rb

@@ -1,58 +0,0 @@
-require "alma_api/collection"
-require "alma_api/object"
-require "json"
-require_relative "../client"
-
-class AlmaApi::Client::Users
-  require_relative "./users/fees"
-  require_relative "./users/loans"
-  require_relative "./users/requests"
-
-  def initialize(client, user_id = nil)
-    @client = client
-    @user_id = user_id
-  end
-
-  def get(options = {})
-    if @user_id
-      (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-        user_id_type: :all_unique,
-        view: :full
-      })
-
-      @client.http(:get, "/v1/users/#{@user_id}", options).try do |_response|
-        if _response.status == 200
-          AlmaApi::Object.new(JSON.parse(_response.body))
-        end
-      end
-    else
-      (options = options.deep_dup).symbolize_keys!.reverse_merge!({
-        limit: 10,
-        offset: 0,
-        order_by: [
-          :last_name,
-          :first_name,
-          :primary_id
-        ]
-      })
-
-      @client.http(:get, "/v1/users", options).try do |_response|
-        if _response.status == 200
-          AlmaApi::Collection.new(JSON.parse(_response.body), "user")
-        end
-      end
-    end
-  end
-
-  def fees(fee_id = nil)
-    Fees.new(@client, @user_id, fee_id)
-  end
-  
-  def loans(loan_id = nil)
-    Loans.new(@client, @user_id, loan_id)
-  end
-
-  def requests(request_id = nil)
-    Requests.new(@client, @user_id, request_id)
-  end
-end

data/lib/alma_api/collection.rb

@@ -1,28 +0,0 @@
-require_relative "./object"
-require_relative "../alma_api"
-
-class AlmaApi::Collection < Delegator
-  def initialize(hash, items_key, item_class = AlmaApi::Object)
-    hash.each do |_key, _value|
-      if _key != items_key
-        singleton_class.class_eval do
-          attr_accessor "#{_key}".to_sym
-        end
-
-        instance_variable_set("@#{_key}".to_sym, _value)
-      end
-    end
-
-    @items = hash.try(:[], items_key).try(:map) do |_item|
-      item_class.new(_item)
-    end || []
-  end
-
-  def __getobj__
-    @items
-  end
-
-  def __setobj__(obj)
-    @items = obj
-  end
-end

data/lib/alma_api/object.rb

@@ -1,16 +0,0 @@
-require "mighty_struct"
-require_relative "../alma_api"
-
-class AlmaApi::Object < MightyStruct
-  def initialize(object)
-    if object.is_a?(Hash)
-      object.each do |_key, _value|
-        if _value.is_a?(String) && _value[/\A\d\d\d\d-\d\d-\d\d\w.*/]
-          object[_key] = Date.parse(_value)
-        end
-      end
-    end
-
-    super(object)
-  end
-end