lieu 1.0.0

data/spec/cassettes/Lieu_Request/given_a_POST_request/with_options/sets_options_as_body_parameters.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://maps.googleapis.com/maps/api/place/fuubar/json?key=<API_KEY>&sensor=false
+    body:
+      encoding: UTF-8
+      string: '{"test":"toto"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Thu, 26 Sep 2013 11:47:29 GMT
+      Content-Type:
+      - text/html; charset=UTF-8
+      Server:
+      - mafe
+      Content-Length:
+      - '1018'
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Alternate-Protocol:
+      - 443:quic
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ZW4+CiAgPG1ldGEgY2hhcnNl
+        dD11dGYtOD4KICA8bWV0YSBuYW1lPXZpZXdwb3J0IGNvbnRlbnQ9ImluaXRp
+        YWwtc2NhbGU9MSwgbWluaW11bS1zY2FsZT0xLCB3aWR0aD1kZXZpY2Utd2lk
+        dGgiPgogIDx0aXRsZT5FcnJvciA0MDQgKE5vdCBGb3VuZCkhITE8L3RpdGxl
+        PgogIDxzdHlsZT4KICAgICp7bWFyZ2luOjA7cGFkZGluZzowfWh0bWwsY29k
+        ZXtmb250OjE1cHgvMjJweCBhcmlhbCxzYW5zLXNlcmlmfWh0bWx7YmFja2dy
+        b3VuZDojZmZmO2NvbG9yOiMyMjI7cGFkZGluZzoxNXB4fWJvZHl7bWFyZ2lu
+        OjclIGF1dG8gMDttYXgtd2lkdGg6MzkwcHg7bWluLWhlaWdodDoxODBweDtw
+        YWRkaW5nOjMwcHggMCAxNXB4fSogPiBib2R5e2JhY2tncm91bmQ6dXJsKC8v
+        d3d3Lmdvb2dsZS5jb20vaW1hZ2VzL2Vycm9ycy9yb2JvdC5wbmcpIDEwMCUg
+        NXB4IG5vLXJlcGVhdDtwYWRkaW5nLXJpZ2h0OjIwNXB4fXB7bWFyZ2luOjEx
+        cHggMCAyMnB4O292ZXJmbG93OmhpZGRlbn1pbnN7Y29sb3I6Izc3Nzt0ZXh0
+        LWRlY29yYXRpb246bm9uZX1hIGltZ3tib3JkZXI6MH1AbWVkaWEgc2NyZWVu
+        IGFuZCAobWF4LXdpZHRoOjc3MnB4KXtib2R5e2JhY2tncm91bmQ6bm9uZTtt
+        YXJnaW4tdG9wOjA7bWF4LXdpZHRoOm5vbmU7cGFkZGluZy1yaWdodDowfX0K
+        ICA8L3N0eWxlPgogIDxhIGhyZWY9Ly93d3cuZ29vZ2xlLmNvbS8+PGltZyBz
+        cmM9Ly93d3cuZ29vZ2xlLmNvbS9pbWFnZXMvZXJyb3JzL2xvZ29fc20uZ2lm
+        IGFsdD1Hb29nbGU+PC9hPgogIDxwPjxiPjQwNC48L2I+IDxpbnM+VGhhdOKA
+        mXMgYW4gZXJyb3IuPC9pbnM+CiAgPHA+VGhlIHJlcXVlc3RlZCBVUkwgPGNv
+        ZGU+L21hcHMvYXBpL3BsYWNlL2Z1dWJhci9qc29uP2tleT1BSXphU3lBaXh4
+        UFUyczdmbVJNNFdfUHVzbWE1MzdWWHdrWVRaYnMmYW1wO3NlbnNvcj1mYWxz
+        ZTwvY29kZT4gd2FzIG5vdCBmb3VuZCBvbiB0aGlzIHNlcnZlci4gIDxpbnM+
+        VGhhdOKAmXMgYWxsIHdlIGtub3cuPC9pbnM+Cg==
+    http_version:
+  recorded_at: Thu, 26 Sep 2013 11:47:29 GMT
+recorded_with: VCR 2.5.0

data/spec/lib/lieu/client/actions_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe Lieu::Client::Actions do
+  describe '.add' do
+    let(:add_place_body) do
+      {
+        location: {
+          lat: '-33.8669710',
+          lng: '151.1958750'
+        },
+        accuracy: 50,
+        name: 'Google Shoes!',
+        types: [
+          'shoe_store'
+        ],
+        language: 'en-AU'
+      }
+    end
+
+    it 'adds a place' do
+      VCR.turn_off!
+
+      stub_post('add').with(add_place_body).to_return(
+        body: { reference: '123', id: '456', status: 'OK' }.to_json,
+        headers: json_content_type
+      )
+
+      new_place = client.add(add_place_body)
+
+      expect(new_place.reference).to eql('123')
+      expect(new_place.id).to eql('456')
+
+      VCR.turn_on!
+    end
+  end
+
+  describe '.delete' do
+    let(:delete_place_body) do
+      {
+        reference: place_reference
+      }
+    end
+
+    it 'deletes a place' do
+      VCR.turn_off!
+
+      stub_post('delete').with(delete_place_body).to_return(
+        body: { status: 'OK' }.to_json,
+        headers: json_content_type
+      )
+
+      delete_request = client.delete(reference: place_reference)
+
+      expect(delete_request).to eql(true)
+
+      VCR.turn_on!
+    end
+  end
+
+  describe '.bump' do
+    before { VCR.turn_off! }
+
+    after { VCR.turn_on! }
+
+    let(:bump_place_body) do
+      {
+        reference: place_reference
+      }
+    end
+
+    context 'bumping a place' do
+      it 'bumps a place' do
+        stub_post('bump').with(bump_place_body).to_return(
+          body: { status: 'OK' }.to_json,
+          headers: json_content_type
+        )
+
+        bump_place_request = client.bump(reference: place_reference)
+
+        expect(bump_place_request).to eql(true)
+      end
+    end
+
+    context 'bumping an event' do
+      let(:bump_event_body) do
+        bump_place_body.merge({ event_id: '123' })
+      end
+
+      it 'bumps an event' do
+        stub_post('bump').with(bump_event_body).to_return(
+          body: { status: 'OK' }.to_json,
+          headers: json_content_type
+        )
+
+        bump_event_request = client.bump(
+          reference: place_reference,
+          event_id: '123'
+        )
+
+        expect(bump_event_request).to eql(true)
+      end
+    end
+  end
+
+  describe '.add_event' do
+    let(:add_event_body) do
+      {
+        duration: 172800,
+        language: 'EN-CA',
+        reference: 'CnRkAAAAGnBVNFDeQoOQHzgdOpOqJNV7K9-etc',
+        summary: 'Rock n Roll Dreams: The band fully electric in my kitchen '\
+        'and drinking all my beer.',
+        url: 'http://www.example.com/event_details/10476.html'
+      }
+    end
+
+    it 'adds an event' do
+      VCR.turn_off!
+
+      stub_post('event/add').with(add_event_body).to_return(
+        body: { event_id: '123', status: 'OK' }.to_json,
+        headers: json_content_type
+      )
+
+      new_event = client.add_event(add_event_body)
+
+      expect(new_event.event_id).to eql('123')
+
+      VCR.turn_on!
+    end
+  end
+
+  describe '.delete_event' do
+    let(:delete_event_body) do
+      {
+        reference: place_reference,
+        event_id: '123'
+      }
+    end
+
+    it 'deletes an event' do
+      VCR.turn_off!
+
+      stub_post('event/delete').with(delete_event_body).to_return(
+        body: { status: 'OK' }.to_json,
+        headers: json_content_type
+      )
+
+      delete_event_request = client.delete_event(
+        reference: place_reference,
+        event_id: '123'
+      )
+
+      expect(delete_event_request).to eql(true)
+
+      VCR.turn_on!
+    end
+
+  end
+
+  describe '.event_details', :vcr do
+    it 'returns an event details' do
+      place = nil
+
+      VCR.use_cassette('Lieu_Client_Details/'\
+                       '_details/returns_a_place_details') do
+        place = client.details(place_reference)
+      end
+
+      event = client.event_details(
+        place.reference,
+        place.events.first.event_id
+      )
+
+      expect(event.event_id).not_to be_empty
+    end
+  end
+end

data/spec/lib/lieu/client/autocomplete_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Lieu::Client::Autocomplete do
+  describe '.autocomplete', :vcr do
+    it 'returns an array of places' do
+      places = client.autocomplete('Google Sydney')
+
+      expect(places).to be_a Array
+    end
+  end
+end

data/spec/lib/lieu/client/details_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Lieu::Client::Details do
+  describe '.details', :vcr do
+    it 'returns a place details' do
+      place = client.details(place_reference)
+
+      expect(place.name).to eql 'Google Sydney'
+    end
+  end
+end

data/spec/lib/lieu/client/photo_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Lieu::Client::Photos do
+  let(:photo_reference) do
+    'CnRtAAAAqCdOEgCrPQY3kaulN3Ywx0CMfg_W97Vfyp5M2tr_qd9HRcodoKvZZhsT_glcV_xJ'\
+      'QDM7br-tI2eb9u1cqkyNYEiMvkVLbky4FvheFSvfoqHUDnnJhjzPMxQfFf3GDGnbBmh6aD'\
+      'lgSOdd2LNHCm5SNBIQBT5s3kRxjhR0oAnzhINbcxoUyvD_Ce1R79aAormNMM5LhcwFU5w'
+  end
+
+  describe '.photo', :vcr do
+    it 'returns a photo image' do
+      image = client.photo(photo_reference, maxheight: 10)
+
+      expect(image).not_to be_empty
+    end
+  end
+end

data/spec/lib/lieu/client/query_autocomplete_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Lieu::Client::QueryAutocomplete do
+  describe '.query_autocomplete', :vcr do
+    it 'returns an array of places' do
+      places = client.query_autocomplete('Google Sydney')
+
+      expect(places).to be_a Array
+    end
+  end
+end

data/spec/lib/lieu/client/search_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Lieu::Client::Search do
+  let(:options) do
+    {
+      location: {
+        lat: '48.85341',
+        lng: '2.3488'
+      },
+      radius: '1500'
+    }
+  end
+
+  describe '.nearby_search', :vcr do
+    it 'returns an array of places' do
+      places = client.nearby_search(options)
+
+      expect(places).to be_a Array
+    end
+  end
+
+  describe '.textsearch', :vcr do
+    it 'returns an array of places' do
+      places = client.text_search('Google Sydney')
+
+      expect(places).to be_a Array
+    end
+  end
+
+  describe '.radarsearch', :vcr do
+    before { options.merge!(types: ['bank', 'atm']) }
+
+    it 'returns an array of places' do
+      places = client.radar_search(options)
+
+      expect(places).to be_a Array
+    end
+  end
+end

data/spec/lib/lieu/client_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Lieu::Client do
+  describe 'module configuration' do
+    before do
+      Lieu.reset!
+
+      Lieu.configure do |config|
+        Lieu::Configuration::VALID_OPTIONS.each do |key|
+          config.send("#{key}=", "Some #{key}")
+        end
+      end
+    end
+
+    after { Lieu.reset! }
+
+    it "inherits the module configuration" do
+      client = Lieu::Client.new
+
+      Lieu::Configuration::VALID_OPTIONS.each do |key|
+        expect(client.instance_variable_get(:"@#{key}")).to eq "Some #{key}"
+      end
+    end
+  end
+
+  context 'with class level configuration' do
+    describe 'api_endpoint' do
+      it 'sets api_endpoint' do
+        client = Lieu::Client.new
+
+        expect(client.api_endpoint).
+          to eql 'https://maps.googleapis.com/maps/api/place/'
+      end
+
+      it 'overrides module configuration' do
+        client = Lieu::Client.new(api_endpoint: 'http://fuubar.com')
+
+        expect(client.api_endpoint).to eql 'http://fuubar.com'
+      end
+    end
+
+    describe 'api_key' do
+      it 'sets api_key'  do
+        client = Lieu::Client.new
+
+        expect(client.api_key).to be_nil
+      end
+
+      it 'overrides module configuration' do
+        client = Lieu::Client.new(api_key: 'randomkey')
+
+        expect(client.api_key).to eql 'randomkey'
+      end
+    end
+
+    describe 'sensor' do
+      it 'sets sensor'  do
+        client = Lieu::Client.new
+
+        expect(client.sensor).to be_false
+      end
+
+      it 'overrides module configuration' do
+        client = Lieu::Client.new(sensor: true)
+
+        expect(client.sensor).to be_true
+      end
+    end
+  end
+end

data/spec/lib/lieu/request_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Lieu::Request do
+  it_behaves_like 'an error', 'INVALID_REQUEST'
+  it_behaves_like 'an error', 'REQUEST_DENIED'
+  it_behaves_like 'an error', 'NOT_FOUND'
+  it_behaves_like 'an error', 'UNKNOWN_ERROR'
+  it_behaves_like 'an error', 'ZERO_RESULTS'
+  it_behaves_like 'an error', 'OVER_QUERY_LIMIT'
+
+  it_behaves_like 'a http error', 400, Lieu::InvalidRequest
+  it_behaves_like 'a http error', 403, Lieu::OverQueryLimit
+
+  context 'given a GET request' do
+    context 'with options', :vcr do
+      before { client.get('fuubar', language: 'fr') }
+
+      it 'sets options as url parameters' do
+        a_request(:get, google_places_url('fuubar')).
+          with(query: { 'language' => 'fr' }).should have_been_made
+      end
+    end
+  end
+
+  context 'given a POST request' do
+    context 'with options', :vcr do
+      before { client.post('fuubar', test: 'toto') }
+
+      it 'sets options as body parameters' do
+        a_request(:post, google_places_url('fuubar')).
+          with(body: { test: 'toto' }.to_json).should have_been_made
+      end
+    end
+  end
+end

data/spec/lib/lieu_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Lieu do
+  describe '.respond_to?' do
+    context 'with an existing Lieu method' do
+      it 'responds to method' do
+        expect(Lieu.respond_to?(:new, true)).to be_true
+      end
+    end
+
+    context 'with an existing Lieu::Client method' do
+      it 'responds to method' do
+        expect(Lieu.respond_to?(:get, true)).to be_true
+      end
+
+      it 'delegates to Lieu::Client' do
+        Lieu::Client.stub_chain(:new, :get).and_return(true)
+
+        expect(Lieu::Client).to receive(:new).ordered
+        expect(Lieu::Client).to receive(:new).ordered
+
+        Lieu.get('fuubar')
+      end
+    end
+  end
+
+  describe '.new' do
+    it 'returns a Lieu::Client' do
+      expect(Lieu.new).to be_a Lieu::Client
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'lib/lieu/response'
+end
+
+require 'rspec'
+require 'vcr'
+require 'json'
+require 'webmock/rspec'
+require 'lieu'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+WebMock.disable_net_connect!(allow: 'coveralls.io')
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('<API_KEY>') do
+    test_api_key
+  end
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+def stub_get(url)
+  stub_request(:get, google_places_url(url))
+end
+
+def stub_post(url)
+  stub_request(:post, google_places_url(url))
+end
+
+def google_places_url(url)
+  "https://maps.googleapis.com/maps/api/place/#{url}/json?key=#{test_api_key}&sensor=false"
+end
+
+def place_reference
+  'CmRYAAAAciqGsTRX1mXRvuXSH2ErwW-jCINE1aLiwP64MCWDN5vkXvXoQGPKldMfmdGyqWS'\
+    'pm7BEYCgDm-iv7Kc2PF7QA7brMAwBbAcqMr5i1f4PwTpaovIZjysCEZTry8Ez30wpEhCN'\
+    'CXpynextCld2EBsDkRKsGhSLayuRyFsex6JA6NPh9dyupoTH3g'
+end
+
+def json_content_type
+  { 'Content-type' => 'application/json' }
+end
+
+def test_api_key
+  ENV.fetch('GOOGLE_PLACES_API_KEY', 'test_api_key')
+end
+
+def client
+  Lieu.new(api_key: test_api_key)
+end

data/spec/support/shared_examples/error.rb

@@ -0,0 +1,33 @@
+shared_examples 'an error' do |error|
+  error_class_name = error.split(/_/).map{ |word| word.capitalize }.join('')
+  exception = Lieu.const_get(error_class_name)
+
+  it "raising #{exception.name} when status is #{error}" do
+    VCR.turn_off!
+
+    endpoint = 'bigboombadaboum'
+
+    stub_get(endpoint).to_return(
+      body: { status: error }.to_json,
+      headers: json_content_type
+    )
+
+    expect { client.get(endpoint) }.to raise_error exception
+
+    VCR.turn_on!
+  end
+end
+
+shared_examples 'a http error' do |status_code, exception|
+  it "raising #{exception.name} when http status code is #{status_code}" do
+    VCR.turn_off!
+
+    endpoint = 'bigboombadaboum'
+
+    stub_get(endpoint).to_return(status: status_code)
+
+    expect { client.get(endpoint) }.to raise_error exception
+
+    VCR.turn_on!
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: lieu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aylic Petit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Simple Ruby wrapper for the Google places API.
+email:
+- sush@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- CONTRIBUTING.md
+- Rakefile
+- lieu.gemspec
+- spec/lib/lieu/client/actions_spec.rb
+- spec/lib/lieu/client/autocomplete_spec.rb
+- spec/lib/lieu/client/details_spec.rb
+- spec/lib/lieu/client/photo_spec.rb
+- spec/lib/lieu/client/query_autocomplete_spec.rb
+- spec/lib/lieu/client/search_spec.rb
+- spec/lib/lieu/client_spec.rb
+- spec/lib/lieu/request_spec.rb
+- spec/lib/lieu_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/error.rb
+- lib/lieu/client/actions.rb
+- lib/lieu/client/autocomplete.rb
+- lib/lieu/client/details.rb
+- lib/lieu/client/photos.rb
+- lib/lieu/client/query_autocomplete.rb
+- lib/lieu/client/search.rb
+- lib/lieu/client.rb
+- lib/lieu/configuration.rb
+- lib/lieu/connection.rb
+- lib/lieu/error.rb
+- lib/lieu/request.rb
+- lib/lieu/response/raise_error.rb
+- lib/lieu/version.rb
+- lib/lieu.rb
+- spec/cassettes/Lieu_Client_Actions/_event_details/returns_an_event_details.yml
+- spec/cassettes/Lieu_Client_Autocomplete/_autocomplete/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Details/_details/returns_a_place_details.yml
+- spec/cassettes/Lieu_Client_Photos/_photo/returns_a_photo_image.yml
+- spec/cassettes/Lieu_Client_QueryAutocomplete/_query_autocomplete/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_nearby_search/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_radarsearch/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_textsearch/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Request/given_a_GET_request/with_options/sets_options_as_url_parameters.yml
+- spec/cassettes/Lieu_Request/given_a_POST_request/with_options/sets_options_as_body_parameters.yml
+homepage: https://github.com/sush/lieu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.0
+signing_key: 
+specification_version: 4
+summary: Google Places API Ruby wrapper
+test_files:
+- spec/cassettes/Lieu_Client_Actions/_event_details/returns_an_event_details.yml
+- spec/cassettes/Lieu_Client_Autocomplete/_autocomplete/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Details/_details/returns_a_place_details.yml
+- spec/cassettes/Lieu_Client_Photos/_photo/returns_a_photo_image.yml
+- spec/cassettes/Lieu_Client_QueryAutocomplete/_query_autocomplete/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_nearby_search/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_radarsearch/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Client_Search/_textsearch/returns_an_array_of_places.yml
+- spec/cassettes/Lieu_Request/given_a_GET_request/with_options/sets_options_as_url_parameters.yml
+- spec/cassettes/Lieu_Request/given_a_POST_request/with_options/sets_options_as_body_parameters.yml
+- spec/lib/lieu/client/actions_spec.rb
+- spec/lib/lieu/client/autocomplete_spec.rb
+- spec/lib/lieu/client/details_spec.rb
+- spec/lib/lieu/client/photo_spec.rb
+- spec/lib/lieu/client/query_autocomplete_spec.rb
+- spec/lib/lieu/client/search_spec.rb
+- spec/lib/lieu/client_spec.rb
+- spec/lib/lieu/request_spec.rb
+- spec/lib/lieu_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/error.rb
+has_rdoc: