summon 2.0.0 → 2.0.1

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 .bundle/
 .idea
 doc

data/Changelog.md

@@ -1,3 +1,7 @@
+### 2.0.1
+* 1 major enhancement
+  * added availability_path field
+
 ### 2.0.0
 * 1 major enhancement
   * added link field to document schema (this now supercedes the url and

data/lib/summon/schema/document.rb

@@ -19,16 +19,17 @@ class Summon::Document < Summon::Schema
   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_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 :in_holdings, :json_name => "inHoldings", :boolean => true
   attr :library
   attr :call_numbers, :json_name => "LCCallNum"
   attr :deweys, :json_name => "DEWEY"
@@ -39,13 +40,13 @@ class Summon::Document < Summon::Schema
   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"
   attr :languages, :json_name => "Language"
-  
+
   attr :snippet #highlight
   attr :abstract
   attr :fulltext, :boolean => true, :json_name => "hasFullText"
@@ -62,9 +63,9 @@ class Summon::Document < Summon::Schema
   attr :availability_id
   attr :eric, :json_name => "ERIC"
   attr :dbid, :json_name => "DBID", :single => false
-  
+
   attr :lib_guide_tab, :json_name => "LibGuideTab_xml", :single => false
-  
+
   attr :spotlight_children, :single => false, :transform => :Document
   attr :fulltext_hit, :json_name => "isFullTextHit"
   attr :peer_documents, :single => false, :json_name => "peerDocuments", :transform => :Document
@@ -76,11 +77,11 @@ class Summon::Document < Summon::Schema
   def isbn
     @isbns.first
   end
-  
+
   def call_number
     @call_numbers.first
   end
-  
+
   def gov_doc_class_num
     @gov_doc_class_nums.first
   end
@@ -88,7 +89,7 @@ class Summon::Document < Summon::Schema
   def pages?
     @start_page || @page_count
   end
-  
+
   def publication_date
     @publication_date || Summon::Date.new({})
   end
@@ -96,15 +97,15 @@ class Summon::Document < Summon::Schema
   def publisher
     @publishers.first
   end
-  
+
   def authors
     @authors.map {|n| Summon::Author.new(n["fullname"], n["surname"], n["givenname"], n["middlename"])}
   end
-  
+
   def corporate_authors
     @corporate_authors.map {|n| Summon::Author.new(n)}
   end
-  
+
   def to_s(options = {})
     "Title: #{title}"
   end
@@ -116,7 +117,7 @@ class Summon::Document < Summon::Schema
   def from_library?
     @availability_id != nil
   end
-  
+
 end
 
 class Summon::Author < Struct.new(:fullname, :surname, :givenname, :middlename)
@@ -136,7 +137,7 @@ class Summon::Author < Struct.new(:fullname, :surname, :givenname, :middlename)
   def middlename(*args)
     super()
   end
-  
+
   alias_method :name, :fullname
 end
 
@@ -144,7 +145,7 @@ class Summon::LibGuideTab < Struct.new(:name, :uri)
   def name(*args)
     super()
   end
-  
+
   def uri(*args)
     super()
   end

data/lib/summon/schema/facet.rb

@@ -7,7 +7,10 @@ class Summon::Facet < Summon::Schema
   attr :page_number
   attr :counts, :transform => :FacetCount
   attr :remove_command
-  attr :remove_value_filters_command    
+  attr :has_applied_value?, :json_name => :hasAppliedValue, :boolean => true
+  attr :has_limiting_value?, :json_name => :hasLimitingValue, :boolean => true
+  attr :list_values_command
+  attr :remove_value_filters_command
 
 
   def to_s
@@ -17,11 +20,11 @@ class Summon::Facet < Summon::Schema
   def range?
     false
   end
-  
+
   def empty?
     @counts.empty?
   end
-  
+
 end
 
 class Summon::FacetCount < Summon::Schema
@@ -37,15 +40,15 @@ class Summon::FacetCount < Summon::Schema
   def escaped_value
     Summon.escape(@value)
   end
-  
+
   def excluded?
     negated?
   end
-  
+
   def included?
     applied? && !excluded?
   end
- 
+
   def abs_value
     value.sub /^-/, ''
   end

data/lib/summon/schema/search.rb

@@ -7,6 +7,7 @@ class Summon::Search < Summon::Schema
   attr :query_time
   attr :total_request_time
 
+  attr :availability_path
   attr :query, :transform => :Query
   attr :recommendations, :transform => :RecommendationList, :json_name => "recommendationLists"
   attr :suggestions, :transform => :Suggestion, :json_name => :didYouMeanSuggestions

data/lib/summon/version.rb

@@ -1,4 +1,4 @@
 
 module Summon
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/summon/schema/document_spec.rb

@@ -1,43 +1,37 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe Summon::Document do
-  it "should map" do
-    pending "This is a really nasty test"
-    doc = Summon::Document.new(@service, 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
+  before {@document = Summon::Document.new(@service, JSON.parse(EXAMPLE_DOCUMENT_JSON))}
+  subject {@document}
+  it {should be_from_library}
+  its(:abstract) {should eql "This is the most awesome document ever"}
+  its(:subject_terms) {should eql ["Women's music", "Popular music", "Rock music"]}
+  its(:issns) {should eql ["1063-7125", "0000-1111"]}
+  its(:isbns) {should eql [ "0849343763 (v. 1)","0849343771 (v. 2)"]}
+  its(:publication_title) {should eql "Batman Books"}
+  it {should be_in_holdings}
 
-  describe "from_library?" do
-    it "should return true if the document has an availability_id" do
-      doc = Summon::Document.new(@service, JSON.parse(EXAMPLE_DOCUMENT_JSON))
-      doc.from_library?.should be(true)
+  describe "authors" do
+    it "combines givenname, middlename, surname if fullname is missing" do
+      @document.authors[2].name.should == "Shi Wang"
+      @document.authors[3].name.should == "Hai C Chu"
     end
-
-    it "should return false if the document doesn't have an availability_id" do
-      document_data = JSON.parse(EXAMPLE_DOCUMENT_JSON)
-      document_data.delete('availabilityId')
-      doc = Summon::Document.new(@service, document_data)
-      doc.from_library?.should be(false)
+    it "preserves order" do
+      @document.authors.map(&:name).should == ["Liang, Yong X", "Gu, Miao N", "Shi Wang", "Hai C Chu"]
     end
   end
-  
-  describe "authors" do
+
+  describe "without any availability ids" do
     before do
       document_data = JSON.parse(EXAMPLE_DOCUMENT_JSON)
-      @doc = Summon::Document.new(@service, document_data)
-    end
-    it "should combine givenname, middlename, surname if fullname is missing" do
-      @doc.authors[2].name.should == "Shi Wang"
-      @doc.authors[3].name.should == "Hai C Chu"
-    end
-    it "should preserve order" do
-      @doc.authors.map(&:name).should == ["Liang, Yong X", "Gu, Miao N", "Shi Wang", "Hai C Chu"]
+      document_data.delete('availabilityId')
+      @document = Summon::Document.new(@service, document_data)
     end
+    subject{@document}
+    it {should_not be_from_library}
   end
-    
+
+
   EXAMPLE_DOCUMENT_JSON = <<-JSON
 {
   "Publisher_xml": [
@@ -66,7 +60,7 @@ describe Summon::Document do
   "XQueryRevision": [
     "Rev: 6229"
   ],
-  "inHoldings": false,
+  "inHoldings": true,
   "DBID": [
     "GXQ"
   ],
@@ -106,7 +100,7 @@ describe Summon::Document do
       "surname": "Chu",
       "middlename": "C",
       "givenname": "Hai"
-    }   
+    }
   ],
   "CorporateAuthor": [
     "Hunter, Rick",
@@ -246,21 +240,21 @@ describe Summon::Document do
   ]
 }
   JSON
-  
+
   EXPECTED_DOCUMENT_YAML = <<-YAML
---- !ruby/object:Summon::Document 
+--- !ruby/object:Summon::Document
 abstract: This is the most awesome document ever
-authors: 
+authors:
 - Hunter, Lisa
 availability_id: b16644323
-call_numbers: 
+call_numbers:
 - M1630.18 .H95 2000
 - M1630.20 .H95 2000
 content_type: Audio Recording
-corporate_authors: 
+corporate_authors:
 - Hunter, Rick
 - Crusher, Beverly
-dbid: 
+dbid:
 - GXQ
 dissertation_advisor: Claudio Friedmann
 dissertation_category: Education
@@ -271,51 +265,51 @@ dissertation_degree_date_decade: "2000"
 dissertation_degree_date_year: "2001"
 dissertation_school: West Virginia University
 doi: 10.1109\/CBMS.2008.1
-edition: 
+edition:
 end_page: i
 fulltext: false
-genres: 
+genres:
 - Biography
 - Congress
-gov_doc_class_nums: 
+gov_doc_class_nums:
 - A 57.38/42:M 45
 - A 57.38/42:M 45
 id: gvsu_catalog_b16644323
-isbns: 
+isbns:
 - 0849343763 (v. 1)
 - 0849343771 (v. 2)
 isi_cited_references_count: 5
 isi_cited_references_uri: http://happy.com
