google_suggest 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21e6d04f9c05098db65ac8bf44dbfa32589e97d2
-  data.tar.gz: db128ed5ca88e34e27bd44e057a61b6bf6fd43ef
+  metadata.gz: 97a251c55415e7ecf907421034dd5a120c6cd9c7
+  data.tar.gz: fb6b46af27920ff5da1770dba21925a23e5d37cf
 SHA512:
-  metadata.gz: 0db4d5aceda209008bfe50f95fb252ff3ac9bff4888c64ccc30570c85194f4ee7453a66828d4816f1fc174e3c55f9621ea6e806538a641f90cd19256067552e8
-  data.tar.gz: c19d4781d6a5f2e7c29e17f6c0227025c4f2d3311c201a30a49e84700a7bf37bee4d5bef2f1f54f8d9ad0ccdaffd1b6a0cbfbfa2a681decf7a7e273e8f57ba21
+  metadata.gz: d802d3d3f7d3508c895f66b327c1f0817bbdcc94630e92ea1cd0a51e3314185aa9db748c26f3fe0650db130dbfa967ba16baedf597ddb5ddc8c41558b5a010d5
+  data.tar.gz: 4517dc27d8908a516ae2214701432fc922cef2661c7afd5d23e082afafec3ff148db838dbcc247db4729b943db4f4c569a657a1a90dd3852f81539a97a4de080

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## GoogleSuggest 0.1.0
+
+* `GoogleSuggest.suggest_for` supports `region` [#2](https://github.com/satoryu/google_suggest/issues/2)
+  The class method allows users to choose their regions by passing `region` option to it like
+  `GoogleSuggest.suggest_for 'foo', region: 'jp'`. You would get different results and  different order.
+  @imargonis, Thank you for proposing your idea.
+
+* Renamed `GoogleSuggest::Configure` with `GoogleSuggest::Configuration`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    google_suggest (0.0.6)
+    google_suggest (0.1.0)
       nokogiri (~> 1.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
-    mini_portile (0.6.2)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    rake (10.4.2)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rake (11.1.2)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -28,3 +28,6 @@ DEPENDENCIES
   google_suggest!
   rake
   rspec (~> 2.14.0)
+
+BUNDLED WITH
+   1.10.6

data/{LICENCE.txt → LICENSE.txt}

@@ -1,6 +1,6 @@
-The MIT License
+The MIT License (MIT)
 
-Copyright (c) 2010 Tatsuya Sato
+Copyright (c) 2016 Tatsuya Sato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,54 @@
+# GoogleSuggest
+
+[![Build Status](https://travis-ci.org/satoryu/google_suggest.svg?branch=master)](https://travis-ci.org/satoryu/google_suggest)
+
+This gem allows you to access google suggest API in your ruby codes. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_suggest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_suggest
+
+## Usage
+
+`GoogleSuggest.suggest_for` gives suggestions for a given keyword. 
+
+```ruby
+GoogleSuggest.suggest_for 'google'
+=> [{"suggestion"=>"google"}, {"suggestion"=>"google maps"}, {"suggestion"=>"google translate"}, {"suggestion"=>"google classroom"}, {"suggestion"=>"google docs"}, {"suggestion"=>"google drive"}, {"suggestion"=>"google earth"}, {"suggestion"=>"google play"}, {"suggestion"=>"google scholar"}, {"suggestion"=>"google slides"}]
+
+```
+
+and allows developers to switch the endpoint by specifying `region` option:
+
+```ruby
+GoogleSuggest.suggest_for 'google'
+=> [{"suggestion"=>"google maps"}, {"suggestion"=>"google"}, {"suggestion"=>"google translate"}, {"suggestion"=>"google drive"}, {"suggestion"=>"google scholar"}, {"suggestion"=>"google docs"}, {"suggestion"=>"google news"}, {"suggestion"=>"google flights"}, {"suggestion"=>"google play"}, {"suggestion"=>"google earth"}]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/satoryu/google_suggest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/google_suggest.gemspec

@@ -2,22 +2,21 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'google_suggest/version'
-require 'rake'
 
 Gem::Specification.new do |spec|
   spec.name = 'google_suggest'
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.1.0'
   spec.summary = 'A gem which allows us to retrieve suggest words from Google in your Ruby Code.'
   spec.version = GoogleSuggest::VERSION
   spec.author  = 'Tatsuya Sato'
   spec.email   = 'satoryu.1981@gmail.com'
   spec.homepage = 'http://github.com/satoryu/google_suggest/'
   spec.license       = "MIT"
-  spec.files = FileList[%w[
-    [A-Z]*
-    lib/**/*.rb
-    spec/**/*
-  ]]
+  spec.files = Dir[
+    'lib/**/*.rb',
+    '[A-Z]*',
+    'spec/**/*'
+  ]
 
   spec.add_runtime_dependency "nokogiri", '~> 1.6.0'
 

data/lib/google_suggest/configuration.rb

@@ -0,0 +1,12 @@
+class GoogleSuggest
+  class Configuration
+    attr_accessor :home_language
+    attr_accessor :proxy
+    attr_accessor :region
+
+    def initialize
+      @home_language = 'en'
+      @region = nil
+    end
+  end
+end

data/lib/google_suggest/region.rb

@@ -0,0 +1,208 @@
+class GoogleSuggest
+  GOOGLE_HOSTS = {
+    ac: 'www.google.ac',
+    ad: 'www.google.ad',
+    ae: 'www.google.ae',
+    af: 'www.google.com.af',
+    ag: 'www.google.com.ag',
+    ag: 'www.google.com.ag',
+    ai: 'www.google.com.ai',
+    al: 'www.google.al',
+    am: 'www.google.am',
+    ao: 'www.google.am',
+    ar: 'www.google.com.ar',
+    as: 'www.google.as',
+    at: 'www.google.at',
+    au: 'www.google.com.au',
+    az: 'www.google.az',
+    ba: 'www.google.ga',
+    bd: 'www.google.com.bd',
+    be: 'www.google.be',
+    bf: 'www.google.bf',
+    bg: 'www.google.bg',
+    bh: 'www.google.com.bh',
+    bi: 'www.google.bi',
+    bj: 'www.google.bj',
+    bn: 'www.google.com.bn',
+    bo: 'www.google.com.bo',
+    br: 'www.google.com.br',
+    bs: 'www.google.bs',
+    bt: 'www.google.bt',
+    bw: 'www.google.co.bw',
+    by: 'www.google.by',
+    bz: 'www.google.com.bz',
+    ca: 'www.google.ca',
+    kh: 'www.google.com.kh',
+    cc: 'www.google.cc',
+    cd: 'www.google.cd',
+    cf: 'www.google.cf',
+    cat: 'www.google.cat',
+    cg: 'www.google.cg',
+    ch: 'www.google.ch',
+    ci: 'www.google.ci',
+    ck: 'www.google.co.ck',
+    cl: 'www.google.cl',
+    cm: 'www.google.cm',
+    cn: 'www.google.cn',
+    co: 'www.google.com.co',
+    cr: 'www.google.co.cr',
+    cu: 'www.google.com.cu',
+    cv: 'www.google.cv',
+    cy: 'www.google.com.cy',
+    cz: 'www.google.cz',
+    de: 'www.google.de',
+    dj: 'www.google.dj',
+    dk: 'www.google.dk',
+    dm: 'www.google.dm',
+    do: 'www.google.com.do',
+    dz: 'www.google.dz',
+    ec: 'www.google.com.ec',
+    ee: 'www.google.ee',
+    eg: 'www.google.com.eg',
+    es: 'www.google.es',
+    et: 'www.google.com.et',
+    fi: 'www.google.fi',
+    fj: 'www.google.com.fj',
+    fm: 'www.google.fm',
+    fr: 'www.google.fr',
+    ga: 'www.google.ga',
+    ge: 'www.google.ge',
+    gf: 'www.google.gf',
+    gg: 'www.google.gg',
+    gh: 'www.google.com.gh',
+    gi: 'www.google.com.gi',
+    gl: 'www.google.gl',
+    gm: 'www.google.gm',
+    gp: 'www.google.gp',
+    gr: 'www.google.gr',
+    gt: 'www.google.com.gt',
+    gy: 'www.google.gy',
+    hk: 'www.google.com.hk',
+    hn: 'www.google.hn',
+    hr: 'www.google.hr',
+    ht: 'www.google.ht',
+    hu: 'www.google.hu',
+    id: 'www.google.co.id',
+    iq: 'www.google.iq',
+    ie: 'www.google.ie',
+    il: 'www.google.co.il',
+    im: 'www.google.im',
+    in: 'www.google.co.in',
+    io: 'www.google.io',
+    is: 'www.google.is',
+    it: 'www.google.it',
+    je: 'www.google.je',
+    jm: 'www.google.com.jm',
+    jo: 'www.google.jo',
+    jp: 'www.google.co.jp',
+    ke: 'www.google.co.ke',
+    ki: 'www.google.ki',
+    kg: 'www.google.kg',
+    kr: 'www.google.co.kr',
+    kw: 'www.google.com.kw',
+    kz: 'www.google.kz',
+    la: 'www.google.la',
+    lb: 'www.google.com.lb',
+    lc: 'www.google.com.lc',
+    li: 'www.google.li',
+    lk: 'www.google.lk',
+    ls: 'www.google.co.ls',
+    lt: 'www.google.lt',
+    lu: 'www.google.lu',
+    lv: 'www.google.lv',
+    ly: 'www.google.com.ly',
+    ma: 'www.google.co.ma',
+    md: 'www.google.md',
+    me: 'www.google.me',
+    mg: 'www.google.mg',
+    mk: 'www.google.mk',
+    ml: 'www.google.ml',
+    mm: 'www.google.com.mm',
+    mn: 'www.google.mn',
+    ms: 'www.google.ms',
+    mt: 'www.google.com.mt',
+    mu: 'www.google.mu',
+    mv: 'www.google.mv',
+    mz: 'www.google.co.mz',
+    na: 'www.google.com.na',
+    ne: 'www.google.ne',
+    nf: 'www.google.com.nf',
+    ng: 'www.google.com.ng',
+    ni: 'www.google.com.ni',
+    nl: 'www.google.nl',
+    no: 'www.google.no',
+    np: 'www.google.com.np',
+    nr: 'www.google.nr',
+    nu: 'www.google.nu',
+    nz: 'www.google.co.nz',
+    om: 'www.google.com.om',
+    pk: 'www.google.com.pk',
+    pa: 'www.google.com.pa',
+    pe: 'www.google.com.pe',
+    ph: 'www.google.com.ph',
+    pl: 'www.google.pl',
+    pg: 'www.google.com.pg',
+    pn: 'www.google.pn',
+    pr: 'www.google.com.pr',
+    ps: 'www.google.ps',
+    pt: 'www.google.pt',
+    py: 'www.google.com.py',
+    qa: 'www.google.com.qa',
+    ro: 'www.google.ro',
+    rs: 'www.google.rs',
+    ru: 'www.google.ru',
+    rw: 'www.google.rw',
+    sa: 'www.google.com.sa',
+    sb: 'www.google.com.sb',
+    sc: 'www.google.sc',
+    se: 'www.google.se',
+    sg: 'www.google.com.sg',
+    sh: 'www.google.sh',
+    si: 'www.google.si',
+    sk: 'www.google.sk',
+    sl: 'www.google.sl',
+    sn: 'www.google.sn',
+    sm: 'www.google.sm',
+    so: 'www.google.so',
+    st: 'www.google.st',
+    sr: 'www.google.sr',
+    sv: 'www.google.com.sv',
+    td: 'www.google.td',
+    tg: 'www.google.tg',
+    th: 'www.google.co.th',
+    tj: 'www.google.com.tj',
+    tk: 'www.google.tk',
+    tl: 'www.google.tl',
+    tm: 'www.google.tm',
+    to: 'www.google.to',
+    tn: 'www.google.tn',
+    tr: 'www.google.com.tr',
+    tt: 'www.google.tt',
+    tw: 'www.google.com.tw',
+    tz: 'www.google.co.tz',
+    ua: 'www.google.com.ua',
+    ug: 'www.google.co.ug',
+    uk: 'www.google.co.uk',
+    com: 'www.google.com',
+    uy: 'www.google.com.uy',
+    uz: 'www.google.co.uz',
+    vc: 'www.google.com.vc',
+    ve: 'www.google.co.ve',
+    vg: 'www.google.vg',
+    vi: 'www.google.co.vi',
+    vn: 'www.google.com.vn',
+    vu: 'www.google.vu',
+    ws: 'www.google.ws',
+    za: 'www.google.co.za',
+    zm: 'www.google.co.zm',
+    zw: 'www.google.co.zw'
+  }
+
+  class Region
+    def self.host_for(region_code=nil)
+      region_code = :com if region_code.nil?
+      region_code = region_code.to_sym if region_code.is_a?(String)
+      GOOGLE_HOSTS[region_code] || DEFAULT_GOOGLE_HOST
+    end
+  end
+end

data/lib/google_suggest/version.rb

@@ -1,3 +1,3 @@
 class GoogleSuggest
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/lib/google_suggest.rb

@@ -3,36 +3,32 @@
 require 'uri'
 require 'nokogiri'
 require 'net/http'
+require 'google_suggest/configuration'
+require 'google_suggest/region'
 
 class GoogleSuggest
-  class Configure
-    attr_accessor :home_language
-    attr_accessor :proxy
-
-    def initialize
-      @home_language = 'en'
-    end
-  end
-
   attr_accessor :home_language
+  attr_accessor :region
   attr_accessor :proxy
 
-  @@configure = Configure.new
+  def self.configure
+    yield configuration if block_given?
 
-  class << self
-    def configure
-      yield @@configure if block_given?
-      @@configure
-    end
+    configuration
+  end
 
-    def suggest_for(keyword)
-      self.new.suggest_for(keyword)
-    end
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  def initialize
-    @home_language = @@configure.home_language
-    @proxy = @@configure.proxy
+  def self.suggest_for(keyword, options={})
+    self.new(options).suggest_for(keyword)
+  end
+
+  def initialize(options={})
+    @home_language = self.class.configuration.home_language
+    @proxy = self.class.configuration.proxy
+    @region = options[:region] || self.class.configure.region
   end
 
   def suggest_for(keyword)
@@ -56,22 +52,24 @@ class GoogleSuggest
   end
 
   private
-  GOOGLE_HOST = 'www.google.com'
 
   def http
     if @proxy
-      proxy_url = URI.parse(@proxy) 
+      proxy_url = URI.parse(@proxy)
       http_class = Net::HTTP.Proxy(proxy_url.host, proxy_url.port)
     else
       http_class = Net::HTTP
     end
-    http_class.new(GOOGLE_HOST)
+    http_class.new(google_host)
   end
 
-  def http_get(path, query) 
+  def http_get(path, query)
     path = path + '?' + query.map{|k,v| "#{k}=#{v}"}.join('&')
     req = Net::HTTP::Get.new(path)
     http.request(req)
   end
 
+  def google_host
+    Region.host_for(region)
+  end
 end

data/spec/google_suggest/region_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe GoogleSuggest::Region do
+  describe '.host_for' do
+    subject { GoogleSuggest::Region.host_for(region_code) }
+
+    context 'when giving nil as region code' do
+      let(:region_code) { nil }
+
+      it 'should be default host "www.google.com"' do
+        should be_eql('www.google.com')
+      end
+    end
+    context 'when giving a valid region code like "ac"' do
+      let(:region_code) { 'ac' }
+
+      it 'shoud be the google host for the given region' do
+        should be_eql('www.google.ac')
+      end
+    end
+  end
+end

data/spec/google_suggest_spec.rb

@@ -1,23 +1,31 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe GoogleSuggest do
-  context "default settiong" do
-    subject { GoogleSuggest.new }
+  describe ".new" do
+    let(:args) { {} }
+    let(:google_suggest) { GoogleSuggest.new(args) }
+
+    subject { google_suggest }
 
     its(:home_language) { should be_eql 'en' }
     its(:proxy) { should be_nil }
+    its(:google_host) { should be_eql 'www.google.com' }
+
+    context 'when giving region option' do
+      let(:args) { { region: 'ac' } }
+
+      its(:home_language) { should be_eql 'en' }
+      its(:google_host) { should be_eql 'www.google.ac' }
+    end
   end
 
-  context "Class Methods" do
+  describe ".suggest_for" do
     before do
       google_suggest = GoogleSuggest.new
       res = Object.new
       allow(res).to receive(:body) do
-        doc = nil
-        File.open(File.join(File.dirname(__FILE__), 'sample_us.xml')) do |f|
-          doc = f.read
-        end
-        doc
+        File.read(File.join(File.dirname(__FILE__), 'sample_us.xml'))
       end
       allow(google_suggest).to receive(:http_get) { res }
       suggestions = google_suggest.suggest_for('google')
@@ -25,41 +33,53 @@ describe GoogleSuggest do
 
       @suggestions = GoogleSuggest.suggest_for('google')
     end
-     
-    it do 
+
+    it do
       @suggestions.size.should be 10
     end
-    it do
-      @suggestions.should be_all do
+
+    context 'When passing Hash as options' do
+      specify 'should initialize new object with the options.' do
+        obj = double(:google_suggest)
+        expect(obj).to receive(:suggest_for).with('google')
+        expect(GoogleSuggest).to receive(:new).with(region: 'jp').and_return(obj)
+
+        GoogleSuggest.suggest_for('google', region: 'jp')
       end
     end
   end
 
-  describe GoogleSuggest::Configure do
-    context "#configure called without block" do
+  describe '.configure' do
+    context "When called without block" do
       before do
         @configure = GoogleSuggest.configure
         @configure.home_language = 'ja'
+        @configure.region = 'ac'
         @configure.proxy = 'http://proxy.example.com'
       end
+
       subject { GoogleSuggest.new }
+
       its(:home_language) { should be_eql 'ja' }
+      its(:region) { should be_eql 'ac' }
       its(:proxy) { should be_eql 'http://proxy.example.com' }
     end
-    context "#configure called and given block" do
+    context "When called with given block" do
       before do
         GoogleSuggest.configure do |c|
           c.home_language = 'us'
           c.proxy = 'http://proxy.example.com'
         end
       end
+
       subject { GoogleSuggest.new }
+
       its(:home_language) { should be_eql 'us' }
       its(:proxy) { should be_eql 'http://proxy.example.com' }
     end
   end
 
-  context "#suggest_from method" do
+  describe "#suggest_from" do
     before :all do
       GoogleSuggest.configure do |c|
         c.home_language = 'us'
@@ -91,7 +111,6 @@ describe GoogleSuggest do
       end
     end
 
-
     it 'all suggestions should have the value of the key \'num_queries\' 'do
       suggestions = @google_suggest.suggest_for 'google'
       suggestions.should be_all do |suggest|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_suggest
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Tatsuya Sato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -58,13 +58,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENCE.txt
+- LICENSE.txt
+- README.md
 - Rakefile
 - google_suggest.gemspec
 - lib/google_suggest.rb
+- lib/google_suggest/configuration.rb
+- lib/google_suggest/region.rb
 - lib/google_suggest/version.rb
+- spec/google_suggest/region_spec.rb
 - spec/google_suggest_spec.rb
 - spec/sample_ja.xml
 - spec/sample_us.xml
@@ -81,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A gem which allows us to retrieve suggest words from Google in your Ruby