dm-geokit 0.10.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt King
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,51 @@
+dm-geokit
+=========
+
+A mixin for Datamapper models that enables geographic functionality.
+
+* Search for content via DataMapper-style query methods, e.g. Location.all(:address.near => {:origin => 'Portland, OR', :distance => 5.mi})
+* Sort by distance easily: Location.all(:address.near => {:origin => 'Portland, OR', :distance => 5.mi}, :order => [:address_distance.desc])
+* Ability to specify multiple fields that are geocodable (mostly)
+
+Usage
+=====
+
+Basic Class Definition:
+
+class Location
+  include DataMapper::Resource
+  property :id, Serial
+  has_geographic_location :address
+end
+
+This will automatically generate fields and methods for use with the DM Object, prefixed with the field name specified.
+Since the above example used the field :address, the following fields would be generated:
+
+* address_street_address
+* address_city
+* address_state
+* address_zip
+* address_country_code
+* address_full_address
+* address_lat
+* address_lng
+
+You can either reference those fields directly, or use the proxy object returned by calling .address on your object:
+
+l = Location.all(:address.near => {:origin => 'Portland, OR', :distance => 5.mi})
+
+l.each do |loc|
+  puts loc.address # .to_s yields string representation of full address, e.g. "12345 My St. Portland, OR USA"
+  puts loc.address.inspect # the proxy object, GeographicLocation, with matching methods for each property
+  puts loc.address.street_address # getting the street_address from the proxy object
+  puts loc.address_street_address # directly access the SQL column
+end
+
+The GeographicLocation proxy object is a convenience to allow you to compare and sort results in Ruby.
+
+Requirements
+===========
+
+* geokit >= 1.5.0
+* dm-core >= 0.10.1
+* dm-aggregates >= 0.10.1

data/Rakefile

@@ -0,0 +1,20 @@
+begin 
+  require 'jeweler' 
+  Jeweler::Tasks.new do |s| 
+    s.name = 'dm-geokit' 
+    s.summary = "DataMapper plugin for geokit stuff forked from Foy Savas's project. Now relies on the geokit gem rather than Foy's gem."
+    s.authors = ['Foy Savas', 'Daniel Higginbotham', 'Matt King']
+    s.email = 'matt@mattking.org'
+    s.homepage = "http://github.com/mattking17/dm-geokit/tree/master" 
+    s.description = "Simple and opinionated helper for creating Rubygem projects on GitHub" 
+    s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore'] 
+    s.require_path     = 'lib'
+    s.has_rdoc         = true
+    s.platform         = Gem::Platform::RUBY
+    s.extra_rdoc_files = %w[ README LICENSE TODO ]
+    s.add_dependency 'dm-core'
+    s.add_dependency 'andre-geokit'
+  end 
+rescue LoadError 
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
+end

data/TODO

@@ -0,0 +1,8 @@
+TODO
+====
+
+
+
+---
+TODO tickets may also be found in the DataMapper Issue Tracker:
+http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 10
+:patch: 1

data/lib/dm-geokit.rb

@@ -0,0 +1,5 @@
+%w(rubygems geokit dm-core dm-aggregates).each{|f| require f}
+%w(distance_measurement distance_support symbol integer float).each{|f|
+  require File.join(File.dirname(__FILE__),'dm-geokit','support',f)
+}
+require File.join(File.dirname(__FILE__),'dm-geokit','resource')

data/lib/dm-geokit/ip_geocode_lookup.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module GeoKit 
+  # Contains a class method geocode_ip_address which can be used to enable automatic geocoding
+  # for request IP addresses.  The geocoded information is stored in a cookie and in the 
+  # session to minimize web service calls.  The point of the helper is to enable location-based
+  # websites to have a best-guess for new visitors.
+  module IpGeocodeLookup
+ 
+    private   
+         
+    # Places the IP address' geocode location into the session if it 
+    # can be found.  Otherwise, looks for a geo location cookie and
+    # uses that value.  The last resort is to call the web service to
+    # get the value.
+    def store_ip_location
+      session[:geo_location] ||= retrieve_location_from_cookie_or_service
+      cookies[:geo_location] = { :value => session[:geo_location].to_yaml, :expires => 30.days.from_now } if session[:geo_location]
+    end    
+    
+    # Uses the stored location value from the cookie if it exists.  If
+    # no cookie exists, calls out to the web service to get the location. 
+    def retrieve_location_from_cookie_or_service
+      return YAML.load(cookies[:geo_location]) if cookies[:geo_location]
+      location = Geocoders::IpGeocoder.geocode(get_ip_address)
+      return location.success ? location : nil
+    end
+    
+    # Returns the real ip address, though this could be the localhost ip
+    # address.  No special handling here anymore.
+    def get_ip_address
+      request.remote_ip
+    end
+  end
+end

data/lib/dm-geokit/resource.rb

@@ -0,0 +1,237 @@
+module DataMapper
+  module GeoKit
+    PROPERTY_NAMES = %w(lat lng street_address city state zip country_code full_address)
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_geographic_location(name, options = {})
+        return if self.included_modules.include?(DataMapper::GeoKit::InstanceMethods)
+        send :include, InstanceMethods
+        send :include, ::GeoKit::Mappable
+
+        property name.to_sym, String, :length => 255
+        property "#{name}_distance".to_sym, Float
+
+        PROPERTY_NAMES.each do |p|
+          if p.match(/l(at|ng)/)
+            property "#{name}_#{p}".to_sym, Float, :precision => 15, :scale => 12, :index => true
+          else
+            property "#{name}_#{p}".to_sym, String, :length => 255
+          end
+        end
+
+        DataMapper.auto_upgrade!
+
+        if options[:auto_geocode] == true or options[:auto_geocode].nil?
+          define_method :auto_geocode? do
+            true
+          end
+        else
+          define_method :auto_geocode? do
+            false
+          end
+        end
+
+        define_method "#{name}" do
+          if attribute_get(name.to_sym).nil?
+            nil
+          else
+            GeographicLocation.new(name, self)
+          end
+        end
+
+        define_method "#{name}=" do |value|
+          if value.nil?
+            nil
+          elsif value.is_a?(String)
+            if auto_geocode?
+              geo = ::GeoKit::Geocoders::MultiGeocoder.geocode(value)
+              if geo.success?
+                attribute_set(name.to_sym, geo.full_address)
+                PROPERTY_NAMES.each do |p|
+                  attribute_set("#{name}_#{p}".to_sym, geo.send(p.to_sym))
+                end
+              end
+            else
+              attribute_set(name.to_sym, value)
+            end
+          end
+        end
+      end
+      alias acts_as_mappable has_geographic_location
+    end
+
+    module InstanceMethods
+      def self.included(base) # :nodoc:
+        base.extend SingletonMethods
+      end
+      
+      module SingletonMethods # :nodoc:
+        def all(query = {})
+          super(prepare_query(query))
+        end
+
+        def first(query = {})
+          super(prepare_query(query))
+        end
+
+        # Required dm-aggregates to work
+        def count(query = {})
+          super(prepare_query(query))
+        end
+
+        private
+
+        # Looks in the query for keys that are a DistanceOperator, then extracts the keys/values and turns them into conditions
+        def prepare_query(query)
+          query.each_pair do |k,v|
+            next if not k.is_a?(DistanceOperator)
+            field = k.target
+            origin = v[:origin].is_a?(String) ? ::GeoKit::Geocoders::MultiGeocoder.geocode(v[:origin]) : v[:origin]
+            distance = v[:distance]
+            query[:conditions] = expand_conditions(query[:conditions], "#{sphere_distance_sql(field, origin, distance.measurement)}", distance.to_f)
+            query[:conditions] = apply_bounds_conditions(query[:conditions], field, bounds_from_distance(distance.to_f, origin, distance.measurement))
+            query[:fields] = expand_fields(query[:fields], field, "#{sphere_distance_sql(field, origin, distance.measurement)}")
+            query.delete(k)
+          end
+          query
+        end
+
+        # Spherical distance sql
+        def sphere_distance_sql(field, origin, units)
+          lat = deg2rad(origin.lat)
+          lng = deg2rad(origin.lng)
+          qualified_lat_column = "`#{storage_name}`.`#{field}_lat`"
+          qualified_lng_column = "`#{storage_name}`.`#{field}_lng`"
+          "(ACOS(least(1,COS(#{lat})*COS(#{lng})*COS(RADIANS(#{qualified_lat_column}))*COS(RADIANS(#{qualified_lng_column}))+COS(#{lat})*SIN(#{lng})*COS(RADIANS(#{qualified_lat_column}))*SIN(RADIANS(#{qualified_lng_column}))+SIN(#{lat})*SIN(RADIANS(#{qualified_lat_column}))))*#{units_sphere_multiplier(units)})"
+        end
+
+        # in case conditions were altered by other means
+        def expand_conditions(conditions, sql, value)
+          if conditions.is_a?(Hash)
+            [conditions.keys.inject(''){|m,k|
+              m << "#{k} = ?"
+            } << " AND #{sql} <= ?"] + ([conditions.values] << value)
+          elsif conditions.is_a?(Array)
+            if conditions.size == 1
+              ["#{conditions[0]} AND #{sql} <= ?", value]
+            else
+              conditions[0] = "#{conditions[0]} AND #{sql} <= ?"
+              conditions << value
+              conditions
+            end
+          else
+            ["#{sql} <= ?", value]
+          end
+        end
+
+        # Hack in the distance field by adding the :fields option to the query
+        def expand_fields(fields, distance_field, sql)
+          f = DataMapper::Property.new(self, "#{distance_field}_distance".to_sym, DataMapper::Types::Distance, :field => "#{sql} as #{distance_field}_distance")
+          if fields.is_a?(Array) # user specified fields, just tack this onto the end
+            fields + [f]
+          else # otherwise since we specify :fields, we have to add back in the original fields it would have selected
+            self.properties(repository.name).defaults + [f]
+          end
+        end
+
+        def bounds_from_distance(distance, origin, units)
+          if distance
+            ::GeoKit::Bounds.from_point_and_radius(origin,distance,:units=>units)
+          else 
+            nil
+          end
+        end
+
+        def apply_bounds_conditions(conditions, field, bounds)
+          qualified_lat_column = "`#{storage_name}`.`#{field}_lat`"
+          qualified_lng_column = "`#{storage_name}`.`#{field}_lng`"
+          sw, ne = bounds.sw, bounds.ne
+          lng_sql = bounds.crosses_meridian? ? "(#{qualified_lng_column}<=#{sw.lng} OR #{qualified_lng_column}>=#{ne.lng})" : "#{qualified_lng_column}>=#{sw.lng} AND #{qualified_lng_column}<=#{ne.lng}"
+          bounds_sql = "#{qualified_lat_column}>=#{sw.lat} AND #{qualified_lat_column}<=#{ne.lat} AND #{lng_sql}"
+          conditions[0] << " AND (#{bounds_sql})"
+          conditions
+        end
+
+      end
+    end
+
+    class GeographicLocation
+      attr_accessor :full_address, :lat, :lng, :street_address, :city, :state, :zip, :country_code, :distance
+      def initialize(field, obj)
+        PROPERTY_NAMES.each do |p|
+          instance_variable_set("@#{p}",obj.send("#{field}_#{p}"))
+        end
+        @distance = obj.send("#{field}_distance") if obj.respond_to?("#{field}_distance".to_sym)
+      end
+      def to_s
+        @full_address
+      end
+      def to_lat_lng
+        ::GeoKit::LatLng.new(@lat,@lng)
+      end
+    end
+
+    class DistanceOperator < DataMapper::Query::Operator
+    end
+
+    module DataObjectsAdapter
+      def self.included(base)
+        base.send(:include, SQL)
+      end
+      module SQL
+        def self.included(base)
+          base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            # FIXME: figure out a cleaner approach than AMC
+            alias property_to_column_name_without_distance property_to_column_name
+            alias property_to_column_name property_to_column_name_with_distance
+          RUBY
+        end
+        
+        def property_to_column_name_with_distance(property, qualify)
+          if property.is_a?(DataMapper::Property) and property.type == DataMapper::Types::Distance
+            property.field
+          else
+            property_to_column_name_without_distance(property, qualify)
+          end
+        end
+      end
+    end
+  end
+
+  module Adapters
+    extendable do
+      # TODO: document
+      # @api private
+      def const_added(const_name)
+        if DataMapper::GeoKit.const_defined?(const_name)
+          adapter = const_get(const_name)
+          adapter.send(:include, DataMapper::GeoKit.const_get(const_name))
+        end
+        super
+      end
+    end
+  end
+
+  module Types
+    class Distance < DataMapper::Type
+      primitive Float
+    end
+  end
+
+  module Aggregates
+    module Model
+      def size
+        count
+      end
+    end
+    module Collection
+      def size
+        loaded? ? super : count
+      end
+    end
+  end
+end

data/lib/dm-geokit/support/distance_measurement.rb

@@ -0,0 +1,16 @@
+class DistanceMeasurement
+  attr_accessor :measurement
+  def initialize(value,measurement)
+    @value = value.to_f
+    @measurement = measurement
+  end
+  def to_s
+    @value.to_s
+  end
+  def to_i
+    @value.to_i
+  end
+  def to_f
+    @value.to_f
+  end
+end

data/lib/dm-geokit/support/distance_support.rb

@@ -0,0 +1,11 @@
+module DistanceSupport
+
+  def mi
+    DistanceMeasurement.new(self, :miles)
+  end
+
+  def km
+    DistanceMeasurement.new(self, :kms)
+  end
+
+end

data/lib/dm-geokit/support/float.rb

@@ -0,0 +1 @@
+Float.send(:include, DistanceSupport)

data/lib/dm-geokit/support/integer.rb

@@ -0,0 +1 @@
+Integer.send(:include, DistanceSupport)

data/lib/dm-geokit/support/symbol.rb

@@ -0,0 +1,11 @@
+class Symbol
+  
+  def near
+    DataMapper::GeoKit::DistanceOperator.new(self, :near)
+  end
+
+  def outside
+    DataMapper::GeoKit::DistanceOperator.new(self, :outside)
+  end
+
+end

data/lib/skeleton/api_keys_template

@@ -0,0 +1,50 @@
+# These defaults are used in GeoKit::Mappable.distance_to and in acts_as_mappable
+GeoKit::default_units = :miles
+GeoKit::default_formula = :sphere
+
+# This is the timeout value in seconds to be used for calls to the geocoder web
+# services.  For no timeout at all, comment out the setting.  The timeout unit
+# is in seconds. 
+GeoKit::Geocoders::timeout = 3
+
+# These settings are used if web service calls must be routed through a proxy.
+# These setting can be nil if not needed, otherwise, addr and port must be 
+# filled in at a minimum.  If the proxy requires authentication, the username
+# and password can be provided as well.
+GeoKit::Geocoders::proxy_addr = nil
+GeoKit::Geocoders::proxy_port = nil
+GeoKit::Geocoders::proxy_user = nil
+GeoKit::Geocoders::proxy_pass = nil
+
+# This is your yahoo application key for the Yahoo Geocoder.
+# See http://developer.yahoo.com/faq/index.html#appid
+# and http://developer.yahoo.com/maps/rest/V1/geocode.html
+GeoKit::Geocoders::yahoo = 'REPLACE_WITH_YOUR_YAHOO_KEY'
+    
+# This is your Google Maps geocoder key. 
+# See http://www.google.com/apis/maps/signup.html
+# and http://www.google.com/apis/maps/documentation/#Geocoding_Examples
+GeoKit::Geocoders::google = 'REPLACE_WITH_YOUR_GOOGLE_KEY'
+    
+# This is your username and password for geocoder.us.
+# To use the free service, the value can be set to nil or false.  For 
+# usage tied to an account, the value should be set to username:password.
+# See http://geocoder.us
+# and http://geocoder.us/user/signup
+GeoKit::Geocoders::geocoder_us = false 
+
+# This is your authorization key for geocoder.ca.
+# To use the free service, the value can be set to nil or false.  For 
+# usage tied to an account, set the value to the key obtained from
+# Geocoder.ca.
+# See http://geocoder.ca
+# and http://geocoder.ca/?register=1
+GeoKit::Geocoders::geocoder_ca = false
+
+# This is the order in which the geocoders are called in a failover scenario
+# If you only want to use a single geocoder, put a single symbol in the array.
+# Valid symbols are :google, :yahoo, :us, and :ca.
+# Be aware that there are Terms of Use restrictions on how you can use the 
+# various geocoders.  Make sure you read up on relevant Terms of Use for each
+# geocoder you are going to use.
+GeoKit::Geocoders::provider_order = [:google,:us]

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: dm-geokit
+version: !ruby/object:Gem::Version 
+  version: 0.10.1
+platform: ruby
+authors: 
+- Matt King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: geokit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-aggregates
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.1
+    version: 
+description: Adds geographic functionality to DataMapper objects
+email: matt@mattking.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- Rakefile
+- README
+- TODO
+- VERSION.yml
+- lib/dm-geokit
+- lib/dm-geokit/ip_geocode_lookup.rb
+- lib/dm-geokit/resource.rb
+- lib/dm-geokit.rb
+- lib/skeleton
+- lib/skeleton/api_keys_template
+- lib/jeweler/templates/.gitignore
+- lib/dm-geokit/support/distance_measurement.rb
+- lib/dm-geokit/support/distance_support.rb
+- lib/dm-geokit/support/float.rb
+- lib/dm-geokit/support/integer.rb
+- lib/dm-geokit/support/symbol.rb
+has_rdoc: true
+homepage: http://github.com/mattking17/dm-geokit/tree/master
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dm-geokit
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Adds geographic functionality to DataMapper objects, relying on the Geokit gem for geocoding and searching by geographic location.
+test_files: []
+