live-search 0.0.2

data/README

@@ -0,0 +1,22 @@
+# LiveAPI.application_id = "YOU_APPLICATION_ID"
+# search = LiveAPI::Search.web("seo")
+# results = search.results #=> 50 happy results :)
+# 
+# results.each do |result|
+# 	puts result.title
+# 	puts result.description
+# 	puts result.url
+# 	puts result.display_url
+# end
+
+You can also provide options in the second parameter. Example:
+
+# LiveAPI::Search.web("seo", :Count => 25, :Offset => 26) #=> Returns 25 results instead of our default 50 and starts on the 2nd page
+
+See LiveAPI::Search::Request for query options.
+
+For more information on the API, visit: http://dev.live.com/livesearch/
+
+=== Contact
+
+info@rubyskills.com if you're looking for some extra help

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+require 'lib/live-search/version'
+
+NAME = "live-search"
+AUTHOR = "Lance Carlson"
+EMAIL = "info@rubyskills.com"
+HOMEPAGE = "http://www.rubyskills.com"
+SUMMARY = "Live Search API"
+DESCRIPTION = "Ruby gem for the Live Search API"
+
+dist_dirs = [ "lib", "spec" ]
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = LiveAPI::Search::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.description = DESCRIPTION
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.has_rdoc = true
+
+  s.add_dependency('rspec')
+  s.add_dependency('rake')
+
+  s.files = [ "Rakefile", "README" ]
+  dist_dirs.each do |dir|
+    s.files = s.files + Dir.glob("#{dir}/**/*")
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Live Search API'
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Run :package and install the resulting .gem'
+task :install => :package do
+  sh %{sudo gem install pkg/#{NAME}-#{LiveAPI::Search::VERSION} --no-rdoc --no-ri}
+end
+
+desc 'Run :clean and uninstall the .gem'
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+desc "Run all specs and generate an rcov report"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts = ['--exclude', 'gems', '--exclude', 'spec']
+end

data/lib/live-search.rb

@@ -0,0 +1,27 @@
+require "open-uri"
+require "json"
+
+module LiveAPI
+  class << self
+    attr_accessor :application_id
+  end
+  
+  module Search
+    class << self
+      def web(query, options = {})
+        options[:Query] = clean_query(query) unless query.nil?
+        Request.new(options)
+      end
+      
+      private
+      
+      def clean_query(query)
+        query.gsub(" ", "+")
+      end
+    end
+  end
+end
+
+%w(request response result version).each do |file|
+  require File.join(File.dirname(__FILE__), "live-search", file)
+end

data/lib/live-search/request.rb

@@ -0,0 +1,57 @@
+module LiveAPI
+  module Search
+    class Request
+      API_DOMAIN = "http://api.search.live.net"
+      FORMAT = "json"
+      SOURCE = "web"
+      DEFAULT_OFFSET = 0
+      DEFAULT_COUNT = 50
+      DEFAULT_MARKET = "en-US"
+      
+      # Converts a hash to a query string
+      def self.hash_to_query(hash)
+        hash.map {|key, value| "#{key}=#{value}"}.join("&")
+      end
+      
+      def initialize(options)
+        @options = options
+        @options[:AppId] = LiveAPI.application_id
+        @options[:Sources] = SOURCE
+        @options[:Count] = @options[:Count] ||= DEFAULT_COUNT
+        @options[:Offset] = @options[:Offset] ||= DEFAULT_OFFSET
+        @options[:Market] = @options[:Market] ||= DEFAULT_MARKET
+        
+        raise "Application ID is needed" if @options[:AppId].empty?
+        raise "A query is needed" unless @options.has_key?(:Query)
+      end
+    
+      # The API URL call
+      def path
+        @options["Web.Count"] = @options[:Count]
+        @options["Web.Offset"] = @options[:Offset]
+        @options.delete(:Count)
+        @options.delete(:Offset)
+        "#{API_DOMAIN}/#{FORMAT}.aspx?#{query_string}"
+      end
+      
+      # The response object of the request
+      def response
+        @response = @response ||= LiveAPI::Search::Response.new(response_body)
+      end
+      
+      # The response body of the request
+      def response_body
+        open(path).readlines.join
+      end
+      
+      # The results from the response object
+      def results
+        response.results
+      end
+      
+      def query_string  
+        self.class.hash_to_query(@options)
+      end
+    end
+  end
+end

data/lib/live-search/response.rb

@@ -0,0 +1,29 @@
+module LiveAPI
+  module Search
+    class Response
+      def initialize(response_body)
+        @body = response_body
+      end
+      
+      # The number of URLs returned. This may be lower than the number of results requested if there were fewer total results available.
+      def total
+        self.to_json["SearchResponse"]["Web"]["Total"].to_i
+      end
+
+      # The result objects returned from the request
+      def results
+        begin
+          self.to_json["SearchResponse"]["Web"]["Results"].map do |result_hash|
+            LiveAPI::Search::Result.new(result_hash)
+          end
+        rescue
+          self.to_json["SearchResponse"]
+        end
+      end
+      
+      def to_json
+        @json = @json ||= JSON.parse(@body)
+      end
+    end
+  end
+end

data/lib/live-search/result.rb

@@ -0,0 +1,24 @@
+module LiveAPI
+  module Search
+    class Result
+      def initialize(hash)
+        @hash = hash
+      end
+      
+      def method_missing(name)
+        @hash[camelize(name)]
+      end
+      
+      private
+      
+      # Ganked from rails
+      def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+        if first_letter_in_uppercase
+          lower_case_and_underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+        else
+          lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+        end
+      end
+    end
+  end
+end

data/lib/live-search/version.rb

@@ -0,0 +1,5 @@
+module LiveAPI
+  module Search
+    VERSION = "0.0.2" unless defined?(LiveAPI::Search::VERSION)
+  end
+end

data/spec/live-search_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe LiveAPI::Search do
+  before do
+    @search_term = "search engine optimization"
+    LiveAPI.application_id = "797DAB5F6860C407969014FD103EA24404AD7F35" # Your app id here
+  end
+  
+  it "should return the top 50 results for the term seo" do
+    search = LiveAPI::Search.web(@search_term)
+    results = search.results
+    results.length.should == 50
+  end
+  
+  it "should return the next 50 results for the search term seo" do
+    search = LiveAPI::Search.web(@search_term, :Offset => 51)
+    results = search.results
+    results.length.should == 50
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# Ensure that only the source is getting tested and not the installed gem
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "rubygems"
+require "test/unit"
+require "spec"
+require File.join(File.dirname(__FILE__), "..", "lib", "live-search")
+
+
+Spec::Runner.configure do |config| 
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: live-search
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Lance Carlson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby gem for the Live Search API
+email: info@rubyskills.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README
+- lib/live-search
+- lib/live-search/request.rb
+- lib/live-search/response.rb
+- lib/live-search/result.rb
+- lib/live-search/version.rb
+- lib/live-search.rb
+- spec/live-search_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.rubyskills.com
+post_install_message: 
+rdoc_options: []
+
+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.3.1
+signing_key: 
+specification_version: 2
+summary: Live Search API
+test_files: []
+