geocoder 1.2.14 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 650f94f889eacdf006a3c98cc55cf2a2f2a0b162
-  data.tar.gz: f373165da885bfca07187488b97bdabede1b9c91
+  metadata.gz: e7a2b3e33175d20be86a8eaf6c74d6178bc71991
+  data.tar.gz: d0dc03b689fbc43f16ae9395c7f743a3dd7876bd
 SHA512:
-  metadata.gz: 02cc8f4d8c8a8f0a681e473ae15a52c17b3cd0406c1be04ae9bb0960885fcdb0248c075823cf51442daa90a473c086909bf5632976804fe84ce31d096f2082f9
-  data.tar.gz: aafb1a59a65180065a47233c4ce3aa86be7a7ea65b83d0be67ea323a1bed2d460e3d8bf1007a2b73e51e10e3a6e7ae7d203aad2ec17d71fecd964385e9cc6d41
+  metadata.gz: cb9f5c459af278bd20438a714475dece555b72222c34eab8c8fb61f6ddfc695848d330e9b84f366c8d67e5f253bda7d5e61020ab46382f8fbb40c8b7a9a58e82
+  data.tar.gz: ca02902240f5287a570ee05b0bc3b0300708200108b09543763e761ad1f0a2371355ef651471cdf96ce5cdabf104a39aedb04ef684e4f02aa3023911c27d7c4a

data/CHANGELOG.md

@@ -3,6 +3,13 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.3.0 (2016 Jan 31)
+-------------------
+* Lazy load lookups to reduce memory footprint (thanks github.com/TrangPham).
+* Add :geoportail_lu lookup (Luxembourg only) (thanks github.com/mdebo).
+* Maxmind local query performance improvement (thanks github.com/vojtad).
+* Remove deprecated Mongo near query methods (please use Mongo-native methods instead).
+
 1.2.14 (2015 Dec 27)
 --------------------
 * Fix bug in :geoip2 lookup (thanks github.com/mromulus).

data/README.md

@@ -637,6 +637,16 @@ Data Science Toolkit provides an API whose reponse format is like Google's but w
 * **Terms of Service**: http://www.itella.fi/liitteet/palvelutjatuotteet/yhteystietopalvelut/Postinumeropalvelut-Palvelukuvausjakayttoehdot.pdf
 * **Limitations**: ?
 
+#### Geoportail.lu (`:geoportail_lu`)
+
+* **API key**: none
+* **Quota**: none
+* **Region**: LU
+* **SSL support**: yes
+* **Languages**: en
+* **Documentation**: http://wiki.geoportail.lu/doku.php?id=en:api
+* **Terms of Service**: http://wiki.geoportail.lu/doku.php?id=en:mcg_1
+* **Limitations**: ?
 
 #### PostcodeAnywhere Uk (`:postcode_anywhere_uk`)
 
@@ -924,6 +934,9 @@ Now, any time Geocoder looks up "New York, NY" its results array will contain on
       ]
     )
 
+Note:
+  Keys must be strings not symbols when calling `add_stub` or `set_default_stub`. For example `'latitude' =>` not `:latitude =>`.
+
 
 Command Line Interface
 ----------------------
@@ -1099,7 +1112,9 @@ If anyone has a more elegant solution to this problem I am very interested in se
 Contributing
 ------------
 
-Contributions are welcome via pull requests on Github. Please respect the following guidelines:
+Contributions are welcome via Github pull requests. If you are new to the project and looking for a way to get involved, try picking up an issue with a "beginner-task" label. Hints about what needs to be done are usually provided.
+
+For all contributions, please respect the following guidelines:
 
 * Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
 * Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).

data/lib/geocoder/calculations.rb

@@ -263,7 +263,7 @@ module Geocoder
     end
 
     ##
-    # Given a start point, distance, and heading (in degrees), provides
+    # Given a start point, heading (in degrees), and distance, provides
     # an endpoint.
     # The starting point is given in the same way that points are given to all
     # Geocoder methods that accept points as arguments. It can be:

data/lib/geocoder/lookup.rb

@@ -1,3 +1,5 @@
+require "geocoder/lookups/test"
+
 module Geocoder
   module Lookup
     extend self
@@ -42,6 +44,7 @@ module Geocoder
         :smarty_streets,
         :okf,
         :postcode_anywhere_uk,
+        :geoportail_lu,
         :test
       ]
     end
@@ -83,6 +86,8 @@ module Geocoder
     #
     def spawn(name)
       if all_services.include?(name)
+        name = name.to_s
+        require "geocoder/lookups/#{name}"
         Geocoder::Lookup.const_get(classify_name(name)).new
       else
         valids = all_services.map(&:inspect).join(", ")
@@ -99,7 +104,3 @@ module Geocoder
     end
   end
 end
-
-Geocoder::Lookup.all_services.each do |name|
-  require "geocoder/lookups/#{name}"
-end

data/lib/geocoder/lookups/geoportail_lu.rb

@@ -0,0 +1,65 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/geoportail_lu"
+
+module Geocoder
+  module Lookup
+    class GeoportailLu < Base
+
+      def name
+        "Geoportail.lu"
+      end
+
+      def query_url(query)
+        url_base_path(query) + url_query_string(query)
+      end
+
+      private
+
+      def url_base_path(query)
+        query.reverse_geocode? ? reverse_geocode_url_base_path : search_url_base_path
+      end
+
+      def search_url_base_path
+        "#{protocol}://api.geoportail.lu/geocoder/search?"
+      end
+
+      def reverse_geocode_url_base_path
+        "#{protocol}://api.geoportail.lu/geocoder/reverseGeocode?"
+      end
+
+      def query_url_geoportail_lu_params(query)
+        query.reverse_geocode? ? reverse_geocode_params(query) : search_params(query)
+      end
+
+      def search_params(query)
+        {
+            queryString: query.sanitized_text
+        }
+      end
+
+      def reverse_geocode_params(query)
+        lat_lon = query.coordinates
+        {
+            lat: lat_lon.first,
+            lon: lat_lon.last
+        }
+      end
+
+      def query_url_params(query)
+        query_url_geoportail_lu_params(query).merge(super)
+      end
+
+      def results(query)
+        return [] unless doc = fetch_data(query)
+        if doc['success'] == true
+          result = doc['results']
+        else
+          result = []
+          raise_error(Geocoder::Error) ||
+              warn("Geportail.lu Geocoding API error")
+        end
+        result
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/maxmind_local.rb

@@ -36,7 +36,7 @@ module Geocoder::Lookup
         addr = IPAddr.new(query.text).to_i
         q = "SELECT l.country, l.region, l.city, l.latitude, l.longitude
           FROM maxmind_geolite_city_location l WHERE l.loc_id = (SELECT b.loc_id FROM maxmind_geolite_city_blocks b
-          WHERE b.start_ip_num <= #{addr} AND #{addr} <= b.end_ip_num LIMIT 1)"
+          WHERE b.start_ip_num <= #{addr} AND #{addr} <= b.end_ip_num)"
         format_result(q, [:country_name, :region_name, :city_name, :latitude, :longitude])
       elsif configuration[:package] == :country
         addr = IPAddr.new(query.text).to_i

data/lib/geocoder/results/esri.rb

@@ -4,13 +4,13 @@ module Geocoder::Result
   class Esri < Base
 
     def address
-      address = reverse_geocode? ? 'Address' : 'Match_addr'
-      attributes[address]
+      address_key = reverse_geocode? ? 'Address' : 'Match_addr'
+      attributes[address_key]
     end
 
     def city
       if !reverse_geocode? && is_city?
-        attributes['PlaceName']
+        place_name
       else
         attributes['City']
       end
@@ -23,8 +23,8 @@ module Geocoder::Result
     alias_method :state, :state_code
 
     def country
-      country = reverse_geocode? ? "CountryCode" : "Country"
-      attributes[country]
+      country_key = reverse_geocode? ? "CountryCode" : "Country"
+      attributes[country_key]
     end
 
     alias_method :country_code, :country
@@ -33,6 +33,15 @@ module Geocoder::Result
       attributes['Postal']
     end
 
+    def place_name
+      place_name_key = reverse_geocode? ? "Address" : "PlaceName"
+      attributes[place_name_key]
+    end
+
+    def place_type
+      reverse_geocode? ? "Address" : attributes['Type']
+    end
+
     def coordinates
       [geometry["y"], geometry["x"]]
     end
@@ -52,7 +61,7 @@ module Geocoder::Result
     end
 
     def is_city?
-      ['City', 'State Capital', 'National Capital'].include?(attributes['Type'])
+      ['City', 'State Capital', 'National Capital'].include?(place_type)
     end
   end
 end

data/lib/geocoder/results/geoportail_lu.rb

@@ -0,0 +1,69 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class GeoportailLu < Base
+
+    def coordinates
+      geomlonlat['coordinates'].reverse if geolocalized?
+    end
+
+    def address
+      full_address
+    end
+
+    def city
+      try_to_extract 'locality', detailled_address
+    end
+
+    def state
+      'Luxembourg'
+    end
+
+    def state_code
+      'LU'
+    end
+
+    def postal_code
+      try_to_extract 'zip', detailled_address
+    end
+
+    def street_address
+      [street_number, street].compact.join(' ')
+    end
+
+    def street_number
+      try_to_extract 'postnumber', detailled_address
+    end
+
+    def street
+      try_to_extract 'street', detailled_address
+    end
+
+    def full_address
+      data['address']
+    end
+
+    def geomlonlat
+      data['geomlonlat']
+    end
+
+    def detailled_address
+      data['AddressDetails']
+    end
+
+    alias_method :country, :state
+    alias_method :province, :state
+    alias_method :country_code, :state_code
+    alias_method :province_code, :state_code
+
+    private
+
+    def geolocalized?
+      try_to_extract('coordinates', geomlonlat).present?
+    end
+
+    def try_to_extract(key, nullable_hash)
+      nullable_hash.try(:[], key)
+    end
+  end
+end

data/lib/geocoder/results/google.rb

@@ -120,5 +120,13 @@ module Geocoder::Result
     def precision
       geometry['location_type'] if geometry
     end
+    
+    def partial_match
+      @data['partial_match']
+    end
+    
+    def place_id
+      @data['place_id']
+    end  
   end
 end

data/lib/geocoder/stores/mongo_base.rb

@@ -11,38 +11,6 @@ module Geocoder::Store
         scope :not_geocoded, lambda {
           where(geocoder_options[:coordinates] => nil)
         }
-
-        scope :near, lambda{ |location, *args|
-          warn "DEPRECATION WARNING: The .near method will be removed for MongoDB-backed models in Geocoder 1.3.0. Please use MongoDB's built-in query language instead."
-          coords  = Geocoder::Calculations.extract_coordinates(location)
-
-          # no results if no lat/lon given
-          return where(:id => false) unless coords.is_a?(Array)
-
-          radius  = args.size > 0 ? args.shift : 20
-          options = args.size > 0 ? args.shift : {}
-          options[:units] ||= geocoder_options[:units]
-
-          # Use BSON::OrderedHash if Ruby's hashes are unordered.
-          # Conditions must be in order required by indexes (see mongo gem).
-          version = RUBY_VERSION.split('.').map { |i| i.to_i }
-          empty = version[0] < 2 && version[1] < 9 ? BSON::OrderedHash.new : {}
-
-          conds = empty.clone
-          field = geocoder_options[:coordinates]
-          conds[field] = empty.clone
-          conds[field]["$nearSphere"]  = coords.reverse
-
-          if radius
-            conds[field]["$maxDistance"] = \
-              Geocoder::Calculations.distance_to_radians(radius, options[:units])
-          end
-
-          if obj = options[:exclude]
-            conds[:_id.ne] = obj.id
-          end
-          where(conds)
-        }
       end
     end
 
@@ -56,18 +24,6 @@ module Geocoder::Store
       coords.is_a?(Array) ? coords.reverse : []
     end
 
-    ##
-    # Get nearby geocoded objects.
-    # Takes the same options hash as the near class method (scope).
-    # Returns nil if the object is not geocoded.
-    #
-    def nearbys(radius = 20, options = {})
-      warn "DEPRECATION WARNING: The #nearbys method will be removed for MongoDB-backed models in Geocoder 1.3.0. Please use MongoDB's built-in query language instead."
-      return nil unless geocoded?
-      options.merge!(:exclude => self) unless send(self.class.primary_key).nil?
-      self.class.near(self, radius, options)
-    end
-
     ##
     # Look up coordinates and assign to +latitude+ and +longitude+ attributes
     # (or other as specified in +geocoded_by+). Returns coordinates (array).

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.2.14"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.2.14
+  version: 1.3.0
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies: []
 description: Provides object geocoding (by street or IP address), reverse geocoding
   (coordinates to street address), distance queries for ActiveRecord and Mongoid,
@@ -57,6 +57,7 @@ files:
 - lib/geocoder/lookups/geocoder_us.rb
 - lib/geocoder/lookups/geocodio.rb
 - lib/geocoder/lookups/geoip2.rb
+- lib/geocoder/lookups/geoportail_lu.rb
 - lib/geocoder/lookups/google.rb
 - lib/geocoder/lookups/google_places_details.rb
 - lib/geocoder/lookups/google_premier.rb
@@ -96,6 +97,7 @@ files:
 - lib/geocoder/results/geocoder_us.rb
 - lib/geocoder/results/geocodio.rb
 - lib/geocoder/results/geoip2.rb
+- lib/geocoder/results/geoportail_lu.rb
 - lib/geocoder/results/google.rb
 - lib/geocoder/results/google_places_details.rb
 - lib/geocoder/results/google_premier.rb
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.