nominatim 0.0.1

data/spec/nominatim/search_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe Nominatim::Search do
+
+  let(:search) { Nominatim::Search.new }
+
+  it 'has no criteria set' do
+    search.criteria.should be_empty
+  end
+
+  it 'allows chaining of criterions' do
+    search.query('Los Angeles').limit(1)
+    search.criteria[:q].should eq 'Los Angeles'
+    search.criteria[:limit].should eq 1
+  end
+
+  describe '#each' do
+
+    let(:search) { Nominatim::Search.new.query('Los Angeles').limit(1) }
+
+    before do
+      stub_get('/search').
+        with(query: { q: 'Los Angeles', limit: 1 }).
+        to_return(body: fixture('search.json'))
+    end
+
+    it 'iterates over the matching places' do
+      search.each do |place|
+        place.should be_a Nominatim::Place
+      end
+    end
+
+    it 'returns all matching places' do
+      search.count.should eq 1
+    end
+
+    it 'returns correct places' do
+      search.first.display_name.should eq 'Los Angeles, California, United States of America'
+      search.first.lat.should eq '34.0966764'
+      search.first.lon.should eq '-117.7196785'
+    end
+  end
+
+  describe '#query' do
+    it 'adds a query criterion' do
+      search.query('Los Angeles')
+      search.criteria[:q].should eq 'Los Angeles'
+    end
+  end
+
+  describe '#country_codes' do
+    it 'adds a country codes criterion' do
+      search.country_codes('us')
+      search.criteria[:countrycodes].should eq 'us'
+    end
+
+    it 'adds all country codes when set with an array' do
+      search.country_codes(['us', 'ca'])
+      search.criteria[:countrycodes].should eq 'us,ca'
+    end
+  end
+
+  describe '#viewbox' do
+    it 'adds a viewbox criterion' do
+      search.viewbox(["52.5487442016602", "-1.81651306152344", "52.5488510131836", "-1.81634628772736"])
+      search.criteria[:viewbox].should eq "52.5487442016602,-1.81651306152344,52.5488510131836,-1.81634628772736"
+    end
+  end
+
+  describe '#bounded' do
+    it 'adds a bounded criterion' do
+      search.bounded(true)
+      search.criteria[:bounded].should eq 1
+    end
+
+    it 'sets 1 when set with true' do
+      search.bounded(true)
+      search.criteria[:bounded].should eq 1
+    end
+
+    it 'sets 0 when set with false' do
+      search.bounded(false)
+      search.criteria[:bounded].should eq 0
+    end
+  end
+
+  describe '#polygon' do
+    it 'adds a polygon criterion' do
+      search.polygon(true)
+      search.criteria[:polygon].should eq 1
+    end
+
+    it 'sets 1 when set with true' do
+      search.polygon(true)
+      search.criteria[:polygon].should eq 1
+    end
+
+    it 'sets 0 when set with false' do
+      search.polygon(false)
+      search.criteria[:polygon].should eq 0
+    end
+  end
+
+  describe '#address_details' do
+    it 'adds an address details criterion' do
+      search.address_details(true)
+      search.criteria[:addressdetails].should eq 1
+    end
+
+    it 'sets 1 when set with true' do
+      search.address_details(true)
+      search.criteria[:addressdetails].should eq 1
+    end
+
+    it 'sets 0 when set with false' do
+      search.address_details(false)
+      search.criteria[:addressdetails].should eq 0
+    end
+  end
+
+  describe '#exclude_place_ids' do
+    it 'excludes given place ids' do
+      search.exclude_place_ids('1')
+      search.criteria[:exclude_place_ids].should eq '1'
+    end
+
+    it 'adds all place ids when set with an array' do
+      search.exclude_place_ids(['1', '2', '3'])
+      search.criteria[:exclude_place_ids].should eq '1,2,3'
+    end
+  end
+
+  describe '#limit' do
+    it 'adds a limit criterion' do
+      search.limit(1)
+      search.criteria[:limit].should eq 1
+    end
+  end
+
+end

data/spec/nominatim_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Nominatim do
+  describe '.search' do
+    it 'returns a Nominatim::Search' do
+      Nominatim.search.should be_a Nominatim::Search
+    end
+
+    it 'adds a query criterion if given as a parameter' do
+      search = Nominatim.search('San Francisco')
+      search.criteria[:q].should eq 'San Francisco'
+    end
+  end
+
+  describe '.configure' do
+
+    before do
+      Nominatim.config.reset!
+    end
+
+    it 'has a default endpoint' do
+      Nominatim.config.endpoint.should eq "http://nominatim.openstreetmap.org"
+    end
+
+    it 'sets the endpoint' do
+      Nominatim.configure do |config|
+        config.endpoint = "http://nominatim.org/"
+      end
+      Nominatim.config.endpoint.should eq "http://nominatim.org/"
+    end
+
+    it 'has a default user agent' do
+      Nominatim.config.user_agent.should eq "Nominatim Ruby Gem #{Nominatim::VERSION}"
+    end
+
+    it 'sets the user agent' do
+      Nominatim.configure do |config|
+        config.user_agent = "MyApp"
+      end
+      Nominatim.config.user_agent.should eq "MyApp"
+    end
+
+    it 'has a default email' do
+      Nominatim.config.email.should be_nil
+    end
+
+    it 'sets the email' do
+      Nominatim.configure do |config|
+        config.email = "foo@bar.com"
+      end
+      Nominatim.config.email.should eq "foo@bar.com"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'nominatim'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before do
+    Nominatim.config.reset!
+  end
+end
+
+def a_get(path)
+  a_request(:get, "#{Nominatim.config.endpoint}#{path}").with(query: { format: 'json' })
+end
+
+def stub_get(path)
+  stub_request(:get, "#{Nominatim.config.endpoint}#{path}").with(query: { format: 'json' })
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: nominatim
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jakub Svehla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Nominatim API.
+email:
+- jakub.svehla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nominatim.rb
+- lib/nominatim/address.rb
+- lib/nominatim/client.rb
+- lib/nominatim/configuration.rb
+- lib/nominatim/place.rb
+- lib/nominatim/response/parse_json.rb
+- lib/nominatim/search.rb
+- lib/nominatim/version.rb
+- nominatim.gemspec
+- spec/fixtures/search.json
+- spec/nominatim/address_spec.rb
+- spec/nominatim/client_spec.rb
+- spec/nominatim/place_spec.rb
+- spec/nominatim/search_spec.rb
+- spec/nominatim_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Nominatim API.
+test_files:
+- spec/fixtures/search.json
+- spec/nominatim/address_spec.rb
+- spec/nominatim/client_spec.rb
+- spec/nominatim/place_spec.rb
+- spec/nominatim/search_spec.rb
+- spec/nominatim_spec.rb
+- spec/spec_helper.rb
+has_rdoc: