google-maps 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e699e56ed738cfac0031a4f8feedb206f81d525
+  data.tar.gz: a875dc4fc48fbd7a96cf4a32c11ba4e0ee9f325d
+SHA512:
+  metadata.gz: 73244c390ea76dbe02e4c38cc34634133b4e945d073e992f94ba163d252fe6ec59f496acaaca7c714bd42073068f90eece6513aca4fa7a3488b53440b92f1a2e
+  data.tar.gz: eea17d91911da12e944fabc9d5bf10e4c7ec0370cc74e460aea5e2dc0028953ec07df5283d8667722002c0083fc6bf21478a10cb989e5f8b226bc77a1a186f8f

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/
+.rvmrc
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in google-maps.gemspec
+gemspec

data/LICENSE.mkd

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Zilverline / Daniël van Hoesel
+
+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.mkd

@@ -0,0 +1,34 @@
+Google Maps
+====================
+
+Installation
+------------
+	gem install google-maps
+
+Usage Examples
+--------------
+	Google::Maps.distance("Science Park, Amsterdam", "Deventer")
+	 #=> "104 km"
+	Google::Maps.duration("Science Park, Amsterdam", "Deventer")
+	 #=> "1 hour 12 mins"
+  
+	route = Google::Maps.route("Science Park, Amsterdam", "Deventer")
+	route.distance.text
+	 #=> "104 km"
+	route.duration.text
+	 #=> "1 hour 12 mins"
+	route.distance.value
+	 #=> 103712
+	route.duration.value
+	 #=> 4337
+
+Testing
+-------
+Run all tests:
+
+	rspec spec/
+
+Copyright
+---------
+Copyright (c) 2011 Zilverline / Daniël van Hoesel.
+See [LICENSE](https://github.com/zilverline/google-maps/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/google-maps.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "google-maps/version"
+
+Gem::Specification.new do |s|
+  s.name        = "google-maps"
+  s.version     = Google::Maps::VERSION
+  s.authors     = ["Daniel van Hoesel"]
+  s.email       = ["daniel@danielvanhoesel.nl"]
+  s.homepage    = "http://zilverline.com/"
+  s.summary     = %q{Ruby wrapper for the Google Maps API}
+  s.description = %q{This is a ruby wrapper for the Google Maps api}
+
+  s.rubyforge_project = "google-maps"
+
+  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) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('bundler', '~> 1.0')
+  s.add_development_dependency('rake', '~> 0.9')
+  s.add_development_dependency('rspec', '~> 2.6')
+  s.add_development_dependency('mocha', '~> 0.10')
+  s.add_development_dependency('simplecov', '~> 0.5')
+  s.add_development_dependency('yard', '~> 0.7')
+  s.add_dependency('json', '~> 1.7.5')
+  s.add_dependency('hashie', '~> 2.0.5')
+  s.add_dependency('httpclient', '~> 2.3.0.1')
+  s.add_dependency('ruby-hmac', '~> 0.4.0')
+end

data/lib/google-maps.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../google-maps/configuration', __FILE__)
+require File.expand_path('../google-maps/logger', __FILE__)
+require File.expand_path('../google-maps/route', __FILE__)
+require File.expand_path('../google-maps/place', __FILE__)
+require File.expand_path('../google-maps/location', __FILE__)
+
+module Google
+  module Maps
+    extend Configuration
+    extend Logger
+    
+    def self.route(from, to, language = self.default_language)
+      Route.new(from, to, language)
+    end
+    
+    def self.distance(from, to, language = self.default_language)
+      Route.new(from, to, language).distance.text
+    end
+    
+    def self.duration(from, to, language = self.default_language)
+      Route.new(from, to, language).duration.text
+    end
+    
+    def self.places(keyword, language = self.default_language)
+      Place.find(keyword, language)
+    end
+
+    def self.place(reference, language = self.default_language)
+      PlaceDetails.find(reference, language)
+    end
+
+    def self.geocode(address, language = self.default_language)
+      Location.find(address, language)
+    rescue ZeroResultsException
+      []
+    end
+  end
+end

data/lib/google-maps/api.rb

@@ -0,0 +1,89 @@
+# require 'net/http'
+require 'httpclient'
+require 'uri'
+require 'json'
+require 'hashie/mash'
+require 'base64'
+require 'hmac'
+require 'hmac-sha1'
+
+module Google
+  module Maps
+    
+    class InvalidResponseException < StandardError; end
+    class InvalidPremierConfigurationException < StandardError; end
+    class ZeroResultsException < InvalidResponseException; end
+        
+    class API
+      
+      STATUS_OK = "OK".freeze
+      STATUS_ZERO_RESULTS = "ZERO_RESULTS".freeze
+
+      class << self
+        def query(service, args = {})
+          default_args = {sensor:  false, use_premier_signing: !Google::Maps.premier_client_id.nil?}
+          args = default_args.merge(args)
+          args = args.merge(Google::Maps.default_params[service]) if Google::Maps.default_params[service]
+          use_premier_signing = args.delete :use_premier_signing
+          args[:client] = Google::Maps.premier_client_id if use_premier_signing
+
+          url = url(service, args)
+          url = premier_signing(url) if use_premier_signing
+          result = Hashie::Mash.new response(url)
+          raise ZeroResultsException.new("Google did not return any results: #{result.status}") if result.status == STATUS_ZERO_RESULTS
+          raise InvalidResponseException.new("Google returned an error status: #{result.status}") if result.status != STATUS_OK
+          result
+        end
+      
+        private
+        
+        def decode_url_safe_base_64(value)
+          Base64.decode64(value.tr('-_','+/'))
+        end
+
+        def encode_url_safe_base_64(value)
+          Base64.encode64(value).tr('+/','-_')
+        end
+
+        def premier_signing(url)
+          raise InvalidPremierConfigurationException.new("No private key set, set Google::Maps.premier_key") if Google::Maps.premier_key.nil?
+          
+          parsed_url = url.is_a?(URI) ? url : URI.parse(url)
+          url_to_sign = parsed_url.path + '?' + parsed_url.query
+
+          # Decode the private key
+          raw_key = decode_url_safe_base_64(Google::Maps.premier_key)
+
+          # create a signature using the private key and the URL
+          sha1 = HMAC::SHA1.new(raw_key)
+          sha1 << url_to_sign
+          raw_sig = sha1.digest
+
+          # encode the signature into base64 for url use form.
+          signature =  encode_url_safe_base_64(raw_sig)
+
+          # prepend the server and append the signature.
+          "#{parsed_url.scheme}://#{parsed_url.host}#{url_to_sign}&signature=#{signature}".strip
+        end
+        
+        def response(url)
+          JSON.parse(HTTPClient.new.get_content(url))
+        rescue Exception => error
+          Google::Maps.logger.error "#{error.message}"
+          raise InvalidResponseException.new("unknown error: #{error.message}")
+        end
+        
+        def url(service, args = {})
+          url = URI.parse("#{Google::Maps.end_point}#{Google::Maps.send(service)}/#{Google::Maps.format}#{query_string(args)}")
+          Google::Maps.logger.debug("url before possible signing: #{url}")
+          url.to_s
+        end
+        
+        def query_string(args = {})
+          '?' + args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join('&') unless args.size <= 0
+        end
+      end
+    end
+    
+  end
+end

data/lib/google-maps/configuration.rb

@@ -0,0 +1,70 @@
+module Google
+  module Maps
+    # Defines constants and methods related to configuration
+    module Configuration
+      # An array of valid keys in the options hash when configuring an {Google::Maps::API}
+      VALID_OPTIONS_KEYS = [:end_point, :premier_key, :premier_client_id, :format, :directions_service, :places_service, :geocode_service, :api_key, :default_language, :place_details_service, :default_params].freeze
+
+      # By default, set "https://maps.googleapis.com/maps/api/" as the server
+      DEFAULT_END_POINT = "https://maps.googleapis.com/maps/api/".freeze
+
+      DEFAULT_DIRECTIONS_SERVICE = "directions".freeze
+      DEFAULT_PLACES_SERVICE = "place/autocomplete".freeze
+      DEFAULT_PLACE_DETAILS_SERVICE = "place/details".freeze
+      DEFAULT_GEOCODE_SERVICE = "geocode".freeze
+
+      DEFAULT_FORMAT = "json".freeze
+      
+      # premier API key to sign parameters
+      DEFAULT_PREMIER_KEY = nil
+      
+      # premier client id
+      DEFAULT_PREMIER_CLIENT_ID = nil
+
+      # a api key
+      DEFAULT_API_KEY = nil
+
+      # default language
+      DEFAULT_LANGUAGE = :en
+
+      # params to send which each request configured per service, ie.: {places_service: {location: "52.0910,5.1220", radius: 300000}}
+      DEFAULT_PARAMS = {}
+      
+      # @private
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      # When this module is extended, set all configuration options to their default values
+      def self.extended(base)
+        base.reset
+      end
+
+      # Convenience method to allow configuration options to be set in a block
+      def configure
+        yield self
+      end
+
+      # Create a hash of options and their values
+      def options
+        VALID_OPTIONS_KEYS.inject({}) do |option, key|
+          option.merge!(key => send(key))
+        end
+      end
+
+      # Reset all configuration options to defaults
+      def reset
+        self.end_point = DEFAULT_END_POINT
+        self.format = DEFAULT_FORMAT
+        self.directions_service = DEFAULT_DIRECTIONS_SERVICE
+        self.places_service = DEFAULT_PLACES_SERVICE
+        self.place_details_service = DEFAULT_PLACE_DETAILS_SERVICE
+        self.geocode_service = DEFAULT_GEOCODE_SERVICE
+        self.premier_client_id = DEFAULT_PREMIER_CLIENT_ID
+        self.premier_key = DEFAULT_PREMIER_KEY
+        self.api_key = DEFAULT_API_KEY
+        self.default_language = DEFAULT_LANGUAGE
+        self.default_params = DEFAULT_PARAMS
+        self
+      end
+    end
+  end
+end

data/lib/google-maps/location.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../api', __FILE__)
+
+module Google
+  module Maps
+    class Location
+      attr_reader :address, :latitude, :longitude
+      alias :to_s :address
+
+      def initialize(address, latitude, longitude)
+        @address = address
+        @latitude = latitude
+        @longitude = longitude
+      end
+
+      def lat_lng
+        [latitude, longitude]
+      end
+
+      def self.find(address, language=:en)
+        API.query(:geocode_service, :language => language, :address => address).results.map { |result| Location.new(result.formatted_address, result.geometry.location.lat, result.geometry.location.lng) }
+      end
+    end
+
+  end
+end

data/lib/google-maps/logger.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module Google
+  module Maps
+    module Logger
+
+      attr_accessor :logger
+          
+      def log_file=(file)
+        self.logger = ::Logger.new(file)
+      end
+      
+      def self.extended(base)
+        base.log_file = RUBY_PLATFORM.index(/mswin(?!ce)|mingw|cygwin|bccwin/) ? "nul" : "/dev/null"
+      end
+    end
+  end
+end

data/lib/google-maps/place.rb

@@ -0,0 +1,88 @@
+require File.expand_path('../api', __FILE__)
+
+module Google
+  module Maps
+    
+    class Place
+      attr_reader :text, :html, :keyword, :reference
+      alias :to_s :text
+      alias :to_html :html
+      
+      def initialize(data, keyword)
+        @text = data.description
+        @reference = data.reference
+        @html = highligh_keywords(data, keyword)
+      end
+      
+      def self.find(keyword, language=:en)
+        args = {:language => language, :input =>  keyword }
+        args.merge!(key: Google::Maps.api_key) unless Google::Maps.api_key.nil?
+
+        API.query(:places_service, args).predictions.map{|prediction| Place.new(prediction, keyword) }
+      end
+
+      private
+
+      def highligh_keywords(data, keyword)
+        keyword = Regexp.escape(keyword)
+        matches = Array(keyword.scan(/\w+/))
+        html = data.description.dup
+        matches.each do |match|
+          html.gsub!(/(#{match})/i, '<strong>\1</strong>')
+        end
+
+        html
+      end
+    end
+
+    class PlaceDetails
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def latitude
+        @data.geometry.location.lat.to_s
+      end
+
+      def longitude
+        @data.geometry.location.lng.to_s
+      end
+
+      def reference
+        @data.reference
+      end
+
+      def address
+        @data.formatted_address
+      end
+      alias :to_s :address
+
+      def address_components
+        AddressComponentsProxy.new(@data.address_components)
+      end
+
+      def self.find(reference, language=:en)
+        args = {:language => language, :reference => reference}
+        args.merge!(key: Google::Maps.api_key) unless Google::Maps.api_key.nil?
+
+        PlaceDetails.new(API.query(:place_details_service, args).result)
+      end
+
+      class AddressComponentsProxy
+        def initialize(address_components)
+          @address_components = address_components
+        end
+
+        def method_missing(method, *args, &block)
+          raise ArgumentError unless args.empty?
+
+          @address_components.find do |component|
+            component.types.first == method.to_s
+          end
+        end
+      end
+    end
+  end
+end