-issns: 
+issns:
 - 1063-7125
 - 0000-1111
 issue: "7"
-languages: 
+languages:
 - English
 lib_guide_tab: []
 
 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 
+patent_number:
+publication_date: !ruby/object:Summon::Date
   day: "02"
   month: "01"
-  service: 
-  src: 
+  service:
+  src:
   text: c2000.
   year: "2000"
 publication_place: Indiana
 publication_series_title: A Bantam book
 publication_title: Batman Books
-publishers: 
+publishers:
 - Spirulina Records
 - Swingsistersound
-service: 
+service:
 snippet: This is the snippet
-src: 
+src:
 start_page: pp23
-subject_terms: 
+subject_terms:
 - Women's music
 - Popular music
 - Rock music
@@ -325,7 +319,7 @@ thumbnail_medium: http://api.test.summon.serialssolutions.com:8093/image/isbn/YX
 thumbnail_small: http://api.test.summon.serialssolutions.com:8093/image/isbn/YX3FL6LB6P/9781864879094/small
 title: Lisa Hunter -- alive
 uri: http://disney.com
-url: 
-volume: 
+url:
+volume:
   YAML
 end

data/spec/summon/schema/facet_spec.rb

@@ -1,29 +1,41 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe Summon::Facet do
-  it "should map" do
-    facet = Summon::Facet.new(@service, JSON.parse(EXAMPLE_FACET_JSON))
-    facet.remove_src
-    facet.counts.each {|f| f.remove_src }
-    facet.to_yaml.should == EXPECTED_FACET_YAML
+  before {@facet = Summon::Facet.new(@service, JSON.parse(EXAMPLE_FACET_JSON))}
+  subject {@facet}
 
-    first = facet.counts.first
-    first.apply_command.should == "addFacetValueFilter(ContentType_sfacet,Book,false)"
-    first.apply_negated_command.should == "addFacetValueFilter(ContentType_sfacet,Book,true)"
-    first.remove_command.should == "eatMyShorts()"
+  its(:page_size) {should eql 10}
+  its(:display_name) {should eql "ContentType"}
+  its(:combine_mode) {should eql "or"}
+  its(:list_values_command) {should eql "listFacetValues(ContentType_sfacet,or)"}
+  it {should_not have_applied_value}
+  its(:field_name) {should eql "ContentType_sfacet"}
+  it {should have_limiting_value}
+  its(:remove_command) {should eql "removeFacetField(ContentType_sfacet)"}
+
+  describe "Summon::FacetCount" do
+    subject {@facet.counts.first}
+    it {should be_further_limiting}
+    it {should be_negated}
+    its(:value) {should eql "Book"}
+    its(:count) {should eql 799602}
+    its(:apply_command) {should eql "addFacetValueFilter(ContentType_sfacet,Book,false)"}
+    its(:remove_command) {should eql "eatMyShorts()"}
+    its(:apply_negated_command) {should eql "addFacetValueFilter(ContentType_sfacet,Book,true)"}
+    it {should be_applied}
   end
