trusty_google_custom_search 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,51 @@
+GoogleCustomSearch
+==================
+
+Rewritten version of the GoogleCustomSearch plugin, replacing the now deprecated AJAX API with
+ the Google Site Search XML API.
+
+How to Use
+==========
+
+After adding the Google Custom Search plugin to your vendor/plugins directory, add the following to your environment.rb file:
+
+    GoogleCustomSearch::Search.google_search_api_key = "Your Google API Key"
+
+From there, you can run a search like so:
+
+  @results = GoogleCustomSearch::Search.new.with_page_index(1).for url_encode("query")
+
+Result items can be accessed through the items parameter (i.e. result.items). An example implementation for a view:
+
+  <% @results.items.each do |result_item| %>
+    <div class="result">
+      <div class="title">
+        <h4>
+          <%= link_to sanitize(result_item.title), result_item.url %>
+        </h4>
+      </div>
+      <div class="description">
+        <%= sanitize(result_item.content) %>
+      </div>
+      <div class="url">
+        <%= result_item.url %>
+      </div>
+    </div>
+  <% end %>
+
+And, finally, a sample implementation to create next and previous page links:
+
+  <div class="pagination-links">
+    <% if @result.items.count > 0 %>
+      <% unless @result.first_page? %>
+        <%= render :partial => "page", :locals => {:page_number => @result.previous_page_number, :label => "&lt; Previous"} %>
+      <% end %>
+      <% unless @result.last_page? %>
+        <%= render :partial => "page", :locals => {:page_number => @result.next_page_number, :label => "Next &gt;"} %>
+      <% end %>
+    <% end %>
+  </div>
+
+
+Modifications (c) 2011 The Pittsburgh Cultural Trust, released under the MIT license
+Copyright (c) 2010 Anand Agarwal / Anay Kamat, released under the MIT license

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require "spec"
+require "spec/rake/spectask"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the google_custom_search plugin.'
+Spec::Rake::SpecTask.new(:test) do |t|
+  plugin_root = File.dirname(__FILE__)
+#  t.rcov = true
+#  t.rcov_opts = lambda do
+#    IO.readlines("#{plugin_root}/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+#  end
+  t.spec_opts = ['--options', "\"#{plugin_root}/spec/spec.opts\""]
+  t.spec_files = FileList[].include(File.join(plugin_root, 'spec', '**/*_spec.rb'))
+end
+
+desc 'Generate documentation for the google_custom_search plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoogleCustomSearch'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), "lib", "google_custom_search")

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/google_custom_search/search.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'open-uri'
+require 'hpricot'
+
+module GoogleCustomSearch
+
+  class Search
+
+    class << self
+      attr_accessor :google_search_api_key
+    end
+    def initialize
+      @page_index = 0
+      @query_parameters = {
+              :num => 10,
+              :start => 1
+      }
+    end
+
+    def for keyword
+      uri = build_query_url(keyword)
+      search_data = uri.read
+      xml_data = Hpricot(search_data)
+      GoogleCustomSearch::SearchResult.new xml_data
+    end
+
+    def with_page_index index
+      @page_index = index - 1
+      self
+    end
+
+    private
+    def build_query_url(keyword)
+      @query_parameters[:start] = @query_parameters[:num] * @page_index
+      google_search_url = "http://www.google.com/cse?client=google-csbe&output=xml_no_dtd"
+      arguments = @query_parameters.collect { |key, value| "#{key}=#{value}" }
+      arguments.sort!
+      URI.parse("#{google_search_url}&cx=#{self.class.google_search_api_key}&q=#{keyword}&"+arguments.join("&"))
+    end
+
+  end
+
+end

data/lib/google_custom_search/search_result.rb

@@ -0,0 +1,45 @@
+require 'hpricot'
+module GoogleCustomSearch
+  class SearchResult
+    def initialize result
+      @result = result
+    end
+
+    def estimated_count
+      (@result/"res"/"m").innerHTML.to_i
+    end
+
+    def start_index
+      @result.at('res').attributes['sn'].to_i
+    end
+
+    def end_index
+      @result.at('res').attributes['en'].to_i
+    end
+
+    def items
+      (@result/"r").collect { |result| SearchResultItem.new result }
+    end
+
+    def range
+      start_index..end_index
+    end
+
+    def first_page?
+      start_index == 1
+    end
+
+    def previous_page_number
+      (start_index - 1) / 10 unless first_page?
+    end
+
+    def last_page?
+      end_index >= estimated_count
+    end
+
+    def next_page_number
+      (end_index / 10) + 1 unless last_page?
+    end
+
+  end
+end

