google-search 1.0.2

data/lib/google-search/item/image.rb

@@ -0,0 +1,40 @@
+
+module Google
+  class Search
+    class Item
+      class Image < self
+        
+        ##
+        # Image id.
+        
+        attr_reader :id
+        
+        ##
+        # Context uri.
+        
+        attr_reader :context_uri
+        
+        ##
+        # Image width in pixels.
+        
+        attr_reader :width
+        
+        ##
+        # Image height in pixels.
+        
+        attr_reader :height
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @id = hash['imageId']
+          @context_uri = hash['originalContextUrl']
+          @width = hash['width'].to_i
+          @height = hash['height'].to_i
+        end
+      end
+    end
+  end
+end

data/lib/google-search/item/local.rb

@@ -0,0 +1,107 @@
+
+module Google
+  class Search
+    class Item
+      class Local < self
+        
+        ##
+        # Country.
+        
+        attr_reader :country
+        
+        ##
+        # Region.
+        
+        attr_reader :region
+        
+        ##
+        # City.
+        
+        attr_reader :city
+        
+        ##
+        # Type.
+        
+        attr_reader :type
+        
+        ##
+        # Accuracy.
+        
+        attr_reader :accuracy
+        
+        ##
+        # Max age in seconds.
+        
+        attr_reader :max_age
+        
+        ##
+        # Google maps directions uri.
+        
+        attr_reader :directions_uri
+        
+        ##
+        # Google maps directions to here uri.
+        
+        attr_reader :directions_to_here_uri
+        
+        ##
+        # Google maps directions from here uri.
+        
+        attr_reader :directions_from_here_uri
+        
+        ##
+        # Longitude float.
+        
+        attr_reader :long
+        
+        ##
+        # Latitude float.
+        
+        attr_reader :lat
+        
+        ##
+        # Viewport mode.
+        
+        attr_reader :viewport_mode
+        
+        ##
+        # Phone numbers array.
+        
+        attr_reader :phone_numbers
+        
+        ##
+        # Street address.
+        
+        attr_reader :street_address
+        
+        ##
+        # Address lines array.
+        
+        attr_reader :address_lines
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @country = hash['country']
+          @region = hash['region']
+          @city = hash['city']
+          @type = hash['listingType']
+          @accuracy = hash['accuracy'].to_i
+          @max_age = hash['maxAge']
+          @directions_uri = hash['ddUrl']
+          @directions_to_here_uri = hash['ddUrlToHere']
+          @directions_from_here_uri = hash['ddUrlFromHere']
+          @thumbnail_uri = hash['staticMapUrl']
+          @long = hash['lng'].to_f
+          @lat = hash['lat'].to_f
+          @viewport_mode = hash['viewportmode']
+          @phone_numbers = hash['phoneNumbers'].map { |phone| phone['number'] }
+          @street_address = hash['streetAddress']
+          @address_lines = hash['addressLines']
+        end
+      end
+    end
+  end
+end

data/lib/google-search/item/news.rb

@@ -0,0 +1,46 @@
+
+module Google
+  class Search
+    class Item
+      class News < self
+        
+        ##
+        # Published DateTime.
+        
+        attr_reader :published
+        
+        ##
+        # Publisher.
+        
+        attr_reader :publisher
+        
+        ##
+        # Location.
+        
+        attr_reader :location
+        
+        ##
+        # Language.
+      
+        attr_reader :language
+        
+        ##
+        # Redirect uri.
+        
+        attr_reader :redirect_uri
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @location = hash['location']
+          @published = DateTime.parse hash['publishedDate']
+          @language = hash['language']
+          @publisher = hash['publisher']
+          @redirect_uri = hash['signedRedirectUrl']
+        end
+      end
+    end
+  end
+end

data/lib/google-search/item/patent.rb

@@ -0,0 +1,40 @@
+
+module Google
+  class Search
+    class Item
+      class Patent < self
+        
+        ##
+        # Patent id.
+        
+        attr_reader :id
+        
+        ##
+        # Patent status.
+        
+        attr_reader :status
+        
+        ##
+        # Assignee.
+        
+        attr_reader :assignee
+        
+        ##
+        # Application DateTime.
+        
+        attr_reader :application_date
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @id = hash['patentNumber'].to_i
+          @application_date = DateTime.parse hash['applicationDate']
+          @assignee = hash['assignee']
+          @status = hash['patentStatus']
+        end
+      end
+    end
+  end
+end

