bing_search_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2af3a12020feeb6a46c830ae44a5f7221e723efe
+  data.tar.gz: ed80c0a5558d046340e18e7aadbef29b5ea4c609
+SHA512:
+  metadata.gz: a415d3906854530d085b1188a476164d6a3a87e21de786d7b5c68abdbc186b14d4c9520d451d3f55f53dfdeded47ee67ee2df6bdc21d215db9acb430f779b8c0
+  data.tar.gz: dd14b98a9e94cd7577b72927cace1be549d1eddb41b2a51181bdbad8955395a38442795de85524c9228ebe9638e9d913b4b2d700fac06da696dcd4e5dd075b42

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+before_install: gem install bundler -v 1.13.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bing_search_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Leanbit s.r.l
+
+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.md

@@ -0,0 +1,62 @@
+[![Build Status](https://travis-ci.org/leanbit/bing_search_client.svg?branch=master)](https://travis-ci.org/leanbit/bing_search_client)
+
+# BingSearchClient
+
+Simple Ruby Bing Api Client for Cognito Search Services.
+Currently support only the News endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bing_search_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bing_search_client
+
+## Usage
+
+Configure your account key, if you do not have one just visit [Microsoft Cognitive Service](https://www.microsoft.com/cognitive-services/en-us/subscriptions)
+
+```ruby
+   BingSearchClient.configure do |c|
+     c.account_key = "123"
+   end
+
+   news_client = BingSearchClient::News.new(num_results: 10, params: {:mkt => 'it-IT'})
+   news_client.search(q: "test")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Run the specs
+
+```
+$ rspec
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leanbit/bing_search_client.
+
+## TODO
+
+Implement other services like Web, Image and Video search.
+Just take a look at the BingSearchClient::News class, add one class for each service. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bing_search_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bing_search_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bing_search_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bing_search_client"
+  spec.version       = BingSearchClient::VERSION
+  spec.authors       = ["Giacomo Macrì"]
+  spec.email            = 'giacomo at leanbit dot it'
+
+  spec.summary       = %q{Bing Search Ruby client for new v5 api}
+  spec.description   = %q{A simple client to interact with Bing search API.}
+  spec.homepage      = "https://github.com/leanbit/bing_search_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

data/lib/bing_search_client.rb

@@ -0,0 +1,54 @@
+require 'json'
+require "bing_search_client/version"
+require "bing_search_client/client"
+require "bing_search_client/result"
+require "bing_search_client/news" 
+#TODO implement client for Web, Image and Video search
+
+module BingSearchClient
+  # Class method to set up configuration parameters
+  #
+  # @example
+  #   BingSearchClient.configure do |c|
+  #     c.account_key = "123"
+  #   end
+  #
+  def self.configure(&block)
+    yield @config ||= Configuration.new
+  end
+
+  # Return configuration parameters
+  #
+  # @example
+  #   BingSearchClient.config.api_key
+  #
+  def self.config
+    @config
+  end
+
+  # Reset configuration parameters
+  #
+  # @example
+  #   BingSearchClient.reset_config
+  #
+  def self.reset_config
+    @config = nil
+  end
+
+
+  # Container for configuration parameters
+  #
+  class Configuration
+    BASE_URL = "https://api.cognitive.microsoft.com/bing/v5.0".freeze
+
+    attr_accessor :account_key, :base_url
+
+    def base_url
+      @base_url || BASE_URL
+    end
+  end
+
+  # Exception raised for connection error
+  #
+  class BadResponse < Exception; end
+end

data/lib/bing_search_client/client.rb

@@ -0,0 +1,30 @@
+module BingSearchClient
+  class Client
+    attr_reader :url
+
+    def initialize(url:)
+      @url = url
+    end
+
+    def get
+      uri = URI(url)
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req.add_field('Ocp-Apim-Subscription-Key', BingSearchClient.config.account_key)
+      response = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+      parse_response(response)
+    end
+
+    private
+
+      def parse_response(response)
+        body = JSON.parse(response.body, symbolize_names: true)
+        if (200..299).include?(response.code.to_i)
+          return { results: BingSearchClient::Result.build_from_array_response(raw_response: body[:value]), extra: body.reject { |k| k != :value } }
+        else
+          raise BingSearchClient::BadResponse.new("#{response.status}: #{body}")
+        end
+      end
+  end
+end

data/lib/bing_search_client/news.rb

@@ -0,0 +1,22 @@
+module BingSearchClient
+  class News
+    
+    attr_reader :num_results, :params
+
+    def initialize(num_results: 100, params: {})
+      @num_results = num_results
+      @params = params
+    end
+
+    def search(q:, offset: 0)
+      query_string = 'q='
+      query_portion = URI.encode_www_form_component('\'' + q + '\'')
+      local_params = "&count=#{num_results}&offset=#{offset}"
+      @params.each do |k,v|
+        local_params << "&#{k.to_s}=#{v.to_s}"
+      end
+      full_address = [BingSearchClient.config.base_url, 'news/search'].join('/') + '?' + query_string + query_portion + local_params
+      Client.new(url: full_address).get
+    end
+  end
+end

data/lib/bing_search_client/result.rb

@@ -0,0 +1,25 @@
+module BingSearchClient
+  class Result
+    attr_reader :body, :expanded_url
+
+    def initialize(body:)
+      @body = body
+      @expanded_url = nil
+    end
+
+    def self.build_from_array_response(raw_response:)
+      raw_response.map do |result_json_response|
+        new(body: result_json_response).tap do |result|
+          result.expand_url!
+        end
+      end
+    end
+
+    # Instance method to get the real url insted of the url bing
+    def expand_url!
+      bing_url = URI(body[:url])
+      parsed_query = CGI::parse(bing_url.query)
+      @expanded_url = parsed_query['r'].first
+    end
+  end
+end

data/lib/bing_search_client/version.rb

@@ -0,0 +1,3 @@
+module BingSearchClient
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bing_search_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Giacomo Macrì
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: A simple client to interact with Bing search API.
+email: giacomo at leanbit dot it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bing_search_client.gemspec
+- lib/bing_search_client.rb
+- lib/bing_search_client/client.rb
+- lib/bing_search_client/news.rb
+- lib/bing_search_client/result.rb
+- lib/bing_search_client/version.rb
+homepage: https://github.com/leanbit/bing_search_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Bing Search Ruby client for new v5 api
+test_files: []