data/lib/google_custom_search/search_result_item.rb

@@ -0,0 +1,15 @@
+require 'hpricot'
+require 'cgi'
+module GoogleCustomSearch
+
+  class SearchResultItem
+
+    attr_reader :title, :content, :url
+
+    def initialize(search_item)
+      @title = CGI.unescapeHTML((search_item/"t").innerHTML)
+      @content = CGI.unescapeHTML((search_item/"s").innerHTML)
+      @url = (search_item/"u").innerHTML
+    end
+  end
+end

data/lib/google_custom_search.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/google_custom_search/**/*.rb"].each { |file| require file }

data/spec/google_custom_search/search_result_item_spec.rb

@@ -0,0 +1,43 @@
+require 'hpricot'
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+describe GoogleCustomSearch::SearchResultItem do
+
+  MOCK_XML =<<-xml
+<GSP VER="3.2">
+<TM>0.129014</TM><Q>Wicked</Q>
+<PARAM name="cx" value="abcd" original_value="abcd" url_escaped_value="abcd" js_escaped_value="abcd"/>
+<PARAM name="client" value="google-csbe" original_value="google-csbe" url_escaped_value="google-csbe" js_escaped_value="google-csbe"/>
+<PARAM name="output" value="xml_no_dtd" original_value="xml_no_dtd" url_escaped_value="xml_no_dtd" js_escaped_value="xml_no_dtd"/>
+<PARAM name="q" value="Wicked" original_value="Wicked" url_escaped_value="Wicked" js_escaped_value="Wicked"/>
+<Context><title>Cultural District Search Engine</title></Context><ARES/><RES SN="1" EN="1">
+<M>33</M>
+<FI/><NB><NU>/custom?q=Wicked&amp;hl=en&amp;safe=off&amp;client=google-csbe&amp;cx=004905679161489350096:rymp5afccji&amp;boostcse=0&amp;site=culturaldistrict.org&amp;output=xml_no_dtd&amp;ie=UTF-8&amp;oe=UTF-8&amp;ei=wFH_TdLGI8fKgQfGpMXwCg&amp;start=10&amp;sa=N</NU>
+</NB><RG START="1" SIZE="1"/><RG START="1" SIZE="1"/><R N="1"><U>http://pgharts.culturaldistrict.org/production/26485</U><UE>http://pgharts.culturaldistrict.org/production/26485</UE><T>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets Entertainment Weekly calls &lt;b&gt;WICKED&lt;/b&gt; &amp;quot;the &lt;br&gt;  best musical of the decade,” and when it first played Pittsburgh in 2006, &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_rymp5afccji</Label><HAS><L/><C SZ="25k" CID="zZcvqAH799sJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+</RES>
+</GSP>
+xml
+
+  def item_xml
+    results = Hpricot(MOCK_XML)
+    (results/"r").first
+  end
+
+
+  it "should return the title of search item" do
+    item = GoogleCustomSearch::SearchResultItem.new item_xml
+    item.title.should == "<b>Wicked</b> Pittsburgh Benedum Center Tickets"
+  end
+
+  it "should return the url of search item" do
+    item = GoogleCustomSearch::SearchResultItem.new item_xml
+    item.url.should == "http://pgharts.culturaldistrict.org/production/26485"
+  end
+
+  it "should return the content of search item" do
+    item = GoogleCustomSearch::SearchResultItem.new item_xml
+    item.content.should_not be_nil
+  end
+
+
+end

data/spec/google_custom_search/search_result_spec.rb

@@ -0,0 +1,84 @@
+require 'spec'
+require 'hpricot'
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+describe GoogleCustomSearch::SearchResult do
+
+  RESULTS_XML = <<xml
+<GSP VER="3.2">
+<TM>0.129014</TM><Q>Wicked</Q>
+<PARAM name="cx" value="abcd" original_value="abcd" url_escaped_value="abcd" js_escaped_value="abcd"/>
+<PARAM name="client" value="google-csbe" original_value="google-csbe" url_escaped_value="google-csbe" js_escaped_value="google-csbe"/>
+<PARAM name="output" value="xml_no_dtd" original_value="xml_no_dtd" url_escaped_value="xml_no_dtd" js_escaped_value="xml_no_dtd"/>
+<PARAM name="q" value="Wicked" original_value="Wicked" url_escaped_value="Wicked" js_escaped_value="Wicked"/>
+<PARAM name="site" value="culturaldistrict.org" original_value="culturaldistrict.org" url_escaped_value="culturaldistrict.org" js_escaped_value="culturaldistrict.org"/>
+<PARAM name="adkw" value="AELymgX673ECcjZDQxtHuHEb5eHdobDdCLAvA552m-THsHQIu0ADF7SYAAoooi6mXsZjdqeBc-erFEdiD5Ir7Jml7ViklMSxqaFvPG05sJJoTebK88Rys-Q" original_value="AELymgX673ECcjZDQxtHuHEb5eHdobDdCLAvA552m-THsHQIu0ADF7SYAAoooi6mXsZjdqeBc-erFEdiD5Ir7Jml7ViklMSxqaFvPG05sJJoTebK88Rys-Q" url_escaped_value="AELymgX673ECcjZDQxtHuHEb5eHdobDdCLAvA552m-THsHQIu0ADF7SYAAoooi6mXsZjdqeBc-erFEdiD5Ir7Jml7ViklMSxqaFvPG05sJJoTebK88Rys-Q" js_escaped_value="AELymgX673ECcjZDQxtHuHEb5eHdobDdCLAvA552m-THsHQIu0ADF7SYAAoooi6mXsZjdqeBc-erFEdiD5Ir7Jml7ViklMSxqaFvPG05sJJoTebK88Rys-Q"/>
+<PARAM name="hl" value="en" original_value="en" url_escaped_value="en" js_escaped_value="en"/>
+<PARAM name="oe" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"/>
+<PARAM name="ie" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"/>
+<PARAM name="boostcse" value="0" original_value="0" url_escaped_value="0" js_escaped_value="0"/>
+<Context><title>Cultural District Search Engine</title></Context><ARES/><RES SN="1" EN="10">
+<M>33</M>
+<FI/><NB><NU>/custom?q=Wicked&amp;hl=en&amp;safe=off&amp;client=google-csbe&amp;cx=004905679161489350096:rymp5afccji&amp;boostcse=0&amp;site=culturaldistrict.org&amp;output=xml_no_dtd&amp;ie=UTF-8&amp;oe=UTF-8&amp;ei=wFH_TdLGI8fKgQfGpMXwCg&amp;start=10&amp;sa=N</NU>
+</NB>
+
+<RG START="1" SIZE="10"/><RG START="1" SIZE="1"/><R N="1"><U>http://pgharts.culturaldistrict.org/production/26485</U><UE>http://pgharts.culturaldistrict.org/production/26485</UE><T>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets Entertainment Weekly calls &lt;b&gt;WICKED&lt;/b&gt; &amp;quot;the &lt;br&gt;  best musical of the decade,” and when it first played Pittsburgh in 2006, &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_rymp5afccji</Label><HAS><L/><C SZ="25k" CID="zZcvqAH799sJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="2" SIZE="1"/><R N="2"><U>http://pgharts.culturaldistrict.org/production/26485/wicked?cid=CT_05122011_FB_Wicked_WickedPresale</U><UE>http://pgharts.culturaldistrict.org/production/26485/wicked%3Fcid%3DCT_05122011_FB_Wicked_WickedPresale</UE><T>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets</T><RK>0</RK><BYLINEDATE>1305231821</BYLINEDATE><S>May 12, 2011 &lt;b&gt;...&lt;/b&gt; &lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets Entertainment Weekly calls &lt;b&gt;WICKED&lt;/b&gt; &amp;quot;the &lt;br&gt;  best musical of the decade,” and when it first played &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="26k" CID="unFTTJ48B_oJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="3" SIZE="1"/><R N="3"><U>http://www.culturaldistrict.org/tickets/tickets/reserve.aspx?performanceNumber=24471</U><UE>http://www.culturaldistrict.org/tickets/tickets/reserve.aspx%3FperformanceNumber%3D24471</UE><T>Idina Menzel Pittsburgh Heinz Hall Tickets</T><RK>0</RK><S>Broadway powerhouse Idina Menzel – the Tony award-winning &amp;quot;Elphaba&amp;quot; from &lt;br&gt;  international blockbuster &lt;b&gt;Wicked&lt;/b&gt; – performs for one-night-only at Heinz Hall &lt;br&gt;  with &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="25k" CID="LixRI1ZIT5oJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="4" SIZE="1"/><R N="4"><U>http://pgharts.culturaldistrict.org/calendar/daily/2011/10/1</U><UE>http://pgharts.culturaldistrict.org/calendar/daily/2011/10/1</UE><T>The Pittsburgh Cultural Trust: Event Calendar: Saturday October 01 &lt;b&gt;...&lt;/b&gt;</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt;. 2:00 PM. Presented By: PNC Broadway Across America - Pittsburgh | Venue: &lt;br&gt;  Benedum Center. The untold story of the witches of Oz &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="31k" CID="-OI1Yk1Uu00J"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="5" SIZE="1"/><R N="5"><U>http://pgharts.culturaldistrict.org/pct_home/subscriptions/pnc-broadway-subscriber-benefits/</U><UE>http://pgharts.culturaldistrict.org/pct_home/subscriptions/pnc-broadway-subscriber-benefits/</UE><T>PNC Broadway Subscriber Benefits</T><RK>0</RK><S>You&amp;#39;ll also be able to swap out of a subscription series show into a special as &lt;br&gt;  they are announced (excludes &lt;b&gt;Wicked&lt;/b&gt;.) You can swap your tickets out of only &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_rymp5afccji</Label><HAS><L/><C SZ="17k" CID="wlaQgeznJUsJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="6" SIZE="1"/><R N="6" MIME="application/pdf"><U>http://pgharts.culturaldistrict.org/uploads/File/PCT%20Group%20Sales/Broadway/bwy_WICKED_groupsales.pdf</U><UE>http://pgharts.culturaldistrict.org/uploads/File/PCT%2520Group%2520Sales/Broadway/bwy_WICKED_groupsales.pdf</UE><T>September 7-October 2, 2011 • Benedum Center</T><RK>0</RK><S>Visit &lt;b&gt;wicked&lt;/b&gt;.pgharts.org for information. $4 per order handling fee is added to &lt;br&gt;  final purchase. prices, dates and times are subject to change without notice &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_rymp5afccji</Label><PageMap><DataObject type="metatags"><Attribute name="creationdate" value="D:20110506145045-04'00'"/><Attribute name="creator" value="Adobe InDesign CS3 (5.0.4)"/><Attribute name="producer" value="Adobe PDF Library 8.0"/><Attribute name="moddate" value="D:20110506145046-04'00'"/></DataObject></PageMap><HAS><L/><C SZ="" CID="D57QXYGUDqAJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET BLOB_REF="ADGEESicCNeh5IbblmeWGTjD7GhHhT-x68j4uxcR1ABteSioixexJKoYjJy8N-QGkEid67mu1eQMILVLRJlcms6fB7PrpRy_Jbq_4DXkV0G-1mEXtPrlG5c5L6_iX055ApzMWVGgP6nC"/></R>
+<RG START="7" SIZE="1"/><R N="7"><U>http://www.culturaldistrict.org/calendar/daily/2011/9/11</U><UE>http://www.culturaldistrict.org/calendar/daily/2011/9/11</UE><T>CulturalDistrict.org: Event Calendar: Sunday September 11, 2011</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt;. 1:00 PM. Presented By: PNC Broadway Across America - Pittsburgh | Venue: &lt;br&gt;  Benedum Center. The untold story of the witches of Oz &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="31k" CID="kLpVCLvWg9MJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="8" SIZE="1"/><R N="8"><U>http://www.culturaldistrict.org/calendar/daily/2011/9/8</U><UE>http://www.culturaldistrict.org/calendar/daily/2011/9/8</UE><T>CulturalDistrict.org: Event Calendar: Thursday September 08, 2011</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt;. 2:00 PM. Presented By: PNC Broadway Across America - Pittsburgh | Venue: &lt;br&gt;  Benedum Center. The untold story of the witches of Oz &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="31k" CID="401rjaqny8oJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="9" SIZE="1"/><R N="9"><U>http://www.culturaldistrict.org/calendar/daily/2011/9/24</U><UE>http://www.culturaldistrict.org/calendar/daily/2011/9/24</UE><T>CulturalDistrict.org: Event Calendar: Saturday September 24, 2011</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt;. 2:00 PM. Presented By: PNC Broadway Across America - Pittsburgh | Venue: &lt;br&gt;  Benedum Center. The untold story of the witches of Oz &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="34k" CID="vvjjOCKmgKIJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+<RG START="10" SIZE="1"/><R N="10"><U>http://www.culturaldistrict.org/calendar/daily/2011/9/30</U><UE>http://www.culturaldistrict.org/calendar/daily/2011/9/30</UE><T>CulturalDistrict.org: Event Calendar: Friday September 30, 2011</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt;. 8:00 PM. Presented By: PNC Broadway Across America - Pittsburgh | Venue: &lt;br&gt;  Benedum Center. The untold story of the witches of Oz &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>3</Label><Label>4</Label><HAS><L/><C SZ="31k" CID="BqNFJisYpOkJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+</RES>
+</GSP>
+xml
+
+  RESULTS_XML_NO_RESULTS = <<xml
+<GSP VER="3.2">
+<TM>0.166453</TM>
+<Q>ffffggggg</Q>
+<PARAM name="cx" value="abcd" original_value="abcd" url_escaped_value="abcd" js_escaped_value="abcd"/>
+<PARAM name="client" value="google-csbe" original_value="google-csbe" url_escaped_value="google-csbe" js_escaped_value="google-csbe"/>
+<PARAM name="output" value="xml_no_dtd" original_value="xml_no_dtd" url_escaped_value="xml_no_dtd" js_escaped_value="xml_no_dtd"/>
+<PARAM name="q" value="ffffggggg" original_value="ffffggggg" url_escaped_value="ffffggggg" js_escaped_value="ffffggggg"/>
+<PARAM name="site" value="culturaldistrict.org" original_value="culturaldistrict.org" url_escaped_value="culturaldistrict.org" js_escaped_value="culturaldistrict.org"/>
+<PARAM name="adkw" value="AELymgXMiR0AyItzzgcJ88snCQ2ZQzi95BHYCpbuWqtNT-FkkxqTr3DTojcP0wKL9BMQD_VtA2nqsPZBKc_VkpC2x_UStZxn28VD4JyE6g1V53hVHpaf2js" original_value="AELymgXMiR0AyItzzgcJ88snCQ2ZQzi95BHYCpbuWqtNT-FkkxqTr3DTojcP0wKL9BMQD_VtA2nqsPZBKc_VkpC2x_UStZxn28VD4JyE6g1V53hVHpaf2js" url_escaped_value="AELymgXMiR0AyItzzgcJ88snCQ2ZQzi95BHYCpbuWqtNT-FkkxqTr3DTojcP0wKL9BMQD_VtA2nqsPZBKc_VkpC2x_UStZxn28VD4JyE6g1V53hVHpaf2js" js_escaped_value="AELymgXMiR0AyItzzgcJ88snCQ2ZQzi95BHYCpbuWqtNT-FkkxqTr3DTojcP0wKL9BMQD_VtA2nqsPZBKc_VkpC2x_UStZxn28VD4JyE6g1V53hVHpaf2js"/>
+<PARAM name="hl" value="en" original_value="en" url_escaped_value="en" js_escaped_value="en"/>
+<PARAM name="oe" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"/>
+<PARAM name="ie" value="UTF-8" original_value="UTF-8" url_escaped_value="UTF-8" js_escaped_value="UTF-8"/>
+<PARAM name="boostcse" value="0" original_value="0" url_escaped_value="0" js_escaped_value="0"/>
+<Spelling>
+<Suggestion q="ffggggg"><b><i>ffggggg</i></b></Suggestion>
+</Spelling>
+<ARES/>
+</GSP>
+xml
+
+  it "should find the estimated count from the given search result json data" do
+    result = GoogleCustomSearch::SearchResult.new Hpricot(RESULTS_XML)
+    result.estimated_count.should == 33
+  end
+
+
+  it "should return the range of results" do
+    result = GoogleCustomSearch::SearchResult.new Hpricot(RESULTS_XML)
+    result.range.should == (1..10)
+  end
+
+  describe "items" do
+    it "should return the search result items" do
+      result = GoogleCustomSearch::SearchResult.new Hpricot(RESULTS_XML)
+      result.items.size.should == 10
+    end
+
+    it "should return the title of search item" do
+      result = GoogleCustomSearch::SearchResult.new Hpricot(RESULTS_XML)
+      result.items.first.title.should == "<b>Wicked</b> Pittsburgh Benedum Center Tickets"
+    end
+  end
+
+
+end

