summon 1.1.14 → 1.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+.idea
+doc
+pkg
+.specification
+.DS_Store
+.rvmrc

data/{History.txt → Changelog.md}

@@ -1,65 +1,98 @@
-=== 1.1.14 2010-10-20
+### 1.2.0 2011-04-09
+
+* removed translations
+* modernize the gemming process
+* support for spotlighting
+* Copyright field in document is now multi-value
+
+### 1.1.17 2011-01-28
+* 1 minor enhancement
+  * copyright field is multi-value (document schema)
+
+### 1.1.16 2011-01-27
+* 8 minor enhancements
+  * document schema changes
+    * renamed dissertation_advisor => dissertation_advisors
+    * renamed dissertation_category => dissertation_categories
+    * renamed dissertation_degree => dissertation_degrees
+    * renamed dissertation_degree_date => dissertation_degrees_dates
+    * renamed dissertation_school = dissertation_schools
+    * removed dissertation_degree_date_decade
+    * removed dissertation_degree_date_century
+    * removed dissertation_degree_date_year
+
+### 1.1.15 2011-01-26
+* 1 major enhancement
+  * added spotlight_children to document schema
+* 6 minor enhancements
+  * added meeting_name to document schema
+  * added deweys to document schema
+  * added eisbns to document schema
+  * added eissns to document schema
+  * added copyright to document schema
+
+### 1.1.14 2010-10-20
 * 1 minor enhancement
   * German translation updates
 
-=== 1.1.13 2010-10-20
+### 1.1.13 2010-10-20
 * 1 minor enhancement
   * fix service cloning
 
-=== 1.1.12 2010-10-19
+### 1.1.12 2010-10-19
 * 1 minor enhancement
   * added lib_guide_tabs to document schema
 
-=== 1.1.11 2010-09-03
+### 1.1.11 2010-09-03
 * 1 minor enhancement
   * added dbid field accessor to the document schema
 
-=== 1.1.10 2010-05-06
+### 1.1.10 2010-05-06
 * 4 minor enhancements
   * updated "en" and "xx" locales
   * Added additional translation stubs
   * Added full on translations
   # Added Edition to document schema
 
-=== 1.1.9 2010-05-03
+### 1.1.9 2010-05-03
 * 2 minor enhancement
-  * fix japanese translation for Publication Date 
+  * fix japanese translation for Publication Date
   * Added publication_place to document schema
 
-=== 1.1.8 2010-03-08
+### 1.1.8 2010-03-08
 * 1 minor enhancements
   * added from_library? to see if a document is from the library catalog
 
-=== 1.1.7 2010-02-18
+### 1.1.7 2010-02-18
 * 1 minor enhancement
   * allow locale to be specified as either a string or a symbol
-  
-=== 1.1.6 2010-01-14
+
+### 1.1.6 2010-01-14
 * 1 minor enhancement
   * tweak database recommendation lists to make it support multiple recommendations
-  
-=== 1.1.5 2010-01-13
+
+### 1.1.5 2010-01-13
 * 1 major enhancement
   * add support for database recomendation lists
-  
-=== 1.1.4 2010-01-12
+
+### 1.1.4 2010-01-12
 * 4 minor enhancements:
   * add ISICitedReferencesCount for documents on which they're available
   * add ISICitedReferencesURI for document on which available
   * add command line option for setting s.role API parameter
   * map Document::URI field
-  
-=== 1.1.3 2010-01-11
+
+### 1.1.3 2010-01-11
 * 2 major enhancements:
   * support for passing locale to summon gem
   * add japanese language translations
 
-=== 1.1.1 2009-12-11
+### 1.1.1 2009-12-11
 * 2 minor enhancements:
   * add support to handle government document classification number (GovDocClassNum)
   * map error.code into error object to allow for finer grained error messages
 
-=== 1.1.0 2009-11-10
+### 1.1.0 2009-11-10
 * 2 major enhancements:
   * add support for Thumbnails in the thumbnail_small, thumbnail_medium, and thumbnail_large fields
   * add availability service for querying physical catalogue records.
@@ -71,7 +104,7 @@
   * empty parameter was causing a NameError on the return trip
   * added range? predicate to range facets so that they can be identified as ranges
 
-=== 1.0.0 2009-09-28
+### 1.0.0 2009-09-28
 
 * 1 major enhancement:
   * Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    summon (1.2.0)