data/lib/google-search/item/video.rb

@@ -0,0 +1,46 @@
+
+module Google
+  class Search
+    class Item
+      class Video < self
+        
+        ##
+        # Rating float.
+        
+        attr_reader :rating
+        
+        ##
+        # Video type.
+        
+        attr_reader :type
+        
+        ##
+        # Publisher.
+        
+        attr_reader :publisher
+        
+        ##
+        # Published DateTime.
+        
+        attr_reader :published
+        
+        ##
+        # Duration in seconds.
+        
+        attr_reader :duration
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @rating = hash['rating'].to_f
+          @type = hash['videoType']
+          @publisher = hash['publisher']
+          @published = DateTime.parse hash['published']
+          @duration = hash['duration'].to_i
+        end
+      end
+    end
+  end
+end

data/lib/google-search/item/web.rb

@@ -0,0 +1,22 @@
+
+module Google
+  class Search
+    class Item
+      class Web < self
+        
+        ##
+        # Cached uri.
+        
+        attr_reader :cache_uri
+        
+        ##
+        # Initialize with _hash_.
+
+        def initialize hash
+          super
+          @cache_uri = hash['cacheUrl']
+        end
+      end
+    end
+  end
+end

data/lib/google-search/response.rb

@@ -0,0 +1,92 @@
+
+module Google
+  class Search
+    class Response
+      
+      #--
+      # Mixins
+      #++
+      
+      include Enumerable
+      
+      ##
+      # Response status code.
+      
+      attr_reader :status
+      
+      ##
+      # Response details.
+      
+      attr_reader :details
+      
+      ##
+      # Raw JSON string.
+      
+      attr_accessor :raw
+      
+      ##
+      # Hash parsed from raw JSON string.
+      
+      attr_reader :hash
+      
+      ##
+      # Items populated by the JSON hash.
+      
+      attr_reader :items
+      
+      ##
+      # Estimated number of results.
+      
+      attr_reader :estimated_count
+      
+      ##
+      # Current page index.
+      
+      attr_reader :page
+      
+      ##
+      # Size of response.
+      
+      attr_reader :size
+
+      ##
+      # Initialize with _hash_.
+      
+      def initialize hash
+        @page = 0
+        @hash = hash
+        @size = (hash['responseSize'] || :large).to_sym
+        @items = []
+        @status = hash['responseStatus']
+        @details = hash['responseDetails']
+        if valid?
+          if hash['responseData'].include? 'cursor'
+            @estimated_count = hash['responseData']['cursor']['estimatedResultCount'].to_i
+            @page = hash['responseData']['cursor']['currentPageIndex'].to_i
+          end
+          @hash['responseData']['results'].each_with_index do |result, i|
+            item_class = Google::Search::Item.class_for result['GsearchResultClass']
+            result['index'] = i + Google::Search.size_for(size) * page
+            items << item_class.new(result)
+          end
+        end
+      end
+      
+      ##
+      # Iterate each item with _block_.
+      
+      def each_item &block
+        items.each { |item| yield item }
+      end
+      alias :each :each_item
+      
+      ##
+      # Check if the response is valid.
+      
+      def valid?
+        hash['responseStatus'] == 200
+      end
+      
+    end
+  end
+end

data/lib/google-search/search.rb

@@ -0,0 +1,11 @@
+
+require 'google-search/search/mixins'
+require 'google-search/search/base'
+require 'google-search/search/web'
+require 'google-search/search/blog'
+require 'google-search/search/image'
+require 'google-search/search/local'
+require 'google-search/search/news'
+require 'google-search/search/video'
+require 'google-search/search/book'
+require 'google-search/search/patent'

data/lib/google-search/search/base.rb