data/spec/google_custom_search/search_spec.rb

@@ -0,0 +1,53 @@
+require 'spec'
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+describe GoogleCustomSearch::Search do
+
+  MOCK_JSON = {"responseData"=>{"results"=>[{"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/production.aspx%3FperformanceNumber%3D17303", "cacheUrl"=>"http://www.google.com/search?q=cache:pGjUcr1qUkgJ:www.localhost.site", "content"=>"Search matching content", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/production.aspx?performanceNumber=17303", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/reserve.aspx%3FperformanceNumber%3D21140", "cacheUrl"=>"http://www.google.com/search?q=cache:E5_VPQiQo3kJ:www.localhost.site", "content"=>"1234", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/reserve.aspx?performanceNumber=21140", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/production.aspx%3FperformanceNumber%3D23379", "cacheUrl"=>"http://www.google.com/search?q=cache:V7cn6Foe2rMJ:www.localhost.site", "content"=>"abcd", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/production.aspx?performanceNumber=23379", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/production.aspx%3FperformanceNumber%3D17350", "cacheUrl"=>"http://www.google.com/search?q=cache:fJurfpC17DYJ:www.localhost.site", "content"=>"uiuio", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/production.aspx?performanceNumber=17350", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/production.aspx%3FperformanceNumber%3D23374", "cacheUrl"=>"http://www.google.com/search?q=cache:jExxaBgeDD0J:www.localhost.site", "content"=>"this looks great", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/production.aspx?performanceNumber=23374", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/tickets/production.aspx%3FperformanceNumber%3D17353", "cacheUrl"=>"http://www.google.com/search?q=cache:h43Ggs_qthYJ:www.localhost.site", "content"=>"super duper content", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/tickets/production.aspx?performanceNumber=17353", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page", "url"=>"http://www.localhost.site/tickets/calendar/", "cacheUrl"=>"http://www.google.com/search?q=cache:cI47PY7ITc4J:www.localhost.site", "content"=>"this should be useful", "visibleUrl"=>"www.localhost.site", "unescapedUrl"=>"http://www.localhost.site/tickets/calendar/", "titleNoFormatting"=>"Tile of the page"}, {"GsearchResultClass"=>"GwebSearch", "title"=>"Tile of the page - Your Show Place!", "url"=>"http://localhost.site/%3Fop%3Dcontact", "cacheUrl"=>"http://www.google.com/search?q=cache:UUq_Mw_-UnIJ:localhost.site", "content"=>"cards game", "visibleUrl"=>"localhost.site", "unescapedUrl"=>"http://localhost.site/?op=contact", "titleNoFormatting"=>"Tile of the page - Your Show Place!"}], "cursor"=>{"estimatedResultCount"=>"409", "currentPageIndex"=>3, "moreResultsUrl"=>"http://www.google.com/cse?oe=utf8&ie=utf8&source=uds&cx=004905679161489350096%3Arymp5afccji&start=28&hl=en&q=org", "pages"=>[{"label"=>1, "start"=>"0"}, {"label"=>2, "start"=>"8"}, {"label"=>3, "start"=>"16"}, {"label"=>4, "start"=>"24"}, {"label"=>5, "start"=>"32"}, {"label"=>6, "start"=>"40"}, {"label"=>7, "start"=>"48"}, {"label"=>8, "start"=>"56"}]}, "context"=>{"title"=>"Cultural District Search Engine", "facets"=>[]}}, "responseDetails"=>nil, "responseStatus"=>200}
+
+  MOCK_XML =<<-xml
+<GSP VER="3.2">
+<TM>0.129014</TM><Q>Wicked</Q>
+<PARAM name="cx" value="abcd" original_value="abcd" url_escaped_value="abcd" js_escaped_value="abcd"/>
+<PARAM name="client" value="google-csbe" original_value="google-csbe" url_escaped_value="google-csbe" js_escaped_value="google-csbe"/>
+<PARAM name="output" value="xml_no_dtd" original_value="xml_no_dtd" url_escaped_value="xml_no_dtd" js_escaped_value="xml_no_dtd"/>
+<PARAM name="q" value="Wicked" original_value="Wicked" url_escaped_value="Wicked" js_escaped_value="Wicked"/>
+<Context><title>Cultural District Search Engine</title></Context><ARES/><RES SN="1" EN="1">
+<M>33</M>
+<FI/><NB><NU>/custom?q=Wicked&amp;hl=en&amp;safe=off&amp;client=google-csbe&amp;cx=004905679161489350096:rymp5afccji&amp;boostcse=0&amp;site=culturaldistrict.org&amp;output=xml_no_dtd&amp;ie=UTF-8&amp;oe=UTF-8&amp;ei=wFH_TdLGI8fKgQfGpMXwCg&amp;start=10&amp;sa=N</NU>
+</NB><RG START="1" SIZE="1"/><RG START="1" SIZE="1"/><R N="1"><U>http://pgharts.culturaldistrict.org/production/26485</U><UE>http://pgharts.culturaldistrict.org/production/26485</UE><T>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets</T><RK>0</RK><S>&lt;b&gt;Wicked&lt;/b&gt; Pittsburgh Benedum Center Tickets Entertainment Weekly calls &lt;b&gt;WICKED&lt;/b&gt; &amp;quot;the &lt;br&gt;  best musical of the decade,” and when it first played Pittsburgh in 2006, &lt;b&gt;...&lt;/b&gt;</S><LANG>en</LANG><Label>_cse_rymp5afccji</Label><HAS><L/><C SZ="25k" CID="zZcvqAH799sJ"/><RT/></HAS><ELIGIBLE_FOR_VISUAL_SNIPPET/></R>
+</RES>
+</GSP>
+xml
+
+  ERROR_RESPONSE = {"responseData" => nil, "responseDetails" => "out of range start", "responseStatus" => 400}
+
+  GoogleCustomSearch::Search.google_search_api_key = "abcd"
+
+  describe "for" do
+
+    it "should return the estimated results count for the given search" do
+      mock_uri "http://www.google.com/cse?client=google-csbe&output=xml_no_dtd&cx=abcd&q=org&num=10&start=0", MOCK_XML
+      search = GoogleCustomSearch::Search.new
+      results = search.for("org")
+      results.estimated_count.should == 33
+    end
+
+  end
+
+  it "should return correct start and end index for results received" do
+    result = MOCK_XML
+    mock_uri "http://www.google.com/cse?client=google-csbe&output=xml_no_dtd&cx=abcd&q=org&num=10&start=10", result
+    search = GoogleCustomSearch::Search.new
+    results = search.with_page_index(2).for("org")
+    results.start_index.should == 1
+    results.end_index.should == 1
+  end
+
+  private
+  def mock_uri url, result
+    mock_uri = mock(URI)
+    mock_uri.should_receive(:read).and_return(result)
+    URI.should_receive(:parse).with(url).and_return(mock_uri)
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,5 @@
+--exclude "spec,tasks"
+--rails
+--include-file "lib/google_custom_search"
+--text-report
+--sort coverage

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+require File.expand_path( File.dirname(__FILE__)+'/../lib/google_custom_search')
+include Spec::Matchers

