summon 1.0.0

data/lib/summon/log.rb

@@ -0,0 +1,40 @@
+require 'logger'
+
+module Summon
+  class Log
+    
+    attr_reader :impl
+    
+    def initialize(spec = nil)
+      @impl = create spec
+    end
+    
+    def method_missing(name, *args, &block)
+      @impl.respond_to?(name) ? @impl.send(name, *args, &block) : super(name, *args, &block)
+    end
+    
+    def respond_to?(name)
+      @impl.respond_to?(name) || super(name)
+    end
+    
+    private
+    
+    def create(spec)
+      case spec
+      when nil
+        Logger.new($stderr).tap do |this|
+          this.level = Logger::WARN
+        end
+      when Hash
+        level = spec[:level] || "warn"
+        init = spec[:initialize] || [$stderr]
+        Logger.new(*init).tap do |this|
+          this.level = Logger.const_get(level.to_s.upcase)
+        end
+      else
+        spec
+      end
+    end
+    
+  end
+end

data/lib/summon/schema.rb

@@ -0,0 +1,109 @@
+
+module Summon
+  class Schema
+    def self.inherited(mod)            
+      class << mod
+        include Summon::Schema::Initializer
+        include Summon::Schema::ClassMethods
+      end
+      mod.module_eval do
+        include Summon::Schema::InstanceMethods
+      end
+      mod.summon!
+    end
+
+    module Initializer
+      def new(values = {})
+        dup = {}
+        for k, v in values
+          dup[k.to_s] = v
+        end
+        instance = allocate
+        instance.instance_eval do
+          @src = values
+        end
+        for attribute in @attrs
+          instance.instance_variable_set("@#{attribute.name}", attribute.get(dup))
+        end
+        instance
+      end
+    end
+    
+    module ClassMethods      
+      
+      def attr(name, options = {})
+        if name.to_s =~ /^(.*)\?$/
+          name = $1
+          options[:boolean] = true
+        end        
+        symbol = name.to_sym
+        @attrs << ::Summon::Schema::Attr.new(symbol, options)
+        define_method(name) do |*args|
+          self.instance_variable_get("@#{name}")  
+        end
+        if options[:boolean]
+          define_method("#{name}?") do
+            send(name)
+          end
+        end
+      end
+      
+      def attrs
+        @attrs
+      end
+      
+      def summon!
+        @attrs = []
+        attr_reader :src
+      end
+    end
+    
+    module InstanceMethods
+      def to_json(*a)
+        self.class.attrs.inject({}) do |json, attr|
+          json.merge attr.name => self.send(attr.name)
+        end.to_json(*a)        
+      end    
+    end
+    
+    class Attr
+      attr_reader :name
+      def initialize(name, options)
+        @name = name
+        @boolean = options[:boolean]
+        @camel_name = camelize(name.to_s)
+        @pascal_name = @camel_name.gsub(/^\w/) {|first| first.upcase}
+        @transform = options[:transform]
+        @json_name = options[:json_name].to_s if options[:json_name]
+        @json_name = "is#{@pascal_name}" if @boolean unless @json_name
+        @single = options[:single].nil? ? !(name.to_s.downcase =~ /s$/) : options[:single]
+      end
+      
+      def get(json)      
+        raw = json[@json_name || @camel_name]
+        raw = json[@pascal_name] if raw.nil?
+        if raw.nil?
+          @single ? nil : []
+        else
+          raw = @single && raw.kind_of?(Array) ? raw.first : raw
+          transform(raw) || raw          
+        end
+      end
+      
+      def camelize(str)
+        str.gsub /(\w)_(\w)/ do 
+          "#{$1}#{$2.upcase}"
+        end
+      end
+      
+      def transform(raw)
+        if @transform
+          ctor = proc do |h| 
+            ::Summon.const_get(@transform).new(h)
+          end
+          raw.kind_of?(Array) ? raw.map(&ctor) : ctor.call(raw)
+        end
+      end
+    end
+  end
+end

data/lib/summon/schema/availability.rb