+      json (>= 1.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec (>= 2.0.0)
+  summon!

data/{README.rdoc → README.md}

@@ -1,34 +1,34 @@
-= summon
+# summon
 
 * http://summon.rubyforge.org
 * http://www.serialssolutions.com/summon
 * http://api.summon.serialssolutions.com
 
-== DESCRIPTION:
+## DESCRIPTION:
 
 Ruby language bindings for Serials Solutions Summon Unified Discovery Service
 
-== FEATURES/PROBLEMS:
+## FEATURES/PROBLEMS:
 
 * perform searches using the Summon public API from within ruby.
 
-== SYNOPSIS:
+## SYNOPSIS:
 
-=== From the Command Line
+### From the Command Line
 
- #help
- summon --help
- 
- #simple text query
- summon "Will Shakespeare"
-  
- #books only please!
- summon "Will Shakespeare" --s.cmd="addFacetValueFilters(ContentType, Book)"
- 
- #lots of results.
- summon "Will Shakespeare" --s.cmd="addFacetValueFilters(ContentType, Book) setPageSize(100)"
+    #help
+    summon --help
+    
+    #simple text query
+    summon "Will Shakespeare"
+    
+    #books only please!
+    summon "Will Shakespeare" --s.cmd="addFacetValueFilters(ContentType, Book)"
 
-=== Inside Code
+    #lots of results.
+    summon "Will Shakespeare" --s.cmd="addFacetValueFilters(ContentType, Book) setPageSize(100)"
+
+### Inside Code
 
   require 'summon'
   @service = Summon::Service.new(:access_id => 'myaccessid', :secret_key => 'mysecretkey')
@@ -43,15 +43,15 @@ Ruby language bindings for Serials Solutions Summon Unified Discovery Service
   #search using commands
   search = @service.search("s.cmd" => "addTextQuery(Elephants) addFacetValueFilters(ContentType,Book)")
 
-== REQUIREMENTS:
+## REQUIREMENTS:
 
 * ruby >= 1.8.6
 
-== INSTALL:
+## INSTALL:
 
-* sudo gem install summon
+    sudo gem install summon
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 

data/Rakefile

@@ -1,25 +1,8 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/summon'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
 
-Hoe.plugin :newgem
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'summon' do
-  self.developer 'Charles Lowell', 'cowboyd@thefrontside.net'
-  self.post_install_message = File.read('PostInstall.txt')
-  self.rubyforge_name       = self.name
-  self.extra_deps           = [
-                                ['json','>= 1.2.0']
-                              ]
-  self.extra_dev_deps       = [
-                                ['rspec', '>= 1.2.9']
-                            ]                          
-  self.version              = Summon::VERSION
-end
+require 'rspec/core/rake_task'
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/summon.rb

@@ -6,14 +6,8 @@ require 'cgi'
 require 'json'
 
 module Summon
-  VERSION = "1.1.14"
-  DEFAULT_LOCALE = 'en'
-  
-  locale_dir = File.dirname(__FILE__) + '/summon/locales'
-  Dir["#{locale_dir}/*.rb"].each { |file| 
-    require file
-  }
 
+  require 'summon/version'
   require 'summon/log'
   require 'summon/service'
   require 'summon/transport'
@@ -29,7 +23,7 @@ module Summon
   require 'summon/schema/citation'
   require 'summon/schema/error'
   require 'summon/schema/recommendation_list'
-  
+
   def self.escape(value)
     value.gsub(/(,|\(|\)|\{|\}|\$|\:)/, '\\\\\1').gsub("\\", '\\')
   end

data/lib/summon/cli.rb

@@ -20,6 +20,7 @@ module Summon
         "s.fvf" => [],
         "s.fvgf" => [],
         "s.rff" => [],
+        "s.sl" => [],
         "s.hs" => "*",
         "s.he" => "*",
         "s.role" => "none"
@@ -47,6 +48,7 @@ module Summon
         opts.on("--s.fvgf=FIELD,MODE,VALUES", "Facet Value Group Filter: advanced functionality. see official api docs. e.g. 'SubjectTerms,or,northern+america,u.s.,canada'")
         opts.on("--s.rff=<facetField>, <minValue>:<maxValue>[:<inclusive>][, <minValue>:<maxValue>[:<inclusive>]]*", "Range Facet Field: e.g. PublicationDate,1971:1980,1981:1990,1991:2000,2001:2010") {|rff| params["s.rff"] << rff}
         opts.on("--s.rf=<fieldName>, <minValue>:<maxValue>[:<inclusive>]", "Range Filter: filter the result list to values lying within the range. e.g. PublicationDate,1971:1980")
+        opts.on("--s.sl=<fieldName>,<value>,<min>,<max>") { |sl| params["s.sl"] << sl }
         opts.on("--s.hl=BOOLEAN", "Highlight: turn highlighting on or off: e.g. --s.hl=false") {|hl| params["s.hl"] = hl}
         opts.on("--s.hs=DELIMITER", String, "Highlight Start: demarcate the beginning of a term hit. default is *") {|d| params["s.hs"] = d}
         opts.on("--s.he=DELIMITER", String, "Highlight End: demarcate the beginning of a term hit. default is *") {|d| params["s.he"] = d}

data/lib/summon/schema.rb

@@ -65,15 +65,6 @@ module Summon
         end.to_json(*a)        
       end
       
-      def locale
-        @service.locale.gsub(/-/, "")
-      end
-      
-      def translate(value)
-        default = Summon::Locale.const_get(Summon::DEFAULT_LOCALE.upcase)
-        translator = Summon::Locale.const_defined?(locale.upcase) ? Summon::Locale.const_get(locale.upcase) : default
-        translator::TRANSLATIONS[value] ? translator::TRANSLATIONS[value] : default::TRANSLATIONS[value] ? default::TRANSLATIONS[value] : value
-      end
     end
     
     class Attr

data/lib/summon/schema/document.rb

@@ -18,27 +18,29 @@ class Summon::Document < Summon::Schema
   attr :page_count
   attr :publication_date, :json_name => "PublicationDate_xml",  :transform => :Date
   attr :publication_place
-
+  attr :meeting_name, :single => false
+  
   attr :isi_cited_references_count, :json_name => "ISICitedReferencesCount"
   attr :isi_cited_references_uri, :json_name => "ISICitedReferencesURI"
   
-  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 :dissertation_advisors, :json_name => "DissertationAdvisor"
+  attr :dissertation_categories, :json_name => "DissertationCategory"
+  attr :dissertation_degrees, :json_name => "DissertationDegree"
+  attr :dissertation_degrees_dates, :json_name => "DissertationDegreeDate"
+  attr :dissertation_schools, :json_name => "DissertationSchool"
   
   attr :library
   attr :call_numbers, :json_name => "LCCallNum"
+  attr :deweys, :json_name => "DEWEY"
   attr :doi, :json_name => "DOI"
   attr :isbns, :json_name => "ISBN"
   attr :issns, :json_name => "ISSN"
+  attr :eisbns, :json_name => "EISBN"
+  attr :eissns, :json_name => "EISSN"
   attr :patent_number
   attr :gov_doc_class_nums, :json_name => "GovDocClassNum"
   
+  attr :copyright, :single => false
   
   attr :subject_terms
   attr :genres, :json_name => "Genre"
@@ -59,6 +61,8 @@ class Summon::Document < Summon::Schema
   attr :dbid, :json_name => "DBID", :single => false
   
   attr :lib_guide_tab, :json_name => "LibGuideTab_xml", :single => false
+  
+  attr :spotlight_children, :single => false, :transform => :Document
 
   def isbn
     @isbns.first
@@ -96,10 +100,6 @@ class Summon::Document < Summon::Schema
     "Title: #{title}"
   end
 
-  def local_content_type
-    translate(@content_type)      
-  end
-
   def lib_guide_tabs
     @lib_guide_tab.map {|n| Summon::LibGuideTab.new(n["name"], n["uri"])}
   end
@@ -107,7 +107,7 @@ class Summon::Document < Summon::Schema
   def from_library?
     @availability_id != nil
   end
-
+  
 end
 
 class Summon::Author < Struct.new(:name)
@@ -124,4 +124,4 @@ class Summon::LibGuideTab < Struct.new(:name, :uri)
   def uri(*args)
     super()
   end
-end
+end

data/lib/summon/schema/facet.rb

@@ -22,9 +22,6 @@ class Summon::Facet < Summon::Schema
     @counts.empty?
   end
   
-  def local_name
-    translate(@display_name)
-  end
 end
 
 class Summon::FacetCount < Summon::Schema
@@ -37,14 +34,6 @@ class Summon::FacetCount < Summon::Schema
   attr :apply_negated_command
   attr :remove_command
 
-  def local_value
-    translate(@value)
-  end
-
-  def escaped_local_value
-    Summon.escape(@local_value)
-  end
-  
   def escaped_value
     Summon.escape(@value)
   end

data/lib/summon/schema/range.rb

@@ -17,10 +17,6 @@ class Summon::RangeFacet < Summon::Schema
     false
   end
   
-  def local_name
-    translate(@display_name)
-  end
-  
   # #COMPATIBILITY
   # 
   # alias_method :name, :display_name
@@ -57,4 +53,4 @@ class Summon::RangeCount < Summon::Schema
   def excluded?
       false
     end
-end
+end