data/tasks/google_custom_search_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :google_custom_search do
+#   # Task goes here
+# end

data/trusty-google-custom-search.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "google_custom_search"
+
+Gem::Specification.new do |s|
+  s.name        = "trusty_google_custom_search"
+  s.version     = '1.0.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Eric Sipple"]
+  s.email       = ["sipple@trustarts.org"]
+  s.homepage    = "https://github.com/pgharts/google_custom_search/"
+  s.summary     = %q{Interface for google custom search}
+  s.description = %q{Provides access to google custom search that can be integrated with a website.}
+
+
+  s.add_dependency "hpricot", '~> 0.8.6'
+
+  ignores = if File.exist?('.gitignore')
+              File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+            else
+              []
+            end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: trusty_google_custom_search
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Sipple
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+description: Provides access to google custom search that can be integrated with a
+  website.
+email:
+- sipple@trustarts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- google_custom_search-1.0.0.gem
+- init.rb
+- install.rb
+- lib/google_custom_search/search.rb
+- lib/google_custom_search/search_result.rb
+- lib/google_custom_search/search_result_item.rb
+- lib/google_custom_search.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- spec/google_custom_search/search_result_item_spec.rb
+- spec/google_custom_search/search_result_spec.rb
+- spec/google_custom_search/search_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/google_custom_search_tasks.rake
+- trusty-google-custom-search.gemspec
+- uninstall.rb
+homepage: https://github.com/pgharts/google_custom_search/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: Interface for google custom search
+test_files:
+- spec/google_custom_search/search_result_item_spec.rb
+- spec/google_custom_search/search_result_spec.rb
+- spec/google_custom_search/search_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb