google_maps_geocoder 0.3.1 → 0.4.0.pre1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2IzNjAyZDM5YWVlOWM3YjM0NTQ0Yjk4ZWU3NWNiYjk2NDBiOTliYw==
-  data.tar.gz: !binary |-
-    NDA3NGI5YmFkZmQ3ZmI1NjExOTU4N2UwOTMyZGU5M2Q0N2RhMTJmMw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZGFiNmM3MDg0Y2FmZDMwMjBiOTFkOTA5MmQ5NTU1ZGQ1NWMxMjgxMDJmODVm
-    Y2ExNTIwZGY4M2ZiZDIwYmRhYmZlY2M4NGNmNDY4OWJjYmZkODA2Y2NlY2M5
-    ZDAzZmY2YThmYzhjZTM3MmZmOWEyY2M1ZWJlODQ4MGE0N2YyYjQ=
-  data.tar.gz: !binary |-
-    ZDNhMzgyOWQzODE5NDk1NDdlZGQ5MzZlZTRjNTYxNzMyMTIzNDcyMTg3Nzgw
-    NjMyNjI2ZTFhOGY2YmVlYjA2N2Y3Y2NjNDhjMmFhZDhiZTgzOTZhN2RjMzE0
-    NDhlMDdhYmRiNGNhMmE1YjJhMDU0NWU3ZDQyMWUxMWQzMjM2OTA=
+SHA1:
+  metadata.gz: 843c384bc9a07abcd15c8d310bced7b1fc80c979
+  data.tar.gz: 3336c894ba548664bcfb7f5b2ef91aed785fff21
+SHA512:
+  metadata.gz: fe1386c06d1bfedea6c5be18de70bd95455cda8778615f918d21bc7991ec197c5aee9bd8525bea23b520b8c00cd734c9a42aad68d5331277623eedb25569928f
+  data.tar.gz: 105330f683835366620945bc14dd2b2118f9f3bc07a1d97f8445f5660152a919ec565c23196c1bf842b1c89ceb6f53e65f55af8f207780c7bcf7b8cdd1963fbd

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3-p385
+2.2.2

data/.travis.yml

@@ -1,3 +1,6 @@
+sudo: false
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.0.0
+script:
+  - bundle exec rake
+  - bundle exec rubocop

data/Gemfile

@@ -1,2 +1,2 @@
 source 'http://rubygems.org'
-gemspec
+gemspec

data/README.md

@@ -1,25 +1,25 @@
-# GoogleMapsGeocoder [![Code Climate](https://codeclimate.com/github/ivanoblomov/google_maps_geocoder.png)](https://codeclimate.com/github/ivanoblomov/google_maps_geocoder) [![Build Status](https://secure.travis-ci.org/ivanoblomov/google_maps_geocoder.png)](http://travis-ci.org/ivanoblomov/google_maps_geocoder) [![Dependency Status](https://gemnasium.com/ivanoblomov/google_maps_geocoder.png)](https://gemnasium.com/ivanoblomov/google_maps_geocoder)
+# GoogleMapsGeocoder
+
+[![Gem Version](https://badge.fury.io/rb/google_maps_geocoder.svg)](http://badge.fury.io/rb/google_maps_geocoder)
+[![Code Climate](https://codeclimate.com/github/ivanoblomov/google_maps_geocoder.png)](https://codeclimate.com/github/ivanoblomov/google_maps_geocoder)
+[![Coverage Status](https://coveralls.io/repos/ivanoblomov/google_maps_geocoder/badge.svg?branch=master&service=github)](https://coveralls.io/github/ivanoblomov/google_maps_geocoder?branch=master)
+[![Build Status](https://secure.travis-ci.org/ivanoblomov/google_maps_geocoder.png)](http://travis-ci.org/ivanoblomov/google_maps_geocoder)
+[![Dependency Status](https://gemnasium.com/ivanoblomov/google_maps_geocoder.png)](https://gemnasium.com/ivanoblomov/google_maps_geocoder)
 
 A simple PORO wrapper for geocoding with Google Maps.
 
 ## Installation
 
-In <b>Rails 3</b>, add this to your Gemfile and run "bundle":
+Add GoogleMapsGeocoder to your Gemfile and run `bundle`:
 
 ```ruby
   gem 'google_maps_geocoder'
 ```
 
-In <b>Rails 2</b>, add this to your environment.rb file:
-
-```ruby
-  config.gem 'google_maps_geocoder'
-```
-
-Or try it out in <b>irb</b> with:
+Or try it out in `irb` with:
 
 ```ruby
-  require './lib/google_maps_geocoder'
+  require './lib/google_maps_geocoder/google_maps_geocoder'
 ```
 
 ## Ready to Go in One Step
@@ -76,6 +76,14 @@ The complete, hopefully self-explanatory, API is:
 * state_long_name
 * state_short_name
 
+## Google Maps API Key (Optional)
+
+To have GoogleMapsGeocoder use your Google Maps API key, set it as an environment variable:
+
+```bash
+export GOOGLE_MAPS_API_KEY=[your key]
+```
+
 ## Contributing to google_maps_geocoder
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/Rakefile

@@ -5,4 +5,4 @@ RSpec::Core::RakeTask.new(:test) do |t|
   t.pattern = 'spec/*/*_spec.rb'
   t.verbose = false
 end
-task :default => :test
+task default: :test

data/google_maps_geocoder.gemspec

@@ -1,21 +1,25 @@
-require File.expand_path '../lib/version', __FILE__
+require File.expand_path '../lib/google_maps_geocoder/version', __FILE__
 Gem::Specification.new do |s|
-  s.name = "google_maps_geocoder"
+  s.name = 'google_maps_geocoder'
   s.version = GoogleMapsGeocoder::VERSION.dup
-  s.summary = "A simple PORO wrapper for geocoding with Google Maps."
-  s.description = "Geocode a location without worrying about parsing Google Maps' response. GoogleMapsGeocoder wraps it in a plain-old Ruby object."
-  s.homepage = "http://github.com/ivanoblomov/google_maps_geocoder"
-  s.authors = ["Roderick Monje"]
+  s.summary = 'A simple PORO wrapper for geocoding with Google Maps.'
+  s.description = 'Geocode a location without worrying about parsing Google '\
+                  "Maps' response. GoogleMapsGeocoder wraps it in a plain-old "\
+                  'Ruby object.'
+  s.homepage = 'http://github.com/ivanoblomov/google_maps_geocoder'
+  s.authors = ['Roderick Monje']
 
+  s.add_development_dependency 'coveralls', '>= 0'
   s.add_development_dependency 'rake', '>= 0'
   s.add_development_dependency 'rspec', '>= 0'
-  s.add_development_dependency 'simplecov', '>= 0'
+  s.add_development_dependency 'rubocop', '>= 0'
 
   s.add_runtime_dependency 'activesupport', '>= 0'
   s.add_runtime_dependency 'rack', '>= 0'
 
-  s.files         = `git ls-files`.split "\n"
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split "\n"
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename f}
-  s.require_paths = ["lib"]
-end
+  s.files       = `git ls-files`.split "\n"
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split "\n"
+  s.executables = `git ls-files -- bin/*`.split("\n")
+    .map { |f| File.basename f }
+  s.require_paths = ['lib']
+end

data/lib/{google_maps_geocoder.rb → google_maps_geocoder/google_maps_geocoder.rb}

@@ -3,15 +3,28 @@ require 'logger'
 require 'net/http'
 require 'rack'
 
+# A simple PORO wrapper for geocoding with Google Maps.
 class GoogleMapsGeocoder
+  GOOGLE_ADDRESS_SEGMENTS = %i(
+    city country_long_name country_short_name county lat lng postal_code
+    state_long_name state_short_name
+  ).freeze
+  GOOGLE_API_URI = 'https://maps.googleapis.com/maps/api/geocode/json'.freeze
+
+  ALL_ADDRESS_SEGMENTS = (
+    GOOGLE_ADDRESS_SEGMENTS + %i(
+      formatted_address formatted_street_address
+    )
+  ).freeze
+
   # Returns the complete formatted address with standardized abbreviations.
   attr_reader :formatted_address
   # Returns the formatted street address with standardized abbreviations.
   attr_reader :formatted_street_address
   # Self-explanatory
-  attr_reader :city, :country_long_name, :country_short_name, :county, :lat, :lng, :postal_code, :state_long_name, :state_short_name
+  attr_reader(*GOOGLE_ADDRESS_SEGMENTS)
 
-  # Instance Methods: Overrides ====================================================================
+  # Instance Methods: Overrides ================================================
 
   # Geocodes the specified address and wraps the results in a geocoder object.
   #
@@ -23,16 +36,19 @@ class GoogleMapsGeocoder
   #
   #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
   #    white_house.formatted_address
-  #     => "1600 Pennsylvania Avenue Northwest, President's Park, Washington, DC 20500, USA"
-  def initialize data
+  #     => "1600 Pennsylvania Avenue Northwest, President's Park,
+  #         Washington, DC 20500, USA"
+  def initialize(data)
     @json = data.is_a?(String) ? json_from_url(data) : data
-		raise "Geocoding \"#{data}\" exceeded query limit! Google returned...\n#{@json.inspect}" if @json.blank? || @json['status'] != 'OK'
+    fail "Geocoding \"#{data}\" exceeded query limit! Google returned...\n"\
+         "#{@json.inspect}" if @json.blank? || @json['status'] != 'OK'
     set_attributes_from_json
-    logger = Logger.new STDERR
-    logger.info('GoogleMapsGeocoder') { "Geocoded \"#{data}\" => \"#{self.formatted_address}\"" }
+    logger.info('GoogleMapsGeocoder') do
+      "Geocoded \"#{data}\" => \"#{formatted_address}\""
+    end
   end
 
-  # Instance Methods ===============================================================================
+  # Instance Methods ===========================================================
 
   # Returns true if the address Google returns is an exact match.
   #
@@ -42,7 +58,7 @@ class GoogleMapsGeocoder
   #    white_house.exact_match?
   #     => true
   def exact_match?
-    ! self.partial_match?
+    !self.partial_match?
   end
 
   # Returns true if the address Google returns isn't an exact match.
@@ -58,18 +74,39 @@ class GoogleMapsGeocoder
 
   private
 
-  def json_from_url url
-    response = Net::HTTP.get_response(URI.parse "http://maps.googleapis.com/maps/api/geocode/json?address=#{Rack::Utils.escape(url)}&sensor=false")
+  def api_key
+    @api_key ||= "&key=#{ENV['GOOGLE_MAPS_API_KEY']}" if
+      ENV['GOOGLE_MAPS_API_KEY']
+  end
+
+  def http(uri)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http
+  end
+
+  def json_from_url(url)
+    uri = URI.parse query_url(url)
+    logger.debug('GoogleMapsGeocoder') { uri }
+    response = http(uri).request(Net::HTTP::Get.new(uri.request_uri))
     ActiveSupport::JSON.decode response.body
   end
 
-  def parse_address_component_type(type, name='long_name')
-    _address_component = @json['results'][0]['address_components'].detect{ |ac| ac['types'] && ac['types'].include?(type) }
-    _address_component && _address_component[name]
+  def logger
+    @logger ||= Logger.new STDERR
+  end
+
+  def parse_address_component_type(type, name = 'long_name')
+    address_component = @json['results'][0]['address_components'].detect do |ac|
+      ac['types'] && ac['types'].include?(type)
+    end
+    address_component && address_component[name]
   end
 
   def parse_city
-    parse_address_component_type('sublocality') || parse_address_component_type('locality')
+    parse_address_component_type('sublocality') ||
+      parse_address_component_type('locality')
   end
 
   def parse_country_long_name
@@ -89,7 +126,8 @@ class GoogleMapsGeocoder
   end
 
   def parse_formatted_street_address
-    "#{parse_address_component_type('street_number')} #{parse_address_component_type('route')}"
+    "#{parse_address_component_type('street_number')} "\
+    "#{parse_address_component_type('route')}"
   end
 
   def parse_lat
@@ -98,7 +136,7 @@ class GoogleMapsGeocoder
 
   def parse_lng
     @json['results'][0]['geometry']['location']['lng']
- end
+  end
 
   def parse_postal_code
     parse_address_component_type('postal_code')
@@ -112,7 +150,14 @@ class GoogleMapsGeocoder
     parse_address_component_type('administrative_area_level_1', 'short_name')
   end
 
+  def query_url(query)
+    "#{GOOGLE_API_URI}?address=#{Rack::Utils.escape query}&sensor=false"\
+    "#{api_key}"
+  end
+
   def set_attributes_from_json
-    @city, @country_short_name, @country_long_name, @county, @formatted_address, @formatted_street_address, @lat, @lng, @postal_code, @state_long_name, @state_short_name = parse_city, parse_country_short_name, parse_country_long_name, parse_county, parse_formatted_address, parse_formatted_street_address, parse_lat, parse_lng, parse_postal_code, parse_state_long_name, parse_state_short_name
+    ALL_ADDRESS_SEGMENTS.each do |segment|
+      instance_variable_set :"@#{segment}", send("parse_#{segment}")
+    end
   end
-end
+end

data/lib/google_maps_geocoder/version.rb

@@ -0,0 +1,4 @@
+# A simple PORO wrapper for geocoding with Google Maps.
+class GoogleMapsGeocoder
+  VERSION = '0.4.0.pre1'.freeze unless defined?(GoogleMapsGeocoder::VERSION)
+end

data/spec/lib/google_maps_geocoder_spec.rb

@@ -13,8 +13,8 @@ describe GoogleMapsGeocoder do
   end
 
   before(:each) do
-    pending 'waiting for a network connection', :if => @no_network
-    pending 'waiting for query limit to pass',  :if => @query_limit
+    pending 'waiting for a network connection' if @no_network
+    pending 'waiting for query limit to pass' if @query_limit
   end
 
   context 'with "837 Union Street Brooklyn NY"' do
@@ -24,13 +24,16 @@ describe GoogleMapsGeocoder do
     context 'address' do
       it { expect(subject.formatted_street_address).to eq '837 Union Street' }
       it { expect(subject.city).to eq 'Brooklyn' }
-      it { expect(subject.county).to match /Kings/ }
+      it { expect(subject.county).to match(/Kings/) }
       it { expect(subject.state_long_name).to eq 'New York' }
       it { expect(subject.state_short_name).to eq 'NY' }
-      it { expect(subject.postal_code).to match /112[0-9]{2}/ }
+      it { expect(subject.postal_code).to match(/112[0-9]{2}/) }
       it { expect(subject.country_short_name).to eq 'US' }
       it { expect(subject.country_long_name).to eq 'United States' }
-      it { expect(subject.formatted_address).to match /837 Union Street, Brooklyn, NY 112[0-9]{2}, USA/ }
+      it do
+        expect(subject.formatted_address)
+          .to match(/837 Union St, Brooklyn, NY 112[0-9]{2}, USA/)
+      end
     end
 
     context 'coordinates' do
@@ -44,19 +47,38 @@ describe GoogleMapsGeocoder do
     it { should be_partial_match }
 
     context 'address' do
-      it { expect(subject.formatted_street_address).to eq '1600 Pennsylvania Avenue Northwest' }
+      it do
+        expect(subject.formatted_street_address)
+          .to eq '1600 Pennsylvania Avenue Southeast'
+      end
       it { expect(subject.city).to eq 'Washington' }
       it { expect(subject.state_long_name).to eq 'District of Columbia' }
       it { expect(subject.state_short_name).to eq 'DC' }
-      it { expect(subject.postal_code).to match /2050[0-9]/ }
+      it { expect(subject.postal_code).to match(/2000[0-9]/) }
       it { expect(subject.country_short_name).to eq 'US' }
       it { expect(subject.country_long_name).to eq 'United States' }
-      it { expect(subject.formatted_address).to match(/1600 Pennsylvania Avenue Northwest, President's Park, Washington, DC 2050[0-9], USA/) }
-   end
+      it do
+        expect(subject.formatted_address)
+          .to match(/1600 Pennsylvania Ave SE, Washington, DC 20003, USA/)
+      end
+    end
+
+    context 'coordinates' do
+      it { expect(subject.lat).to be_within(0.005).of(38.8791981) }
+      it { expect(subject.lng).to be_within(0.005).of(-76.9818437) }
+    end
+  end
 
-   context 'coordinates' do
-      it { expect(subject.lat).to be_within(0.005).of(38.8976964) }
-      it { expect(subject.lng).to be_within(0.005).of(-77.0365191) }
-   end
+  context "when ENV['GOOGLE_MAPS_API_KEY'] = 'INVALID_KEY'" do
+    before { ENV['GOOGLE_MAPS_API_KEY'] = 'INVALID_KEY' }
+
+    subject { @exact_match }
+
+    it do
+      expect(subject.send :query_url, nil).to eq(
+        'https://maps.googleapis.com/maps/api/geocode/json?address='\
+        '&sensor=false&key=INVALID_KEY'
+      )
+    end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,14 @@
-require 'simplecov'
-SimpleCov.start
+require 'coveralls'
+Coveralls.wear!
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'google_maps_geocoder'
+require 'google_maps_geocoder/google_maps_geocoder'

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_geocoder
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0.pre1
 platform: ruby
 authors:
 - Roderick Monje
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Geocode a location without worrying about parsing Google Maps' response.
@@ -87,17 +101,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - google_maps_geocoder.gemspec
-- lib/google_maps_geocoder.rb
-- lib/version.rb
+- lib/google_maps_geocoder/google_maps_geocoder.rb
+- lib/google_maps_geocoder/version.rb
 - spec/lib/google_maps_geocoder_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ivanoblomov/google_maps_geocoder
@@ -109,17 +123,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A simple PORO wrapper for geocoding with Google Maps.

data/lib/version.rb

@@ -1,3 +0,0 @@
-class GoogleMapsGeocoder
-  VERSION = '0.3.1'.freeze unless defined?(GoogleMapsGeocoder::VERSION)
-end