mikedemers-rbing 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Demers <mike_(at)_9astronauts.com>
+
+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.rdoc

@@ -0,0 +1,92 @@
+
+== RBing
+
+A gem that provides an interface to Microsoft's Bing search API.
+
+
+== Usage
+
+Get a App ID at: <http://www.bing.com/developers/createapp.aspx>
+
+  require 'rubygems'
+  require 'rbing'
+  bing = RBing.new("YOURAPPID")
+  
+  rsp = bing.web("ruby")
+  puts rsp.web.results[0].title
+  => "Ruby (programming language) - Wikipedia, the free encyclopedia"
+  
+  rsp = bing.web("ruby", :site => "github.com")
+  puts rsp.web.results[0].url
+  => "http://github.com/vim-ruby/vim-ruby/tree/master"
+  
+  rsp = bing.web("ruby", :site => ["github.com", "rubyforge.org"])
+  puts rsp.web.results[0].url
+  => "http://rubyforge.org/"
+  
+  rsp = bing.news("search engines")
+  puts rsp.web.results[0].title
+  => "Microsoft Bing more popular than Yahoo"
+  
+  rsp = bing.spell("coincidance")
+  puts rsp.spell.results[0].value
+  => "coincidence"
+  
+  rsp = bing.instant_answer("How many rods in a furlong?")
+  puts rsp.instant_answer.results[0].instant_answer_specific_data.encarta.value
+  => "1 furlong = 40 rods"
+
+
+== Command Line Utility
+
+RBing also has a simple command line interface.
+
+Put your App Id into $HOME/.rbing_app_id and you can use rbing:
+
+  $> rbing "ruby gems"
+  [{"Url"=>"http://rubygems.org/",
+    "Title"=>"RubyGems Manuals",
+    "CacheUrl"=>
+     "http://cc.bingj.com/cache.aspx?q=ruby+gems&d=76167709461212&w=39b024d8,55a87382",
+    "DisplayUrl"=>"rubygems.org",
+    "DateTime"=>Wed Jun 03 11:25:29 UTC 2009,
+    "Description"=>
+     "The Gem::Specification object controls the data..."},
+   ...
+  ]
+
+The default source is "web" but you can specify another:
+
+  $> rbing news "revolutionary technology"
+  [{"BreakingNews"=>0,
+    "Url"=>
+     "http://www.tmcnet.com/usubmit/-bt-successfully-completes-exchange-exchange-cisco-telepresence-call-/2009/06/04/4211245.htm",
+    "Source"=>"TMCnet",
+    "Title"=>
+     "BT Successfully Completes Exchange to Exchange Cisco TelePresence Call ... ",
+    "Snippet"=>
+     "BT Successfully Completes Exchange to Exchange Cisco TelePresence Call; Revolutionary...",
+    "Date"=>Thu Jun 04 13:33:09 UTC 2009},
+   ...
+  ]
+
+
+== Dependencies
+
+ * HTTParty: <http://httparty.rubyforge.org/>
+
+
+== Resources
+
+RBing:
+
+ * Source Code: <http://github.com/mikedemers/rbing/tree>
+ * Support: <http://github.com/mikedemers/rbing/issues>
+
+Bing:
+
+ * Bing API: <http://www.bing.com/developers>
+ * Register for App Id: <http://www.bing.com/developers/createapp.aspx>
+ * Bing API Reference: <http://msdn.microsoft.com/en-us/library/dd251056.aspx>
+ * Query Keywords: <http://help.live.com/help.aspx?project=wl_searchv1&market=en-US&querytype=keyword&query=redliub&tmt=&domain=www.bing.com:80>
+

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "rbing"
+GEM_VERSION = "1.0.0"
+AUTHOR = "Mike Demers"
+EMAIL = "mike@9astronauts.com"
+HOMEPAGE = "http://9astronauts.com/code/ruby/rbing"
+SUMMARY = "A gem that provides an interface to Microsoft's Bing search API"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.rdoc_options = ["--main", "README.rdoc"]
+  
+  s.add_dependency("httparty", [">= 0.4.0"])
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile TODO) + Dir.glob("{bin,lib,spec}/**/*")
+  
+  s.executables = ["rbing"]
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/bin/rbing

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require 'rubygems'
+require 'rbing'
+
+bing = RBing.new
+
+if query = ARGV[1]
+  source = ARGV[0]
+elsif query = ARGV[0]
+  source = "web"
+else
+  STDERR.puts "Usage: #{$0} [source] query"
+  STDERR.puts ""
+  STDERR.puts "Also, don't forget to put your App Id in $HOME/.rbing_app_id"
+  STDERR.puts ""
+  STDERR.puts "If you don't have an App Id, get one here: http://www.bing.com/developers"
+  STDERR.puts ""
+  exit
+end
+
+rsp = bing.search(source, query)
+
+begin
+  pp rsp.send(source).results
+rescue
+  pp rsp
+end

data/lib/rbing.rb

@@ -0,0 +1,192 @@
+require "httparty"
+require "yaml"
+#
+# Usage:
+# 
+#  bing = RBing.new("YOURAPPID")
+#  
+#  rsp = bing.web("ruby")
+#  puts rsp.web.results[0].title
+#  => "Ruby (programming language) - Wikipedia, the free encyclopedia"
+#  
+#  rsp = bing.web("ruby", :site => "github.com")
+#  puts rsp.web.results[0].url
+#  => "http://github.com/vim-ruby/vim-ruby/tree/master"
+#  
+#  rsp = bing.web("ruby", :site => ["github.com", "rubyforge.org"])
+#  puts rsp.web.results[0].url
+#  => "http://rubyforge.org/"
+#  
+#  rsp = bing.news("search engines")
+#  puts rsp.web.results[0].title
+#  => "Microsoft Bing more popular than Yahoo"
+#  
+#  rsp = bing.spell("coincidance")
+#  puts rsp.spell.results[0].value
+#  => "coincidence"
+#  
+#  rsp = bing.instant_answer("How many rods in a furlong?")
+#  puts rsp.instant_answer.results[0].instant_answer_specific_data.encarta.value
+#  => "1 furlong = 40 rods"
+#
+class RBing
+  
+  # Convenience wrapper for the response Hash.
+  # Converts keys to Strings. Crawls through all
+  # member data and converts any other Hashes it
+  # finds. Provides access to values through
+  # method calls, which will convert underscored
+  # to camel case.
+  #
+  # Usage:
+  # 
+  #  rd = ResponseData.new("AlphaBeta" => 1, "Results" => {"Gamma" => 2, "delta" => [3, 4]})
+  #  puts rd.alpha_beta
+  #  => 1
+  #  puts rd.alpha_beta.results.gamma
+  #  => 2
+  #  puts rd.alpha_beta.results.delta
+  #  => [3, 4]
+  #
+  class ResponseData < Hash
+  private
+    def initialize(data={})
+      data.each_pair {|k,v| self[k.to_s] = deep_parse(v) }
+    end
+    def deep_parse(data)
+      case data
+      when Hash
+        self.class.new(data)
+      when Array
+        data.map {|v| deep_parse(v) }
+      else
+        data
+      end
+    end
+    def method_missing(*args)
+      name = args[0].to_s
+      return self[name] if has_key? name
+      camelname = name.split('_').map {|w| "#{w[0,1].upcase}#{w[1..-1]}" }.join("")
+      if has_key? camelname
+        self[camelname]
+      else
+        super *args
+      end
+    end
+  end
+  
+  include HTTParty
+  
+  attr_accessor :instance_options
+  
+  base_uri "http://api.search.live.net/json.aspx"
+  format :json
+  
+  BASE_OPTIONS = [:version, :market, :adult, :query, :appid, :sources]
+  
+  # Query Keywords: <http://help.live.com/help.aspx?project=wl_searchv1&market=en-US&querytype=keyword&query=redliub&tmt=&domain=www.bing.com:80>
+  #
+  QUERY_KEYWORDS = [:site, :language, :contains, :filetype, :inanchor, :inbody, :intitle, :ip, :loc, :location, :prefer, :feed, :hasfeed, :url]
+  
+  # Source Types: <http://msdn.microsoft.com/en-us/library/dd250847.aspx>
+  #
+  SOURCES = %w(Ad Image InstantAnswer News Phonebook RelatedSearch Spell Web)
+  
+  # Set up methods for each search source:
+  # +ad+, +image+, +instant_answer+, +news+, +phonebook+, +related_search+,
+  # +spell+ and +web+
+  #
+  # Example:
+  # 
+  #   bing = RBing.new(YOUR_APP_ID)
+  #   bing.web("ruby gems", :count => 10)
+  #
+  SOURCES.each do |source|
+    fn = source.to_s.gsub(/[a-z][A-Z]/) {|c| "#{c[0,1]}_#{c[1,1]}" }.downcase
+    class_eval "def #{fn}(query, options={}) ; search('#{source}', query, options) ; end"
+  end
+  
+  
+  # issues a search for +query+ in +source+
+  #
+  def search(source, query, options={})
+    rsp = self.class.get('', options_for(source, query, options))
+    ResponseData.new(rsp['SearchResponse']) if rsp
+  end
+  
+  
+private
+  
+  
+  # instantiates a new RBing client with the given +app_id+.
+  # +options+ can contain values to be passed with each query.
+  #
+  def initialize(app_id=nil, options={})
+    @instance_options = options.merge(:AppId => (app_id || user_app_id))
+  end
+  # constructs a query string for the given
+  # +query+ and the optional query +options+
+  #
+  def build_query(query, options={})
+    queries = []
+    QUERY_KEYWORDS.each do |kw|
+      next unless options[kw]
+      if options[kw].is_a? Array
+        kw_query = options[kw].map {|s| "#{s}".strip }.join(" OR ")
+        queries << " (#{kw}:#{kw_query})"
+      else
+        queries << " #{kw}:#{options[kw]}"
+      end
+    end
+    "#{query} #{queries.join(' ')}".strip
+  end
+  
+  
+  # returns +options+ with its keys converted to
+  # strings and any keys in +exclude+ omitted.
+  #
+  def filter_hash(options, exclude=[])
+    ex = exclude.inject({}) {|h,k| h[k.to_s] = true; h }
+    options.inject({}) {|h,kv| h[kv[0]] = kv[1] unless ex[kv[0].to_s]; h }
+  end
+  
+  
+  # returns an options Hash suitable for passing to
+  # HTTParty's +get+ method
+  #
+  def options_for(type, query, options={})
+    opts = instance_options.merge(filter_hash(options, BASE_OPTIONS))
+    opts.merge!(:sources => type.to_s, :query => build_query(query, options))
+    
+    source_options = filter_hash(options, [:http] + BASE_OPTIONS + QUERY_KEYWORDS)
+    opts.merge!(scope_source_options(type, source_options))
+    
+    http_options = options[:http] || {}
+    http_options.merge(:query => opts)
+  end
+  
+  
+  # returns a Hash containing the data in +options+
+  # with the keys prefixed with +type+ and '.'
+  #
+  def scope_source_options(type, options={})
+    options.inject({}) {|h,kv| h["#{type}.#{kv[0]}"] = kv[1]; h }
+  end
+  
+  
+  # returns the user's default app id, if one has been
+  # defined in ~/.rbing_app_id
+  #
+  def user_app_id(force=false)
+    @user_app_id = nil if force
+    @user_app_id ||= read_user_app_id
+  end
+  
+  
+  # reads the App Id stored in ~/.rbing_app_id
+  #
+  def read_user_app_id
+    fn = File.join(RUBY_PLATFORM =~ /mswin32/ ? ENV['USERPROFILE'] : ENV['HOME'], ".rbing_app_id")
+    File.read(fn).strip if File.exists?(fn)
+  end
+end

