oldskool-gcse 0.0.1

data/lib/oldskool/gcse.rb

@@ -0,0 +1,100 @@
+module Oldskool
+  class GCSE
+    attr_reader :querytime
+
+    include HTTParty
+
+    def initialize(apikey, cx, apiurl='https://www.googleapis.com/customsearch/v1')
+      @cx = cx
+      @apikey = apikey
+      @api = apiurl
+      @lastresult = nil
+      @querytime = 0
+      @error = nil
+    end
+
+    def search(q, args={})
+      args[:start] = (args.delete(:page) * 10 + 1) if args[:page]
+
+      start = Time.now
+      @lastresult = self.class.get(@api, :query => {:q => q, :key => @apikey, :cx => @cx}.merge(args))
+
+      @querytime = Time.now - start
+
+      if @lastresult["error"]
+        @error = @lastresult["error"]["message"]
+      else
+        @error = nil
+      end
+
+      self
+    end
+
+    # Array of search results
+    def items
+      @lastresult["items"]
+    end
+
+    def total
+      Integer(@lastresult["queries"]["request"].first["totalResults"])
+    end
+
+    # Custom Search Engine title
+    def title
+      @lastresult["context"]["title"]
+    end
+
+    # number of total results found in the search
+    def total_results
+      @lastresults["request"]["totalResults"]
+    end
+
+    def has_previous?
+      !!@lastresult["queries"]["previousPage"]
+    end
+
+    def has_next?
+      !!@lastresult["queries"]["nextPage"]
+    end
+
+    def next_start
+      if has_next?
+        return @lastresult["queries"]["nextPage"].first["startIndex"]
+      end
+    end
+
+    def previous_start
+      if has_previous?
+        return @lastresult["queries"]["previousPage"].first["startIndex"]
+      end
+    end
+
+    # do search for the previous results
+    def previous
+      if (r = @lastresult["queries"]["previousPage"])
+        return search_by_query_hash(r.first)
+      else
+        return nil
+      end
+    end
+
+    # do a search for the next results
+    def next
+      if (r = @lastresult["queries"]["nextPage"])
+        @previous = @lastresult.clone
+
+        return search_by_query_hash(r.first)
+      else
+        return nil
+      end
+    end
+
+    def search_by_query_hash(query)
+      if query["startIndex"]
+        return search(query["searchTerms"], {:start => query["startIndex"]})
+      else
+        return search(query["searchTerms"])
+      end
+    end
+  end
+end

data/lib/oldskool/gcse_handler.rb

@@ -0,0 +1,32 @@
+module Oldskool
+  class GcseHandler
+    include Utils
+
+    def initialize(params, keyword, config)
+      @params = params
+      @keyword = keyword
+      @config = config
+      self
+    end
+
+    def handle_request(keyword, query)
+      gcse = GCSE.new(@config[:google_api_key], @keyword[:cx])
+
+      if @params["page"]
+        @params["page"] = Integer(@params["page"])
+      else
+        @params["page"] = 1
+      end
+
+      args = {:start => ((@params["page"] - 1) * 10 + 1)}
+
+      gcse.search @params[:q], args
+
+      sidemenu = [{:title => "Google", :url => "http://google.com/search?q=%s" % [ escape_html((query || keyword)) ]},
+                  {:title => "Images", :url => "http://google.com/search?q=%s&tbm=isch" % [escape_html query]},
+                  {:title => "Videos", :url => "http://google.com/search?q=%s&tbm=vid" % [ escape_html query ]} ]
+
+      {:template => plugin_template(:gcse, __FILE__), :gcse => gcse, :sidemenu => sidemenu}
+    end
+  end
+end

data/lib/oldskool-gcse.rb

@@ -0,0 +1,2 @@
+require 'oldskool/gcse'
+require 'oldskool/gcse_handler'

data/views/gcse.erb

@@ -0,0 +1,59 @@
+<% unless @error %>
+  <style type="text/css">
+    .gcse_results {
+      margin-left: auto;
+      margin-right: auto;
+      width: 100%;
+      background-color:#b0e0e6;
+    }
+
+    .gcse_stats {
+      font-size: 75%;
+    }
+
+    .gcse_result {
+      padding-bottom: 20px;
+    }
+
+    .gcse_linktext {
+      color: green;
+      font-size: 80%;
+    }
+  </style>
+  <% if @result[:gcse].items %>
+    <div class="gcse_results">
+      <% @result[:gcse].items.each do |item| %>
+        <div class="gcse_result">
+          <div class="gcse_title"><a href="<%= item["link"] %>"><%= item["htmlTitle"] %></a></div>
+          <div class="gcse_snippet"><%= item["htmlSnippet"] %></div>
+          <div class="gcse_linktext"><%= item["link"] %></div>
+        </div>
+      <% end %>
+      <div class="gcse_stats"><%= @result[:gcse].total %> items found in <%= @result[:gcse].querytime %> seconds</div>
+    </div>
+    <div class="pagination">
+      <ul>
+        <% if @result[:gcse].has_previous? %>
+          <li class="prev"><a href="/do?q=<%= @params["q"] %>&page=<%= @params[:page] - 1 %>">&larr; Previous</a></li>
+        <% else %>
+          <li class="prev disabled"><a href="#">&larr; Previous</a></li>
+        <% end %>
+        <% (1..10).each do |i| %>
+          <% break if (i * 10) >= @result[:gcse].total %>
+          <% if @params[:page] == i %>
+            <li class="active"><a href="/do?q=<%= @params["q"] %>&page=<%= i %>"><%= i %></a></li>
+          <% else %>
+            <li><a href="/do?q=<%= @params["q"] %>&page=<%= i %>"><%= i %></a></li>
+          <% end %>
+        <% end %>
+        <% if @result[:gcse].has_next? %>
+          <li class="next"><a href="/do?q=<%= @params["q"] %>&page=<%= @params[:page] + 1 %>">Next &rarr;</a></li>
+        <% else %>
+          <li class="next disabled"><a href="#">Next &rarr;</a></li>
+        <% end %>
+      </ul>
+    </div>
+  <% else %>
+    No results found, daily API limit might have been reached
+  <% end %>
+<% end %>

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: oldskool-gcse
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- R.I.Pienaar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-14 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "description: Google Custom Search plugin for Oldskool"
+email: rip@devco.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/oldskool/gcse.rb
+- lib/oldskool/gcse_handler.rb
+- lib/oldskool-gcse.rb
+- views/gcse.erb
+has_rdoc: true
+homepage: http://devco.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: oldskool-gcse
+test_files: []
+