google-custom_search 0.0.1

data/lib/google/custom_search/config.rb

@@ -0,0 +1,57 @@
+module Google
+  module CustomSearch
+    class Config
+      attr_accessor :path
+      attr_accessor :environment
+      
+      [:key, :cx, :cse_id, :cref, :service].each do |key|
+        attr_writer key
+        define_method(key) do
+          instance_variable_get("@#{key}".to_sym) || read(key)
+        end
+      end
+      
+      def service_type
+        eval("#{self.service.upcase}::Service")
+      end
+    
+    private
+  
+      def read(key)
+        env_config[key.to_s] || raise("Key '#{key}' was not found in your config file #{path}. Alternatives: #{env_config.keys.join(',')}")
+      end
+      
+      def env_config
+        all_config[environment] || raise("No key for environment '#{environment}' found in #{path}")
+      end
+  
+      def all_config
+        return @config if @config
+        [:path, :environment].each do |param|
+          raise "Please set Google::CustomSearch.config.#{param}" unless self.send(param)
+        end
+
+        raise "Config file does not exist at #{path}" unless File.exists?(path)
+        @config = YAML.load_file(path)
+      end
+    end
+  
+    class << self
+      attr_accessor :config
+
+      def configure
+        yield config
+      end
+      
+    end
+    
+    self.config = Config.new
+  end
+end
+
+if defined?(Rails)
+  Google::CustomSearch.configure do |config|
+    config.path = "#{Rails.root}/config/google.yml"
+    config.environment = Rails.env
+  end
+end

data/lib/google/custom_search/json/results.rb

@@ -0,0 +1,102 @@
+require 'json'
+
+module Google
+  module CustomSearch
+    
+    module JSON
+      
+      class Results
+        include Enumerable
+
+        def initialize(response)
+          @data = ::JSON.parse(response)
+        end
+
+        def each(&block)
+          items.each(&block)
+        end
+
+        def empty?
+          items.empty?
+        end
+
+        def length
+          items.length
+        end
+
+        def next_page
+          Page.new(@data['queries']['nextPage'] || @data['queries']['request'])
+        end
+
+        def current_page
+          Page.new(@data['queries']['request'])
+        end
+
+        def previous_page
+          Page.new(@data['queries']['previousPage'] || @data['queries']['request'])
+        end
+
+      private
+
+        def items
+          @items ||= (@data['items'] || []).map do |item|
+            Result.new(item)
+          end
+        end
+
+        class Page
+          def initialize(data)
+            @data = data[0]
+          end
+
+          def start_index
+            @data['startIndex']
+          end
+
+          def to_s
+            "results #{start_index}-#{end_index} of #{total}"
+          end
+
+          def ==(other)
+            other.start_index == start_index
+          end
+
+        private
+
+          def total
+            @data['totalResults']
+          end
+
+          def end_index
+            start_index + @data['count'] - 1
+          end
+        end
+
+      end
+      
+      class Result
+        def initialize(data)
+          @data = data
+        end
+    
+        def title
+          @data['title'] || ''
+        end
+    
+        def uri
+          @data['link']
+        end
+    
+        def content
+          @data['htmlSnippet']
+        end
+
+        def site
+          @data['displayLink']
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/google/custom_search/json/service.rb

@@ -0,0 +1,38 @@
+require 'google/custom_search/json/results'
+
+module Google
+  module CustomSearch
+    module JSON
+
+      class Service
+
+        def initialize(config)
+          @config = config
+          @resource = RestClient::Resource.new('https://www.googleapis.com/customsearch/v1')
+        end
+
+        def request(query_string, start_index)
+          @resource.get(:params => params(query_string, start_index)) do |response, request, result|
+            unless response.code == 200
+              raise BadRequestError, "Unable to fetch results from Google: #{response}"
+            end
+            Results.new(response)
+          end
+        end
+
+      private
+
+        def params(query_string, start_index)
+          {
+            :q => query_string,
+            :start => start_index,
+            :key  => @config.key,
+            :cref => @config.cref,
+          }
+        end
+
+      end
+      
+    end
+  end
+end

data/lib/google/custom_search/query.rb

@@ -0,0 +1,35 @@
+require 'google/custom_search/config'
+require 'google/custom_search/json/service'
+require 'google/custom_search/xml/service'
+
+module Google
+  module CustomSearch
+
+    class BadRequestError < StandardError
+    end
+
+    class ConfigurationError < StandardError
+    end
+
+    class Query
+
+      def initialize(query_string, start_index, config = Google::CustomSearch.config)
+        @query_string = query_string
+        @start_index = start_index
+        @service = config.service_type.new(config)
+      end
+
+      def results
+        attempts = 5
+        begin
+          @service.request(@query_string, @start_index)
+        rescue BadRequestError
+          attempts -= 1
+          retry if attempts > 0
+          raise
+        end
+      end
+      
+    end
+  end
+end

