gmaps_geocoding 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce042c8153814605f23987fa685e04e97d645c17
-  data.tar.gz: cb452da2de881780f2181980bff931b977e2e541
+  metadata.gz: 3b5e8f1bc785e0ddee97bdc381830b4a6b3d728c
+  data.tar.gz: b29c97b2bf0aec977373e9e32edf55603daf49b6
 SHA512:
-  metadata.gz: 0d95573f126ec6cfc5784b0d61f85b26b8c01930230f64b9fbe089c940b5b1f7faecf8aae77ab1ae90707433b3b6a07bcb21d5d323ab04c2a89c89cf4e7bde0a
-  data.tar.gz: 09e80b0f6b157c3b3a0f2d21a3a1326ce492c82e89a1f8a20c4ceaeb8ab9854547c6d0edd9bbfb4290d59cbd59a50d433545d51866024d32693582e652f3aafc
+  metadata.gz: 34b7bb966efb1ee1d27d35a50a00bb027844a183cf8de821c4299de00cae085df59f8ef905b4bbe4dc21593a48bd189e92b78b6d0fdb867a041197a71e43b700
+  data.tar.gz: c23de144517af7aca69d6d2aa787dc7cecb81905dbabd60c62643e888a607a9ed6203208ae955565e8d812af7eabae0effab5abc6368efb19890b3a281ec541c

data/.rubocop.yml

@@ -2,8 +2,8 @@
 
 Metrics/LineLength:
   Description: 'Limit lines to 310 characters.'
-  Enabled: true
-  Max: 310
+  Enabled: false
+  Max: 120
 
 Metrics/MethodLength:
   Description: 'Try to avoid methods longer than 50 lines of code.'

data/README.md

