blekko 0.0.1

data/lib/blekko.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+
+require 'cgi'
+require 'json'
+require 'open-uri'
+
+
+BlekkoResult = Struct.new :title, :abstract, :url, :display_url, :short_host,
+    :short_host_url, :rss, :main_slashtag_boosted
+
+
+class Blekko 
+  # API for Blekko search engine
+  # 
+  # Example:
+  #   >> Blekko.new('[Referer]', ['Num results']).search('nano fibers')
+  #   => [ #<ClioResult:...>, ... ]
+  #
+  # Arguments:
+  #   referer: (String)
+  #   num_results: (Integer+)
+
+  API_PROTOCOL_HTTPS = 'https://'
+  API_PROTOCOL_HTTP = 'http://'
+  API_PATH = 'www.blekko.com/ws/?q='
+  CHUNK_SIZE = 10
+  MAX_TTL = 2
+  MIN_SECS_BTWN_REQS = 1
+
+  attr_accessor :referer, :num_results, :api_key, :last_request
+
+  def initialize(api_key='', referer='', num_results=100, secure=true)
+    @api_protocol = secure ? API_PROTOCOL_HTTPS : API_PROTOCOL_HTTP
+    @api_key = api_key
+    @referer = referer
+    @num_results = num_results
+    @last_request = nil
+  end
+
+  def search(query, page=1)
+    # API Parameters
+    # auth=api key
+    # q=query
+    # p=page
+    # ps=num results
+
+    params = "#{CGI.escape(query)}+/json&auth=#{@api_key}&ps=#{@num_results}"
+
+    url = "#{@api_protocol}#{API_PATH}#{params}&p=#{page}"
+
+    # enforce rate limit
+    sleep_for_rate_limit
+
+    response = open(url, { 'Referer' => @referer })
+    unless response.class.superclass == Net::HTTPServerError
+      doc = JSON.load(response)
+      @json = doc
+
+      # if total_num is defined, then RESULTS is
+      return [] unless doc['total_num']
+      doc['RESULT'].map do |result|
+        BlekkoResult.new(
+          result['url_title'],
+          result['snippet'],
+          result['url'],
+          result['display_url'],
+          result['short_host'],
+          result['short_host_url'],
+          result['rss'],
+          result['main_slashtag_boosted']
+        )
+      end
+    end
+  end
+
+  private
+  def sleep_for_rate_limit
+    # If we have a last request, the minimum time between requests has not
+    # passed, and the time to sleep is positive (in case the check got blocked),
+    # then sleep for the needed time.
+    # In any case, reset the last request time to now.
+    if @last_request and\
+        (Time.now) - @last_request < MIN_SECS_BTWN_REQS and\
+        (time_to_sleep = MIN_SECS_BTWN_REQS - (Time.now - @last_request)) > 0
+      sleep time_to_sleep
+    end
+    @last_request = Time.now
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: blekko
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Lubell-Doughtie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-28 00:00:00.000000000 Z
+dependencies: []
+description: API for Blekko
+email: peter@helioid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/blekko.rb
+homepage: http://www.helioid.com/
+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.24
+signing_key: 
+specification_version: 3
+summary: API for Blekko
+test_files: []