static_map 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/*.png

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in static_map.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sean Behan
+
+MIT License
+
+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.md

@@ -0,0 +1,87 @@
+# StaticMap
+
+Build static image maps using Google's Static Map API
+
+## Installation
+
+    gem 'static_map'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_map
+
+## Usage
+
+```ruby
+image = StaticMap::Image.new({
+  size: '500x500',
+  sensor: false,
+  markers: [],
+  maptype: 'road',
+  zoom: 8,
+  title: 'A map',
+  alt: 'Alt text for img html',
+  path: './my-map.png'
+})
+
+image.url
+# => http://maps.google.com/maps/api/staticmap?size=500x500&zoom=1&sensor=true
+
+image.to_html
+# => <img src='http://maps.google.com/maps/api/staticmap?size=500x500&zoom=1&sensor=true' title='' alt=''/>
+
+img.save # save map to disk with path option
+
+```
+
+The options are
+
+* center String   - center the map around this location
+* zoom Integer    - zoom level of the map
+* size String     - in pixels of the image. 500x500
+* sensor Boolean  - autodetect user location
+* markers Array of Hashes - location of pins on map. Requires a location address or lat/long coordinates
+* maptype String  - type of map (satellite, road, hybrid, terrain)
+* path String     - path to write file to when #save is called
+* alt String      - alt text if using image tag
+* title String    - title text if using image tag
+
+### Usage with Rails
+
+```erb
+<%=raw StaticMap::Image.new %>
+```
+
+The markers option accepts either a location (E.g., "Burlington, Vermont") or latitude and longitude coordinates.
+
+```ruby
+<%=raw StaticMap::Image.new({
+  zoom: 13,
+  markers: [
+    { location: "Winooski,Vermont", color: "green", label: "A" },
+    { latitude: 44.477171, longitude: -73.222032, color: "blue", label: "B" }
+    ]
+  }) %>
+```
+
+![StaticMap::Image of Burlington Vermont](http://maps.google.com/maps/api/staticmap?size=500x500&zoom=13&sensor=true&markers=color:green|label:A|Winooski,VT&markers=color:blue|label:B|44.477171,-73.222032)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits and Resources
+
+The following links are great resources for working with Google Maps API
+
+- https://developers.google.com/maps/
+- http://www.lateralcode.com/new-google-maps-api/
+- https://developers.google.com/maps/documentation/staticmaps/

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/static_map.rb

@@ -0,0 +1,78 @@
+# http://www.lateralcode.com/new-google-maps-api/
+require "static_map/version"
+require 'cgi'
+require 'open-uri'
+
+module StaticMap
+  #
+  # Example
+  #
+  # img = StaticMap::Image.new(size: 500)
+  # img.center = 'Burlington, VT'
+  # img.zoom = 4
+  # img.markers << {latitude: 123, longitude: 321, color: 'red', label: 'VT'}
+  #
+  class Image
+    # Base URL for Google Static Maps API endpoint
+    URL = "http://maps.google.com/maps/api/staticmap"
+
+    # center String   - center the map around this location
+    # zoom Integer    - zoom level of the map
+    # size String     - in pixels of the image. 500x500
+    # sensor Boolean  - autodetect user user location
+    # markers Hash    - location of pin on map, requires location address or lat/long
+    # maptype String  - satelite, road... etc
+    # path String     - where to save the file
+    # alt String      - alt text if using image tag
+    # title String    - title text if using image tag
+    attr_accessor :center, :zoom, :size, :sensor, :markers, :maptype, :path, :alt, :title
+
+    def initialize(options={})
+      @markers  = options[:markers] || []
+      @size     = options[:size]    || '500x500'
+      @sensor   = options[:sensor]  || true
+      @zoom     = options[:zoom]    || 1
+      @center   = options[:center]  || nil
+      @maptype  = options[:maptype] || 'road'
+      @path     = options[:path]    || nil
+      @alt      = options[:alt]     || nil
+      @title    = options[:title]   || nil
+    end
+
+    def save
+      raise "Please set the path argument to save the image" unless @path
+
+      File.open(@path, "w") { |f| f.write(open(url).read) }
+    end
+
+    def url
+      "#{URL}?#{params}"
+    end
+
+    def params
+      x = { size: size, center: center, zoom: zoom, sensor: sensor, maptype: maptype }.reject { |k,v| v.nil? }.map do |k,v|
+        "#{k}=#{CGI.escape(v.to_s)}"
+      end.join("&")
+
+      x += "&#{marker_params}" if @markers.any?
+      x
+    end
+
+    def marker_params
+      @markers.map do |marker|
+        str = ["markers="]
+        str << ["color:#{marker[:color]}"] if marker[:color]
+        str << ["label:#{marker[:label]}"] if marker[:label]
+        str << ["#{marker[:location]}"] if marker[:location]
+        str << ["#{marker[:latitude]},#{marker[:longitude]}"] if marker[:latitude] && marker[:longitude]
+        str.join("|")
+      end.join("&").gsub(/\=\|/i, '=')
+    end
+
+    def to_html
+      "<img src='#{url}' title='#{title}' alt='#{alt}'/>"
+    end
+    alias_method :to_s, :to_html
+
+  end
+end

data/lib/static_map/version.rb

@@ -0,0 +1,3 @@
+module StaticMap
+  VERSION = "0.1.0"
+end

data/static_map.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/static_map/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sean Behan"]
+  gem.email         = ["inbox@seanbehan.com"]
+  gem.description   = %q{Google Static Map API with Ruby}
+  gem.summary       = %q{Build static maps using Google's Static Map API}
+  gem.homepage      = "http://github.com/gristmill/static_map"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "static_map"
+  gem.require_paths = ["lib"]
+  gem.version       = StaticMap::VERSION
+end

data/test/static_map_test.rb

@@ -0,0 +1,49 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+
+require 'test/unit'
+require 'static_map'
+
+class StaticMapTest < Test::Unit::TestCase
+
+  def test_defaults
+    img = StaticMap::Image.new
+    assert_equal "http://maps.google.com/maps/api/staticmap?size=500x500&zoom=1&sensor=true", img.url
+    assert_equal %{<img src='http://maps.google.com/maps/api/staticmap?size=500x500&zoom=1&sensor=true' title='' alt=''/>}, img.to_html
+  end
+
+  def test_params
+    img = StaticMap::Image.new
+    assert_equal "size=500x500&zoom=1&sensor=true", img.params
+    img.size = '900x900'
+    assert_equal "size=900x900&zoom=1&sensor=true", img.params
+  end
+
+  def test_marker_params
+    img = StaticMap::Image.new
+    img.markers << { latitude: 44.477462, longitude: -73.212032, color: "red", label: "A" }
+    img.markers << { location: "Winooski, Vermont", color: "red", label: "B" }
+    assert_equal "markers=color:red|label:A|44.477462,-73.212032&markers=color:red|label:B|Winooski, Vermont", img.marker_params
+  end
+
+  def test_url
+    img = StaticMap::Image.new
+    img.center = nil
+    img.size = '300x300'
+    img.zoom = 11
+    img.sensor = false
+    img.markers << { latitude: 44.477462, longitude: -73.212032, color: "green", label: "A" }
+    assert_equal "http://maps.google.com/maps/api/staticmap?size=300x300&zoom=11&sensor=false&markers=color:green|label:A|44.477462,-73.212032", img.url
+  end
+
+  def test_to_html
+    img = StaticMap::Image.new(:size => "500x500", :alt => "Alt Test", :title => "Title Test")
+    assert_equal "<img src='http://maps.google.com/maps/api/staticmap?size=500x500&zoom=1&sensor=true' title='Title Test' alt='Alt Test'/>", img.to_html
+  end
+
+  def test_save
+    # TODO fake the remote resource
+    img = StaticMap::Image.new(path: "./test/tmp.png").save
+    assert File.exists?("./test/tmp.png")
+    File.delete("./test/tmp.png")
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: static_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Behan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-19 00:00:00.000000000 Z
+dependencies: []
+description: Google Static Map API with Ruby
+email:
+- inbox@seanbehan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/static_map.rb
+- lib/static_map/version.rb
+- static_map.gemspec
+- test/static_map_test.rb
+homepage: http://github.com/gristmill/static_map
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Build static maps using Google's Static Map API
+test_files:
+- test/static_map_test.rb