@@ -24,14 +24,19 @@ See [Google Maps Geocoding service documentation](https://developers.google.com/
 
 All options could be overriden with corresponding environment variable:
 
-* GOOGLE_MAPS_GEOCODING_OUTPUT
-* GOOGLE_MAPS_GEOCODING_ADDRESS
-* GOOGLE_MAPS_GEOCODING_LATLNG
-* GOOGLE_MAPS_GEOCODING_COMPONENTS
-* GOOGLE_MAPS_GEOCODING_SENSOR
-* GOOGLE_MAPS_GEOCODING_BOUNDS
-* GOOGLE_MAPS_GEOCODING_LANGUAGE
-* GOOGLE_MAPS_GEOCODING_REGION
+* `GOOGLE_MAPS_GEOCODING_URL`: HTTP endpoint to the Google geocoding service by default is set to [https://maps.googleapis.com/maps/api/geocode](https://maps.googleapis.com/maps/api/geocode).
+* `GOOGLE_MAPS_GEOCODING_OUTPUT`: By default is set to `json`
+* `GOOGLE_MAPS_GEOCODING_KEY`
+* `GOOGLE_MAPS_GEOCODING_ADDRESS`
+* `GOOGLE_MAPS_GEOCODING_LATLNG`
+* `GOOGLE_MAPS_GEOCODING_COMPONENTS`
+* `GOOGLE_MAPS_GEOCODING_SENSOR`: By default is set to `false`
+* `GOOGLE_MAPS_GEOCODING_BOUNDS`
+* `GOOGLE_MAPS_GEOCODING_LANGUAGE`
+* `GOOGLE_MAPS_GEOCODING_REGION`
+* `GOOGLE_MAPS_GEOCODING_PLACE_ID`
+* `GOOGLE_MAPS_GEOCODING_RESULT_TYPE`
+* `GOOGLE_MAPS_GEOCODING_LOCATION_TYPE`
 
 ### Easy way to use for both JSON and XML format
 

data/lib/gmaps_geocoding/api.rb

@@ -48,10 +48,10 @@ module GmapsGeocoding
                      Yajl::Parser.parse(rest_client)
                    else
                      r = Nori.new.parse(rest_client)
-                     if r.include?('GeocodeResponse')
+                     if r.include?('GeocodeResponse'.freeze)
                        r['GeocodeResponse']
                      else
-                       { status: 'UNKNOWN_ERROR' }
+                       { status: 'UNKNOWN_ERROR'.freeze }
                      end
                    end
           return result
@@ -84,12 +84,12 @@ module GmapsGeocoding
     # rubocop:disable Metrics/AbcSize
     def finest_latlng(data)
       result = retrieve_finest_location(data)
-      return [result['ROOFTOP'][:lng], result['ROOFTOP'][:lat]] if result.include?('ROOFTOP')
-      return [result['RANGE_INTERPOLATED'][:lng], result['RANGE_INTERPOLATED'][:lat]] if result.include?('RANGE_INTERPOLATED')
-      return [result['GEOMETRIC_CENTER'][:lng], result['GEOMETRIC_CENTER'][:lat]] if result.include?('GEOMETRIC_CENTER')
+      return [result['ROOFTOP'][:lng], result['ROOFTOP'][:lat]] if result.include?('ROOFTOP'.freeze)
+      return [result['RANGE_INTERPOLATED'][:lng], result['RANGE_INTERPOLATED'][:lat]] if result.include?('RANGE_INTERPOLATED'.freeze)
+      return [result['GEOMETRIC_CENTER'][:lng], result['GEOMETRIC_CENTER'][:lat]] if result.include?('GEOMETRIC_CENTER'.freeze)
       [result['APPROXIMATE'][:lng], result['APPROXIMATE'][:lat]]
     rescue
-      [0.0, 0.0]
+      [0.0, 0.0].freeze
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -107,18 +107,17 @@ module GmapsGeocoding
     end
 
     def build_url_query
-      query = {}
-      [:address, :latlng, :components, :sensor, :bounds, :language, :region].each do |k|
+      query_params = {}
+      VALID_QUERY_PARAMS.each do |k|
         val = @config.send(k)
-        query[k] = val if val
+        query_params[k] = val if val
       end
-      url = "#{@config.url}/#{@config.output}"
-      { url: url, query: query }.freeze
+      { url: "#{@config.url}/#{@config.output}", params: query_params }.freeze
     end
 
     def retrieve_geocoding_data
       data = build_url_query
-      RestClient.get data[:url], params: data[:query]
+      RestClient.get data[:url], params: data[:params]
     end
   end
 end

data/lib/gmaps_geocoding/config.rb

@@ -1,100 +1,32 @@
 # Gmaps geocoding module
 module GmapsGeocoding
+  # Configuration valid keys
+  VALID_KEYS = [:url, :output, :key, :address, :latlng, :components, :sensor, :bounds, :language, :region, :place_id, :result_type, :location_type].freeze
+
+  # Valid query parameters
+  VALID_QUERY_PARAMS = VALID_KEYS - [:url, :output].freeze
+
   # Configuration class for GmapsGeocoding API.
   class Config
-    # Configuration valid keys
-    VALID_KEYS = [:url, :output, :address, :latlng, :components, :sensor, :bounds, :language, :region].freeze
+    # All valid keys is stored in instance attribute
+    attr_accessor(*VALID_KEYS)
 
     # Default configuration values
     DEFAULT_CONFIG = {
-      url: 'https://maps.googleapis.com/maps/api/geocode',
-      output: 'json',
-      sensor: 'false'
+      url: 'https://maps.googleapis.com/maps/api/geocode'.freeze,
+      output: 'json'.freeze,
+      sensor: 'false'.freeze
     }.freeze
 
     def initialize(opts = {})
-      @options = {}
-      @options.merge!(DEFAULT_CONFIG)
-      opts.each do |k, _|
+      opts = DEFAULT_CONFIG.merge(opts)
+      VALID_KEYS.each do |k, _|
         next unless VALID_KEYS.include?(k)
-        val = if k.eql?(:url)
-                opts.delete(k)
-              else
-                ENV["GOOGLE_MAPS_GEOCODING_#{k.to_s.upcase}"] || opts.delete(k)
-              end
-        @options[k] = val if val
+        val = ENV["GOOGLE_MAPS_GEOCODING_#{k.to_s.upcase}"] || opts.delete(k)
+        send("#{k}=", val) if val
       end
     end
 
-    # URL of the Google Maps Geocoding Service
-    #
-    # @return [String] URL of the Google Maps Geocoding Service
-    def url
-      @options[:url]
-    end
-
-    # Output format of the Google Maps Geocoding Service
-    #
-    # @return [String] Output format of the Google Maps Geocoding Service. Only _xml_ or _json_ formats are available
-    def output
-      @options[:output]
-    end
-
-    # The address that you want to geocode
-    #
-    # @return [String] The address that you want to geocode.
-    def address
-      @options[:address]
-    end
-
-    # The textual latitude/longitude value for which you wish to obtain the closest, human-readable address
-    #
-    # @example
-    #  "40.714224,-73.961452"
-    #
-    # @return [String] The textual latitude/longitude value for which you wish to obtain the closest, human-readable address
-    def latlng
-      @options[:latlng]
-    end
-
-    # A component filter for which you wish to obtain a geocode
-    #
-    # {https://developers.google.com/maps/documentation/geocoding/#ComponentFiltering}
-    # @return [String] A component filter for which you wish to obtain a geocode
-    def components
-      @options[:components]
-    end
-
-    # Indicates whether or not the geocoding request comes from a device with a location sensor.
-    #
-    # @return [String] Indicates whether or not the geocoding request comes from a device with a location sensor. Must be either "true" or "false".
-    def sensor
-      @options[:sensor]
-    end
-
-    # The bounding box of the viewport within which to bias geocode results more prominently
-    #
-    # {https://developers.google.com/maps/documentation/geocoding/#Viewports}
-    # @return [String] The bounding box of the viewport within which to bias geocode results more prominently
-    def bounds
-      @options[:bounds]
-    end
-
-    # The language in which to return results
-    #
-    # @return [String] The language in which to return results. {https://developers.google.com/maps/faq#languagesupport Supported languages}.
-    def language
-      @options[:language]
-    end
-
-    # The region code, specified as a ccTLD ("top-level domain") two-character value
-    #
-    # {https://developers.google.com/maps/documentation/geocoding/#RegionCodes}
-    # @return [String] The region code, specified as a ccTLD ("top-level domain") two-character value
-    def region
-      @options[:region]
-    end
-
     # Check if the configuration object is valid
     #
     # @return [true, false] Return _true_ or _false_
@@ -106,14 +38,14 @@ module GmapsGeocoding
     #
     # @return [true, false] Return _true_ or _false_
     def json_format?
-      'json'.eql?(output)
+      'json'.freeze.eql?(output)
     end
 
     # Check if the output format of the query is set to _xml_
     #
     # @return [true, false] Return _true_ or _false_
     def xml_format?
-      'xml'.eql?(output)
+      'xml'.freeze.eql?(output)
     end
 
     private
@@ -122,9 +54,9 @@ module GmapsGeocoding
     #
     # According to the specifications: {https://developers.google.com/maps/documentation/geocoding/#GeocodingRequests}
     def query_valid?
-      (@options.include?(:address) && !@options.include?(:latlng)) ||
-        (!@options.include?(:address) && @options.include?(:latlng)) ||
-        @options.include?(:components)
+      (address && latlng.nil?) ||
+        (latlng && address.nil?) ||
+        !components.nil?
     end
 
     # Check if the output format is valid

data/lib/gmaps_geocoding/version.rb

@@ -1,3 +1,3 @@
 module GmapsGeocoding
-  VERSION = '1.1.3'.freeze
+  VERSION = '1.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gmaps_geocoding
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Christian Kakesa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client