summon 1.0.0

data/spec/summon/service_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Summon::Service do
+  
+  it "can be configured" do
+    Object.new.tap do |log|
+      Summon::Transport::Http.should_receive(:new).with(hash_including(:url => "http://google.com", :access_id => "Bob", :session_id => "foo", :client_key => "Justice", :secret_key => "Happiness"))
+      @service = Summon::Service.new :url => "http://google.com", :access_id => "Bob", :secret_key => "Happiness", :session_id => "foo", :client_key => "Justice"
+      @service.url.should == "http://google.com"
+      @service.access_id.should == "Bob"
+    end
+  end
+  
+  it "has a default url which is the public production summon url" do
+    Summon::Service.new.url.should == "http://api.summon.serialssolutions.com"
+  end
+    
+end

data/spec/summon/transport/headers_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Transport::Headers do
+  
+  before(:each) do
+    Time.httpdate("Tue, 30 Jun 2009 12:10:24 GMT").tap do |point|
+      Time.stub!(:now).and_return(point)  
+    end    
+  end
+  
+  it "give the request parameters, it represents the correct headers" do            
+    Summon::Transport::Headers.new(
+        :url => "http://magg1.beta.projectmagnolia.net:8083/summon-search-api/search2",
+        :access_id => "test",
+        :client_key => "PX3FK6GB6M",
+        :secret_key => "ed2ee2e0-65c1-11de-8a39-0800200c9a66",
+        :accept => "xml", 
+        :params => {'s.ff' => 'ContentType,or,1,15', 's.q' => 'forest'}
+      ).should == {
+        'Content-Type' => 'application/x-www-form-urlencoded; charset=utf8',
+        'Accept' => 'application/xml',
+        'x-summon-date' => 'Tue, 30 Jun 2009 12:10:24 GMT',
+        'Authorization' => 'Summon test;PX3FK6GB6M;g1SZb73Vg6bV7VhFQ2KkCLy98rE=',
+        'Host' => 'magg1.beta.projectmagnolia.net:8083'
+    }
+  end
+  
+  it "successfully handles array parameters" do    
+    Summon::Transport::Headers.new(
+        :url => "http://magg1.beta.projectmagnolia.net:8083/summon-search-api/search2",
+        :access_id => "test",
+        :client_key => "PX3FK6GB6M",
+        :secret_key => "ed2ee2e0-65c1-11de-8a39-0800200c9a66",
+        :session_id => "Session-3000!",
+        :accept => "xml", 
+        :params => {'s.ff' => ['ContentType,or,1,15'], 's.q' => ['forest']}
+      ).should == {
+        'Content-Type' => 'application/x-www-form-urlencoded; charset=utf8',
+        'Accept' => 'application/xml',
+        'x-summon-date' => 'Tue, 30 Jun 2009 12:10:24 GMT',
+        'x-summon-session-id' => "Session-3000!",
+        'Authorization' => 'Summon test;PX3FK6GB6M;g1SZb73Vg6bV7VhFQ2KkCLy98rE=',
+        'Host' => 'magg1.beta.projectmagnolia.net:8083'
+    }
+    
+  end
+end

data/spec/summon/transport/http_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Transport::Http do
+  attr_reader :http
+  
+  before do
+    @http = Summon::Transport::Http.new
+  end
+  
+  describe "parse" do
+    it "should parse json" do
+      response = stub("response", :content_type => "application/json", 
+                                  :body => '{"some":"json","foo":[1,2],"bar":3}')
+      http.parse(response).should == {"some" => "json", "foo" => [1,2], "bar" => 3}
+    end
+  
+    it "should parse text" do
+      response = stub("response", :content_type => "text/plain", 
+                                  :body => "some string\r\nand another one\r\n")
+      http.parse(response).should == "some string\r\nand another one\r\n"
+    end
+  
+    it "should raise error on anything else" do
+      response = stub("response", :content_type => "text/xml", 
+                                  :body => "<some>xml</some>")
+      proc {http.parse(response)}.should raise_error(Summon::Transport::ServiceError, "service returned unexpected text/xml : <some>xml</some>")
+    end
+  end
+end

data/spec/summon/transport/qstring_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Summon::Transport::Qstring do
+  before(:each) do
+    extend Summon::Transport::Qstring
+  end
+  
+  it "can decode a query string into hash parameters" do
+    from_query_string("foo=bar&baz=bang").should == {"foo" => "bar", "baz" => "bang"}
+  end
+  
+  it "stuffs multiple keys into the same value as a list" do
+    from_query_string("foo=bar&foo=baz&bar=bang").should == {"foo" => ["bar", "baz"], "bar" => "bang"}
+  end
+  
+  it "url decodes keys and values" do
+    from_query_string("foo=bar%20bar&baz=bang+bang").should == {"foo" => "bar bar", "baz" => "bang bang"}
+  end
+  
+  it "returns an empty hash if the query string is blank" do
+    from_query_string(nil).should be_empty
+    from_query_string("").should be_empty
+  end
+end