data/lib/google/custom_search/xml/results.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'nokogiri'
+
+module Google
+  module CustomSearch
+    
+    module XML
+      
+      class Results
+        include Enumerable
+
+        def initialize(response)
+          @doc = Nokogiri::XML.parse(response)
+        end
+
+        def each(&block)
+          items.each(&block)
+        end
+
+        def empty?
+          items.empty?
+        end
+
+        def length
+          items.length
+        end
+        
+        def next_page
+          return current_page unless @doc.search('//RES/NB').any?
+          Page.new(current_page.end_index + 1, current_page.end_index + 11, 10)
+        end
+
+        def current_page
+          Page.from_xml(@doc.search('//RES').first)
+        end
+
+        def previous_page
+          return current_page if current_page.start_index == 1
+          Page.new(current_page.start_index - 10, current_page.start_index, 10)
+        end
+
+      private
+
+        def items
+          @items ||= @doc.search('//RES/R').map do |node|
+            Result.new(node)
+          end
+        end
+        
+        class Page < Struct.new(:start_index, :end_index, :total)
+          def self.from_xml(node)
+            new(
+              node.attributes['SN'].text.to_i,
+              node.attributes['EN'].text.to_i,
+              node.search('M').text.to_i)
+          end
+          
+          def to_s
+            "results #{start_index}-#{end_index} of #{total}"
+          end
+        
+          def ==(other)
+            other.start_index == start_index
+          end
+        
+        end
+
+      end
+      
+      class Result
+        def initialize(node)
+          @node = node
+        end
+    
+        def title
+          @node.search('T').text
+        end
+    
+        def uri
+          @node.search('U').text
+        end
+    
+        def content
+          @node.search('S').text
+        end
+
+        def site
+          URI.parse(@node.search('U').text).host
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/google/custom_search/xml/service.rb

@@ -0,0 +1,38 @@
+require 'google/custom_search/xml/results'
+
+module Google
+  module CustomSearch
+    module XML
+
+      class Service
+
+        def initialize(config)
+          @config = config
+          @resource = RestClient::Resource.new('http://www.google.com/cse')
+        end
+
+        def request(query_string, start_index)
+          @resource.get(:params => params(query_string, start_index)) do |response, request, result|
+            unless response.code == 200
+              raise BadRequestError, "Unable to fetch results from Google: #{response}"
+            end
+            Results.new(response)
+          end
+        end
+
+      private
+
+        def params(query_string, start_index)
+          {
+            :q => query_string,
+            :output => 'xml_no_dtd',
+            :start => start_index - 1,
+            :cx => @config.cx,
+          }
+        end
+
+      end
+      
+    end
+  end
+end

data/lib/google/custom_search.rb

@@ -0,0 +1,3 @@
+require 'rest-client'
+require 'json'
+require 'google/custom_search/query'

data/spec/lib/google/custom_search/json/result_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+module Google::CustomSearch::JSON
+  describe Result do
+    it "returns an empty string where there is no title" do
+      Result.new({}).title.should == ''
+    end
+  end
+end