data/spec/rbing_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rbing'
+
+describe "RBing" do
+  before :each do
+    @bing = RBing.new
+  end
+  
+  it "should provide an ad search method" do
+    @bing.should respond_to(:ad)
+  end
+  
+  it "should provide an image search method" do
+    @bing.should respond_to(:image)
+  end
+  
+  it "should provide an instant_answer search method" do
+    @bing.should respond_to(:instant_answer)
+  end
+  
+  it "should provide a news search method" do
+    @bing.should respond_to(:news)
+  end
+  
+  it "should provide a phonebook search method" do
+    @bing.should respond_to(:phonebook)
+  end
+  
+  it "should provide a related_search method" do
+    @bing.should respond_to(:related_search)
+  end
+  
+  it "should provide an spell method" do
+    @bing.should respond_to(:spell)
+  end
+  
+  it "should provide a web search method" do
+    @bing.should respond_to(:web)
+  end
+  
+  it "should return a ResponseData object" do
+    @bing.web("ruby").should be_a(RBing::ResponseData)
+  end
+  
+  it "should return search results" do
+    @bing.web("ruby").web.results.should_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: mikedemers-rbing
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mike Demers
+autorequire: rbing
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: rbing
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+description: A gem that provides an interface to Microsoft's Bing search API
+email: mike@9astronauts.com
+executables: 
+- rbing
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- bin/rbing
+- lib/rbing.rb
+- spec/rbing_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://9astronauts.com/code/ruby/rbing
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A gem that provides an interface to Microsoft's Bing search API
+test_files: []
+