data/spec/summon_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Summon Gem Integration Test" do
+  it "maps an api request correctly" do
+    service = Summon::Service.new(:transport => Summon::Transport::Canned.new)
+    search = service.search
+    search.should_not be_nil
+    search.record_count.should == 1506825
+    search.page_count.should == 100456
+    search.total_request_time.should == 80
+    search.query_time.should == 57
+    search.suggestions.should_not be_nil
+    search.suggestions.length.should == 1
+    dym = search.suggestions.first
+    dym.original_query.should == "louis rmstrong"
+    dym.suggested_query.should == "louis armstrong"
+    
+    documents = search.documents
+    documents.should_not be_nil
+    documents.length.should == 15
+    d = documents[0]
+    d.id.should == "gvsu_catalog_b16644323"
+    d.content_type.should == "Audio Recording"
+    d.authors.map{|a| a.name}.should == ["Hunter, Lisa"]
+    d.open_url.should == "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"
+    d.fulltext?.should be(false)
+    
+    
+    facets = search.facets
+    facets.should_not be_nil
+    facets.length.should >= 5
+    ctype = facets[2]
+    ctype.display_name.should == "ContentType"
+    ctype.combine_mode.should == 'or'
+  end
+  
+  it "should now how to escape values" do
+    check_escape("the quick, brown, fox", 'the quick\, brown\, fox')
+    Summon.escape(': everything (else) and $1 or {is} it\ ').should == '\: everything \(else\) and \$1 or \{is\} it\\ '
+  end
+  
+  def check_escape(unescaped, escaped)
+    Summon.escape(unescaped).should == escaped
+    Summon.unescape(escaped).should == unescaped
+    Summon.unescape(Summon.escape(unescaped)).should == unescaped
+    Summon.escape(Summon.unescape(escaped)).should == escaped
+  end
+end

data/summon.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{summon}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Charles Lowell"]
+  s.date = %q{2009-09-28}
+  s.description = %q{Ruby language bindings for Serials Solutions Summon Unified Discovery Service}
+  s.email = ["cowboyd@thefrontside.net"]
+  s.executables = ["summon", "summonh"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
+  s.files = [".specification", "History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/summon", "bin/summonh", "ispec/integration_spec.rb", "lib/summon.rb", "lib/summon/cli.rb", "lib/summon/log.rb", "lib/summon/schema.rb", "lib/summon/schema/availability.rb", "lib/summon/schema/citation.rb", "lib/summon/schema/date.rb", "lib/summon/schema/document.rb", "lib/summon/schema/error.rb", "lib/summon/schema/facet.rb", "lib/summon/schema/query.rb", "lib/summon/schema/range.rb", "lib/summon/schema/search.rb", "lib/summon/schema/suggestion.rb", "lib/summon/service.rb", "lib/summon/transport.rb", "lib/summon/transport/canned.json", "lib/summon/transport/canned.rb", "lib/summon/transport/errors.rb", "lib/summon/transport/headers.rb", "lib/summon/transport/http.rb", "lib/summon/transport/qstring.rb", "script/console", "script/destroy", "script/generate", "spec/spec.opts", "spec/spec_helper.rb", "spec/summon/log_spec.rb", "spec/summon/schema/availability_spec.rb", "spec/summon/schema/citation_spec.rb", "spec/summon/schema/date_spec.rb", "spec/summon/schema/document_spec.rb", "spec/summon/schema/facet_spec.rb", "spec/summon/schema/query_spec.rb", "spec/summon/schema/range_spec.rb", "spec/summon/schema/search_spec.rb", "spec/summon/schema_spec.rb", "spec/summon/service_spec.rb", "spec/summon/transport/headers_spec.rb", "spec/summon/transport/http_spec.rb", "spec/summon/transport/qstring_spec.rb", "spec/summon_spec.rb", "summon.gemspec"]
+  s.homepage = %q{http://summon.rubyforge.org}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{summon}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby language bindings for Serials Solutions Summon Unified Discovery Service}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json_pure>, [">= 1.1.7"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.7"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<json_pure>, [">= 1.1.7"])
+      s.add_dependency(%q<rspec>, [">= 1.2.7"])
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<json_pure>, [">= 1.1.7"])
+    s.add_dependency(%q<rspec>, [">= 1.2.7"])
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: summon
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Ruby language bindings for Serials Solutions Summon Unified Discovery Service
+email: 
+- cowboyd@thefrontside.net
+executables: 
+- summon
+- summonh
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- .specification
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/summon
+- bin/summonh
+- ispec/integration_spec.rb
+- lib/summon.rb
+- lib/summon/cli.rb
+- lib/summon/log.rb
+- lib/summon/schema.rb
+- lib/summon/schema/availability.rb
+- lib/summon/schema/citation.rb
+- lib/summon/schema/date.rb
+- lib/summon/schema/document.rb
+- lib/summon/schema/error.rb
+- lib/summon/schema/facet.rb
+- lib/summon/schema/query.rb
+- lib/summon/schema/range.rb
+- lib/summon/schema/search.rb
+- lib/summon/schema/suggestion.rb
+- lib/summon/service.rb
+- lib/summon/transport.rb
+- lib/summon/transport/canned.json
+- lib/summon/transport/canned.rb
+- lib/summon/transport/errors.rb
+- lib/summon/transport/headers.rb
+- lib/summon/transport/http.rb
+- lib/summon/transport/qstring.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/summon/log_spec.rb
+- spec/summon/schema/availability_spec.rb
+- spec/summon/schema/citation_spec.rb
+- spec/summon/schema/date_spec.rb
+- spec/summon/schema/document_spec.rb
+- spec/summon/schema/facet_spec.rb
+- spec/summon/schema/query_spec.rb
+- spec/summon/schema/range_spec.rb
+- spec/summon/schema/search_spec.rb
+- spec/summon/schema_spec.rb
+- spec/summon/service_spec.rb
+- spec/summon/transport/headers_spec.rb
+- spec/summon/transport/http_spec.rb
+- spec/summon/transport/qstring_spec.rb
+- spec/summon_spec.rb
+- summon.gemspec
+has_rdoc: true
+homepage: http://summon.rubyforge.org
+licenses: []
+
+post_install_message: |
+  
+  For comprehensive documentation on Summon API options and usage visit:
+  
+  http://api.summon.serialssolutions.com
+
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: summon
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby language bindings for Serials Solutions Summon Unified Discovery Service
+test_files: []
+