binged 0.3.0 → 1.0.0

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem "hashie"
+gem 'activesupport', '>= 3.0.0'
+
+group :development do
+  gem "rspec", ">= 1.3.0"
+  gem "fakeweb", ">=1.2.8"
+  gem "yard", ">= 0"
+end

data/HISTORY

@@ -1,9 +1,13 @@
+== 1.0.0 (unreleased)
+* Migrate to Bing Search API 2.0. See https://datamarket.azure.com/dataset/bing/search and http://go.microsoft.com/fwlink/?LinkID=248077 for more details.
+* Raise a Bing::Search::Error in at least some of the failure modes.
+
 == 0.3.0 2010-03-15
 
 === New features
 * Added an Video source provider to allow for Video searching with Binged
 
 == 0.2.0 2010-03-12
-  
+
 === New features
 * Added an Image source provider to allow for Image searching with Binged

data/README.md

@@ -15,19 +15,19 @@ To use binged, you will require a Bing API key. Create one at: [http://www.bing.
 ## Usage
 
 ### Instantiate a client
-    binged = Binged::Client.new(:api_key => 'binged')
-  
+    binged = Binged::Client.new(:account_key => 'binged')
+
 ### Ruby on Rails
-  
+
 Binged allows for configuration to be done once using a configure block. To use binged in your Ruby on Rails project, configure it globally in an initializer.
-    
+
     # config/initializers/binged.rb
     Binged.configure do |config|
-      config.api_key = 'api_key'
+      config.account_key = 'account_key'
     end
-      
+
     # Client initialization
-    binged = Binged::Client.new            
+    binged = Binged::Client.new
 
 ### Web Search Example
 
@@ -39,10 +39,10 @@ Binged allows for configuration to be done once using a configure block. To use
 
     # Find all portrait Matz images with a wide aspect ratio
     image_search = Binged::Client.new.image
-    image_search.containing('Yukihiro Matsumoto').portrait.wide.each {|image| pp image}
-    
+    image_search.containing('Yukihiro Matsumoto').portrait.safe_search(:strict).wide.each {|image| pp image}
+
 ## Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/Rakefile

@@ -10,11 +10,6 @@ begin
     gem.email = "kevin.faustino@gmail.com"
     gem.homepage = "http://github.com/kfaustino/binged"
     gem.authors = ["Kevin Faustino"]
-    gem.add_dependency "hashie", "~>0.1.0"
-    gem.add_dependency "crack", ">=0.1.6"
-    gem.add_development_dependency "rspec", ">= 1.3.0"
-    gem.add_development_dependency "fakeweb", ">=1.2.8"
-    gem.add_development_dependency "yard", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -22,20 +17,16 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
 begin

data/VERSION

@@ -1 +1 @@
-0.3.0
+1.0.0

data/binged.gemspec

@@ -1,85 +1,76 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{binged}
-  s.version = "0.3.0"
+  s.name = "binged"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Faustino"]
-  s.date = %q{2010-03-15}
-  s.description = %q{A wrapper for the bing api}
-  s.email = %q{kevin.faustino@gmail.com}
+  s.date = "2012-11-06"
+  s.description = "A wrapper for the bing api"
+  s.email = "kevin.faustino@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+    "README.md"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "HISTORY",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "binged.gemspec",
-     "lib/binged.rb",
-     "lib/binged/client.rb",
-     "lib/binged/hashie_extensions.rb",
-     "lib/binged/search.rb",
-     "lib/binged/search/base.rb",
-     "lib/binged/search/image.rb",
-     "lib/binged/search/video.rb",
-     "lib/binged/search/web.rb",
-     "spec/binged/search/image_spec.rb",
-     "spec/binged/search/video_spec.rb",
-     "spec/binged/search/web_spec.rb",
-     "spec/binged_spec.rb",
-     "spec/fixtures/images.json",
-     "spec/fixtures/videos.json",
-     "spec/fixtures/web.json",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/support/shared_examples/filter.rb",
-     "spec/support/shared_examples/pageable.rb"
-  ]
-  s.homepage = %q{http://github.com/kfaustino/binged}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A wrapper for the bing api}
-  s.test_files = [
+    "Gemfile",
+    "HISTORY",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "binged.gemspec",
+    "lib/binged.rb",
+    "lib/binged/client.rb",
+    "lib/binged/hashie_extensions.rb",
+    "lib/binged/search.rb",
+    "lib/binged/search/base.rb",
+    "lib/binged/search/image.rb",
+    "lib/binged/search/video.rb",
+    "lib/binged/search/web.rb",
+    "spec/binged/search/client_spec.rb",
     "spec/binged/search/image_spec.rb",
-     "spec/binged/search/video_spec.rb",
-     "spec/binged/search/web_spec.rb",
-     "spec/binged_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/support/shared_examples/filter.rb",
-     "spec/support/shared_examples/pageable.rb"
+    "spec/binged/search/video_spec.rb",
+    "spec/binged/search/web_spec.rb",
+    "spec/binged_spec.rb",
+    "spec/fixtures/bad_request.curl",
+    "spec/fixtures/images.curl",
+    "spec/fixtures/videos.curl",
+    "spec/fixtures/web.curl",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/support/shared_examples/filter.rb",
+    "spec/support/shared_examples/pageable.rb"
   ]
+  s.homepage = "http://github.com/kfaustino/binged"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A wrapper for the bing api"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<hashie>, ["~> 0.1.0"])
-      s.add_runtime_dependency(%q<crack>, [">= 0.1.6"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
       s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<hashie>, ["~> 0.1.0"])
-      s.add_dependency(%q<crack>, [">= 0.1.6"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
       s.add_dependency(%q<rspec>, [">= 1.3.0"])
       s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<hashie>, ["~> 0.1.0"])
-    s.add_dependency(%q<crack>, [">= 0.1.6"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
     s.add_dependency(%q<rspec>, [">= 1.3.0"])
     s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
     s.add_dependency(%q<yard>, [">= 0"])

data/lib/binged/client.rb

@@ -3,30 +3,32 @@ module Binged
   # A client which encapsulates the Bing API
   class Client
 
-    attr_accessor :api_key
+    attr_accessor :account_key
 
     # @param [Hash] options the options to create a client with.
-    # @option options [String] :api_key The Bing API key used to make all API calls.
+    # @option options [String] :account_key The Bing API key used to make all API calls.
     def initialize(options = {})
-      @api_key = options[:api_key] || Binged.api_key
+      invalid_options = options.keys - [:account_key]
+      raise ArgumentError, "Invalid options: #{invalid_options.inspect}." unless invalid_options.empty?
+      @account_key = options[:account_key] || Binged.account_key
     end
 
     # Create a web search through Bing
-    # 
+    #
     # @param [String] query The search term to be sent to Bing
     def web(query='')
       Search::Web.new(self,query)
     end
-    
+
     # Create a image search through Bing
-    # 
+    #
     # @param [String] query The search term to be sent to Bing
     def image(query='')
       Search::Image.new(self,query)
     end
-    
+
     # Create a video search through Bing
-    # 
+    #
     # @param [String] query The search term to be sent to Bing
     def video(query='')
       Search::Video.new(self,query)

data/lib/binged/search/base.rb

@@ -1,12 +1,16 @@
 module Binged
   module Search
+    class Error < StandardError
+    end
 
     # @abstract Subclass and set @source to implement a custom Searchable class
     class Base
       include Enumerable
       attr_reader :client, :query, :source
 
-      BASE_URI = 'http://api.bing.net/json.aspx?'
+      BASE_URI = 'https://api.datamarket.azure.com/Data.ashx/Bing/Search/'
+
+      SUPPORTED_ADULT_OPTIONS = [:off, :moderate, :strict]
 
       # @param [Binged::Client] client
       # @param [String] query The search term to be sent to Bing
@@ -26,6 +30,12 @@ module Binged
         self
       end
 
+      def adult(adult_option)
+        @query[:Adult] = adult_option if SUPPORTED_ADULT_OPTIONS.include?(adult_option)
+        self
+      end
+      alias safe_search adult
+
       # Clears all filters to perform a new search
       def clear
         @fetch = nil
@@ -39,7 +49,7 @@ module Binged
       def fetch
         if @fetch.nil?
           response = perform
-          @fetch = Hashie::Mash.new(response["SearchResponse"][self.source.to_s.capitalize])
+          @fetch = Hashie::Mash.new(response["d"])
         end
 
         @fetch
@@ -49,16 +59,26 @@ module Binged
       #
       # @return [Hash] Hash of Bing API response
       def perform
-        url = URI.parse BASE_URI
+        url = URI.parse [BASE_URI, self.source.to_s.capitalize].join
         query = @query.dup
         query[:Query] = query[:Query].join(' ')
-        query[:Sources] = self.source
         callbacks.each {|callback| callback.call(query) }
-        query_options = default_options.merge(query).to_params
+        query.each do |key, value|
+          query[key] = %{'#{value}'} unless key[0] == '$' || ['Latitude', 'Longitude'].include?(key)
+        end
+        query_options = default_options.merge(query).to_query
         query_options.gsub! '%2B', '+'
         url.query = query_options
-        response = Net::HTTP.get(url)
-        Crack::JSON.parse(response)
+        request = Net::HTTP::Get.new(url.request_uri)
+        request.basic_auth(@client.account_key, @client.account_key)
+        response = Net::HTTP.start(url.hostname, url.port, :use_ssl => true) {|http|
+          http.request(request)
+        }
+        begin
+          JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          raise Error, response.body.strip
+        end
       end
 
       # @yieldreturn [Hash] A result from a Bing query
@@ -73,13 +93,13 @@ module Binged
       private
 
         def default_options
-          {:AppId => @client.api_key, :JsonType => 'raw', :Version => '2.2'  }
+          { '$format' => 'JSON' }
         end
 
         def reset_query
           @query = { :Query => [] }
         end
-        
+
     end
 
   end

data/lib/binged/search/image.rb

@@ -17,7 +17,7 @@ module Binged
       end
 
       # Restrict images to those small in size
-      # 
+      #
       # @return [self]
       def small
         filter << 'Size:Small'
@@ -25,7 +25,7 @@ module Binged
       end
 
       # Restrict images to those medium in size
-      # 
+      #
       # @return [self]
       def medium
         filter << 'Size:Medium'
@@ -58,7 +58,7 @@ module Binged
       end
 
       # Restrict images to those that have a square aspect ratio
-      # 
+      #
       # @return [self]
       def square
         filter << 'Aspect:Square'
@@ -66,7 +66,7 @@ module Binged
       end
 
       # Restrict images to those that have a wide aspect ratio
-      # 
+      #
       # @return [self]
       def wide
         filter << 'Aspect:Wide'
@@ -74,55 +74,55 @@ module Binged
       end
 
       # Restrict images to those that have a tall aspect ratio
-      # 
+      #
       # @return [self]
       def tall
         filter << 'Aspect:Tall'
         self
       end
-      
+
       # Restrict images to those that are in color
-      # 
+      #
       # @return [self]
       def color
         filter << 'Color:Color'
-        self      
+        self
+      end
+
+      # Restrict images to those that are in black and white
+      #
+      # @return [self]
+      def monochrome
+        filter << 'Color:Monochrome'
+        self
       end
-      
+
       # Restrict images to those which contain photos
-      # 
+      #
       # @return [self]
       def photo
         filter << 'Style:Photo'
         self
       end
-      
+
       # Restrict images to those which contain graphics or illustrations
-      # 
+      #
       # @return [self]
       def graphics
         filter << 'Style:Graphics'
         self
       end
-      
-      # Restrict images to those that are in black and white
-      # 
-      # @return [self]
-      def monochrome
-        filter << 'Color:Monochrome'
-        self
-      end
-      
+
       # Restrict images to those which contain faces
-      # 
+      #
       # @return [self]
       def face
         filter << 'Face:Face'
         self
       end
-      
+
       # Restrict images to those which contain portraits(head and shoulders)
-      # 
+      #
       # @return [self]
       def portrait
         filter << 'Face:Portrait'
@@ -132,11 +132,11 @@ module Binged
       private
 
         def create_filter_callback
-          @callbacks << Proc.new { |query| query['Image.Filters'] = query['Image.Filters'].join('+') if query['Image.Filters'] }
+          @callbacks << Proc.new { |query| query['ImageFilters'] = query['ImageFilters'].join('+') if query['ImageFilters'] && !query['ImageFilters'].empty? }
         end
 
         def filter
-          @query['Image.Filters'] ||= []
+          @query['ImageFilters'] ||= []
         end
 
     end

data/lib/binged/search.rb

@@ -8,14 +8,14 @@ module Binged
     autoload :Video, "binged/search/video"
 
     module Pageable
-      
+
       # Set the page number of the results to display
       #
       # @param [Fixnum] num The page number of the search results
       # @return [self]
       def page(num=1)
         @offset = num - 1
-        @query["#{@source.to_s.capitalize}.Offset"] = @results_per_page * @offset
+        @query["$skip"] = @results_per_page * @offset
         self
       end
 
@@ -25,20 +25,20 @@ module Binged
       # @return [self]
       def per_page(num)
         @results_per_page = num
-        @query["#{@source.to_s.capitalize}.Count"] = @results_per_page
+        @query["$top"] = @results_per_page
         self
       end
-      
+
       protected
-      
+
         def set_paging_defaults
           self.per_page(20).page(1)
         end
-      
+
     end
-    
+
     module Filter
-      
+
       # # Isolate search results to a specific site
       #
       # @example
@@ -50,8 +50,8 @@ module Binged
         @query[:Query] << "site:#{site}"
         self
       end
-      
+
     end
-    
+
   end
 end

data/lib/binged.rb

@@ -1,9 +1,9 @@
-require 'crack'
+require 'active_support/core_ext/object/to_query'
+require 'json'
 require 'hashie'
-require 'net/http'
+require 'net/https'
 require 'uri'
 
-Hash.send :include, Hashie::HashExtensions
 require 'binged/hashie_extensions'
 
 # The module that contains everything Binged related
@@ -13,23 +13,21 @@ require 'binged/hashie_extensions'
 module Binged
   autoload :Client, "binged/client"
   autoload :Search, "binged/search"
-    
+
+  extend self
+
   # Configure global options for Binged
-  # 
+  #
   # For example:
-  # 
+  #
   #     Binged.configure do |config|
-  #       config.api_key = 'api_key'
+  #       config.account_key = 'account_key'
   #     end
-  def self.configure
+  attr_accessor :account_key
+
+  def configure
     yield self
     true
   end
 
-  class << self
-    attr_accessor :api_key
-  end
-
 end
-
-

data/spec/binged/search/client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Binged::Client do
+  describe '.new' do
+    context 'with a defunct api_key' do
+      it 'raises' do
+        expect {
+          Binged::Client.new(:api_key => 'binged')
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end