summon 1.0.0

data/lib/summon/transport/canned.rb

@@ -0,0 +1,9 @@
+module Summon
+  module Transport    
+    class Canned
+      def get(*args)
+        JSON.parse(File.read(File.dirname(__FILE__) + '/canned.json'))
+      end
+    end    
+  end
+end

data/lib/summon/transport/errors.rb

@@ -0,0 +1,12 @@
+module Summon::Transport
+  
+  class TransportError < StandardError; end
+  
+  class AuthorizationError < TransportError; end
+  
+  class ServiceError < TransportError; end
+  
+  class RequestError < TransportError; end
+  
+  class UnknownResponseError < TransportError; end
+end

data/lib/summon/transport/headers.rb

@@ -0,0 +1,55 @@
+require 'time'
+require 'uri'
+require 'openssl'
+require 'sha1'
+require 'base64'
+
+module Summon::Transport
+  class Headers < Hash
+    include Qstring
+    def initialize(options = {})
+      @params       = options[:params] || {}
+      @url          = options[:url]
+      @uri          = URI.parse(@url)
+      @access_id    = options[:access_id]
+      @client_key   = options[:client_key]
+      @secret_key   = options[:secret_key]
+      @session_id   = options[:session_id]
+      @log          = Summon::Log.new(options[:log])
+      @accept       = "application/#{options[:accept] || 'json'}"
+      @time         = Time.now.httpdate
+      validate!
+      merge!({
+        "Content-Type" => "application/x-www-form-urlencoded; charset=utf8",
+        "Accept" => @accept,
+        "x-summon-date" => @time,
+        "x-summon-session-id" => @session_id,
+        "Authorization" => "Summon #{[@access_id, @client_key, digest].reject {|o| o.nil?}.join(';')}",
+        "Host" => "#{@uri.host}:#{@uri.port}"
+      }).reject! {|k,v| v.nil?}
+      @log.debug {
+        "#{self.class.name}\n#{self.map {|k,v| "#{k}: #{v}"}.join("\n")}"          
+      }
+    end
+    
+    def digest
+      id = [@accept, @time, "#{@uri.host}:#{@uri.port}", @uri.path, qstr].join("\n") + "\n"
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @secret_key, id)).chomp.tap {|digest|
+        # @log.debug {"ID: #{id.inspect}"}
+        # @log.debug {"DIGEST: #{digest}\n"}
+      }
+    end
+    
+    def qstr
+      to_query_string(@params, false)      
+    end
+  
+    private
+    
+    def validate!
+      raise AuthorizationError, "No Access ID specified" if @access_id.nil?
+      raise AuthorizationError, "Secret Key not provided for Access ID: #{@access_id}" if @secret_key.nil?
+    end      
+  
+  end
+end

data/lib/summon/transport/http.rb

@@ -0,0 +1,114 @@
+require 'socket'
+require 'net/http'
+
+module Summon::Transport
+  class Http
+    include Qstring
+
+    DEFAULTS = {:url => "http://api.summon.serialssolutions.com"}
+
+    def initialize(options = {:url => nil, :access_id => nil, :secret_key => nil, :client_key => nil, :session_id => nil, :log => nil})
+      @options    = DEFAULTS.merge options
+      @access_id  = @options[:access_id]
+      @secret_key = @options[:secret_key]
+      @client_key = @options[:client_key]
+      @session_id = @options[:session_id] || "SUMMON-SESSION-#{Socket.gethostname}-#{$$}-#{sidalloc}"
+      @url        = @options[:url]
+      @log        = Summon::Log.new(options[:log])
+    end
+
+    def get(path, params = {})
+      session_id = params["s.session.id"]
+      params.delete "s.session.id"
+      urlget "#{@url}#{path}?#{to_query_string(params, true)}", params, session_id
+    end    
+
+    def urlget(url, params = nil, session_id = nil)
+      uri = URI.parse url
+      params ||= from_query_string(uri.query)      
+      session_id ||= @session_id
+      headers = Headers.new(
+        :url => url,
+        :params => params,
+        :access_id => @access_id,
+        :secret_key => @secret_key,
+        :client_key => @client_key,
+        :session_id => session_id,
+        :log => @log
+      )
+      
+      @log.info("ruby-summon:transport") {
+        "GET: #{url}"
+      }
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.start do
+        get = Net::HTTP::Get.new("#{uri.path}#{'?' + uri.query if uri.query && uri.query != ''}")
+        get.merge! headers
+        http.request(get) do |response|          
+          case response
+            when Net::HTTPSuccess
+              return parse(response)
+            when Net::HTTPUnauthorized
+              raise AuthorizationError, status(response)
+            when Net::HTTPClientError
+              raise RequestError, error(response)
+            when Net::HTTPServerError
+              raise ServiceError, error(response)
+            else
+              raise UnknownResponseError, "Unknown response: #{response}"
+          end
+        end
+      end
+    end
+
+    def parse(response)
+      case response.content_type
+      when "application/json"
+        JSON.parse(response.body).tap do |json|
+          @log.debug("ruby-summon::transport") { "JSON RESPONSE: #{json.inspect}" }
+        end
+      
+      when "text/plain"
+        response.body.tap do |text|
+          @log.debug("ruby-summon::transport") { "TEXT RESPONSE: #{text.inspect}" }
+        end
+        
+      else
+        raise ServiceError, "service returned unexpected #{response.content_type} : #{response.body}"
+      end
+    end
+    
+    def error(response)
+      case response.content_type
+      when "application/json"
+        JSON.parse(response.body)["errors"].first["message"]
+      else
+        status(response)
+      end
+    end
+
+    def status(response)
+      "#{response.code}: #{response.message}"
+    end
+    
+    private
+    
+    @sessions = 0
+    
+    def sidalloc
+      self.class.instance_eval do
+        @sessions += 1
+      end
+    end    
+    
+  end  
+end
+
+
+module Net::HTTPHeader
+  def merge!(hash)
+    for k, v in hash
+      self[k] = v
+    end
+  end
+end

data/lib/summon/transport/qstring.rb

@@ -0,0 +1,49 @@
+
+require 'cgi'
+
+module Summon::Transport
+  module Qstring
+  
+    def to_query_string(hash, urlencode = true)
+      hash.reject {|k,v| v.nil? || v == ''}.inject([]) do |qs,pair|
+        qs.tap do
+          k,v = pair
+          if v.is_a?(Array)
+            for el in v
+              qs << encode_param(k, el, urlencode)
+            end
+          else
+            qs << encode_param(k, v, urlencode)
+          end
+        end
+      end.reject{|o| o.nil? || o.empty?}.sort.join('&')        
+    end
+    
+    def urlencode(str)
+      str.gsub(/[^a-zA-Z0-9_\.\-]/n) {|s| sprintf('%%%02x', s[0]) }
+    end
+    
+    def urldecode(str)
+      CGI.unescape(str)
+    end
+  
+    def encode_param(k, v, do_urlencode)
+      "#{k.to_s}=#{do_urlencode ? urlencode(v.to_s) : v.to_s}"
+    end
+    
+    def from_query_string(qstr)
+      qstr ||= ""
+      {}.tap do |result|
+        for param in qstr.split('&')
+          m,k,v = *param.match(/^(.*?)=(.*?)$/)
+          if current = result[k]
+            result[k] = current.to_a
+            result[k] << urldecode(v)
+          else
+            result[k] = urldecode(v)
+          end
+        end        
+      end
+    end
+  end 
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion -rubygems"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/summon.rb'}"
+puts "Loading summon gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/summon')
+gem 'rspec'
+require 'spec'
+
+def pre(text)
+  puts "<pre>" +
+    text.to_s.
+      gsub("&", "&amp;").
+      gsub("<", "&lt;").
+      gsub(">", "&gt;") +
+    "</pre>"
+end
+
+class Object
+  def remove_src
+    @src = nil
+  end
+end
+    

data/spec/summon/log_spec.rb

@@ -0,0 +1,28 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Summon::Log do
+
+  before(:each) do
+    @logger = stub(:Logger)
+  end
+  
+  it "passes through all methods to the underlying logger" do
+    log = Summon::Log.new(@logger)
+    @logger.should_receive(:info).with("foo")
+    log.info("foo")
+  end
+  
+  it "creates a stderr logger when no spec is provided" do
+    Logger.should_receive(:new).with($stderr).and_return(@logger)
+    @logger.should_receive(:level=).with(Logger::WARN)
+    log = Summon::Log.new    
+  end
+  
+  it "creates a logger from an option hash when the spec is a set of options" do
+    out = stub(:OutputStream)
+    Logger.should_receive(:new).with(out).and_return(@logger)
+    @logger.should_receive(:level=).with(Logger::ERROR)
+    log = Summon::Log.new(:level => :error, :initialize => [out])
+  end
+end

data/spec/summon/schema/availability_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Availability do
+  it "should map" do
+    availabilities = Summon::Availability.parse_results("Result"=>{"RecordSummary"=>[
+      {
+        "ID"=>"1038053",
+        "RecordList"=>"http://api.staging.summon.serialssolutions.com:8093/status?key=HD3UV5FG9E&output=application%2Fjson&action=list&token=1038053", 
+        "Record"=>{"Status"=>"unknown", "StatusMessage"=>"Available", "Location"=>"Architecture Library", "CallNumber"=>" 720.979 A534"}, 
+        "RecordCount"=>1}, 
+      {
+        "ID"=>"1038082", 
+        "RecordList"=>"http://api.staging.summon.serialssolutions.com:8093/status?key=HD3UV5FG9E&output=application%2Fjson&action=list&token=1038082", 
+        "Record"=>{"Status"=>"unknown", "StatusMessage"=>"Available", "Location"=>"Main Library", "CallNumber"=>" 628.5 B6157"}, 
+        "RecordCount"=>1}]})
+        
+    one, two = availabilities
+    
+    one.token.should == "1038053"
+    one.status.should == "unknown"
+    one.status_message.should == "Available"
+    one.location.should == "Architecture Library"
+    one.call_number.should == " 720.979 A534"
+    
+    two.token.should == "1038082"
+    two.status.should == "unknown"
+    two.status_message.should == "Available"
+    two.location.should == "Main Library"
+    two.call_number.should == " 628.5 B6157"
+  end
+end

data/spec/summon/schema/citation_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Citation do
+  it "should map" do
+    results = {"Results"=>{"Citations"=>{"Citation"=>[
+      {
+        "Name"=>"American Medical Association, 10th Edition", 
+        "Text"=>"Morrow BH, Price VB. <span class=\"italic\">Anasazi architecture and American design</span>. 1st ed. ed. Albuquerque: University of New Mexico Press; Wed. www.magnolia.com.", 
+        "ShortName"=>"AMA"}, 
+      {
+        "Label"=>"Chicago 15th Edition (Notes & Bibliography)", 
+        "Text"=>"Morrow, Baker H. and V. B. Price. Anasazi Architecture and American Design. 1st ed. ed. Albuquerque: University of New Mexico Press, Wed,  (accessed August 5, 2009).", 
+        "ShortName"=>"Chicago NB"}, 
+      {
+        "Label"=>"MLA", 
+        "Text"=>"Morrow, Baker H., and V. B. Price. Anasazi Architecture and American Design. 1st ed. ed. Albuquerque: University of New Mexico Press, Wed. .  5 Aug. 2009", 
+        "Caption"=>"Modern Language Association, 6th Edition", 
+        "ShortName"=>"MLA"}, 
+      {
+        "Label"=>"Vancouver", 
+        "Text"=>"Morrow BH, Price VB. Anasazi architecture and American design. 1st ed. ed. Albuquerque: University of New Mexico Press; Wed.", 
+        "ShortName"=>"Vancouver"}
+    ]}, "Timing"=>{"ElapsedQueryTime"=>16, "TotalQueryTime"=>14, "TotalExecutionTime"=>1938}}}
+
+    citations = Summon::Citation.parse_results(results)
+    citations[0].name.should == "American Medical Association, 10th Edition"
+    citations[0].text.should == "Morrow BH, Price VB. <span class=\"italic\">Anasazi architecture and American design</span>. 1st ed. ed. Albuquerque: University of New Mexico Press; Wed. www.magnolia.com."
+    citations[0].short_name.should == "AMA"
+    
+    citations[2].name.should == nil
+    citations[2].label.should == "MLA"
+    
+  end
+end

data/spec/summon/schema/date_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Date do
+  it "should do stuff w/ date" do
+    date = Summon::Date.new({"month"=>"01", "text"=>"c2000.", "day"=>"02", "year"=>"2000"})
+
+    date.day.should == 2
+    date.month.should == 1
+    date.year.should == 2000
+    date.text.should == "c2000."
+  end
+end

data/spec/summon/schema/document_spec.rb

@@ -0,0 +1,235 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Document do
+  it "should map" do
+    doc = Summon::Document.new(JSON.parse(EXAMPLE_DOCUMENT_JSON))
+    doc.remove_src
+    doc.publication_date.remove_src
+    doc.authors.each {|a| a.remove_src }
+    doc.to_yaml.should == EXPECTED_DOCUMENT_YAML
+  end
+    
+  EXAMPLE_DOCUMENT_JSON = <<-JSON
+{
+  "Publisher_xml": [
+    {
+      "name": "Spirulina Records"
+    },
+    {
+      "name": "Swingsistersound"
+    }
+  ],
+  "Abstract": ["This is the most awesome document ever"],
+  "DOI": [ "10.1109\/CBMS.2008.1"],
+  "ISSN": ["1063-7125", "0000-1111"],
+  "Issue": ["7"],
+  "PublicationTitle": ["Batman Books"],
+  "StartPage": ["pp23"],
+  "SubjectTerms": [
+    "Women's music",
+    "Popular music",
+    "Rock music"
+  ],
+  "EndPage": ["i"],
+  "TableOfContents": [
+    "The very thing -- Dark night -- 2 truths & uh lie -- Reckless -- Spin -- Free -- Real of you -- Fire -- Purple hair -- Ghost -- Nuthin' -- Faith."
+  ],
+  "XQueryRevision": [
+    "Rev: 6229"
+  ],
+  "inHoldings": false,
+  "DBID": [
+    "GXQ"
+  ],
+  "Notes": [
+    "Compact disc."
+  ],
+  "PublicationDateYear": [
+    "2000"
+  ],
+  "hasFullText": false,
+  "timestamp": [
+    "Thu Jul 09 19:44:12 EDT 2009"
+  ],
+  "Author": [
+    "Hunter, Lisa"
+  ],
+  "PublicationDate": [
+    "c2000."
+  ],
+  "Subtitle": [
+    "the life and death of Joey Stefano"
+  ],
+  "Title": [
+    "Lisa Hunter -- alive"
+  ],
+  "ID": [
+    "gvsu_catalog_b16644323"
+  ],
+  "LCCallNum": [
+    "M1630.18 .H95 2000"
+  ],
+  "Language": [
+    "English"
+  ],
+  "PublicationDateCentury": [
+    "2000"
+  ],
+  "PublicationDateDecade": [
+    "2000"
+  ],
+  "openUrl": "ctx_ver=Z39.88-2004&rfr_id=info:sid\/summon.serialssolutions.com&rft_val_fmt=info:ofi\/fmt:kev:mtx:dc&rft.title=Lisa+Hunter+--+alive&rft.creator=Hunter%2C+Lisa&rft.date=c200-0.&rft.pub=Spirulina+Records&rft.externalDBID=n%2Fa&rft.externalDocID=b16644323",
+  "Author_xml": [
+    {
+      "fullname": "Hunter, Lisa",
+      "surname": "Hunter",
+      "givenname": "Lisa"
+    }
+  ],
+  "Library": [
+    "Women's Center Library"
+  ],
+  "PublicationDate_xml": [
+    {
+      "month": "01",
+      "text": "c2000.",
+      "day": "02",
+      "year": "2000"
+    }
+  ],
+  "PublicationPlace": [
+    "S.l.",
+    "Ann Arbor, Mich"
+  ],
+  "TemporalSubjectTerms": [
+    "1991-2000"
+  ],
+  "PublicationPlace_xml": [
+    {
+      "name": "S.l."
+    },
+    {
+      "name": "Ann Arbor, Mich"
+    }
+  ],
+  "DocumentTitleAlternate": [
+    "Alive"
+  ],
+  "score": [
+    "1.0"
+  ],
+  "Snippet": [
+    "This is the snippet"
+  ],
+  "availabilityToken": "b16644323",
+  "ContentType": [
+    "Audio Recording"
+  ],
+  "Publisher": [
+    "Spirulina Records",
+    "Swingsistersound"
+  ],
+  "PageCount": [
+    "xxviii, 140 p."
+  ],
+  "Genre": [
+    "Biography",
+    "Congress"
+  ],
+  "ISBN": [
+    "0849343763 (v. 1)",
+    "0849343771 (v. 2)"
+  ],
+  "PublicationSeriesTitle": [
+    "A Bantam book"
+  ],
+  "DissertationAdvisor": [
+    "Claudio Friedmann"
+  ],
+  "DissertationCategory": [
+    "Education"
+  ],
+  "DissertationDegree": [
+    "M.S.J."
+  ],
+  "DissertationDegreeDate": [
+    "2001"
+  ],
+  "DissertationDegreeDateCentury": [
+    "2000"
+  ],
+  "DissertationDegreeDateDecade":[
+    "2000"
+  ],
+  "DissertationDegreeDateYear": [
+    "2001"
+  ],
+  "DissertationSchool": [
+    "West Virginia University"
+  ]
+}
+  JSON
+  
+  EXPECTED_DOCUMENT_YAML = <<-YAML
+--- !ruby/object:Summon::Document 
+abstract: This is the most awesome document ever
+authors: 
+- Hunter, Lisa
+availability_token: b16644323
+call_number: M1630.18 .H95 2000
+content_type: Audio Recording
+dissertation_advisor: Claudio Friedmann
+dissertation_category: Education
+dissertation_degree: M.S.J.
+dissertation_degree_date: "2001"
+dissertation_degree_date_century: "2000"
+dissertation_degree_date_decade: "2000"
+dissertation_degree_date_year: "2001"
+dissertation_school: West Virginia University
+doi: 10.1109\/CBMS.2008.1
+end_page: i
+fulltext: false
+genres: 
+- Biography
+- Congress
+id: gvsu_catalog_b16644323
+isbns: 
+- 0849343763 (v. 1)
+- 0849343771 (v. 2)
+issns: 
+- 1063-7125
+- 0000-1111
+issue: "7"
+languages: 
+- English
+library: Women's Center Library
+open_url: ctx_ver=Z39.88-2004&rfr_id=info:sid/summon.serialssolutions.com&rft_val_fmt=info:ofi/fmt:kev:mtx:dc&rft.title=Lisa+Hunter+--+alive&rft.creator=Hunter%2C+Lisa&rft.date=c200-0.&rft.pub=Spirulina+Records&rft.externalDBID=n%2Fa&rft.externalDocID=b16644323
+page_count: xxviii, 140 p.
+patent_number: 
+publication_date: !ruby/object:Summon::Date 
+  day: "02"
+  month: "01"
+  src: 
+  text: c2000.
+  year: "2000"
+publication_series_title: A Bantam book
+publication_title: Batman Books
+publishers: 
+- Spirulina Records
+- Swingsistersound
+snippet: This is the snippet
+src: 
+start_page: pp23
+subject_terms: 
+- Women's music
+- Popular music
+- Rock music
+subtitle: the life and death of Joey Stefano
+thumbnail_large: 
+thumbnail_medium: 
+thumbnail_small: 
+title: Lisa Hunter -- alive
+url: 
+volume: 
+  YAML
+end