alma_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2251cc05e84f6e62b33f7138a6a29016a1d78821
+  data.tar.gz: 8df5fa4c4ae44cf958b45b0f86d42aa306a2f10f
+SHA512:
+  metadata.gz: ffe7b8a6ec6d0256686540beda16362ffd32fcb7bffb40eb3028c1b4f04788ac711e269ca25fee41f4e64ce6cc8ecfdb47850bc2b4252447a0bea5c0a834e0ec
+  data.tar.gz: de96d0f55d7de94861ecc0c0305b9e2e23ba2b7f3515ce0e7311558a2a06c50bd2184fd1471f5d302aa441d867cde7ddc5e4a9d513e553158bd14e2fb8af5e71

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

@@ -0,0 +1,22 @@
+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/README.md

@@ -0,0 +1,62 @@
+# alma_api
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "alma_api"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alma_api
+
+## Usage
+
+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```.
+
+```ruby
+require "alma_api"
+
+client = AlmaApi::Client.new(apikey: "your_api_key", host: "https://alma_host")
+
+# 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
+```
+
+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`.
+
+```ruby
+require "alma_api"
+
+client = AlmaApi::Client.new(apikey: "your_api_key", host: "https://alma_host")
+some_user = client.users(client.users.get.first.primary_id).get
+
+# now you can investigate the user with method notation
+some_user.contact_info.email.first.email_address # => "some@email_adress.org"
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,14 @@
+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/alma_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$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.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.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"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,7 @@
+#!/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.rb

@@ -0,0 +1,11 @@
+require "active_support"
+require "active_support/core_ext"
+require "alma_api/version"
+
+module AlmaApi
+  require_relative "./alma_api/client"
+
+  def self.debug(arg)
+    binding.pry
+  end
+end

data/lib/alma_api/client.rb

@@ -0,0 +1,35 @@
+require "faraday"
+require_relative "../alma_api"
+
+class AlmaApi::Client
+  require_relative "./client/users"
+
+  API_ROOT_PATH="/almaws"
+
+  attr_accessor :apikey
+  attr_accessor :host
+
+  alias_method :api_key, :apikey
+  alias_method :api_key=, :apikey=
+
+  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)
+    end
+  end
+
+  def users(user_id = nil)
+    Users.new(self, user_id)
+  end
+
+  # inter-client api
+  def http(method, path, options = {})
+    connection = Faraday.new.tap do |_connection|
+      _connection.headers["Accept"] = "application/json"
+      _connection.params["apikey"] = apikey
+    end
+
+    connection.send(method, "#{host}#{API_ROOT_PATH}#{path}", options)
+  end
+end

data/lib/alma_api/client/users.rb

@@ -0,0 +1,58 @@
+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/client/users/fees.rb

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

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

@@ -0,0 +1,30 @@
+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/collection.rb

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

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

data/lib/alma_api/version.rb

@@ -0,0 +1,3 @@
+module AlmaApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: alma_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mighty_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- 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/version.rb
+homepage: https://github.com/ubpb/alma-api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the Alma REST api
+test_files: []