bing-search 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f89243c5039d162db74eea16a768640ca39c090
-  data.tar.gz: 5bbed193646f93ccd1b1bfa802cea73612a426ee
+  metadata.gz: 83ee14e6e62c2b189475c2ec3170c42a52cb2396
+  data.tar.gz: 5c130b278bb5ba002ab1a41a1c7dc229d7610afb
 SHA512:
-  metadata.gz: 7502295d14673dbe7880875c4db6b52edc09c97d9e39a2ff50a178ab18832bc784e1ba0af297b4d5a4c86aeea44bb34ecc99c5bb10e4e151a4f2a2c263bcbe85
-  data.tar.gz: 1639f625fdedaf8efceb98224e6da870bc10d5d92b387aed79fd90d30a6cb2eece3e033f1d1bb8062ba2b3b071f8e1adb8443bdd3595c26f7e76dc107781d607
+  metadata.gz: cad7e20d0aae7166625ae49039a15ac68fc8c8f606285a74a70145d3013fa3b046b8d8b57b459fa397cbdd43d2c7a41e45d69f9bf3f01d09f3686ea3f0a512ed
+  data.tar.gz: b837f50a97b484ec36a90c89f74588f54de220ee1b7c4bb4e7b8c72337088706af8b7f030fd0b02a42cba74dc6273b6da2ac5f3702597d769737cb422e424336

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+README.md
+LICENSE.txt

data/README.md

@@ -2,6 +2,9 @@
 
 A Ruby client for the [Bing Search API](http://datamarket.azure.com/dataset/bing/search).
 
+[![Gem Version](https://badge.fury.io/rb/bing-search.svg)](http://badge.fury.io/rb/bing-search)
+[![Build Status](https://travis-ci.org/jonahb/bing-search.svg?branch=master)](https://travis-ci.org/jonahb/bing-search)
+
 ## Getting Started
 
 ### Installation
@@ -14,6 +17,10 @@ gem install bing-search
 
 Sign up for the [Bing Search API](https://datamarket.azure.com/dataset/bing/search) or the [Web-Only Bing Search API](https://datamarket.azure.com/dataset/bing/searchweb) at the Microsoft Azure Marketplace. Then retrieve your Account Key from the [My Account](https://datamarket.azure.com/account) section of the marketplace and provide it as shown below.
 
+### Documentation
+
+This README provides an overview of bing-search. Full documentation is available at [rubydoc.info](http://www.rubydoc.info/gems/bing-search).
+
 ## Basics
 
 To use bing-search, first supply your Account Key:
@@ -95,7 +102,7 @@ To retrieve multiple result types at once, use {BingSearch.composite}:
 result = BingSearch.composite('Majorana', [:web, :image, :news])
 ```
 
-The result is a {BingSearch::CompositeResult} ...
+The result is a {BingSearch::CompositeSearchResult} ...
 
 ```ruby
 result.class # => BingSearch::CompositeResult
@@ -115,7 +122,7 @@ All of the single-type search options are supported in composite searches, thoug
 BingSearch.composite 'Fermi', [:image, :video], image_filters: [:small], video_filters: [:short]
 ```
 
-Composite searches also give you access more data about the search including the total number of results in the Bing index and whether Bing corrected apparent errors in the query text:
+Composite searches also give you access to more data about the search including the total number of results in the Bing index and whether Bing corrected apparent errors in the query text:
 
 ```ruby
 result = BingSearch.composite('Feyman', [:web, :image, :news])
@@ -148,7 +155,7 @@ end
 Or to override global settings:
 
 ```ruby
-client = BingSearch::Client.new(access_key: 'hzy9+Y6...', web_only: true)
+client = BingSearch::Client.new(account_key: 'hzy9+Y6...', web_only: true)
 ```
 
 ## Tests
@@ -156,7 +163,7 @@ client = BingSearch::Client.new(access_key: 'hzy9+Y6...', web_only: true)
 To run the tests:
 
 1. Sign up for both the standard and web-only APIs
-2. Set the environment variable BING\_SEARCH\_ACCESS\_KEY to your Access Key
+2. Set the environment variable BING\_SEARCH\_ACCOUNT\_KEY to your Account Key
 3. `rake`
 
 ## Contributing

data/lib/bing-search.rb

@@ -1,11 +1,12 @@
 %w{
-  client
   enums
+  client
   errors
   models
+  util
   version
 }.each do |file|
-  require File.expand_path("../bing-search/#{file}", __FILE__)
+  require "bing-search/#{file}"
 end
 
 module BingSearch
@@ -13,81 +14,81 @@ module BingSearch
   HIGHLIGHT_DELIMITER = "\u{e001}"
 
   class << self
-    # An Access Key obtained from the Azure Marketplace. You can set this
-    # attribute once instead of instantiating each {Client} with an Access Key.
+    # An Account Key obtained from the Azure Marketplace. You can set this
+    # attribute once instead of instantiating each {Client} with an Account Key.
     # @return [String]
-    attr_accessor :access_key
+    attr_accessor :account_key
 
     # Whether to use the less expensive web-only API
     # @return [Boolean]
     attr_accessor :web_only
 
     # Convenience method that creates a {Client} and searches for web pages.
-    # Takes the same arguments as {Client#web}. Set {access_key} before calling.
+    # Takes the same arguments as {Client#web}. Set {account_key} before calling.
     # @return (see Client#web)
     # @see Client#web
     #
     def web(*args)
-      Client.new.web *args
+      Client.new.web(*args)
     end
 
     # Convenience method that creates a {Client} and searches for images. Takes
-    # the same arguments as {Client#image}. Set {access_key} before calling.
+    # the same arguments as {Client#image}. Set {account_key} before calling.
     # @return (see Client#image)
     # @see Client#image
     #
     def image(*args)
-      Client.new.image *args
+      Client.new.image(*args)
     end
 
     # Convenience method that creates a {Client} and searches for videos. Takes
-    # the same arguments as {Client#video}. Set {access_key} before calling.
+    # the same arguments as {Client#video}. Set {account_key} before calling.
     # @return (see Client#video)
     # @see Client#video
     #
     def video(*args)
-      Client.new.video *args
+      Client.new.video(*args)
     end
 
     # Convenience method that creates a {Client} and searches for news. Takes
-    # the same arguments as {Client#news}. Set {access_key} before calling.
+    # the same arguments as {Client#news}. Set {account_key} before calling.
     # @return (see Client#news)
     # @see Client#news
     #
     def news(*args)
-      Client.new.news *args
+      Client.new.news(*args)
     end
 
     # Convenience method that creates a {Client} and searches for related
-    # queries. Takes the same arguments as {Client#related_search}. Set {access_key}
+    # queries. Takes the same arguments as {Client#related_search}. Set {account_key}
     # before calling.
     # @return (see Client#related_search)
     # @see Client#related_search
     #
     def related_search(*args)
-      Client.new.related_search *args
+      Client.new.related_search(*args)
     end
     alias_method :related, :related_search
 
     # Convenience method that creates a {Client} and corrects spelling in the
     # query text. Takes the same arguments as {Client#related_search}. Set
-    # {access_key} before calling.
+    # {account_key} before calling.
     # @return (see Client#spelling_suggestions)
     # @see Client#spelling_suggestions
     #
     def spelling_suggestions(*args)
-      Client.new.spelling_suggestions *args
+      Client.new.spelling_suggestions(*args)
     end
     alias_method :spelling, :spelling_suggestions
 
-    # Convenience method that creates a {Client} and searches multiple sources
-    # Takes the same arguments as {Client#related_search}. Set {access_key} before
+    # Convenience method that creates a {Client} and searches multiple sources.
+    # Takes the same arguments as {Client#related_search}. Set {account_key} before
     # calling.
     # @return (see Client#composite)
     # @see Client#composite
     #
     def composite(*args)
-      Client.new.composite *args
+      Client.new.composite(*args)
     end
   end
 end

data/lib/bing-search/client.rb

@@ -2,17 +2,12 @@ require 'date'
 require 'json'
 require 'net/http'
 require 'uri'
-require 'active_support/core_ext/hash/slice'
-require 'active_support/core_ext/string/inflections'
-require_relative 'errors'
-require_relative 'models'
-require_relative 'enums'
 
 module BingSearch
   class Client
-    # The Access Key obtained from the Azure Marketplace
+    # The Account Key obtained from the Azure Marketplace
     # @return [String]
-    attr_reader :access_key
+    attr_reader :account_key
 
     # Whether to use the less expensive web-only API
     # @return [Boolean]
@@ -21,19 +16,20 @@ module BingSearch
 
     # @!group Constructors
 
-    # @param [String, nil] access_key
-    #   An Access Key obtained from the Azure Marketplace. If nil,
-    #   {BingSearch.access_key} is assumed.
+    # @param [String, nil] account_key
+    #   An Account Key obtained from the Azure Marketplace. If nil,
+    #   {BingSearch.account_key} is assumed.
     # @param [Boolean, nil] web_only
     #   Whether to use the less expensive web-only API. If nil,
     #   {BingSearch.web_only} is assumed.
     #
-    def initialize(access_key: nil, web_only: nil)
-      @access_key = access_key || BingSearch.access_key
+    def initialize(account_key: nil, web_only: nil)
+      @session = nil
+      @account_key = account_key || BingSearch.account_key
       @web_only = web_only.nil? ? BingSearch.web_only : web_only
 
-      unless @access_key
-        raise ArgumentError, "Pass an Access Key or set BingSearch.access_key"
+      unless @account_key
+        raise ArgumentError, "Pass an Account Key or set BingSearch.account_key"
       end
     end
 
@@ -113,7 +109,7 @@ module BingSearch
     #   @param [String] query
     #     The query text; supports the
     #     {http://msdn.microsoft.com/en-us/library/ff795667.aspx Bing Query Language}
-    #   @param [Hash<Symbol => Object>] opts
+    #   @param [Hash{Symbol => Object}] opts
     #   @option opts [Integer] :limit
     #     The maximum number of results to return
     #   @option opts [Integer] :offset
@@ -335,15 +331,15 @@ module BingSearch
     #   e.g. 'Web'
     # @param [String] query
     #   The query text
-    # @param [Hash<Symbol => Object>] opts
+    # @param [Hash{Symbol => Object}] opts
     #   The options hash provided by the caller
     # @param [Array<Symbol>] passthrough_opts
     #   Keys of the options to copy to the params hash
-    # @param [Hash<Symbol => Module>] enum_opt_to_module
+    # @param [Hash{Symbol => Module}] enum_opt_to_module
     #   Maps an enum option key to the module containing the enum's values.
     #   Used to translate symbols to enum values. E.g. maps +:web_file_type+
     #   to {FileType}.
-    # @param [Hash<Symbol => Object>] params
+    # @param [Hash{Symbol => Object}] params
     #   Parameters for the invocation
     # @return [Object]
     # @raise [ServiceError]
@@ -363,7 +359,7 @@ module BingSearch
       end
 
       params = params.
-        merge(opts.slice(*GENERAL_PASSTHROUGH_OPTS, *passthrough_opts)).
+        merge(Util.slice_hash(opts, *GENERAL_PASSTHROUGH_OPTS, *passthrough_opts)).
         merge(query: query, offset: offset, options: options, format: :JSON).
         delete_if { |_, v| v.nil? || (v.is_a?(Array) && v.empty?) }
 
@@ -373,7 +369,7 @@ module BingSearch
 
       response = in_session do |session|
         request = Net::HTTP::Get.new("#{base_path}/#{operation}?#{query}")
-        request.basic_auth(access_key, access_key)
+        request.basic_auth(account_key, account_key)
         session.request request
       end
 
@@ -423,18 +419,18 @@ module BingSearch
     #   The module does not contain a constant corresponing to the symbol
     #
     def enum_from_symbol(symbol, module_)
-      [symbol.to_s.camelcase, symbol.to_s.upcase].each do |const|
+      [Util.camelcase(symbol.to_s), symbol.to_s.upcase].each do |const|
         return module_.const_get(const) if module_.const_defined?(const)
       end
       raise ArgumentError, "#{module_} does not contain a constant corresponding to #{symbol}"
     end
 
-    # @param [Hash<Symbol => Object>] params
-    # @return [Hash<String => Object]
+    # @param [Hash{Symbol => Object}] params
+    # @return [Hash{String => Object}]
     #
     def replace_param_names(params, replacements)
       params.each_with_object(Hash.new) do |(key, value), hash|
-        key = replacements[key] || GENERAL_PARAM_NAME_REPLACEMENTS[key] || key.to_s.camelcase
+        key = replacements[key] || GENERAL_PARAM_NAME_REPLACEMENTS[key] || Util.camelcase(key.to_s)
         hash[key] = value
       end
     end
@@ -515,7 +511,7 @@ module BingSearch
 
       for key, value in raw
         next if key == '__metadata'
-        attr = key.underscore.to_sym
+        attr = Util.underscore(key).to_sym
         model.set attr, parse(value, attr_to_type[attr])
       end
 

data/lib/bing-search/util.rb

@@ -0,0 +1,22 @@
+module BingSearch
+
+  # @private
+  module Util
+    class << self
+      def underscore(string)
+        string.gsub(/([^A-Z])([A-Z])/, '\1_\2').downcase
+      end
+
+      def camelcase(string)
+        string.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+      end
+
+      def slice_hash(hash, *keys)
+        keys.each_with_object(Hash.new) do |key, result|
+          result[key] = hash[key] if hash.has_key?(key)
+        end
+      end
+    end
+  end
+
+end

data/lib/bing-search/version.rb

@@ -1,3 +1,3 @@
 module BingSearch
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bing-search
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonah Burke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE.txt
 - README.md
 - lib/bing-search.rb
@@ -80,6 +67,7 @@ files:
 - lib/bing-search/enums.rb
 - lib/bing-search/errors.rb
 - lib/bing-search/models.rb
+- lib/bing-search/util.rb
 - lib/bing-search/version.rb
 homepage: http://github.com/jonahb/bing-search
 licenses:
@@ -101,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the Bing Search API