aleph_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b66c529a807fedc74fc2906f3f2d9cb43c1fabca
+  data.tar.gz: 19b7f15ef2d1ea93c10bd3a8e665deabd4631d92
+SHA512:
+  metadata.gz: c533420154c0cd1bc6352c9e2c17a61b0a016095610b7aa2bebc0561d9449445b8c3fff4697bc302be396733c14c60478d375e57c80f3b45c2af4bc5962513b0
+  data.tar.gz: cbf4b67132b92fcfcf5339ce61a20b6ff28667afb4b651a7c8cce160ec09baa020f58659751393706241143f759fca6612c81e53f2319c616a1ff619265f411e

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,20 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in your gemspec
+gemspec
+
+if !ENV["CI"]
+  group :development do
+    gem "hashdiff"
+    #gem "patron", github: "toland/patron", branch: :master
+    gem "pry",                "~> 0.9.12.6"
+    gem "pry-byebug",         "<= 1.3.2"
+    gem "pry-rescue",         "~> 1.4.2"
+    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/README.md

@@ -0,0 +1,39 @@
+# AlephApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aleph_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aleph_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aleph_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[my-github-username]/aleph_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/aleph_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aleph_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aleph_api"
+  spec.version       = AlephApi::VERSION
+  spec.authors       = ["Michael Sievers"]
+  spec.summary       = %q{A ruby wrapper for the aleph rest and xservices apis}
+  spec.homepage      = "http://github.com/ubpb/aleph_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_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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aleph_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.
+
+begin
+  require "pry"
+  Pry.start
+rescue
+  require "irb"
+  IRB.start
+end

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/aleph_api/faraday/response/enforce_utf8_encoded_body.rb

@@ -0,0 +1,14 @@
+require "faraday/middleware"
+require_relative "../../../aleph_api"
+
+module AlephApi::Faraday
+  module Response
+    class EnforceUtf8EncodedBody < Faraday::Middleware
+      def call(request_env)
+        @app.call(request_env).on_complete do |_response_env|
+         _response_env.body.force_encoding("utf-8")
+        end
+      end
+    end
+  end
+end

data/lib/aleph_api/restful_api_client/patron/circulation_actions/cash.rb

@@ -0,0 +1,21 @@
+require_relative "../circulation_actions"
+
+class AlephApi::RestfulApiClient::Patron::CirculationActions::Cash
+  def initialize(client, patron_id, cash_id = nil)
+    @client = client
+    @cash_id = cash_id
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    if @cash_id
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/cash/#{@cash_id}", options).try do |_response|
+        _response.body
+      end
+    else
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/cash", options).try do |_response|
+        _response.body
+      end
+    end
+  end
+end

data/lib/aleph_api/restful_api_client/patron/circulation_actions/loans.rb

@@ -0,0 +1,21 @@
+require_relative "../circulation_actions"
+
+class AlephApi::RestfulApiClient::Patron::CirculationActions::Loans
+  def initialize(client, patron_id, loan_id = nil)
+    @client = client
+    @loan_id = loan_id
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    if @loan_id
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/loans/#{@loan_id}", options).try do |_response|
+        _response.body
+      end
+    else
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/loans", options).try do |_response|
+        _response.body
+      end
+    end
+  end
+end

data/lib/aleph_api/restful_api_client/patron/circulation_actions/requests/holds.rb

@@ -0,0 +1,31 @@
+require_relative "../requests"
+
+class AlephApi::RestfulApiClient::Patron::CirculationActions::Requests::Holds
+  def initialize(client, patron_id, hold_id = nil)
+    @client = client
+    @hold_id = hold_id
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    if @hold_id
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/requests/holds/#{@hold_id}", options).try do |_response|
+        _response.body
+      end
+    else
+      @client.http(:get, "/patron/#{@patron_id}/circulationActions/requests/holds", options).try do |_response|
+        _response.body
+      end
+    end
+  end
+
+  def delete(options = {})
+    if @hold_id
+      @client.http(:delete, "/patron/#{@patron_id}/circulationActions/requests/holds/#{@hold_id}", options).try do |_response|
+        _response.body
+      end
+    else
+      raise ArgumentError, "No hold id given!"
+    end
+  end
+end

data/lib/aleph_api/restful_api_client/patron/circulation_actions/requests.rb

@@ -0,0 +1,20 @@
+require_relative "../circulation_actions"
+
+class AlephApi::RestfulApiClient::Patron::CirculationActions::Requests
+  require_relative "./requests/holds"
+
+  def initialize(client, patron_id)
+    @client = client
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    @client.http(:get, "/patron/#{@patron_id}/circulationActions/requests", options).try do |_response|
+      _response.body
+    end
+  end
+
+  def holds(hold_id = nil)
+    Holds.new(@client, @patron_id, hold_id)
+  end
+end

data/lib/aleph_api/restful_api_client/patron/circulation_actions.rb

@@ -0,0 +1,30 @@
+require_relative "../patron"
+
+class AlephApi::RestfulApiClient::Patron::CirculationActions
+  require_relative "./circulation_actions/cash"
+  require_relative "./circulation_actions/loans"
+  require_relative "./circulation_actions/requests"
+
+  def initialize(client, patron_id)
+    @client = client
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    @client.http(:get, "/patron/#{@patron_id}/circulationActions", options).try do |_response|
+      _response.body
+    end
+  end
+
+  def cash(cash_id = nil)
+    Cash.new(@client, @patron_id, cash_id)
+  end
+
+  def loans(loan_id = nil)
+    Loans.new(@client, @patron_id, loan_id)
+  end
+
+  def requests
+    Requests.new(@client, @patron_id)
+  end
+end

data/lib/aleph_api/restful_api_client/patron.rb

@@ -0,0 +1,20 @@
+require_relative "../restful_api_client"
+
+class AlephApi::RestfulApiClient::Patron
+  require_relative "./patron/circulation_actions"
+
+  def initialize(client, patron_id)
+    @client = client
+    @patron_id = patron_id
+  end
+
+  def get(options = {})
+    @client.http(:get, "/patron/#{@patron_id}", options).try do |_response|
+      _response.body
+    end
+  end
+
+  def circulationActions
+    CirculationActions.new(@client, @patron_id)
+  end
+end

data/lib/aleph_api/restful_api_client/record/items.rb

@@ -0,0 +1,21 @@
+require_relative "../record"
+
+class AlephApi::RestfulApiClient::Record::Items
+  def initialize(client, record_id, item_id = nil)
+    @client = client
+    @item_id = item_id
+    @record_id = record_id
+  end
+
+  def get(options = {})
+    if @item_id
+      @client.http(:get, "/record/#{@record_id}/items/#{@item_id}", options).try do |_response|
+        _response.body
+      end
+    else
+      @client.http(:get, "/record/#{@record_id}/items", options).try do |_response|
+        _response.body
+      end
+    end
+  end
+end

data/lib/aleph_api/restful_api_client/record.rb

@@ -0,0 +1,20 @@
+require_relative "../restful_api_client"
+
+class AlephApi::RestfulApiClient::Record
+  require_relative "./record/items"
+
+  def initialize(client, record_id)
+    @client = client
+    @record_id = record_id
+  end
+
+  def get(options = {})
+    @client.http(:get, "/record/#{@record_id}", options).try do |_response|
+      _response.body
+    end
+  end
+
+  def items(item_id = nil)
+    Items.new(@client, @record_id, item_id)
+  end
+end

data/lib/aleph_api/restful_api_client.rb

