skala 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aae9b8b40ca397d60ff19d4b4e18388bff0c0394
-  data.tar.gz: b560ab30285fab610ba6b04de36c21f94070983f
+  metadata.gz: 2b49a392c417efbb429dc81c5191f1681f69d7c4
+  data.tar.gz: 0915bf5e0d80f0815415ce6051e1e38689736943
 SHA512:
-  metadata.gz: 66c797c3536ab3e72c8be2c57d2eb59585df9757387663c0d48a454f770297d111a8a440728fb2d7f625eb14666899713f52b1740bfeae8e55cbae433854fc99
-  data.tar.gz: 5fe5fd9cfdea4785ed5b1ef1866a7813dbeb80385eab89bec1ecd82734f3370e6a17e3d8c876a70b23d94f8eeecae1b672a4f7eeba31f6df4a301fa7cb18e978
+  metadata.gz: 5e8696bd6f15999acd5c28a91229ffc252b4e93e998b2cba058e402eafdab6a3b3ca642efe307555d9e677e3ba0591c2cfbd3fcfc68e0fa8936bdf01d9f1894d
+  data.tar.gz: b8cc76becfede01661bdcccaee8bbf3a40ed89be96e6e58946b38d51e8d58b5f14f1aaecca482f630b9d54ae27751acec5e09564840f951578b84bfc0a6d59e7

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle
@@ -7,16 +8,15 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
-lib/bundler/man
+doc
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
 tmp
+log
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+*.sqlite3

data/Gemfile

@@ -1,8 +1,17 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in skala.gemspec
 gemspec
 
