pinpoint 0.3.1 → 0.4.0

data/lib/pinpoint/address.rb

@@ -1,7 +1,10 @@
 require 'pinpoint/formatter'
+require 'pinpoint/mapable'
 
 module Pinpoint
   class Address
+    include Mapable
+
     ATTRIBUTE_NAMES = [
         :name,
         :street_and_premises,

data/lib/pinpoint/mapable.rb

@@ -0,0 +1,56 @@
+require 'active_support/core_ext/string/inflections'
+require 'pinpoint/mapable_services/google_maps'
+require 'pinpoint/mapable_services/yahoo_maps'
+require 'pinpoint/mapable_services/mapquest'
+
+module Pinpoint
+  module Mapable
+
+    ##
+    # Public: Creates a URL which can be used to locate the Mapable on a map
+    # using one of the supported services:
+    #
+    # * Google Maps
+    # * Yahoo Maps
+    # * Mapquest
+    #
+    # options - A Hash of options which will apply to the map URL
+    #
+    #           :via - A Symbol representing the service to use to create the
+    #                  map URL. Options include:
+    #
+    #                  * :google_maps
+    #                  * :yahoo_maps
+    #                  * :mapquest
+    #
+    #                 (defaults to google_maps)
+    #
+    # Returns a String representing the URL which will display the location in
+    #   the browser.
+    #
+    def map_url(options = {})
+      service              = options.fetch(:via, :google_maps)
+      service_class        = service_class_for(service)
+
+      service_class.map_url location:       self.to_s,
+                            location_name:  self.name
+    end
+
+    private
+
+    ##
+    # Private: Finds the class name of the service that will be used to resolve
+    # the map URL in #map_url.
+    #
+    # service - A Symbol or String representing the service to be looked up
+    #
+    # Example
+    #
+    #   service_class_for :google_maps
+    #   # => <Class Pinpoint::MapableService::GoogleMaps>
+    #
+    def service_class_for(service)
+      "Pinpoint::MapableService::#{service.to_s.camelize}".constantize
+    end
+  end
+end

data/lib/pinpoint/mapable_services/google_maps.rb

@@ -0,0 +1,37 @@
+require 'cgi'
+
+module Pinpoint
+  module MapableService
+    class GoogleMaps
+
+      ##
+      # Private: Renders a URL for a given location and location name using the
+      # Google Maps mapping service.
+      #
+      # The location and location name will be properly escaped.
+      #
+      # options - A Hash of options used in the method
+      #
+      #           :location      - A String representing the location to display
+      #                            via the map URL
+      #           :location_name - A String representing the name of the
+      #                            location to be displayed via the map URL
+      #
+      # Example
+      #
+      #   map_url location:       'London, UK',
+      #           location_name:  'Capital of the UK'
+      #   # => http://maps.google.com?q=London%2C+UK+%28Capital+of+the+UK%29
+      #
+      def self.map_url(options = {})
+        escaped_map_location  = CGI.escape options.fetch(:location).to_str
+        escaped_location_name = CGI.escape "(#{options.fetch(:location_name)})"
+
+        'http://maps.google.com?q=' +
+        escaped_map_location +
+        '+' +
+        escaped_location_name
+      end
+    end
+  end
+end

data/lib/pinpoint/mapable_services/mapquest.rb

@@ -0,0 +1,37 @@
+require 'cgi'
+
+module Pinpoint
+  module MapableService
+    class Mapquest
+
+      ##
+      # Private: Renders a URL for a given location and location name using the
+      # Mapquest mapping service.
+      #
+      # The location and location name will be properly escaped.
+      #
+      # options - A Hash of options used in the method
+      #
+      #           :location      - A String representing the location to display
+      #                            via the map URL
+      #           :location_name - A String representing the name of the
+      #                            location to be displayed via the map URL
+      #
+      # Example
+      #
+      #   map_url location:       'London, UK',
+      #           location_name:  'Capital of the UK'
+      #   # => http://mapquest.com?q=London%2C+UK+%28Capital+of+the+UK%29
+      #
+      def self.map_url(options = {})
+        escaped_map_location  = CGI.escape options.fetch(:location).to_str
+        escaped_location_name = CGI.escape "(#{options.fetch(:location_name)})"
+
+        'http://mapquest.com?q=' +
+        escaped_map_location +
+        '+' +
+        escaped_location_name
+      end
+    end
+  end
+end

data/lib/pinpoint/mapable_services/yahoo_maps.rb

@@ -0,0 +1,37 @@
+require 'cgi'
+
+module Pinpoint
+  module MapableService
+    class YahooMaps
+
+      ##
+      # Private: Renders a URL for a given location and location name using the
+      # Yahoo Maps mapping service.
+      #
+      # The location and location name will be properly escaped.
+      #
+      # options - A Hash of options used in the method
+      #
+      #           :location      - A String representing the location to display
+      #                            via the map URL
+      #           :location_name - A String representing the name of the
+      #                            location to be displayed via the map URL
+      #
+      # Example
+      #
+      #   map_url location:       'London, UK',
+      #           location_name:  'Capital of the UK'
+      #   # => http://maps.yahoo.com#q=London%2C+UK&tt=Capital+of+the+UK
+      #
+      def self.map_url(options = {})
+        escaped_map_location  = CGI.escape options.fetch(:location).to_str
+        escaped_location_name = CGI.escape options.fetch(:location_name)
+
+        'http://maps.yahoo.com#q=' +
+        escaped_map_location +
+        '&tt=' +
+        escaped_location_name
+      end
+    end
+  end
+end

data/lib/pinpoint/version.rb

@@ -1,3 +1,3 @@
 module Pinpoint
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/mapable_services/google_maps_spec.rb

@@ -0,0 +1,17 @@
+require 'rspectacular'
+require 'pinpoint/mapable_services/google_maps'
+
+describe Pinpoint::MapableService::GoogleMaps do
+  it 'can create a GoogleMaps URL from the location string' do
+    map_url = Pinpoint::MapableService::GoogleMaps.map_url(
+                location_name: 'name with \\stuff/',
+                location:      'location with \\stuff/')
+
+    map_url.should eql(
+      'http://maps.google.com?q=' +
+      'location+with+%5Cstuff%2F' +
+      '+' +
+      '%28name+with+%5Cstuff%2F%29'
+    )
+  end
+end

data/spec/mapable_services/mapquest_spec.rb

@@ -0,0 +1,17 @@
+require 'rspectacular'
+require 'pinpoint/mapable_services/mapquest'
+
+describe Pinpoint::MapableService::Mapquest do
+  it 'can create a Mapquest URL from the location string' do
+    map_url = Pinpoint::MapableService::Mapquest.map_url(
+                location_name: 'name with \\stuff/',
+                location:      'location with \\stuff/')
+
+    map_url.should eql(
+      'http://mapquest.com?q=' +
+      'location+with+%5Cstuff%2F' +
+      '+' +
+      '%28name+with+%5Cstuff%2F%29'
+    )
+  end
+end

data/spec/mapable_services/yahoo_maps_spec.rb

@@ -0,0 +1,17 @@
+require 'rspectacular'
+require 'pinpoint/mapable_services/yahoo_maps'
+
+describe Pinpoint::MapableService::YahooMaps do
+  it 'can create a YahooMaps URL from the location string' do
+    map_url = Pinpoint::MapableService::YahooMaps.map_url(
+                location_name: 'name with \\stuff/',
+                location:      'location with \\stuff/')
+
+    map_url.should eql(
+      'http://maps.yahoo.com#q=' +
+      'location+with+%5Cstuff%2F' +
+      '&tt=' +
+      'name+with+%5Cstuff%2F'
+    )
+  end
+end

data/spec/mapable_spec.rb

@@ -0,0 +1,22 @@
+require 'rspectacular'
+require 'pinpoint/mapable'
+
+class MyMapableClass
+  include Pinpoint::Mapable
+end
+
+describe Pinpoint::Mapable do
+  let(:mapable) { MyMapableClass.new }
+
+  it 'can locate the map URL for itself via a given service' do
+    Pinpoint::MapableService::GoogleMaps.should_receive(:map_url)
+                                        .with(location_name: 'my_name',
+                                              location:      'my_location')
+                                        .and_return('map_url')
+
+    mapable.should_receive(:to_s).and_return 'my_location'
+    mapable.should_receive(:name).and_return 'my_name'
+
+    mapable.map_url(:via => :google_maps)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinpoint
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -100,6 +100,10 @@ files:
 - lib/pinpoint/format/tokenizer.rb
 - lib/pinpoint/format.rb
 - lib/pinpoint/formatter.rb
+- lib/pinpoint/mapable.rb
+- lib/pinpoint/mapable_services/google_maps.rb
+- lib/pinpoint/mapable_services/mapquest.rb
+- lib/pinpoint/mapable_services/yahoo_maps.rb
 - lib/pinpoint/model_support.rb
 - lib/pinpoint/validations.rb
 - lib/pinpoint/version.rb
@@ -117,6 +121,10 @@ files:
 - spec/format/tokenizer_spec.rb
 - spec/format_spec.rb
 - spec/formatter_spec.rb
+- spec/mapable_services/google_maps_spec.rb
+- spec/mapable_services/mapquest_spec.rb
+- spec/mapable_services/yahoo_maps_spec.rb
+- spec/mapable_spec.rb
 - spec/model_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/focused.rb
@@ -158,6 +166,10 @@ test_files:
 - spec/format/tokenizer_spec.rb
 - spec/format_spec.rb
 - spec/formatter_spec.rb
+- spec/mapable_services/google_maps_spec.rb
+- spec/mapable_services/mapquest_spec.rb
+- spec/mapable_services/yahoo_maps_spec.rb
+- spec/mapable_spec.rb
 - spec/model_support_spec.rb
 - spec/spec_helper.rb
 - spec/support/focused.rb