google_maps_geocoder 0.4.0.pre1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843c384bc9a07abcd15c8d310bced7b1fc80c979
-  data.tar.gz: 3336c894ba548664bcfb7f5b2ef91aed785fff21
+  metadata.gz: 060caf858407bc718955028bc0edc35a518b2f63
+  data.tar.gz: 616a78c20c6ff0926380a413b51094fe8b824bf1
 SHA512:
-  metadata.gz: fe1386c06d1bfedea6c5be18de70bd95455cda8778615f918d21bc7991ec197c5aee9bd8525bea23b520b8c00cd734c9a42aad68d5331277623eedb25569928f
-  data.tar.gz: 105330f683835366620945bc14dd2b2118f9f3bc07a1d97f8445f5660152a919ec565c23196c1bf842b1c89ceb6f53e65f55af8f207780c7bcf7b8cdd1963fbd
+  metadata.gz: 6aebec357d9d33fbba4586cc7c09cceebcd3d159ecc7cd648b1548e6f80810838208f486fba1c526b81e73c40d30eb7e9cffed58912a8d1c1462aa6977d961a2
+  data.tar.gz: a624fd613c2c84ed5641186c1549135760d545976c4f83e12fce3c05322bdc24e7be9929e3f96020bc19f42608992af2de6d5035e23e070f6e9102bba9705017

data/README.md

@@ -1,12 +1,13 @@
 # GoogleMapsGeocoder
 
