alma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e55ff048167a0ab10d80f1480ba2b18cc9fdb10
+  data.tar.gz: 87f0c5b9c23ac7a7c3c5927866f6f204db71656b
+SHA512:
+  metadata.gz: f047816c46187fc7ed8521156cfe4b5be6aa192f6fa1f67bf68f2330ec8a206d1423ace8d9232eabb7bc496f9472d1cfc89a1289f14aa67445d533949f02f603
+  data.tar.gz: 5912e6b39e09e6c6f5b29ac70e8223eaf1b2a343524b2f7a774641c63c452e63e8bf55b14ec4e2c6d2ec26eaeeffb469a4006562b24373b55bd13b4164981e5b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+alma

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at chad.nelson@temple.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alma.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chad Nelson
+
+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

@@ -0,0 +1,98 @@
+# Alma
+
+A client for Web Services provided by the Ex Libris's Alma Library System.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alma', :git => "https://github.com/tulibraries/alma_rb.git"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alma_rb
+
+## Usage
+
+### Configuration
+
+You'll need to configure the Alma gem to ensure you query the appropriate data. To do so in a rails app, create `config/initializers/alma.rb` with :
+
+```ruby
+Alma.configure do |config|
+  # You have to set te 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
+end
+```
+
+Now you can access those configuration attributes with `Alma.configuration.apikey`
+
+### 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.first_name
+ > Chad
+ 
+ user.email
+ > chad.nelson@fictional.edu
+ ```
+ 
+ Once you have a user, you can also request that users loans, fines, requests.
+ 
+ ```ruby
+ fines = user.fines
+ fines.sum
+ > 20.0
+ 
+ fines.list.first.title
+ > Practical Object Oriented Design with Ruby
+ 
+ user.loans.list
+ [\<Item Object 1\>, \<Item Oject 2\>]
+ ```
+ 
+ Loans, fines and Requests can also be accessed statically
+  
+  ```ruby
+ fines = Alma::User.get_fines({:user_id => 123456789})
+ 
+ loans = Alma::User.get_loans({:user_id => 123456789})
+ 
+ ```
+## 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).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/alma.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{Client for Ex Libris Alma Web Services}
+  spec.description   = %q{Client for Ex Libris Alma Web Services}
+  spec.homepage      = "https://github.com/tulibraries/alma_rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ezwadl'
+
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alma"
+
+# 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

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

data/lib/alma.rb

@@ -0,0 +1,18 @@
+require 'alma/version'
+require 'alma/config'
+require 'alma/api'
+require 'alma/alma_record'
+require 'alma/user'
+require 'alma/result_set'
+require 'alma/loan_set'
+require 'alma/user_set'
+require 'alma/fine_set'
+require 'alma/user_set'
+require 'alma/request_set'
+
+module Alma
+
+  ROOT = File.dirname __dir__
+  WADL_DIR = File.join(Alma::ROOT, 'lib','alma','wadl')
+
+end

data/lib/alma/alma_record.rb

@@ -0,0 +1,28 @@
+module Alma
+  class AlmaRecord
+
+    def initialize(record)
+      @raw_record = record
+      post_initialize()
+    end
+
+    def method_missing(name)
+      return response[name.to_s] if response.has_key?(name.to_s)
+      super.method_missing name
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      response.has_key?(name.to_s) || super
+    end
+
+    def response
+      @raw_record
+    end
+
+    def post_initialize
+      # Subclasses can define this method to perform extra initialization
+      # after the super class init.
+    end
+
+  end
+end

data/lib/alma/api.rb

@@ -0,0 +1,33 @@
+require 'ezwadl'
+
+module Alma
+  module Api
+
+
+    def default_params
+      { :query => { :apikey => Alma.configuration.apikey } }
+    end
+
+    def query_merge(hash)
+      {:query => default_params[:query].merge(hash)}
+    end
+
+    def resources
+      @resources ||= load_wadl
+    end
+
+    def load_wadl(wadl_filename = nil)
+      wadl_filename ||= set_wadl_filename
+      parsed_wadl = EzWadl::Parser.parse(File.join(Alma::WADL_DIR, wadl_filename)) do |rs|
+        rs.first.path = Alma.configuration.region
+      end
+      parsed_wadl.first
+    end
+
+    def set_wadl_filename
+      # Each class including this module should define this
+      raise NotImplementedError 'You must define the wadl_filename method'
+    end
+
+  end
+end

data/lib/alma/config.rb

@@ -0,0 +1,20 @@
+module Alma
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure()
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :apikey, :region
+
+    def initialize
+      @apikey = "TEST_API_KEY"
+      @region = 'https://api-na.hosted.exlibrisgroup.com'
+    end
+
+  end
+end

data/lib/alma/fine_set.rb

@@ -0,0 +1,21 @@
+module Alma
+  class FineSet < ResultSet
+
+    def top_level_key
+      'fees'
+    end
+
+    def response_records_key
+      'fee'
+    end
+
+    def sum
+      @ws_response['fees'].fetch('total_sum', 0)
+    end
+
+    def currency
+      @ws_response['fees'].fetch('total_sum', nil)
+    end
+
+  end
+end

data/lib/alma/loan_set.rb

@@ -0,0 +1,23 @@
+module Alma
+  class LoanSet
+
+    attr_reader :total_record_count, :list
+
+    def initialize(ws_response)
+      @ws_response = ws_response
+      @total_record_count = ws_response.fetch(total_record_count, 0)
+      @list ||= list_results
+    end
+
+    def response_records
+      @ws_response['item_loans'].fetch('item_loan',[])
+    end
+
+    def list_results
+      response_records.map do |loan|
+        Alma::AlmaRecord.new(loan)
+      end
+    end
+
+  end
+end