@@ -0,0 +1,14 @@
+class Summon::Availability < Summon::Schema
+  attr :token
+  attr :status
+  attr :status_message
+  attr :location
+  attr :location_string
+  attr :call_number
+
+  def self.parse_results(results)
+    results["Result"]["RecordSummary"].map do |record| 
+      new(record["Record"].merge(:token => record["ID"]))
+    end
+  end
+end

data/lib/summon/schema/citation.rb

@@ -0,0 +1,11 @@
+class Summon::Citation < Summon::Schema
+  attr :name
+  attr :label
+  attr :short_name
+  attr :caption
+  attr :text
+  
+  def self.parse_results(results)
+    results["Results"]["Citations"]["Citation"].map {|result| new(result) }
+  end
+end

data/lib/summon/schema/date.rb

@@ -0,0 +1,23 @@
+
+class Summon::Date < Summon::Schema
+  attr :day
+  attr :month
+  attr :text
+  attr :year
+  
+  def day
+    @day.to_i if @day
+  end
+  
+  def month
+    @month.to_i if @month
+  end
+  
+  def year
+    @year.to_i if @year
+  end
+
+  def to_s(options = {})
+    "Date: #{text}"
+  end
+end

data/lib/summon/schema/document.rb

@@ -0,0 +1,84 @@
+
+class Summon::Document < Summon::Schema
+  attr :id, :json_name => "ID"
+  attr :title
+  attr :subtitle
+  attr :publication_title
+  attr :publication_series_title
+  attr :content_type
+
+  attr :authors, :json_name => "Author"
+  attr :publishers, :json_name => "Publisher"
+  attr :volume
+  attr :issue
+  attr :start_page
+  attr :end_page
+  attr :page_count
+  attr :publication_date, :json_name => "PublicationDate_xml",  :transform => :Date
+  
+  attr :dissertation_advisor
+  attr :dissertation_category
+  attr :dissertation_degree
+  attr :dissertation_degree_date
+  attr :dissertation_degree_date_decade
+  attr :dissertation_degree_date_century
+  attr :dissertation_degree_date_year
+  attr :dissertation_school
+  
+  attr :library
+  attr :call_number, :json_name => "LCCallNum"
+  attr :doi, :json_name => "DOI"
+  attr :isbns, :json_name => "ISBN"
+  attr :issns, :json_name => "ISSN"
+  attr :patent_number
+  
+  
+  attr :subject_terms
+  attr :genres, :json_name => "Genre"
+  attr :languages, :json_name => "Language"
+  
+  attr :snippet #highlight
+  attr :abstract
+  attr :fulltext, :boolean => true, :json_name => "hasFullText"
+  attr :url
+  attr :open_url
+  attr :subject_terms
+
+  attr :thumbnail_small, :json_name => "Thumbnail-s"
+  attr :thumbnail_medium, :json_name => "Thumbnail-m"
+  attr :thumbnail_large, :json_name => "Thumbnail-l"
+  attr :availability_token
+
+
+  def isbn
+    @isbns.first
+  end
+
+  def pages?
+    @start_page || @page_count
+  end
+  
+  def publication_date
+    @publication_date || Summon::Date.new({})
+  end
+
+  def publisher
+    @publishers.first
+  end
+  
+  def authors
+    @authors.map {|n| Summon::Author.new(n)}
+  end
+  
+  def to_s(options = {})
+    "Title: #{title}"
+  end
+end
+
+
+class Summon::Author < Struct.new(:name)
+  def name(*args)
+    super()
+  end
+end
+

data/lib/summon/schema/error.rb

@@ -0,0 +1,4 @@
+class Summon::Error < Summon::Schema
+  attr :suggestion, :transform => :Suggestion
+  attr :message
+end

data/lib/summon/schema/facet.rb

@@ -0,0 +1,51 @@
+
+class Summon::Facet < Summon::Schema
+  attr :page_size
+  attr :display_name
+  attr :field_name
+  attr :combine_mode
+  attr :page_number
+  attr :counts, :transform => :FacetCount
+  attr :remove_command
+  attr :remove_value_filters_command    
+
+  def to_s
+    "Facet(#{display_name}, #{field_name})"
+  end
+
+  def range?
+    false
+  end
+  
+  def empty?
+    @counts.empty?
+  end
+end
+
+class Summon::FacetCount < Summon::Schema
+  attr :value
+  attr :count
+  attr :negated?
+  attr :applied?
+  attr :further_limiting?
+  attr :apply_command
+  attr :apply_negated_command
+  attr :remove_command
+
+  def escaped_value
+    Summon.escape(@value)
+  end
+  
+  def excluded?
+    negated?
+  end
+  
+  def included?
+    applied? && !excluded?
+  end
+ 
+  def abs_value
+    value.sub /^-/, ''
+  end
+
+end

data/lib/summon/schema/query.rb

@@ -0,0 +1,96 @@
+class Summon::Query < Summon::Schema
+
+  attr :page_number
+  attr :page_size
+  attr :search_terms
+  attr :query_string
+  attr :facet_value_filters, :transform => :FacetValueFilter
+  attr :facet_value_group_filters, :transform => :FacetValueGroupFilter
+  attr :text_queries
+  attr :text_filters
+  attr :range_filters, :transform => :RangeFilter
+  attr :facet_fields
+  attr :sorts, :transform => :Sort, :json_name => "sort"
+  attr :params
+  attr :holdings_only_enabled?
+
+  def sort
+    @sorts.first
+  end
+    
+  def date_min
+    date_filter do |f|
+      val = f.range.min_value
+      return val == "*" ? nil : val.to_i
+    end
+  end
+
+  def date_max
+    date_filter do |f|    
+      val = f.range.max_value
+      return val == "*" ? nil : val.to_i
+    end
+  end
+  
+  def date_filter
+    range_filters.find {|f| f.field_name == "PublicationDate"}.tap do |this|
+      yield this if this && block_given?
+    end
+  end
+      
+  def to_hash
+    return {} if query_string.nil? || query_string == ""
+    params = query_string.split("&").inject({}) do |params, param|
+      name, value = param.split("=")
+      name = CGI.unescape(name)
+      value = CGI.unescape(value)
+      params.tap do
+        case params[name]
+          when nil
+            params[name] = value
+          when String
+            params[name] = [params[name], value]
+          else
+            params[name] << value
+        end
+      end
+    end
+  end
+end
+
+class Summon::Sort < Summon::Schema
+  attr :field_name
+  attr :sort_order
+end
+
+class Summon::FacetValueFilter < Summon::Schema
+  attr :negated?
+  attr :value
+  attr :field_name
+  attr :remove_command
+  attr :negate_command
+end
+
+class Summon::FacetValueGroupFilter < Summon::Schema
+  attr :combine_mode
+  attr :tag
+  attr :field_name
+  attr :remove_command
+  attr :values, :transform => :FacetValueGroupFilterValue
+end
+
+class Summon::FacetValueGroupFilterValue < Summon::Schema
+  attr :value
+  attr :remove_command
+end
+
+class Summon::RangeFilter < Summon::Schema
+  attr :field_name
+  attr :range, :transform => :Range
+  attr :remove_command
+end
+
+class Summon::Range < Summon::Schema
+  attr :min_value
+  attr :max_value
+end

data/lib/summon/schema/range.rb

@@ -0,0 +1,52 @@
+
+class Summon::RangeFacet < Summon::Schema
+  attr :display_name
+  attr :field_name
+  attr :remove_command
+  attr :counts, :transform => :RangeCount
+  
+  def clear_filters_command
+    "removeRangeFilter(#{field_name})"
+  end
+  
+  def empty?
+    false
+  end
+  
+  # #COMPATIBILITY
+  # 
+  # alias_method :name, :display_name
+  # alias_method :label, :display_name
+  # alias_method :facets, :counts
+  # alias_method :ranges, :counts
+
+end
+
+class Summon::RangeCount < Summon::Schema
+  attr :count
+  attr :applied?
+  attr :apply_command
+  attr :range
+  
+  def min
+    @range["minValue"]
+  end
+  
+  def max
+    @range["maxValue"]
+  end
+
+  def abs_value
+    ""
+  end
+  
+  def apply_negated_command
+    ""
+  end
+  
+  alias_method :included?, :applied?
+   
+  def excluded?
+      false
+    end
+end