@@ -0,0 +1,56 @@
+require "faraday"
+require_relative "./faraday/response/enforce_utf8_encoded_body"
+require_relative "../aleph_api"
+
+# if patron curl based http client is available, require it
+begin require "patron"; rescue LoadError; end
+
+class AlephApi::RestfulApiClient
+  require_relative "./restful_api_client/patron"
+  require_relative "./restful_api_client/record"
+
+  RESTFUL_API_DEFAULT_PORT = 1891
+  RESTFUL_API_DEFAULT_ROOT_PATH="/rest-dlf"
+  RESTFUL_API_DEFAULT_SCHEME = "http"
+
+  # don's use a constant here, because faraday treats them diffrently
+  @@faraday_adapter = defined?(::Patron) ? :patron : ::Faraday.default_adapter
+
+  attr_accessor :host
+  attr_accessor :url
+
+  def url
+    @url || "#{RESTFUL_API_DEFAULT_SCHEME}://#{@host}:#{RESTFUL_API_DEFAULT_PORT}#{RESTFUL_API_DEFAULT_ROOT_PATH}"
+  end
+
+  def initialize(options = {})
+    options.symbolize_keys.try do |_sanitized_options|
+      @host = (_sanitized_options[:host] || ENV["ALEPH_RESTFUL_API_HOST"] || ENV["ALEPH_API_HOST"]).try(:strip)
+      @url = (_sanitized_options[:url] || ENV["ALEPH_RESTFUL_API_URL"]).try(:strip)
+    end
+  end
+
+  def patron(patron_id)
+    Patron.new(self, patron_id)
+  end
+
+  def record(record_id)
+    Record.new(self, record_id)
+  end
+
+  # inter-client api
+  def http(method, path, options = {})
+    # http://www.intridea.com/blog/2012/3/12/faraday-one-http-client-to-rule-them-all
+    connection = ::Faraday.new do |_builder|
+      _builder.request :url_encoded
+      _builder.use AlephApi::Faraday::Response::EnforceUtf8EncodedBody
+      _builder.adapter @@faraday_adapter
+    end
+
+    connection.send(method, "#{self.url}#{path}", options) do |_request|
+      # some http libraries (e.g. patron) have tight connection timeouts which
+      # may lead to (unnecessary) errors when used with aleph, so we raise 'em
+      _request.options.open_timeout = 20 # seconds
+    end
+  end
+end

data/lib/aleph_api/version.rb

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

data/lib/aleph_api/x_services_client.rb

@@ -0,0 +1,26 @@
+require "faraday"
+require_relative "../aleph_api"
+
+class AlephApi::XServicesClient
+  attr_accessor :host
+  attr_accessor :url
+
+  def url
+    @url || (@host ? "#{@host}/X" : nil)
+  end
+
+  def initialize(options = {})
+    options.symbolize_keys.try do |_sanitized_options|
+      @host = (_sanitized_options[:host] || ENV["ALEPH_X_XSERVICES_HOST"] || ENV["ALEPH_API_HOST"]).try(:strip)
+      @url = (_sanitized_options[:url] || ENV["ALEPH_X_SERVICES_URL"]).try(:strip)
+    end
+  end
+
+  def get(params = {})
+    Faraday.get(self.url, params).body
+  end
+
+  def post(params = {})
+    Faraday.post(self.url, params).body
+  end
+end

data/lib/aleph_api.rb

@@ -0,0 +1,8 @@
+require "active_support"
+require "active_support/core_ext"
+require "aleph_api/version"
+
+module AlephApi
+  require_relative "./aleph_api/restful_api_client"
+  require_relative "./aleph_api/x_services_client"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: aleph_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-02 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: 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
+- README.md
+- Rakefile
+- aleph_api.gemspec
+- bin/console
+- bin/setup
+- lib/aleph_api.rb
+- lib/aleph_api/faraday/response/enforce_utf8_encoded_body.rb
+- lib/aleph_api/restful_api_client.rb
+- lib/aleph_api/restful_api_client/patron.rb
+- lib/aleph_api/restful_api_client/patron/circulation_actions.rb
+- lib/aleph_api/restful_api_client/patron/circulation_actions/cash.rb
+- lib/aleph_api/restful_api_client/patron/circulation_actions/loans.rb
+- lib/aleph_api/restful_api_client/patron/circulation_actions/requests.rb
+- lib/aleph_api/restful_api_client/patron/circulation_actions/requests/holds.rb
+- lib/aleph_api/restful_api_client/record.rb
+- lib/aleph_api/restful_api_client/record/items.rb
+- lib/aleph_api/version.rb
+- lib/aleph_api/x_services_client.rb
+homepage: http://github.com/ubpb/aleph_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.8
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the aleph rest and xservices apis
+test_files: []