-  
+
   it "should now how to escape values" do
     service = mock(:service)
-    
+
     count = Summon::FacetCount.new(service, :value => "the quick, brown, fox")
     count.value.should == "the quick, brown, fox"
     count.escaped_value.should == 'the quick\, brown\, fox'
-    
-    Summon::FacetCount.new(service, :value => ': everything (else) and $1 or {is} it\ ').escaped_value.should == 
+
+    Summon::FacetCount.new(service, :value => ': everything (else) and $1 or {is} it\ ').escaped_value.should ==
                                      '\: everything \(else\) and \$1 or \{is\} it\\ '
   end
-  
+
   EXAMPLE_FACET_JSON = <<-JSON
   {
     "pageSize": 10,
@@ -39,13 +51,13 @@ describe Summon::Facet do
     "counts": [
       {
         "isFurtherLimiting": true,
-        "isNegated": false,
+        "isNegated": true,
         "value": "Book",
         "count": 799602,
         "applyCommand": "addFacetValueFilter(ContentType_sfacet,Book,false)",
         "removeCommand": "eatMyShorts()",
         "applyNegatedCommand": "addFacetValueFilter(ContentType_sfacet,Book,true)",
-        "isApplied": false
+        "isApplied": true
       },
       {
         "isFurtherLimiting": true,
@@ -70,51 +82,5 @@ describe Summon::Facet do
     ]
   }
   JSON
-  
-  EXPECTED_FACET_YAML = <<-YAML
---- !ruby/object:Summon::Facet 
-combine_mode: or
-counts: 
-- !ruby/object:Summon::FacetCount 
-  applied: false
-  apply_command: addFacetValueFilter(ContentType_sfacet,Book,false)
-  apply_negated_command: addFacetValueFilter(ContentType_sfacet,Book,true)
-  count: 799602
-  further_limiting: true
-  negated: false
-  remove_command: eatMyShorts()
-  service: 
-  src: 
-  value: Book
-- !ruby/object:Summon::FacetCount 
-  applied: false
-  apply_command: addFacetValueFilter(ContentType_sfacet,JournalArticle,false)
-  apply_negated_command: addFacetValueFilter(ContentType_sfacet,JournalArticle,true)
-  count: 49765
-  further_limiting: true
-  negated: false
-  remove_command: eatMyShorts()
-  service: 
-  src: 
-  value: JournalArticle
-- !ruby/object:Summon::FacetCount 
-  applied: false
-  apply_command: addFacetValueFilter(ContentType_sfacet,Journal Article,false)
-  apply_negated_command: addFacetValueFilter(ContentType_sfacet,Journal Article,true)
-  count: 179002
-  further_limiting: true
-  negated: false
-  remove_command: eatMyShorts()
-  service: 
-  src: 
-  value: Journal Article
-display_name: ContentType
-field_name: ContentType_sfacet
-page_number: 1
-page_size: 10
-remove_command: removeFacetField(ContentType_sfacet)
-remove_value_filters_command: removeFacetValueFilters(ContentType)
-service: 
-src: 
-  YAML
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: summon
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 0
-  - 0
-  version: 2.0.0
+  - 1
+  version: 2.0.1
 platform: ruby
 authors: 
 - Charles Lowell
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-20 00:00:00 -05:00
+date: 2011-11-06 01:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency