cartographie 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Conway
+
+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,37 @@
+# Cartographie
+
+Cartographie is a wrapper for Google's Static Maps API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cartographie'
+
+Or install it yourself as:
+
+    $ gem install cartographie
+
+## Usage
+
+```ruby
+require 'cartographie'
+Cartographie.map('San Francisco, CA')
+Cartographie.map('New York, NY', width: 200, height: 200, zoom: 10)
+```
+
+**Defaults**
+
+- width: 300
+- height: 300
+- zoom: 15
+- format: 'png'
+- sensor: false
+
+## 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,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/cartographie.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cartographie/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matthew Conway"]
+  gem.email         = ["mattonrails@shortmail.com"]
+  gem.description   = %q{Beautiful map generation}
+  gem.summary       = %q{Wrapper for Google's Static Maps API}
+  gem.homepage      = "http://mattonrails.github.com/cartographie/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cartographie"
+  gem.require_paths = ["lib"]
+  gem.version       = Cartographie::VERSION
+
+  gem.add_dependency("addressable")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec", "~>2.11")
+end

data/lib/cartographie.rb

@@ -0,0 +1,28 @@
+require "cartographie/version"
+
+# Cartographie is the root module for all of Cartographie's components
+module Cartographie
+
+  autoload :Map, 'cartographie/map'
+
+  # Public: Create a new Map instance.
+  #
+  # location - The String for the map's location (default: 'Paris, France').
+  # options  - The Hash options used to configure the map (default: {}):
+  #            :width       - The Integer width of the map (optional).
+  #            :height      - The Integer height of the map (optional).
+  #            :zoom        - The Integer zoom level (optional).
+  #            :file_format - The String file format for the image (optional).
+  #            :sensor      - The Boolean indicating GPS usage (optional).
+  #
+  # Examples
+  #
+  #   Cartographie.map('Tokyo, Japan')
+  #   Cartographie.map('San Francisco, CA', zoom: 10)
+  #
+  # Returns an instance of Cartographie::Map
+  def self.map(location = 'Paris, France', options={})
+    Map.new(location, options)
+  end
+
+end

data/lib/cartographie/map.rb

@@ -0,0 +1,92 @@
+require 'addressable/uri'
+
+module Cartographie
+  # Map represents a map, and contains the details regarding a
+  # map's dimensions, zoom level, the image file format, and whether a GPS
+  # sensor was used in determining the map's location.
+  class Map
+
+    # Public: Gets/Sets the String location of the map.
+    attr_accessor :location
+    # Public: Gets/Sets the Hash options for the map.
+    attr_accessor :options
+
+    API_ENDPOINT        = 'http://maps.googleapis.com/maps/api/staticmap'
+    DEFAULT_WIDTH       = 300
+    DEFAULT_HEIGHT      = 300
+    DEFAULT_ZOOM        = 15
+    DEFAULT_FILE_FORMAT = 'png'
+    DEFAULT_SENSOR      = false
+
+    # Public: Initialize a Map
+    #
+    # location - The String for the map's location (default: 'Paris, France').
+    # options  - The Hash options used to configure the map (default: {}):
+    #            :width       - The Integer width of the map (optional).
+    #            :height      - The Integer height of the map (optional).
+    #            :zoom        - The Integer zoom level (optional).
+    #            :file_format - The String file format for the image (optional).
+    #            :sensor      - The Boolean indicating GPS usage (optional).
+    #
+    # Examples
+    #
+    #   Cartographie::Map.new('San Francisco, CA', zoom: 10)
+    def initialize(location='Paris, France', options={})
+      self.location = location
+      self.options = options
+    end
+
+    # Public: Build a Google Static Maps image URI
+    #
+    # Returns the String URI pointing an image of the map
+    def uri
+      params = {
+        center: location,
+        size: size,
+        zoom: zoom,
+        format: file_format,
+        sensor: sensor.to_s
+      }
+      Addressable::URI.parse(api_endpoint).tap do |uri|
+        uri.query_values = params
+      end.to_s
+    end
+    alias to_s uri
+
+    # Returns the Integer width passed in options, or default
+    def width
+      options[:width] || DEFAULT_WIDTH
+    end
+
+    # Returns the Integer height passed in options, or default
+    def height
+      options[:height] || DEFAULT_HEIGHT
+    end
+
+    # Returns the Integer zoom level passed in options, or default
+    def zoom
+      options[:zoom] || DEFAULT_ZOOM
+    end
+
+    # Returns the String file format passed in options, or default
+    def file_format
+      options[:file_format] || DEFAULT_FILE_FORMAT
+    end
+
+    # Returns the Boolean indicating sensor usage passed in options, or default
+    def sensor
+      options[:sensor] || DEFAULT_SENSOR
+    end
+
+    # Returns a string combining width and height into dimensions
+    def size
+      "#{width}x#{height}"
+    end
+
+    private
+
+    def api_endpoint
+      API_ENDPOINT
+    end
+  end
+end

data/lib/cartographie/version.rb

@@ -0,0 +1,3 @@
+module Cartographie
+  VERSION = '0.0.1'
+end

data/spec/cartographie/map_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'cartographie/map'
+
+describe Cartographie::Map do
+
+  subject { described_class.new }
+
+  describe 'defaults' do
+    its(:location) { should eq('Paris, France') }
+    its(:width) { should eq(300) }
+    its(:height) { should eq(300) }
+    its(:size) { should eq('300x300') }
+    its(:zoom) { should eq(15) }
+    its(:file_format) { should eq('png') }
+    its(:sensor) { should be_false }
+  end
+
+  describe 'with options' do
+    let(:options) do
+      { width: 75, height: 75, zoom: 10, file_format: 'jpg', sensor: true }
+    end
+    subject { described_class.new 'New York, NY', options }
+
+    its(:location) { should eq('New York, NY') }
+    its(:width) { should eq(75) }
+    its(:height) { should eq(75) }
+    its(:size) { should eq('75x75') }
+    its(:zoom) { should eq(10) }
+    its(:file_format) { should eq('jpg') }
+    its(:sensor) { should be_true }
+  end
+
+  describe '#uri' do
+    let(:map) { described_class.new 'Tokyo' }
+
+    subject { map.uri }
+
+    it "should match the instance's string representation" do
+      subject.should eq(map.to_s)
+    end
+
+    it 'returns a Google Static Maps URI' do
+      subject.should include('http://maps.googleapis.com/maps/api/staticmap')
+    end
+
+    it 'contains the map location' do
+      subject.should include(map.location)
+    end
+
+    it 'contains the map size, like 640x640' do
+      subject.should include(map.size)
+    end
+
+    it 'contains the map zoom level' do
+      subject.should include(map.zoom.to_s)
+    end
+
+    it 'contains the map file format' do
+      subject.should include(map.file_format)
+    end
+
+    it 'contains the map sensor indication' do
+      subject.should include(map.sensor.to_s)
+    end
+  end
+
+end

data/spec/cartographie_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'cartographie'
+
+describe Cartographie do
+
+  subject { described_class.map }
+
+  describe '.map' do
+    class Cartographie::Map
+    end
+
+    it { should be_a(Cartographie::Map) }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: cartographie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70348616677260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70348616677260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70348616676800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70348616676800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70348616676220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: *70348616676220
+description: Beautiful map generation
+email:
+- mattonrails@shortmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cartographie.gemspec
+- lib/cartographie.rb
+- lib/cartographie/map.rb
+- lib/cartographie/version.rb
+- spec/cartographie/map_spec.rb
+- spec/cartographie_spec.rb
+- spec/spec_helper.rb
+homepage: http://mattonrails.github.com/cartographie/
+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.16
+signing_key: 
+specification_version: 3
+summary: Wrapper for Google's Static Maps API
+test_files:
+- spec/cartographie/map_spec.rb
+- spec/cartographie_spec.rb
+- spec/spec_helper.rb