@@ -0,0 +1,212 @@
+
+module Google
+  class Search
+    
+    #--
+    # Mixins
+    #++
+    
+    include Enumerable
+    
+    #--
+    # Constants
+    #++
+    
+    URI = 'http://www.google.com/uds'
+    
+    #--
+    # Exceptions
+    #++
+    
+    class Error < StandardError; end
+    
+    ##
+    # Version. Defaults to 1.0
+    
+    attr_accessor :version
+    
+    ##
+    # Search type symbol.
+    
+    attr_accessor :type
+    
+    ##
+    # Offset. Defaults to 0
+    
+    attr_accessor :offset
+    
+    ##
+    # Language. Defaults to :en
+    
+    attr_accessor :language
+    
+    ##
+    # Weither or not a search request has been sent.
+    
+    attr_accessor :sent
+    
+    ##
+    # Query. Defaults to nil
+    
+    attr_accessor :query
+    
+    ##
+    # API Key. Defaults to :notsupplied
+    
+    attr_accessor :api_key
+    
+    ##
+    # Size. Defaults to :large
+    #
+    #  - :small = 4
+    #  - :large = 8
+    #
+    
+    attr_accessor :size
+    
+    ##
+    # Additional options. All those listed above
+    # are deleted. The remaining represent query
+    # string key / value pairs.
+    
+    attr_reader :options
+    
+    ##
+    # Initialize search _type_ with _options_. Optionally
+    # a block may be passed, and the Search instance will 
+    # be yielded to it.
+    
+    def initialize options = {}, &block
+      @type = self.class.to_s.split('::').last.downcase.to_sym
+      @version = options.delete(:version) || 1.0
+      @offset = options.delete(:offset) || 0
+      @size = options.delete(:size) || :large
+      @language = options.delete(:language) || :en
+      @query = options.delete(:query)
+      @api_key = options.delete(:api_key) || :notsupplied
+      @options = options
+      raise Error, 'Do not initialize Google::Search; Use a subclass such as Google::Search::Web' if @type == :search
+      yield self if block
+    end
+    
+    ##
+    # Set a response _block_ which is called every time
+    # #get_response is called. Useful for reporting etc.
+    
+    def each_response &block
+      @each_response = block
+    end
+    
+    ##
+    # Iterate each item with _block_.
+    
+    def each_item &block
+      response = self.next.response
+      if response.valid?
+        response.each { |item| yield item }
+        each_item &block
+      end
+    end
+    alias :each :each_item
+    
+    ##
+    # Return all items.
+    
+    def all_items
+      select { true }
+    end
+    alias :all :all_items
+    
+    ##
+    # Return uri.
+    
+    def get_uri
+      URI + "/G#{@type}Search?" + 
+        (get_uri_params + options.to_a).
+          map { |key, value| "#{key}=#{Search.url_encode(value)}" unless value.nil? }.compact.join('&')
+    end
+    
+    #:nodoc:
+    
+    def get_uri_params
+      validate(:query) { |query| query.respond_to?(:to_str) && !query.to_str.empty? }
+      validate(:version) { |version| Numeric === version }
+      [[:start, offset],
+      [:rsz, size],
+      [:hl, language],
+      [:key, api_key],
+      [:v, version],
+      [:q, query]]
+    end
+    
+    ##
+    # Prepare for next request.
+    
+    def next
+      @offset += Search.size_for(size) if sent
+      self
+    end
+    
+    ##
+    # Return raw JSON response string.
+    
+    def get_raw
+      @sent = true
+      open(get_uri).read
+    end
+    
+    ##
+    # Return hash parsed from the raw JSON response.
+    
+    def get_hash
+      Search.json_decode get_raw
+    end
+    
+    ##
+    # Return Response object wrapping the JSON
+    # response hash.
+    
+    def get_response
+      raw = get_raw
+      hash = Search.json_decode raw
+      hash['responseSize'] = size
+      response = Response.new hash
+      response.raw = raw
+      @each_response.call response if @each_response
+      response
+    end
+    alias :response :get_response
+    
+    ##
+    # Return int for size _sym_.
+    
+    def self.size_for sym
+      { :small => 4,
+        :large => 8 }[sym]
+    end
+    
+    #:nodoc:
+    
+    def validate meth, &block
+      value = send meth
+      raise Error, "invalid #{type} #{meth} #{value.inspect}", caller unless yield value
+    end
+    
+    ##
+    # Decode JSON _string_.
+    
+    def self.json_decode string
+      JSON.parse string
+    end
+    
+    ##
+    # Url encode _string_.
+    
+    def self.url_encode string
+      string.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+        '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      }.tr(' ', '+')
+    end
+    
+  end
+end