graticule 2.1.0 → 2.2.0

data/README.textile

@@ -1,6 +1,6 @@
 h1. Graticule
 
-Graticule is a geocoding API for looking up address coordinates.  It supports many popular APIs, including Yahoo, Google, Geocoder.ca and Geocoder.us.
+Graticule is a geocoding API for looking up address coordinates.  It supports many popular APIs, including Yahoo, Google, Yandex, Geocoder.ca and Geocoder.us.
 
 h2. Usage
 
@@ -28,16 +28,37 @@ h2. Mailing List
 
 Join us on the "mailing list":http://groups.google.com/group/graticule.
 
-h2. How to contribute
+h2. Contributing
 
-If you find what you might think is a bug:
+In the spirit of "free software":http://www.fsf.org/licensing/essays/free-sw.html, **everyone** is encouraged to help improve this project.
 
-# Check the "GitHub issue tracker":http://github.com/collectiveidea/graticule/issues/ to see if anyone else has had the same issue.
-# If you don't see anything, create an issue with information on how to reproduce it.
+Here are some ways *you* can contribute:
 
-If you want to contribute an enhancement or a fix:
+* using alpha, beta, and prerelease versions
+* reporting bugs
+* suggesting new features
+* writing or editing documentation
+* writing specifications
+* writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* refactoring code
+* closing "issues":https://github.com/collectiveidea/graticule/issues
+* reviewing patches
 
-# Fork "the project":http://github.com/collectiveidea/graticule/ on GitHub.
-# Make your changes with tests.
-# Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
-# Send a pull request.
+h2. Submitting an Issue
+
+We use the "GitHub issue tracker":https://github.com/collectiveidea/graticule/issues to track bugs
+and features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a "Gist":https://gist.github.com/ that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+h2. Submitting a Pull Request
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add specs for your feature or bug fix.
+5. Run @bundle exec rake@. If your changes are not 100% covered and passing, go back to step 4.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

data/lib/graticule.rb

@@ -12,6 +12,7 @@ require 'graticule/geocoder'
 require 'graticule/geocoder/base'
 require 'graticule/geocoder/bogus'
 require 'graticule/geocoder/google'
+require 'graticule/geocoder/yandex'
 require 'graticule/geocoder/host_ip'
 require 'graticule/geocoder/multi'
 require 'graticule/geocoder/yahoo'

data/lib/graticule/cli.rb

@@ -29,11 +29,13 @@ module Graticule
         opts.separator ""
         opts.separator "Options: "
 
-        opts.on("-s service", %w(yahoo google geocoder_us metacarta), "--service service", "Geocoding service") do |service|
+        opts.on("-s service", %w(yahoo google yandex geocoder_us metacarta), "--service service", "Geocoding service") do |service|
           options[:service] = service
         end
 
-        opts.on("-a apikey", "--apikey apikey", "API key for the selected service")
+        opts.on("-a apikey", "--apikey apikey", "API key for the selected service") do |apikey|
+          options[:api_key] = apikey
+        end
 
         opts.on_tail("-h", "--help", "Help") do
           puts opts

data/lib/graticule/distance/vincenty.rb

@@ -23,7 +23,7 @@ module Graticule
         from_latitude   = from.latitude.to_radians
         to_longitude    = to.longitude.to_radians
         to_latitude     = to.latitude.to_radians
-        
+
         earth_major_axis_radius = EARTH_MAJOR_AXIS_RADIUS[units.to_sym]
         earth_minor_axis_radius = EARTH_MINOR_AXIS_RADIUS[units.to_sym]
 
@@ -43,7 +43,7 @@ module Graticule
         while (lambda-lambda_p).abs > 1e-12 && (iteration_limit -= 1) > 0
           sin_lambda = sin(lambda)
           cos_lambda = cos(lambda)
-          sin_sigma = sqrt((cos_u2*sin_lambda) * (cos_u2*sin_lambda) + 
+          sin_sigma = sqrt((cos_u2*sin_lambda) * (cos_u2*sin_lambda) +
             (cos_u1*sin_u2-sin_u1*cos_u2*cos_lambda) * (cos_u1*sin_u2-sin_u1*cos_u2*cos_lambda))
           return 0 if sin_sigma == 0  # co-incident points
           cos_sigma = sin_u1*sin_u2 + cos_u1*cos_u2*cos_lambda
@@ -58,20 +58,19 @@ module Graticule
           lambda_p = lambda
           lambda = l + (1-c) * f * sin_alpha *
             (sigma + c*sin_sigma*(cos2SigmaM+c*cos_sigma*(-1+2*cos2SigmaM*cos2SigmaM)))
-       end
-       # formula failed to converge (happens on antipodal points)
-       # We'll call Haversine formula instead.
-       return Haversine.distance(from, to, units) if iteration_limit == 0 
+        end
+        # formula failed to converge (happens on antipodal points)
+        # We'll call Haversine formula instead.
+        return Haversine.distance(from, to, units) if iteration_limit == 0
+
+        uSq = cosSqAlpha * (earth_major_axis_radius**2 - earth_minor_axis_radius**2) / (earth_minor_axis_radius**2)
+        a = 1 + uSq/16384*(4096+uSq*(-768+uSq*(320-175*uSq)))
+        b = uSq/1024 * (256+uSq*(-128+uSq*(74-47*uSq)))
+        delta_sigma = b*sin_sigma*(cos2SigmaM+b/4*(cos_sigma*(-1+2*cos2SigmaM*cos2SigmaM)-
+          b/6*cos2SigmaM*(-3+4*sin_sigma*sin_sigma)*(-3+4*cos2SigmaM*cos2SigmaM)))
 
-       uSq = cosSqAlpha * (earth_major_axis_radius**2 - earth_minor_axis_radius**2) / (earth_minor_axis_radius**2)
-       a = 1 + uSq/16384*(4096+uSq*(-768+uSq*(320-175*uSq)))
-       b = uSq/1024 * (256+uSq*(-128+uSq*(74-47*uSq)))
-       delta_sigma = b*sin_sigma*(cos2SigmaM+b/4*(cos_sigma*(-1+2*cos2SigmaM*cos2SigmaM)-
-         b/6*cos2SigmaM*(-3+4*sin_sigma*sin_sigma)*(-3+4*cos2SigmaM*cos2SigmaM)))
-         
         earth_minor_axis_radius * a * (sigma-delta_sigma)
       end
-  
     end
   end
 end

data/lib/graticule/geocoder/base.rb

@@ -89,7 +89,7 @@ module Graticule #:nodoc:
       # you need to add extra params like an application id or output type.
       def make_url(params)
         escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
-          "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
+          "#{escape k.to_s}=#{escape v.to_s}"
         end
 
         url = @url.dup
@@ -108,6 +108,14 @@ module Graticule #:nodoc:
         raise NotImplementedError
       end
 
+      def escape(string)
+        if URI.const_defined?(:Parser)
+          parser = URI::Parser.new
+          parser.escape string
+        else
+          URI.escape string
+        end
+      end
     end
   end
 end

data/lib/graticule/geocoder/mapquest.rb

@@ -46,7 +46,7 @@ module Graticule #:nodoc:
         query = "e=5&<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?><Geocode Version=\"1\"> \
           #{address_string(params[:q])}#{authentication_string}</Geocode>"
         url = @url.dup
-        url.query = URI.escape(query)
+        url.query = escape(query)
         url
       end
 

data/lib/graticule/geocoder/yandex.rb

@@ -0,0 +1,131 @@
+# encoding: UTF-8
+module Graticule #:nodoc:
+  module Geocoder #:nodoc:
+
+    # First you need a Yandex Maps API key.  You can register for one here:
+    # http://api.yandex.ru/maps/form.xml
+    #
+    #   gg = Graticule.service(:yandex).new(MAPS_API_KEY)
+    #   location = gg.locate 'Россия, Москва, ул. Моховая, д.18'
+    #   p location.coordinates
+    #   #=> [37.612281, 55.753342]
+    #
+    class Yandex < Base
+      # http://api.yandex.ru/maps/geocoder/doc/desc/concepts/input_params.xml
+      # http://api.yandex.ru/maps/geocoder/doc/desc/concepts/response_structure.xml
+
+      PRECISION = {
+        :country  => Precision::Country,      # Country level accuracy.
+        :province => Precision::Region,       # Region (state, province, prefecture, etc.) level accuracy.
+        :area     => Precision::Region,       # Sub-region (county, municipality, etc.) level accuracy.
+        :locality => Precision::Locality,     # Town (city, village) level accuracy.
+        :metro    => Precision::Street,       # Street level accuracy.
+        :street   => Precision::Street,       # Intersection level accuracy.
+        :house    => Precision::Address,      # Address level accuracy.
+      }.stringify_keys
+
+      def initialize(key)
+        @key = key
+        @url = URI.parse 'http://geocode-maps.yandex.ru/1.x/'
+      end
+
+      # Locates +address+ returning a Location
+      def locate(address)
+        get :geocode => address.is_a?(String) ? address : location_from_params(address).to_s
+      end
+
+    private
+
+      class GeocoderMetaData
+        include HappyMapper
+
+        tag 'GeocoderMetaData'
+        namespace 'http://maps.yandex.ru/geocoder/1.x'
+
+        element :kind, String, :tag => 'kind'
+      end
+
+      class FeatureMember
+        include HappyMapper
+
+        tag 'featureMember'
+        namespace 'http://www.opengis.net/gml'
+
+        has_one :geocoder_meta_data, GeocoderMetaData
+
+        attr_reader :longitude, :latitude
+
+        element :coordinates, String, :tag => 'pos', :deep => true
+
+        with_options :deep => true, :namespace => 'urn:oasis:names:tc:ciq:xsdschema:xAL:2.0' do |map|
+          map.element :street,      String, :tag => 'ThoroughfareName'
+          map.element :locality,    String, :tag => 'LocalityName'
+          map.element :region,      String, :tag => 'AdministrativeAreaName'
+          map.element :postal_code, String, :tag => 'PostalCodeNumber'
+          map.element :country,     String, :tag => 'CountryNameCode'
+        end
+
+        def coordinates=(coordinates)
+          @longitude, @latitude = coordinates.split(' ').map { |v| v.to_f }
+        end
+
+        def precision
+          PRECISION[geocoder_meta_data.kind] || :unknown
+        end
+      end
+
+      class Error
+        include HappyMapper
+
+        tag 'error'
+        element :status, Integer, :tag => 'status'
+        element :message, String, :tag => 'message'
+      end
+
+      class Response
+        include HappyMapper
+
+        tag 'GeoObjectCollection'
+        has_many :feature_members, FeatureMember
+
+        def status
+          200
+        end
+      end
+
+      def prepare_response(xml)
+        Response.parse(xml, :single => true) || Error.parse(xml, :single => true)
+      end
+
+      def parse_response(response) #:nodoc:
+        result = response.feature_members.first
+        Location.new(
+          :latitude    => result.latitude,
+          :longitude   => result.longitude,
+          :street      => result.street,
+          :locality    => result.locality,
+          :country     => result.country,
+          :precision   => result.precision
+        )
+      end
+
+      # Extracts and raises an error from +xml+, if any.
+      def check_error(response) #:nodoc:
+        case response.status
+        when 200 then # ignore, ok
+        when 401 then
+          raise CredentialsError, response.message
+        else
+          raise Error, response.message
+        end
+      end
+
+      # Creates a URL from the Hash +params+.
+      # sets the output type to 'xml'.
+      def make_url(params) #:nodoc:
+        super params.merge(:key => @key)
+      end
+    end
+  end
+end
+

data/lib/graticule/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module Graticule
-  VERSION = '2.1.0' unless defined?(::Graticule::VERSION)
+  VERSION = '2.2.0' unless defined?(::Graticule::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graticule
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-05 00:00:00.000000000Z
+date: 2011-09-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70239866982580 !ruby/object:Gem::Requirement
+  requirement: &70276838707980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239866982580
+  version_requirements: *70276838707980
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70239866981940 !ruby/object:Gem::Requirement
+  requirement: &70276838705640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239866981940
+  version_requirements: *70276838705640
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70239866981260 !ruby/object:Gem::Requirement
+  requirement: &70276838703420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70239866981260
+  version_requirements: *70276838703420
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70239866980440 !ruby/object:Gem::Requirement
+  requirement: &70276838701800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239866980440
+  version_requirements: *70276838701800
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70239866979600 !ruby/object:Gem::Requirement
+  requirement: &70276838699580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239866979600
+  version_requirements: *70276838699580
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70239866978740 !ruby/object:Gem::Requirement
+  requirement: &70276838697520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239866978740
+  version_requirements: *70276838697520
 description: Graticule is a geocoding API that provides a common interface to all
   the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.
 email: brandon@opensoul.org
@@ -108,6 +108,7 @@ files:
 - lib/graticule/geocoder/multimap.rb
 - lib/graticule/geocoder/simple_geo.rb
 - lib/graticule/geocoder/yahoo.rb
+- lib/graticule/geocoder/yandex.rb
 - lib/graticule/geocoder.rb
 - lib/graticule/location.rb
 - lib/graticule/precision.rb
@@ -134,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -334130965420677482
+      hash: 473484385783211524
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -334130965420677482
+      hash: 473484385783211524
 requirements: []
 rubyforge_project: graticule
 rubygems_version: 1.8.6