philologic-client 0.0.5 → 0.0.6

data/.gitignore

@@ -2,7 +2,7 @@
 *.gem
 .bundle
 coverage/
-doc/
 Gemfile.lock
+html/
 out.txt
 pkg/*

data/HISTORY.rdoc

@@ -1,5 +1,9 @@
 = Philologic::Client History
 
+== 2012-01-04 v0.0.6
+
+* +Philologic::Client#search()+ now supports arbitrary key-value query parameters.
+
 == 2012-01-03 v0.0.5
 
 * Added +Philologic::Link#document()+

data/README.rdoc

@@ -16,11 +16,16 @@
    doc   = first.document
    txt   = doc.text
 
-   # Search (currently only limited support)
+   # Simple search
    client.search('sartre').each do |result|
      puts [ child['href'], child['author'], child['title'] ].join("\t")
    end
 
+   # Search by arbitrary key-value pairs
+   client.search( :query => 'sartre', :foo => 1 ).each do |result|
+     puts [ child['href'], child['author'], child['title'] ].join("\t")
+   end
+
    # Get/Set encoding
    encoding        = client.encoding 
    client.encoding = 'utf-8' # Default
@@ -46,10 +51,7 @@ https://github.com/blairc/philologic-client/
 
 == To Do
 
-* Expand search support
-* Switch to MiniTest::Mock?
 * Add +children+ to Philologic::Document
 * Add +parent+ to Philologic::Document
 * Unify Philologic::Link and Philologic::Document
-* Build +RDoc+
 

data/Rakefile

@@ -2,9 +2,10 @@ require 'bundler/gem_tasks'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rdoc-readme/rake_task'
+require 'rdoc/task'
 
-%w{ coverage doc out.txt pkg }.each { |p| CLEAN.include(p) }
-%w{ build install test }.each       { |t| task t.to_sym => [ 'rdoc:readme' ] }
+%w{ coverage html out.txt pkg }.each { |p| CLEAN.include(p) }
+%w{ build install rdoc test }.each   { |t| task t.to_sym => [ 'rdoc:readme' ] }
 
 task :default => :test
 
@@ -16,3 +17,8 @@ end
 
 RDoc::Readme::RakeTask.new 'lib/philologic-client.rb', 'README.rdoc'
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end
+

data/lib/philologic-client/version.rb

@@ -2,6 +2,6 @@
 
 module Philologic
   class Client
-    VERSION = '0.0.5'
+    VERSION = '0.0.6'
   end
 end

data/lib/philologic-client.rb

@@ -24,11 +24,16 @@ require 'open-uri'
 #    doc   = first.document
 #    txt   = doc.text
 #
-#    # Search (currently only limited support)
+#    # Simple search
 #    client.search('sartre').each do |result|
 #      puts [ child['href'], child['author'], child['title'] ].join("\t")
 #    end
 #
+#    # Search by arbitrary key-value pairs
+#    client.search( :query => 'sartre', :foo => 1 ).each do |result|
+#      puts [ child['href'], child['author'], child['title'] ].join("\t")
+#    end
+#
 #    # Get/Set encoding
 #    encoding        = client.encoding 
 #    client.encoding = 'utf-8' # Default
@@ -54,20 +59,22 @@ require 'open-uri'
 #
 # == To Do
 #
-# * Expand search support
-# * Switch to MiniTest::Mock?
 # * Add +children+ to Philologic::Document
 # * Add +parent+ to Philologic::Document
 # * Unify Philologic::Link and Philologic::Document
-# * Build +RDoc+
 #
-module Philologic
+module Philologic # :nodoc:
 
   #
   # Philologic client.
   #
   class Client
 
+    #
+    # Default encoding.
+    #
+    DEFAULT_ENCODING = 'utf-8'
+
     #
     # Get/Set +encoding+
     #
@@ -82,10 +89,10 @@ module Philologic
     # Initialize Philologic::Client
     #
     # Params:
-    #   +endpoint+:: Philologic endpoint (defaults to +nil+)
+    # +endpoint+:: Philologic endpoint (defaults to +nil+)
     #
     def initialize( endpoint = nil )
-      @encoding = 'utf-8'
+      @encoding = DEFAULT_ENCODING
       @endpoint = endpoint
       yield self if block_given?
       self
@@ -95,7 +102,7 @@ module Philologic
     # Return +Array+ of Philologic::Link objects.
     #
     # Params:
-    #   +path+:: Return children of this path (defaults to +/+)
+    # +path+:: Return children of this path (defaults to +/+)
     #
     def children( path = '/' )
       doc = _get(path)
@@ -106,7 +113,7 @@ module Philologic
     # Return Philologic::Document object or +nil+.
     #
     # Params:
-    #   +path+:: Return document at this path (defaults to +/+)
+    # +path+:: Return document at this path (defaults to +/+)
     #
     def document( path = '/' )
       doc = _get(path)
@@ -116,30 +123,41 @@ module Philologic
     #
     # Return +Array+ of Philologic::Link objects.
     #
-    # *NOTE:* Currently only returns the first page of results.
+    # *NOTE:* Currently only returns the first page of results by default.
     #
     # Params:
-    #   +query+:: Search for this query string.
+    # +query+:: Search for this query +String+ or +Hash+ key-value pairs.
     #
     def search(query)
-      raise('no query specified') if query.nil?
-      doc = _query(query)
+      raise('no query specified') if ( query.nil? || !( [ Hash,  String ].include?( query.class ) )) || query.empty?
+      doc = _query( query.kind_of?(String) ? { :query => query } : query )
       return doc.kind_of?(Array) ? doc : nil
     end
 
+
     private
 
-    def _build_query(query)
-      raise('no query specified') if query.nil?
-      "?query=#{query}"
+    #
+    # Build query +String+ from +Hash+.
+    #
+    def _build_query(pairs)
+      raise('no query specified') if pairs.nil? || !pairs.kind_of?(Hash) || pairs.empty?
+      "?" + pairs.map { |k,v| "#{k}=#{v}" }.join('&')
     end
 
+    #
+    # Return parsed version of +path+.
+    #
     def _get(path)
       raise('no endpoint specified') if @endpoint.nil?
       uri = "#{ @endpoint }#{ @endpoint =~ /\/$/ || '/' }#{ path }"
       _parse( Nokogiri::HTML( open(uri).read, nil, @encoding ) )
     end
 
+    #
+    # Return parsed document or +nil+.
+    #
+    # TODO This needs some love.
     def _parse(doc)
       if    !doc.css('div.philologic_cite_list').first.nil?
         children = []
@@ -159,6 +177,9 @@ module Philologic
       nil
     end
 
+    #
+    # Build query string from +query+, perform query and return results.
+    #
     def _query(query)
       return _get( _build_query(query) )
     end
@@ -171,6 +192,12 @@ module Philologic
   #
   class Document
 
+    #
+    # Initialize Philologic::Document object.
+    #
+    # Params:
+    # +document+:: Nokogiri document
+    #
     def initialize(document)
       @doc  = document
       @text = nil
@@ -199,6 +226,13 @@ module Philologic
   #
   class Link
 
+    #
+    # Initialize Philologic::Link object.
+    #
+    # Params:
+    # +client+:: Philologic::Client object
+    # +document+:: Nokogiri document
+    #
     def initialize(client, document)
       @client     = client
       @doc        = document

data/philologic-client.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'mocha'
-  s.add_development_dependency 'rdoc-readme'
+  s.add_development_dependency 'rdoc-readme', '~> 0.1.2'
   s.add_development_dependency 'simplecov'
   s.add_runtime_dependency     'nokogiri'
 end

data/test/test_philologic_client.rb

@@ -52,13 +52,9 @@ class TestPhilologicClient < Test::Unit::TestCase
 
   def test_encoding_accessor
     Philologic::Client.new do |client|
-      assert_equal  'utf-8', client.encoding
-      assert_equal  'foo',   client.encoding = 'foo'
-      assert_equal  'foo',   client.encoding
-#
-#      assert_nil   client.endpoint,                        'defaults to nil'
-#      assert_equal @endpoint, client.endpoint = @endpoint, 'returns value on set'
-#      assert_equal @endpoint, client.endpoint,             'returns value on get'
+      assert_equal  Philologic::Client::DEFAULT_ENCODING, client.encoding
+      assert_equal  'foo',                                client.encoding = 'foo'
+      assert_equal  'foo',                                client.encoding
     end
   end
 
@@ -169,44 +165,45 @@ class TestPhilologicClient < Test::Unit::TestCase
     end
   end
 
-  def test_nil_search
+  def test_underscore_query
     Philologic::Client.new(@endpoint) do |client|
-      assert_raise(RuntimeError, 'no query specified') { client.search(nil) }
+      doc = client.send( :_parse, Nokogiri::HTML( open(@query_file) ) )
+      client.stubs(:_get).with('?query=sartre').returns(doc)
+      assert_equal  doc, client.send( :_query, :query => 'sartre' )
     end
   end
 
-  def test_underscore_query
+  def test_underscore_build_query_with_invalid_queries
     Philologic::Client.new(@endpoint) do |client|
-      doc = client.send( :_parse, Nokogiri::HTML( open(@query_file) ) )
-      q   = 'sartre'
-      qs  = "?query=#{q}"
-      client.stubs(:_get).with(qs).returns(doc)
-      assert_equal  doc, client.send(:_query, q)
+      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, nil)   }
+      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, {})    }
+      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, [])    }
+      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, '')    }
+      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, 'foo') }
     end
   end
 
-  def test_underscore_build_query_with_nil_query
+  def test_underscore_build_query
     Philologic::Client.new(@endpoint) do |client|
-      assert_raise(RuntimeError, 'no query specified') { client.send(:_build_query, nil) }
+      assert_equal '?query=sartre',         client.send( :_build_query, :query => 'sartre' )
+      assert_equal '?query=sartre&foo=bar', client.send( :_build_query, :query => 'sartre', :foo => 'bar' )
     end
   end
 
-  def test_underscore_build_query
+  def test_search_with_invalid_queries
     Philologic::Client.new(@endpoint) do |client|
-      q   = 'sartre'
-      qs  = "?query=#{q}"
-      assert_equal qs, client.send(:_build_query, q)
+      [ nil, [], {}, '', [ '' ], [ nil ], Object.new ].each do |q|
+        assert_raise(RuntimeError, 'invalid query') { client.search(q) }
+      end
     end
   end
 
   def test_search
     Philologic::Client.new(@endpoint) do |client|
       doc = client.send( :_parse, Nokogiri::HTML( open(@query_file) ) )
-      q   = 'sartre'
-      qs  = "?query=#{q}"
-      client.stubs(:_get).with(qs).returns(doc)
+      client.stubs(:_get).with('?query=sartre').returns(doc)
 
-      results = client.search(q)
+      results = client.search('sartre')
 
       assert_not_nil  results
       assert_kind_of  Array, results
@@ -236,5 +233,42 @@ class TestPhilologicClient < Test::Unit::TestCase
 
     end
   end
+
+  def test_search_with_key_value_pairs
+    Philologic::Client.new(@endpoint) do |client|
+      doc = client.send( :_parse, Nokogiri::HTML( open(@query_file) ) )
+      client.stubs(:_get).with('?query=sartre').returns(doc)
+
+      results = client.search( :query => 'sartre' )
+
+      assert_not_nil  results
+      assert_kind_of  Array, results
+      assert_equal    50,    results.size
+      results.each do |result|
+        assert_kind_of Philologic::Link,  result
+        assert_equal   'philologic_cite', result['class']
+        assert_not_nil result['href']
+        assert_nil     result['some random attribute']
+        assert_not_nil result['author']
+        assert_nil     result['filename']
+        assert_not_nil result['title']
+        assert_raise(NoMethodError) { result.text }
+      end
+
+      assert_equal './54/1/0/0',             results.first['href']
+      assert_equal 'Peiresc N. de',          results.first['author']
+      assert_equal 'Lettres T. 6 1602-1637', results.first['title']
+      assert_nil   results.first['filename']
+      assert_raise(NoMethodError) { results.first.text }
+
+      assert_equal './1792/11/0/0',          results.last['href']
+      assert_equal 'Gide A.',                results.last['author']
+      assert_equal 'Journal 1939-1949',      results.last['title']
+      assert_nil   results.last['filename']
+      assert_raise(NoMethodError) { results.last.text }
+
+    end
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philologic-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000Z
+date: 2012-01-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70270934047440 !ruby/object:Gem::Requirement
+  requirement: &70118250803080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270934047440
+  version_requirements: *70118250803080
 - !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70270934047000 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &70118250802640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270934047000
+  version_requirements: *70118250802640
 - !ruby/object:Gem::Dependency
-  name: rdoc-readme
-  requirement: &70270934046580 !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: &70118250802220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270934046580
+  version_requirements: *70118250802220
+- !ruby/object:Gem::Dependency
+  name: rdoc-readme
+  requirement: &70118250801720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *70118250801720
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70270934046160 !ruby/object:Gem::Requirement
+  requirement: &70118250801300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70270934046160
+  version_requirements: *70118250801300
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70270934045740 !ruby/object:Gem::Requirement
+  requirement: &70118250800840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270934045740
+  version_requirements: *70118250800840
 description: Ruby client for interacting with the Philologic API.
 email:
 - blair.christensen@gmail.com
@@ -99,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2626252476221214395
+      hash: -808024732695732071
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2626252476221214395
+      hash: -808024732695732071
 requirements: []
 rubyforge_project: philologic-client
 rubygems_version: 1.8.7