skala 0.3.0 → 1.1.0

data/lib/skala/adapter/authenticate_user.rb

@@ -0,0 +1,4 @@
+require_relative "../adapter"
+
+class Skala::Adapter::AuthenticateUser < Skala::Adapter::Operation
+end

data/lib/skala/adapter/create_user_hold_request.rb

@@ -0,0 +1,7 @@
+require_relative "../adapter"
+
+class Skala::Adapter::CreateUserHoldRequest < Skala::Adapter::Operation
+  class AlreadyRequestedError < Skala::Adapter::RequestFailedError; end
+
+  require_relative "./create_user_hold_request/result"
+end

data/lib/skala/adapter/create_user_hold_request/result.rb

@@ -0,0 +1,10 @@
+require "skala/adapter/operation/result"
+require "skala/hold_request"
+require_relative "../create_user_hold_request"
+
+class Skala::Adapter::CreateUserHoldRequest::Result < Skala::Adapter::Operation::Result
+  include Virtus.model
+
+  attribute :hold_request, Skala::HoldRequest
+  attribute :source
+end

data/lib/skala/adapter/delete_user_hold_request.rb

@@ -0,0 +1,7 @@
+require_relative "../adapter"
+
+class Skala::Adapter::DeleteUserHoldRequest < Skala::Adapter::Operation
+  class HoldRequestMissingError < Skala::Adapter::RequestFailedError; end
+
+  class Result < Skala::Adapter::Operation::Result; end
+end

data/lib/skala/adapter/get_record_holdable_items.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetRecordHoldableItems < Skala::Adapter::Operation
+  require_relative "./get_record_holdable_items/result"
+end

data/lib/skala/adapter/get_record_holdable_items/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/item"
+require_relative "../get_record_holdable_items"
+
+class Skala::Adapter::GetRecordHoldableItems::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :holdable_items, Array[Skala::Item]
+
+  def each
+    block_given? ? holdable_items.each { |_element| yield _element } : holdable_items.each
+  end
+end

data/lib/skala/adapter/get_record_items.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetRecordItems < Skala::Adapter::Operation
+  require_relative "./get_record_items/result"
+end

data/lib/skala/adapter/get_record_items/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/item"
+require_relative "../get_record_items"
+
+class Skala::Adapter::GetRecordItems::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :items, Array[Skala::Item]
+
+  def each
+    block_given? ? items.each { |_element| yield _element } : items.each
+  end
+end

data/lib/skala/adapter/get_records.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetRecords < Skala::Adapter::Operation
+  require_relative "./get_records/result"
+end

data/lib/skala/adapter/get_records/result.rb

@@ -0,0 +1,28 @@
+require "skala/adapter/operation/result"
+require "skala/record"
+require_relative "../get_records"
+
+class Skala::Adapter::GetRecords::Result < Skala::Adapter::Operation::Result
+  # This is the GetRecords::Result::Record, the object which holds meta informations
+  # and has a record property, which holds the actual Skala::Record.
+  class Record
+    include Virtus.model
+
+    attribute :found, Boolean, default: false
+    attribute :id, String
+    attribute :index, String
+    attribute :record, Skala::Record
+    attribute :type, String
+    attribute :version, Integer
+  end
+
+  include Enumerable
+  include Virtus.model
+
+  attribute :records, Array[Record]
+  attribute :source, String
+
+  def each
+    block_given? ? records.each { |_element| yield _element } : records.each
+  end
+end

data/lib/skala/adapter/get_user.rb

@@ -0,0 +1,4 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUser < Skala::Adapter::Operation
+end

data/lib/skala/adapter/get_user_former_loans.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUserFormerLoans < Skala::Adapter::Operation
+  require_relative "./get_user_former_loans/result"
+end

data/lib/skala/adapter/get_user_former_loans/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/loan"
+require_relative "../get_user_former_loans"
+
+class Skala::Adapter::GetUserFormerLoans::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :former_loans, Array[Skala::Loan]
+
+  def each
+    block_given? ? former_loans.each { |_element| yield _element } : former_loans.each
+  end
+end

data/lib/skala/adapter/get_user_hold_requests.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUserHoldRequests < Skala::Adapter::Operation
+  require_relative "./get_user_hold_requests/result"
+end