+group :development, :test do
+  gem "bundler",   ">= 1.9"
+  gem "rake",      ">= 10.0"
+  gem "rspec",     ">= 3.0.0",  "< 4.0.0"
+  gem "simplecov", ">= 0.8.0"
+  gem "sqlite3",   ">= 1.3"
+  gem "vcr",       ">= 2.9.0",  "< 3.0.0"
+  gem "webmock",   ">= 1.19.0", "< 2.0.0"
+end
+
 if !ENV["CI"]
   group :development do
     gem "pry",                "~> 0.9.12.6"

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2015 Michael Sievers
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2015 University of 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:
+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 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.
+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,34 +1 @@
-# Skala
-[![Build Status](https://travis-ci.org/ubpb/skala.svg?branch=master)](https://travis-ci.org/ubpb/skala)
-[![Test Coverage](https://codeclimate.com/github/ubpb/skala/badges/coverage.svg)](https://codeclimate.com/github/ubpb/skala)
-[![Code Climate](https://codeclimate.com/github/ubpb/skala/badges/gpa.svg)](https://codeclimate.com/github/ubpb/skala)
-
-Skala was created as a base for common adapter specific code and functionality. It was extract from ```celsius``` and ```fahrenheit``` to avoid code duplication and unnecessary inter-gem-linkage.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'skala'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install skala
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/ubpb/skala/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
+TBD.

data/README.primo_adapter.md

@@ -0,0 +1,42 @@
+## Primo Central
+
+### Known Facets
+
+* creator
+* lcc
+  * Library of Congress Classification (https://www.loc.gov/catdir/cpso/lcco)
+* lang
+  * ISO 639-2/B language codes
+* rtype
+  * books
+  * reviews
+  * articles
+  * journals
+  * other
+  * text_resources
+  * websites
+  * newspaper_articles
+  * reference_entrys
+  * technical_reports
+  * research_datasets
+  * databases
+  * Dissertations
+  * images
+  * conference_proceedings
+  * media
+* topic
+* tlevel
+  * online_resources
+  * peer_reviewed
+* pfilter
+  * same types as rtype
+* creationdate
+  * four digit strings like "2008"
+* domain
+  * something like publisher, but with a more wide meaning
+  * examples
+    * Literature Resource Center (Gale)
+    * ITPro (Books24x7)
+    * SpringerLink
+* jtitle
+  * the journal title

data/bin/console

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

data/config/initializers/skala.rb

@@ -0,0 +1,5 @@
+module Skala
+  def self.config
+    @config ||= Skala::Config.new(Rails.application.config_for(:skala))
+  end
+end

data/config/skala.yml

@@ -0,0 +1,65 @@
+common_settings: &common_settings
+  #
+  # Example config
+  #
+
+  # ils_adapter:
+  #   class_name: "Skala::AlephAdapter"
+  #   options:
+  #     default_document_base: "PAD01"
+  #     default_user_library: "PAD50"
+  #     restful_api_url: "http://ubtest.uni-paderborn.de:1891/rest-dlf"
+  #     x_services_url: "https://ubtest.uni-paderborn.de/X"
+  #     #source_id: "PAD_ALEPH"
+
+  # search_scopes:
+  #   local:
+  #     search_engine_adapter:
+  #       class_name: "Skala::ElasticsearchAdapter"
+  #       options:
+  #         hosts:
+  #           - host: "ubstage1.uni-paderborn.de"
+  #         facets_via_aggregations: true
+  #         index: catalog
+  #     defaults:
+  #       facets:
+  #         __aggregatable.creator:
+  #           terms:
+  #             field: "__aggregatable.creator"
+  #             shard_size: 75
+
+  #         __aggregatable.subject:
+  #           terms:
+  #             field: "__aggregatable.subject"
+  #             shard_size: 75
+
+  #         __aggregatable.classification:
+  #           terms:
+  #             field: "__aggregatable.classification"
+  #             shard_size: 75
+
+  #       search_request:
+  #         from: 0
+  #         size: 20
+  #         sort:
+  #           - _score
+
+  #     searchable_fields:
+  #       - _all
+  #       - "__searchable.creator"
+  #       - "__searchable.title"
+  #       - "__searchable.subject"
+  #       - "__searchable.identifier"
+
+  #     sortable_fields:
+  #       - _score
+
+development: &development
+  <<: *common_settings
+
+test:
+  <<: *development
+
+production:
+ <<: *common_settings
+

data/db/migrate/20141006133522_create_skala_users.rb

@@ -0,0 +1,13 @@
+class CreateSkalaUsers < ActiveRecord::Migration
+  def change
+    create_table :skala_users do |t|
+      t.string :api_key
+      t.string :username
+
+      t.timestamps
+    end
+
+    add_index :skala_users, :api_key, unique: true
+    add_index :skala_users, :username, unique: true
+  end
+end

data/db/migrate/20141006133649_create_skala_user_watch_lists.rb

@@ -0,0 +1,14 @@
+class CreateSkalaUserWatchLists < ActiveRecord::Migration
+  def change
+    create_table :skala_user_watch_lists do |t|
+      t.text       :description
+      t.string     :name
+      t.boolean    :public, default: false
+      t.references :user
+
+      t.timestamps
+    end
+
+    add_index :skala_user_watch_lists, :user_id
+  end
+end

data/db/migrate/20141006135644_create_skala_user_watch_list_entries.rb

@@ -0,0 +1,13 @@
+class CreateSkalaUserWatchListEntries < ActiveRecord::Migration
+  def change
+    create_table :skala_user_watch_list_entries do |t|
+      t.string     :record_id
+      t.string     :scope_id
+      t.references :watch_list
+
+      t.timestamps
+    end
+
+    add_index :skala_user_watch_list_entries, :watch_list_id
+  end
+end

data/db/migrate/20141006140435_create_skala_user_notes.rb

@@ -0,0 +1,16 @@
+class CreateSkalaUserNotes < ActiveRecord::Migration
+  def change
+    create_table :skala_user_notes do |t|
+      t.references :user
+
+      t.string     :record_id
+      t.string     :scope_id
+      t.text       :value, limit: 1073741823
+
+      t.timestamps
+    end
+
+    add_index :skala_user_notes, :record_id
+    add_index :skala_user_notes, :user_id
+  end
+end

data/lib/skala.rb

@@ -1,7 +1,40 @@
-require "skala/version"
+require "active_support"
+require "active_support/core_ext"
+require "virtus"
+
+if ::Object.const_defined?("Rails")
+  require_relative "skala/engine"
+end
 
 module Skala
+  # virtus objects do not deep_dup correctly, so the have to include this
+  module DeepDupable
+    def deep_dup
+      Marshal.load(Marshal.dump(self))
+    end
+  end
+
   require_relative "skala/adapter"
-  require_relative "skala/i18n"
-  require_relative "skala/transformation"
+  require_relative "skala/aleph_adapter"
+  require_relative "skala/elasticsearch_adapter"
+  require_relative "skala/primo_adapter"
+
+  require_relative "skala/hold_request"
+  require_relative "skala/item"
+  require_relative "skala/loan"
+  require_relative "skala/record"
+  require_relative "skala/transaction"
+end
+
+# patch Virtus to not serialize unset lazy attributes
+class Virtus::AttributeSet
+  def get(object)
+    each_with_object({}) do |attribute, attributes|
+      name = attribute.name
+
+      if attribute.public_reader? && (!attribute.lazy? || attribute.defined?(object))
+        attributes[name] = object.__send__(name)
+      end
+    end
+  end
 end

data/lib/skala/adapter.rb

@@ -1,8 +1,126 @@
-require_relative "./i18n"
 require_relative "../skala"
 
-class Skala::Adapter
-  require_relative "./adapter/operation"
+module Skala
+  class Adapter
+    require_relative "adapter/operation"
 
-  include Skala::I18n
+    #
+    # errors (must come before includes for operation to be able to derive own errors)
+    #
+    class Error < StandardError; end
+    class BadRequestError < Error; end
+    class RequestFailedError < Error; end
+
+    # operations
+    require_relative "./adapter/authenticate_user"
+    require_relative "./adapter/create_user_hold_request"
+    require_relative "./adapter/delete_user_hold_request"
+    require_relative "./adapter/get_record_holdable_items"
+    require_relative "./adapter/get_record_items"
+    require_relative "./adapter/get_records"
+    require_relative "./adapter/get_user"
+    require_relative "./adapter/get_user_former_loans"
+    require_relative "./adapter/get_user_hold_requests"
+    require_relative "./adapter/get_user_inter_library_loans"
+    require_relative "./adapter/get_user_loans"
+    require_relative "./adapter/get_user_transactions"
+    require_relative "./adapter/renew_user_loan"
+    require_relative "./adapter/renew_user_loans"
+    require_relative "./adapter/search"
+    require_relative "./adapter/update_user"
+
+    # TODO: all others are 'typed', e.g. get_user, get_record_items ... should this be typed, too ?
+    def search(request, *args)
+      request = request.is_a?(Search::Request) ? request : Search::Request.new(request)
+      self.class::Search.new(self).call(request, *args)
+    end
+
+    #
+    # records
+    #
+    def get_records(*args)
+      self.class::GetRecords.new(self).call(*args)
+    end
+
+    #
+    # record item(s)
+    #
+    def get_record_items(*args)
+      self.class::GetRecordItems.new(self).call(*args)
+    end
+
+    def get_record_holdable_items(*args)
+      self.class::GetRecordHoldableItems.new(self).call(*args)
+    end
+
+    #
+    # user(s)
+    #
+    def authenticate_user(*args)
+      self.class::AuthenticateUser.new(self).call(*args)
+    end
+
+    def get_user(*args)
+      self.class::GetUser.new(self).call(*args)
+    end
+
+    def update_user(*args)
+      self.class::UpdateUser.new(self).call(*args)
+    end
+
+    #
+    # user cash
+    #
+    def get_user_cash(*args)
+      self.class::GetUserCash.new(self).call(*args)
+    end
+
+    #
+    # user hold request(s)
+    #
+    def create_user_hold_request(*args)
+      self.class::CreateUserHoldRequest.new(self).call(*args)
+    end
+
+    def delete_user_hold_request(*args)
+      self.class::DeleteUserHoldRequest.new(self).call(*args)
+    end
+
+    def get_user_hold_requests(*args)
+      self.class::GetUserHoldRequests.new(self).call(*args)
+    end
+
+    #
+    # user inter library loans
+    #
+    def get_user_inter_library_loans(*args)
+      self.class::GetUserInterLibraryLoans.new(self).call(*args)
+    end
+
+    #
+    # user loan(s)
+    #
+    def get_user_former_loans(*args)
+      self.class::GetUserFormerLoans.new(self).call(*args)
+    end
+
+    def get_user_loans(*args)
+      self.class::GetUserLoans.new(self).call(*args)
+    end
+
+    def renew_user_loan(*args)
+      self.class::RenewUserLoan.new(self).call(*args)
+    end
+
+    def renew_user_loans(*args)
+      self.class::RenewUserLoans.new(self).call(*args)
+    end
+
+    #
+    # user transactions
+    #
+    def get_user_transactions(*args)
+      self.class::GetUserTransactions.new(self).call(*args)
+    end
+  end
 end