google-maps 2.2.0 → 3.0.0

data/README.mkd

@@ -1,39 +0,0 @@
-[![Gem Version](https://badge.fury.io/rb/google-maps.svg)](http://badge.fury.io/rb/google-maps)
-[![Build Status](https://travis-ci.org/zilverline/google-maps.svg?branch=master)](https://travis-ci.org/zilverline/google-maps)
-[![Coverage Status](https://coveralls.io/repos/zilverline/google-maps/badge.svg?branch=master)](https://coveralls.io/r/zilverline/google-maps?branch=master)
-[![Code Climate](https://codeclimate.com/repos/55671579695680044d01e0ac/badges/8f4d88f30585847e4fcf/gpa.svg)](https://codeclimate.com/repos/55671579695680044d01e0ac/feed)
-
-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-2014 Zilverline / Daniël van Hoesel.
-See [LICENSE](https://github.com/zilverline/google-maps/blob/master/LICENSE.mkd) for details.

data/lib/google-maps.rb

@@ -1,44 +0,0 @@
-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, options={})
-      Route.new(from, to, options_with_defaults(options))
-    end
-
-    def self.distance(from, to, options={})
-      Route.new(from, to, options_with_defaults(options)).distance.text
-    end
-
-    def self.duration(from, to, options={})
-      Route.new(from, to, options_with_defaults(options)).duration.text
-    end
-
-    def self.places(keyword, language = self.default_language)
-      Place.find(keyword, language)
-    end
-
-    def self.place(place_id, language = self.default_language)
-      PlaceDetails.find(place_id, language)
-    end
-
-    def self.geocode(address, language = self.default_language)
-      Location.find(address, language)
-    rescue ZeroResultsException
-      []
-    end
-
-    protected
-
-    def self.options_with_defaults(options)
-      {language: self.default_language}.merge(options)
-    end
-  end
-end

data/lib/google-maps/api.rb

@@ -1,89 +0,0 @@
-# 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

@@ -1,70 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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/route.rb

@@ -1,38 +0,0 @@
-require File.expand_path('../api', __FILE__)
-
-module Google
-  module Maps
-
-    class Route
-      attr_accessor :from, :to, :options
-
-      def initialize(from, to, options={})
-        options = {language: options} unless options.is_a? Hash
-        @from, @to, @options = from, to, {language: :en}.merge(options)
-      end
-
-      def method_missing(name, *args, &block)
-        if route.legs.first.key?(name)
-          route.legs.first.send(name)
-        else
-          super
-        end
-      end
-
-      def origin_latlong
-        "#{self.start_location.lat},#{self.start_location.lng}"
-      end
-
-      def destination_latlong
-        "#{self.end_location.lat},#{self.end_location.lng}"
-      end
-
-      private
-      def route
-        # default to the first returned route (the most efficient one)
-        @response ||= API.query(:directions_service, @options.merge(origin: from, destination: to)).routes.first
-      end
-    end
-
-  end
-end

data/lib/google-maps/version.rb

@@ -1,5 +0,0 @@
-module Google
-  module Maps
-    VERSION = "2.2.0"
-  end
-end

data/spec/google-maps/api_spec.rb

@@ -1,103 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-describe Google::Maps::API do
-  it "should raise a custom exception when the query fails by net" do
-    HTTPClient.any_instance.unstub(:get_content)
-    
-    Google::Maps.end_point = "http://unknown.tld/"
-    lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error(Google::Maps::InvalidResponseException)
-    Google::Maps.end_point = "http://unknown-domain-asdasdasdas123123zxcasd.com/"
-    lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error(Google::Maps::InvalidResponseException)
-    Google::Maps.end_point = "http://www.google.com/404"
-    lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error(Google::Maps::InvalidResponseException)
-  end
-
-  it "should raise a custom exception when the query fails by Google" do
-    stub_response("over_query_limit.json")
-    lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error(Google::Maps::InvalidResponseException)    
-  end
-
-  it "should raise a custom exception when there are no results" do
-    stub_response("zero-results.json")
-    lambda{ Google::Maps.distance("Blah blah", "Jalala") }.should raise_error(Google::Maps::ZeroResultsException)
-  end
-
-  it "should raise a custom exception that is rescue-able" do
-    stub_response("zero-results.json")
-    begin
-      Google::Maps.distance("Blah blah", "Jalala")
-    rescue => error
-      @error = error
-    ensure
-      @error.should_not be_nil
-      @error.should be_a_kind_of StandardError
-    end
-  end
-
-  describe "premier signing" do
-    before :each do 
-      Google::Maps.configure do |config|
-        config.premier_client_id = "clientID"
-        config.premier_key = "vNIXE0xscrmjlyV-12Nj_BvUPaw="
-      end
-    end
-    
-    it "should raise an exception when a client id is set but no key" do
-      Google::Maps.premier_key = nil
-      lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error(Google::Maps::InvalidPremierConfigurationException)
-    end
-    
-    it "should sign the url parameters when a client id and premier key is set" do
-      # http://code.google.com/apis/maps/documentation/webservices/index.html#URLSigning
-
-      # Example:
-      # Private Key: vNIXE0xscrmjlyV-12Nj_BvUPaw=
-      # Signature: KrU1TzVQM7Ur0i8i7K3huiw3MsA=
-      # Client ID: clientID
-      # URL: http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID
-      url = "http://maps.google.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID"
-      signed_url = Google::Maps::API.send(:premier_signing, url)
-      signed_url.should == "#{url}&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA="
-    end
-    
-    it "should allow a parsed URI object to be used for signing" do
-      url = URI.parse("http://maps.google.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID")
-      signed_url = Google::Maps::API.send(:premier_signing, url)
-      signed_url.should == "#{url}&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA="
-    end
-
-    context "per service overrides" do
-      let(:place_id) { "CpQBiAAAAGs4XDizjQoVk9NjuY3ll3aLBLafpDxaFPSJSO7icOj07IRHO4KjjcRIbKEmeSVTcG75kIvwqE7VzA8D7BFvWp8OPwgAiKMveQQUsTGfJrRG5EVd7J34hY8e5JDbaXEPOMUPIWLfiugwUfQqAImvWQCGrMG1iyOpZfaW22NNhornssEg90uxrLbwLJ7QZhwGIRIQSBc_BlD7mILqQaixzTqE1BoUbNrhbmsZYkIurvK4l9exKBryfKk" }
-      let(:api_key) { "some_api_key" }
-      let(:parameters) { [:premier_client_id, :premier_key, :api_key, :default_params] }
-
-      before :each do
-        parameters.each do |what|
-          self.instance_variable_set(:"@old_#{what}", Google::Maps.send(what))
-        end
-
-        Google::Maps.configure do |config|
-          config.premier_client_id = "gme-test"
-          config.premier_key = "secret"
-          config.api_key = api_key
-          config.default_params = {place_details_service: {:use_premier_signing => false}}
-        end
-      end
-
-      after :each do
-        Google::Maps.configure do |config|
-          parameters.each do |what|
-            config.send(:"#{what}=", self.instance_variable_get(:"@old_#{what}"))
-          end
-        end
-      end
-
-      it "should not be used when configured for a certain service" do
-        stub_response("place_details.json", "https://maps.googleapis.com/maps/api/place/details/json?sensor=false&language=nl&placeid=#{place_id}&key=#{api_key}")
-
-        Google::Maps::place(place_id, :nl).should_not be_nil
-      end
-    end
-  end
-
-end

data/spec/google-maps/logger_spec.rb

@@ -1,15 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-require 'logger'
-
-describe Google::Maps::Logger do
-  it "should be able to log messages when a log output is set" do
-    # fake an exception
-    HTTPClient.any_instance.expects(:get_content).raises("test exception")
-    
-    # expect the logger to be called once
-    Logger.any_instance.expects(:error).at_least_once
-
-    # trigger the exception
-    lambda{ Google::Maps.distance("Amsterdam", "Deventer") }.should raise_error
-  end
-end

data/spec/google-maps/place_details_spec.rb

@@ -1,32 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-describe Google::Maps::PlaceDetails do
-  let(:place_id) { "CpQBiAAAAGs4XDizjQoVk9NjuY3ll3aLBLafpDxaFPSJSO7icOj07IRHO4KjjcRIbKEmeSVTcG75kIvwqE7VzA8D7BFvWp8OPwgAiKMveQQUsTGfJrRG5EVd7J34hY8e5JDbaXEPOMUPIWLfiugwUfQqAImvWQCGrMG1iyOpZfaW22NNhornssEg90uxrLbwLJ7QZhwGIRIQSBc_BlD7mILqQaixzTqE1BoUbNrhbmsZYkIurvK4l9exKBryfKk" }
-
-  context "given a canned response" do
-    before(:each) do
-      stub_response("place_details.json")
-      @details = Google::Maps::PlaceDetails.find(place_id, :nl)
-    end
-
-    it "should have a place_id" do
-      @details.place_id.should == place_id
-    end
-
-    it "should have a latlong" do
-      @details.latitude.should == "-33.866975"
-      @details.longitude.should =="151.195677"
-    end
-
-    it "has data containing at least address components" do
-      @details.data.address_components.should_not be_empty
-    end
-
-    context "#address_components" do
-      it "allows easy access by type" do
-        @details.address_components.postal_code.long_name.should eq "2009"
-        @details.address_components.locality.long_name.should eq "Pyrmont"
-      end
-    end
-  end
-end