data/spec/lib/google/custom_search_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+module Google
+  describe CustomSearch do
+    let(:config) do
+      stub \
+        :cref => 'https://github.com/mattwynne/google-custom_search/blob/master/spec/fixtures/mcht-only.xml',
+        :key => 'AIzaSyA-AayUZh6S5mGMmja3pt2gfpsncLiwqN8',
+        :service_type => CustomSearch::JSON::Service
+    end
+
+    def search_for(query_string, options = {})
+      start_index = options[:start_index] || 1
+      query = CustomSearch::Query.new(query_string, start_index, config)
+      query.results
+    end
+    
+    describe "retry on error" do
+
+      context "when Google returns a 400 bad request error" do
+
+        before(:each) do
+          stub_request(:any, /.*/).to_return(
+            :status => [400, "Bad Request"],
+            :body => "A helpful message"
+          )
+        end
+
+        it "raises an error" do
+          expect { search_for 'foo' }.to raise_error(CustomSearch::BadRequestError)
+        end
+
+        it "returns the body of the response in the error message" do
+          begin
+            search_for 'foo'
+          rescue => error
+            error.to_s.should =~ /A helpful message/
+          end
+        end
+
+      end
+
+      context "when Google returns a 500 bad request error for the first four requests but subsequent requests are OK" do
+
+        before(:each) do
+          stub_request(:any, /.*/).to_return(
+            { :status => [500, "Bad Request"] },
+            { :status => [500, "Bad Request"] },
+            { :status => [500, "Bad Request"] },
+            { :status => [500, "Bad Request"] },
+            { :status => [200, "OK"], :body => '[]' }
+          )
+        end
+
+        it "does not raise an error" do
+          expect { search_for 'foo' }.to_not raise_error(CustomSearch::BadRequestError)
+        end
+
+      end
+    end
+    
+    { 
+      :json => {
+        :service_type => CustomSearch::JSON::Service,
+        :cref => 'https://raw.github.com/mattwynne/google-custom_search/master/spec/fixtures/json_api_annotations.xml',
+        :key => 'AIzaSyA-AayUZh6S5mGMmja3pt2gfpsncLiwqN8' 
+      },
+      :xml => {
+        :service_type => CustomSearch::XML::Service,
+        :cx => '003087164461061609361:-u1ua6laowa'
+      }
+    }.each do |service, config|
+
+      context "using the #{service} service" do
+        let(:config) { stub config }
+        before { config.stub(:service => service) }
+        
+        context "searching for something that exists in the list" do
+          let(:results) { search_for 'kath morgan' }
+
+          it "returns results" do
+            results.any?.should be_true
+          end
+
+          it "returns the expected result" do
+            results.first.content.should =~ /01270 275215/
+            # that's Kath's phone number
+          end
+
+          it 'returns the expected site' do
+            results.first.site.should == 'www.mcht.nhs.uk'
+          end
+
+        end
+
+        context "searching for something that doesn't exist" do
+          let(:results) { search_for 'bobbins' }
+
+          it "returns no results" do
+            results.should be_empty
+          end
+        end
+        
+        describe "#next_page" do
+        
+          context "a search that returns multiple pages of results" do
+            let(:results) { search_for 'trust' }
+        
+            it "has a start_index of 11" do
+              results.next_page.start_index.should == 11
+            end
+          end
+        
+          context "a search for the second of multiple pages" do
+            let(:results) { search_for 'trust', :start_index => 11 }
+        
+            it "has a start_index of 21" do
+              results.next_page.start_index.should == 21
+            end
+          end
+        
+          context "a search that returns one page of results" do
+            let(:results) { search_for 'kath morgan' }
+        
+            it "returns 1, pointing you back to the same page of results" do
+              results.next_page.start_index.should == 1
+            end
+        
+            it "is equal to the #current_page" do
+              results.next_page.should == results.current_page
+            end
+          end
+        end
+
+        describe "#current_page" do
+          context "a search for the second of multiple pages" do
+            let(:results) { search_for 'trust', :start_index => 11 }
+        
+            it "has a start_index of 11" do
+              results.current_page.start_index.should == 11
+            end
+        
+            it "converts to a summary string" do
+              results.current_page.to_s.should =~ /results 11-20 of \d+/
+            end
+          end
+        end
+        
+        describe "#previous_page" do
+          context "a search for the second of multiple pages" do
+            let(:results) { search_for 'trust', :start_index => 11 }
+        
+            it "has a start_index of 1" do
+              results.previous_page.start_index.should == 1
+            end
+        
+          end
+        end
+        
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+require 'webmock/rspec'
+WebMock.allow_net_connect!
+
+require 'google/custom_search'
+Google::CustomSearch.configure do |config|
+  config.path = File.dirname(__FILE__) + '/fixtures/config/google.yml'
+  config.environment = 'test'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: google-custom_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Wynne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2152308960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152308960
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2152307820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152307820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152306800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2152306800
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2152305660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2152305660
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2152305060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152305060
+description: Ruby library for querying Google's Custom Search APIs.
+email: matt@mattwynne.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/google/custom_search/config.rb
+- lib/google/custom_search/json/results.rb
+- lib/google/custom_search/json/service.rb
+- lib/google/custom_search/query.rb
+- lib/google/custom_search/xml/results.rb
+- lib/google/custom_search/xml/service.rb
+- lib/google/custom_search.rb
+- spec/lib/google/custom_search/json/result_spec.rb
+- spec/lib/google/custom_search_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mattwynne/gooogle-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.10
+signing_key: 
+specification_version: 3
+summary: Interface for Google's Custom Search APIs
+test_files: []