-[![Gem Version](https://badge.fury.io/rb/google_maps_geocoder.svg)](http://badge.fury.io/rb/google_maps_geocoder)
+[![Build Status](https://secure.travis-ci.org/ivanoblomov/google_maps_geocoder.png)](http://travis-ci.org/ivanoblomov/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)
+[![Inch CI](https://inch-ci.org/github/Ivanoblomov/google_maps_geocoder.svg?branch=master&style=flat)](https://inch-ci.org/github/Ivanoblomov/google_maps_geocoder)
+[![Gem Version](https://badge.fury.io/rb/google_maps_geocoder.svg)](http://badge.fury.io/rb/google_maps_geocoder)
 
-A simple PORO wrapper for geocoding with Google Maps.
+A simple Plain Old Ruby Object wrapper for geocoding with Google Maps.
 
 ## Installation
 
@@ -62,19 +63,19 @@ chez_barack.state_short_name
 
 The complete, hopefully self-explanatory, API is:
 
-* city
-* country_long_name
-* country_short_name
-* county
-* exact_match?
-* formatted_address
-* formatted_street_address
-* lat
-* lng
-* partial_match?
-* postal_code
-* state_long_name
-* state_short_name
+* `GoogleMapsGeocoder#city`
+* `GoogleMapsGeocoder#country_long_name`
+* `GoogleMapsGeocoder#country_short_name`
+* `GoogleMapsGeocoder#county`
+* `GoogleMapsGeocoder#exact_match?`
+* `GoogleMapsGeocoder#formatted_address`
+* `GoogleMapsGeocoder#formatted_street_address`
+* `GoogleMapsGeocoder#lat`
+* `GoogleMapsGeocoder#lng`
+* `GoogleMapsGeocoder#partial_match?`
+* `GoogleMapsGeocoder#postal_code`
+* `GoogleMapsGeocoder#state_long_name`
+* `GoogleMapsGeocoder#state_short_name`
 
 ## Google Maps API Key (Optional)
 

data/google_maps_geocoder.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.homepage = 'http://github.com/ivanoblomov/google_maps_geocoder'
   s.authors = ['Roderick Monje']
 
+  s.add_development_dependency 'codeclimate-test-reporter', '>= 0'
   s.add_development_dependency 'coveralls', '>= 0'
   s.add_development_dependency 'rake', '>= 0'
   s.add_development_dependency 'rspec', '>= 0'
@@ -20,6 +21,6 @@ Gem::Specification.new do |s|
   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 }
+                                         .map { |f| File.basename f }
   s.require_paths = ['lib']
 end

data/lib/google_maps_geocoder/google_maps_geocoder.rb

@@ -1,10 +1,43 @@
 require 'active_support'
+require 'active_support/core_ext/string/inflections'
 require 'logger'
 require 'net/http'
 require 'rack'
 
 # A simple PORO wrapper for geocoding with Google Maps.
+#
+# @example
+#   chez_barack = GoogleMapsGeocoder.new '1600 Pennsylvania Ave'
+#   chez_barack.formatted_address
+#     => "1600 Pennsylvania Avenue Northwest, President's Park,
+#         Washington, DC 20500, USA"
+# rubocop:disable Metrics/ClassLength
 class GoogleMapsGeocoder
+  # Error handling for google statuses
+  class GeocodingError < StandardError
+    def initialize(response_json = '')
+      @json = response_json
+      super
+    end
+
+    def message
+      "Google returned:\n#{@json.inspect}"
+    end
+  end
+
+  class ZeroResultsError < GeocodingError; end
+  class QueryLimitError < GeocodingError; end
+  class RequestDeniedError < GeocodingError; end
+  class InvalidRequestError < GeocodingError; end
+  class UnknownError < GeocodingError; end
+
+  ERROR_STATUSES = { zero_results: 'ZERO_RESULTS',
+                     query_limit: 'OVER_QUERY_LIMIT',
+                     request_denied: 'REQUEST_DENIED',
+                     invalid_request: 'INVALID_REQUEST',
+                     unknown: 'UNKNOWN_ERROR'
+                   }.freeze
+
   GOOGLE_ADDRESS_SEGMENTS = %i(
     city country_long_name country_short_name county lat lng postal_code
     state_long_name state_short_name
@@ -18,60 +51,65 @@ class GoogleMapsGeocoder
   ).freeze
 
   # Returns the complete formatted address with standardized abbreviations.
+  #
+  # @return [String] the complete formatted address
+  # @example
+  #   chez_barack.formatted_address
+  #     => "1600 Pennsylvania Avenue Northwest, President's Park,
+  #         Washington, DC 20500, USA"
   attr_reader :formatted_address
+
   # Returns the formatted street address with standardized abbreviations.
+  #
+  # @return [String] the formatted street address
+  # @example
+  #   chez_barack.formatted_street_address
+  #     => "1600 Pennsylvania Avenue"
   attr_reader :formatted_street_address
   # Self-explanatory
   attr_reader(*GOOGLE_ADDRESS_SEGMENTS)
 
-  # Instance Methods: Overrides ================================================
-
-  # Geocodes the specified address and wraps the results in a geocoder object.
-  #
-  # ==== Attributes
-  #
-  # * +data+ - a geocodable address
+  # Geocodes the specified address and wraps the results in a GoogleMapsGeocoder
+  # object.
   #
-  # ==== Examples
-  #
-  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
-  #    white_house.formatted_address
-  #     => "1600 Pennsylvania Avenue Northwest, President's Park,
-  #         Washington, DC 20500, USA"
+  # @param data [String] a geocodable address
+  # @return [GoogleMapsGeocoder] the Google Maps result for the specified
+  #   address
+  # @example
+  #   chez_barack = GoogleMapsGeocoder.new '1600 Pennsylvania Ave'
   def initialize(data)
     @json = data.is_a?(String) ? json_from_url(data) : data
-    fail "Geocoding \"#{data}\" exceeded query limit! Google returned...\n"\
-         "#{@json.inspect}" if @json.blank? || @json['status'] != 'OK'
+    handle_error if @json.blank? || @json['status'] != 'OK'
     set_attributes_from_json
     logger.info('GoogleMapsGeocoder') do
       "Geocoded \"#{data}\" => \"#{formatted_address}\""
     end
   end
 
-  # Instance Methods ===========================================================
-
   # Returns true if the address Google returns is an exact match.
   #
-  # ==== Examples
-  #
-  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Ave')
-  #    white_house.exact_match?
+  # @return [boolean] whether the Google Maps result is an exact match
+  # @example
+  #   chez_barack.exact_match?
   #     => true
   def exact_match?
-    !self.partial_match?
+    !partial_match?
   end
 
   # Returns true if the address Google returns isn't an exact match.
   #
-  # ==== Examples
-  #
-  #    white_house = GoogleMapsGeocoder.new('1600 Pennsylvania Washington')
-  #    white_house.exact_match?
-  #     => false
+  # @return [boolean] whether the Google Maps result is a partial match
+  # @example
+  #   GoogleMapsGeocoder.new('1600 Pennsylvania Washington').partial_match?
+  #     => true
   def partial_match?
     @json['results'][0]['partial_match'] == true
   end
 
+  def self.error_class_name(key)
+    "google_maps_geocoder/#{key}_error".classify.constantize
+  end
+
   private
 
   def api_key
@@ -88,11 +126,23 @@ class GoogleMapsGeocoder
 
   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 handle_error
+    status = @json['status']
+    message = GeocodingError.new(@json).message
+
+    # for status codes see https://developers.google.com/maps/documentation/geocoding/intro#StatusCodes
+    ERROR_STATUSES.each do |key, value|
+      raise GoogleMapsGeocoder.error_class_name(key), message if status == value
+    end
+  end
+
   def logger
     @logger ||= Logger.new STDERR
   end

data/lib/google_maps_geocoder/version.rb

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

data/spec/lib/google_maps_geocoder_spec.rb

@@ -75,10 +75,24 @@ describe GoogleMapsGeocoder do
     subject { @exact_match }
 
     it do
-      expect(subject.send :query_url, nil).to eq(
+      expect(subject.send(:query_url, nil)).to eq(
         'https://maps.googleapis.com/maps/api/geocode/json?address='\
         '&sensor=false&key=INVALID_KEY'
       )
     end
   end
+
+  context 'with google returns empty results' do
+    let(:results_hash) { { 'results' => [] } }
+
+    GoogleMapsGeocoder::ERROR_STATUSES.each do |key, value|
+      it "raises #{key} error" do
+        allow_any_instance_of(GoogleMapsGeocoder).to receive(:json_from_url)\
+          .and_return results_hash.merge('status' => value)
+
+        expect { GoogleMapsGeocoder.new('anything') }.to \
+          raise_error(GoogleMapsGeocoder.error_class_name(key))
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 require 'coveralls'
 Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  CodeClimate::TestReporter::Formatter,
+  Coveralls::SimpleCov::Formatter
+]
 require 'rubygems'
 require 'bundler'
 begin

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_geocoder
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre1
+  version: 0.5.0
 platform: ruby
 authors:
 - Roderick Monje
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -128,12 +142,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple PORO wrapper for geocoding with Google Maps.