static_maps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7ba7e06afbb871683653df0ff74a584fbb80f35
+  data.tar.gz: 444573695bd919136dc1462cb903b797b68fa498
+SHA512:
+  metadata.gz: d1e9b7c18bf39716ae529e9e2a7854072abc61b6fd810509e9f5cde8ad32c021e45a0a88ece7606d5e613ddd5d8a78b4c0394b2661b691d6c7a8124bc2a65d2e
+  data.tar.gz: 6ef8a38f120243ec2f362ad30cc959d823e143efe2c56d953aa904a1f63b56d8639a39918d85c3a207df4ea749e831037af88b6087821fda497ff8fdc24ae6ea

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicholas Hwang
+
+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,39 @@
+# StaticMaps (Google Static Maps V2 API)
+
+(Work in Progress...)
+
+Simple Ruby Wrapper for Google Static Maps V2 API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'static_maps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_maps
+
+## Usage
+
+```ruby
+StaticMaps::API.fetch
+=> "http://maps.googleapis.com/maps/api/staticmap?visual_refresh=true&center=Stan,Mountain+View,CA&size=640x640&sensor=false&zoom=16"
+
+StaticMaps::API.fetch({:center => 'Boston, MA', :size => '200x200'})
+=> "http://maps.googleapis.com/maps/api/staticmap?visual_refresh=true&center=Boston,MA&size=200x200&sensor=false&zoom=16"
+
+...To be continued
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gmaps

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# Simple CLI wrapper
+
+require 'optparse'
+require 'static_maps'
+
+# CLI Arguments
+params = {}
+options = {}
+
+OptionParser.new do |opts|
+
+  opts.on('-c','--center LOCATION', String,'Location of map center') do |c|
+    params[:center] = c
+  end
+
+  options[:open] = false
+  opts.on('-o','--[no-]open', 'Open in browser') do |o|
+    options[:open] = o
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+# Fetch Google Maps URL
+url = StaticMaps::API.fetch params
+
+# Outputs
+if options[:open]
+  puts %x{open #{url}}
+else
+  puts 'Generated URL:', url
+end

data/lib/static_maps.rb

@@ -0,0 +1,4 @@
+require "static_maps/version"
+require "static_maps/validations"
+require "static_maps/params"
+require "static_maps/API"

data/lib/static_maps/API.rb

@@ -0,0 +1,9 @@
+module StaticMaps
+  module API
+    class << self
+      def fetch(params={})
+        Params.build_url(params)
+      end
+    end
+  end
+end

data/lib/static_maps/params.rb

@@ -0,0 +1,46 @@
+module StaticMaps
+  module Params
+    extend self
+
+    BASE_URL = 'http://maps.googleapis.com/maps/api/staticmap'
+
+    DEFAULTS = {
+      :visual_refresh => true,                    # Use new color scheme
+      :center         => 'Stan,Mountain View,CA', # GooglePlex's Stan
+      :size           => '640x640',               # Max size (free API)
+      :sensor         => false,                   # No sensor
+      :zoom           => 16                       # No sensor
+    }.freeze
+
+    ALLOWED = [:visual_refresh, :center, :size, :sensor, :language, :region,
+               :zoom, :scale, :markers, :format, :maptype, :visible].freeze
+
+    def filter_allowed(params)
+      DEFAULTS.merge params.select {|k,v| ALLOWED.include? k}
+    end
+
+    def validated_params(params)
+      {}.tap do |p|
+        filter_allowed(params).map {|k,v| p[k] = Validations::validate(k,v)}
+      end
+    end
+
+    def concat_params(params)
+      [].tap do |url|
+        validated_params(params).each_with_index do |(k,v),i|
+          url << "#{i==0 ? '?' : '&'}#{k}=#{v}"
+        end
+      end.join('')
+    end
+
+    def url_safe(str)
+      str.strip.gsub(/[ |]+/,' ' => '+', '|' => '%7C')
+    end
+
+    def build_url(params)
+      url_safe(BASE_URL + concat_params(params))
+    end
+
+  end
+end
+

data/lib/static_maps/validations.rb

@@ -0,0 +1,55 @@
+module StaticMaps
+  module Validations
+    extend self
+
+    def validate(key,value)
+      value = case key
+      when :visual_refresh
+        to_bool(value, true)
+
+      when :sensor
+        to_bool(value, false)
+
+      when :size
+        size = value.match(/([\d]+)[\sx-]*([\d]+)?/)
+        if size
+          size[2].nil? ? size[1]+'x'+size[1] : size[1]+'x'+size[2]
+        else
+          '640x640'
+        end
+
+      when :scale
+        [1, value.to_i, 2].sort[1]
+
+      when :zoom
+        value.to_i == 0 ? 12 : value.to_i
+
+      when :format
+        ['png8','png','png32','gif','jpg','jpg-baseline'].
+          include?(value) ? value : 'png'
+
+      when :maptype
+        ['roadmap','satellite','terrain','hybrid'].
+          include?(value) ? value : 'roadmap'
+
+      else
+        value
+      end
+    end
+
+
+    private
+
+    # Naive bool force with fallback
+    def to_bool(value, fallback = false)
+      if !!value == value
+        value == true ? true : fallback
+      elsif value.class == String
+        value.casecmp('true') == 0 ? true : fallback
+      else
+        fallback
+      end
+    end
+
+  end
+end

data/lib/static_maps/version.rb

@@ -0,0 +1,3 @@
+module StaticMaps
+  VERSION = "0.0.1"
+end

data/spec/API_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'static_maps'
+
+describe 'Google Maps API' do
+  let(:maps) { StaticMaps::API }
+
+  describe 'default url' do
+    it 'should return a simple map url' do
+      maps.fetch.should eq base_url+base_params
+    end
+  end
+
+  describe 'output' do
+    it 'should return a string url' do
+      maps.fetch.class.should eq String
+    end
+  end
+
+  describe 'response' do
+    pending 'should response act accordingly i.e. 400'
+  end
+
+  def base_url
+    "http://maps.googleapis.com/maps/api/staticmap?"
+  end
+  def base_params
+    "visual_refresh=true&center=Stan,Mountain+View,CA&"+
+    "size=640x640&sensor=false&zoom=16"
+  end
+end
+

data/spec/params_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'static_maps'
+
+describe 'Params' do
+  let(:params)    { StaticMaps::Params }
+  let(:base_url)  { params::BASE_URL }
+  let(:defaults)  { params::DEFAULTS }
+  let(:allowed)   { params::ALLOWED }
+
+  describe 'base url' do
+    it { base_url.should eq 'http://maps.googleapis.com/maps/api/staticmap' }
+  end
+
+  describe 'defaults' do
+    it { defaults.frozen?.should eq true }
+    it { defaults.should include :visual_refresh }
+    it { defaults.should include :center }
+    it { defaults.should include :size }
+    it { defaults.should include :sensor }
+    it { defaults.should include :zoom }
+  end
+
+  describe 'allowed' do
+    let(:filtered_params){
+      params.filter_allowed({:scale => 2, :invalid => false })
+    }
+
+    it { allowed.frozen?.should eq true }
+    it { filtered_params.should include :zoom }
+    it { filtered_params.should_not include :invalid }
+  end
+
+  describe 'build url' do
+    let(:url) {
+      params.build_url({:center => 'City Hall, New York, NY',
+                        :markers => 'color:red|City Hall, New York, NY'})
+    }
+
+    it { url.should include base_url }
+    it { url.should include 'City+Hall,+New+York,+NY' }
+    it { url.should_not include ' ' }
+    it { url.should include 'color:red%7CCity+Hall,+New+York,+NY' }
+    it { url.should_not include '|' }
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+  # Fail Fast
+  config.fail_fast = true
+
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_framework = :rspec
+end

data/spec/static_maps_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'static_maps'
+
+describe StaticMaps do
+
+  it 'must have correct name' do
+    StaticMaps.name.should eq 'StaticMaps'
+  end
+
+  it 'must be defined (VERSION)' do
+    StaticMaps::VERSION.should_not eq nil
+  end
+end

data/spec/validations_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'static_maps'
+
+describe 'Param Validation' do
+  let(:params) { StaticMaps::Params }
+  let(:valids) { StaticMaps::Validations }
+
+  describe 'Visual Refresh and Sensor' do
+    it 'should permit boolean values' do
+      valids.validate(:visual_refresh, true).should eq true
+      valids.validate(:sensor, false).should eq false
+    end
+    it 'should permit string values' do
+      valids.validate(:visual_refresh, 'true').should eq true
+      valids.validate(:sensor, 'FalSE').should eq false
+    end
+    it 'should fallback to opinionated default' do
+      valids.validate(:visual_refresh, 'yes').should eq true
+      valids.validate(:sensor, nil).should eq false
+    end
+  end
+
+  describe 'Size' do
+    it 'should extract regex pattern /\n+x\n+/' do
+      valids.validate(:size, '300x300').should eq '300x300'
+      valids.validate(:size, 'bad300x300 bad').should eq '300x300'
+    end
+    it 'should take single value or non-zero value' do
+      valids.validate(:size, '300').should eq '300x300'
+      valids.validate(:size, 'x300').should eq '300x300'
+      valids.validate(:size, '-100x - 300').should eq '100x300'
+    end
+    it 'should fallback to max size' do
+      valids.validate(:size, '').should eq '640x640'
+      pending 'test for zero values i.e. 0, 0x0, 00x0000'
+    end
+  end
+
+  describe 'Scale' do
+    it 'should permit 1 or 2 numbers' do
+      valids.validate(:scale,1).should eq 1
+      valids.validate(:scale,2).should eq 2
+    end
+    it 'should permit 1 or 2 string' do
+      valids.validate(:scale,"1").should eq 1
+      valids.validate(:scale,"2").should eq 2
+    end
+    it 'should fallback to 1' do
+      valids.validate(:scale,"0").should eq 1
+      valids.validate(:scale,"").should eq 1
+      valids.validate(:scale,"bad").should eq 1
+    end
+  end
+
+  describe 'Zoom' do
+    it 'should permit numbers' do
+      valids.validate(:zoom,16).should eq 16
+    end
+    it 'should permit strings' do
+      valids.validate(:zoom,'16').should eq 16
+    end
+    it 'should fallback to zoom=12' do
+      valids.validate(:zoom,'').should eq 12
+      valids.validate(:zoom,'bad').should eq 12
+    end
+  end
+
+  describe 'Format' do
+    it 'should permit string' do
+      valids.validate(:format,'gif').should eq 'gif'
+    end
+    it 'should fallback to png' do
+      valids.validate(:format,'badgif').should eq 'png'
+      valids.validate(:format,false).should eq 'png'
+    end
+  end
+
+  describe 'Map Type' do
+    it 'should permit string' do
+      valids.validate(:maptype,'terrain').should eq 'terrain'
+    end
+    it 'should fallback to roadmap' do
+      valids.validate(:maptype,'badtype').should eq 'roadmap'
+      valids.validate(:maptype,false).should eq 'roadmap'
+    end
+  end
+
+  pending 'center (lat/long or loc) - comma delimit'
+  pending 'marker {size{tiny, mid, small}, color{HEX/basic}, label {A-Z0-9}}'
+  pending 'style, paths, & complex markers...TBD'
+end

data/static_maps.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static_maps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "static_maps"
+  spec.version       = StaticMaps::VERSION
+  spec.authors       = ["Nicholas Hwang"]
+  spec.email         = ["nick.joosung.hwang@gmail.com"]
+  spec.description   = ["Static Google Maps v2 API"]
+  spec.summary       = ["Ruby wrapper for Static Google Maps v2 API"]
+  spec.homepage      = "https://github.com/geekjuice/static_google_maps_v2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  # spec.executables   = %w( maps )
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: static_maps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicholas Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '["Static Google Maps v2 API"]'
+email:
+- nick.joosung.hwang@gmail.com
+executables:
+- gmaps
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gmaps
+- lib/static_maps.rb
+- lib/static_maps/API.rb
+- lib/static_maps/params.rb
+- lib/static_maps/validations.rb
+- lib/static_maps/version.rb
+- spec/API_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb
+- spec/static_maps_spec.rb
+- spec/validations_spec.rb
+- static_maps.gemspec
+homepage: https://github.com/geekjuice/static_google_maps_v2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.2
+signing_key: 
+specification_version: 4
+summary: '["Ruby wrapper for Static Google Maps v2 API"]'
+test_files:
+- spec/API_spec.rb
+- spec/params_spec.rb
+- spec/spec_helper.rb
+- spec/static_maps_spec.rb
+- spec/validations_spec.rb