data/lib/skala/adapter/get_user_hold_requests/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/hold_request"
+require_relative "../get_user_hold_requests"
+
+class Skala::Adapter::GetUserHoldRequests::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :hold_requests, Array[Skala::HoldRequest]
+
+  def each
+    block_given? ? hold_requests.each { |_element| yield _element } : hold_requests.each
+  end
+end

data/lib/skala/adapter/get_user_inter_library_loans.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUserInterLibraryLoans < Skala::Adapter::Operation
+  require_relative "./get_user_inter_library_loans/result"
+end

data/lib/skala/adapter/get_user_inter_library_loans/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/loan"
+require_relative "../get_user_inter_library_loans"
+
+class Skala::Adapter::GetUserInterLibraryLoans::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :inter_library_loans, Array[Skala::Loan]
+
+  def each
+    block_given? ? inter_library_loans.each { |_element| yield _element } : inter_library_loans.each
+  end
+end

data/lib/skala/adapter/get_user_loans.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUserLoans < Skala::Adapter::Operation
+  require_relative "./get_user_loans/result"
+end

data/lib/skala/adapter/get_user_loans/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/loan"
+require_relative "../get_user_loans"
+
+class Skala::Adapter::GetUserLoans::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :loans, Array[Skala::Loan]
+
+  def each
+    block_given? ? loans.each { |_element| yield _element } : loans.each
+  end
+end

data/lib/skala/adapter/get_user_transactions.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::GetUserTransactions < Skala::Adapter::Operation
+  require_relative "./get_user_transactions/result"
+end

data/lib/skala/adapter/get_user_transactions/result.rb

@@ -0,0 +1,14 @@
+require "skala/adapter/operation/result"
+require "skala/transaction"
+require_relative "../get_user_transactions"
+
+class Skala::Adapter::GetUserTransactions::Result < Skala::Adapter::Operation::Result
+  include Enumerable
+  include Virtus.model
+
+  attribute :transactions, Array[Skala::Transaction]
+
+  def each
+    block_given? ? transactions.each { |_element| yield _element } : transactions.each
+  end
+end

data/lib/skala/adapter/operation.rb

@@ -1,6 +1,8 @@
 require_relative "../adapter"
 
 class Skala::Adapter::Operation
+  require_relative "./operation/result"
+
   attr_accessor :adapter
 
   def initialize(adapter)

data/lib/skala/adapter/operation/request.rb

@@ -0,0 +1,6 @@
+require_relative "../operation"
+
+class Skala::Adapter::Operation::Request
+  include Skala::DeepDupable
+  include Virtus.model
+end

data/lib/skala/adapter/operation/result.rb

@@ -0,0 +1,7 @@
+require_relative "../operation"
+
+class Skala::Adapter::Operation::Result
+  include Virtus.model
+
+  attribute :source
+end

data/lib/skala/adapter/renew_user_loan.rb

@@ -0,0 +1,7 @@
+require_relative "../adapter"
+
+class Skala::Adapter::RenewUserLoan < Skala::Adapter::Operation
+  class RenewFailedError < Skala::Adapter::RequestFailedError; end
+
+  require_relative "./renew_user_loan/result"
+end

data/lib/skala/adapter/renew_user_loan/result.rb

@@ -0,0 +1,7 @@
+require_relative "../renew_user_loan"
+
+class Skala::Adapter::RenewUserLoan::Result
+  include Virtus.model
+
+  attribute :source
+end

data/lib/skala/adapter/renew_user_loans.rb

@@ -0,0 +1,5 @@
+require_relative "../adapter"
+
+class Skala::Adapter::RenewUserLoans < Skala::Adapter::Operation
+  require_relative "./renew_user_loans/result"
+end

data/lib/skala/adapter/renew_user_loans/result.rb

@@ -0,0 +1,9 @@
+require "skala/loan"
+require_relative "../renew_user_loans"
+
+class Skala::Adapter::RenewUserLoans::Result
+  include Virtus.model
+
+  attribute :renewed_loans, Array[Skala::Loan]
+  attribute :source
+end

data/lib/skala/adapter/search.rb

@@ -0,0 +1,6 @@
+require_relative "../adapter"
+
+class Skala::Adapter::Search < Skala::Adapter::Operation
+  require_relative "./search/request"
+  require_relative "./search/result"
+end

data/lib/skala/adapter/search/request.rb

@@ -0,0 +1,91 @@
+require "json"
+require "skala/adapter/operation/request"
+require_relative "../search"
+
+class Skala::Adapter::Search::Request < Skala::Adapter::Operation::Request
+  # facets
+  require_relative "./request/histogram_facet"
+  require_relative "./request/range_facet"
+  require_relative "./request/terms_facet"
+
+  # queries
+  require_relative "./request/ids_query"
+  require_relative "./request/match_query"
+  require_relative "./request/ordered_terms_query"
+  require_relative "./request/query_string_query"
+  require_relative "./request/range_query"
+  require_relative "./request/simple_query_string_query"
+  require_relative "./request/unscored_terms_query"
+
+  # sort
+  require_relative "./request/sort_request"
+
+  # attributes
+  attribute :facets,        Array[Facet],       lazy: true
+  attribute :facet_queries, Array[Query],       lazy: true
+  attribute :from,          Fixnum,             default: 0
+  attribute :queries,       Array[Query],       required: true
+  attribute :size,          Fixnum,             default: 25
+  attribute :sort,          Array[SortRequest], lazy: true
+
+  # override facet setter in order to determine facet type
+  def facets=(value)
+    if sanitized_value = [value].flatten(1).compact.presence
+      mapped_values = sanitized_value.map do |_element|
+        _element.is_a?(Hash) ? self.class.facet_factory(_element) : _element
+      end
+
+      super(mapped_values)
+    end
+  end
+
+  # override (facet_)queries setters in order to determine query type
+  def facet_queries=(value)
+    if sanitized_value = [value].flatten(1).compact.presence
+      mapped_values = sanitized_value.map do |_element|
+        _element.is_a?(Hash) ? self.class.query_factory(_element) : _element
+      end
+
+      super(mapped_values)
+    end
+  end
+
+  def queries=(value)
+    if sanitized_value = [value].flatten(1).compact.presence
+      mapped_values = sanitized_value.map do |_element|
+        _element.is_a?(Hash) ? self.class.query_factory(_element) : _element
+      end
+
+      super(mapped_values)
+    end
+  end
+
+  #
+  # helpers to implement facets/queries setters
+  #
+  def self.factory(postfix) # e.g. :facet or :query which turns to "#{type}_#{postfix}", e.g. "match_query" or "range_facet"
+    -> (value) do
+      class_name = "#{value[:type] || value["type"]}_#{postfix}".classify
+
+      if const_defined?(class_name)
+        const_get(class_name).new(value)
+      else
+        raise ArgumentError.new("Unknown #{postfix} type!")
+      end
+    end
+  end
+
+  def self.facet_factory(value)
+    factory(:facet).call(value)
+  end
+
+  def self.query_factory(value)
+    factory(:query).call(value)
+  end
+
+  # TODO: move to frontend
+  def to_param(*)
+    # binding.pry
+    to_json
+  end
+end

data/lib/skala/adapter/search/request/date_histogram_facet.rb

@@ -0,0 +1,5 @@
+require_relative "../request"
+require_relative "./facet"
+
+class Skala::Adapter::Search::Request::DateHistogramFacet < Skala::Adapter::Search::Request::Facet
+end

data/lib/skala/adapter/search/request/facet.rb

@@ -0,0 +1,29 @@
+require_relative "../request"
+
+class Skala::Adapter::Search::Request::Facet
+  include Virtus.model
+
+  attribute :type, String, default: -> (instance, _) do
+    class_name = instance.class.to_s.demodulize.underscore
+
+    if (splitted_class_name = class_name.split("_")).last == "facet"
+      splitted_class_name[0..-2].join("_")
+    else
+      class_name
+    end
+  end
+
+  require_relative "./histogram_facet"
+  require_relative "./range_facet"
+  require_relative "./terms_facet"
+
+  def self.factory(options)
+    if (options[:type] || options["type"]) == "histogram"
+      parent::HistogramFacet.new(options)
+    elsif (options[:type] || options["type"]) == "range"
+      parent::RangeFacet.new(options)
+    elsif (options[:type] || options["type"]) == "terms"
+      parent::TermsFacet.new(options)
+    end
+  end
+end

data/lib/skala/adapter/search/request/histogram_facet.rb

@@ -0,0 +1,8 @@
+require_relative "../request"
+require_relative "./facet"
+
+class Skala::Adapter::Search::Request::HistogramFacet < Skala::Adapter::Search::Request::Facet
+  attribute :field,    String,  required: true
+  attribute :interval, Integer, default: 1
+  attribute :name,     String,  required: true
+end