gcmapper 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/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Svilen Vassilev
+
+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,96 @@
+# GCMapper [![Build Status](https://secure.travis-ci.org/tarakanbg/gcmapper.png)](http://travis-ci.org/tarakanbg/gcmapper)
+
+A Ruby gem for easy generation of Great Circle Map images between 2 or more airports.
+The gem provides an API for constructing the image URLs, the maps themselves are pulled from
+[gcmap.com](http://www.gcmap.com/).
+
+The look and size of the map image can be customized by passing an optional hash of arguments, as explained
+in the [Usage section](#usage).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gcmapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gcmapper
+
+## Usage
+
+The `.gcmap` method can be applied to a string (or variable containing a string), representing a valid route
+between 2 or more airports (ICAO or IATA codes), connected with dashes, like this: `EGLL-LOWI` or
+`LFST-LSZH-LBSF`. Here are some examples:
+
+```ruby
+# An example of normal route:
+route = "EGLL-LOWI"
+route.gcmap # => Returns an image map URL for the route EGLL-LOWI
+
+# An exampmle of layover route:
+another_route = "LFST-LSZH-LBSF"
+another_route.gcmap # => Returns an image map URL for the layover route LFST-LSZH-LBSF
+
+# The method can be applied directly to a string:
+"EGLL-LOWI".gcmap # => Returns an image map URL for the route EGLL-LOWI
+
+# It's not case sensitive:
+"egll-lowi".gcmap # => Returns an image map URL for the route EGLL-LOWI
+```
+
+The resulting image size and look can be customized by passing an optional hash of arguments to the
+`.gcmap` method. Customizable attributes include *width, height* and *terrain* (toggle satelite terrain overlay).
+These options can be combined in any way or omitted entirely. Examples:
+
+```ruby
+# Passing width only (default is 720px):
+route = "egll-lowi"
+route.gcmap(:width => "600") # => Returns an image map URL with width set to 600px
+
+# Passing height only (default is 360px):
+route = "egll-lowi"
+route.gcmap(:height => 400)  # => Returns an image map URL with height set to 400px
+
+# Passing width and height:
+"egll-lowi".gcmap(:width => "800", :height => "400") # => Returns an image map URL with width 800px and height 400px
+
+# Enabling terrain overlay:
+route = "egll-lowi"
+route.gcmap(:terrain => true) # => Returns an image map URL with terrain overlay enabled
+
+# Setting width, height and enabling terrain overlay:
+"egll-lowi".gcmap(:width => 800, :height => 400, :terrain => true) # => Returns an image map URL with set width, height and terrain
+```
+
+Finally, here's an example of how to use the gem in a Rails application:
+
+*In your controller:*
+```ruby
+@route = "egll-lowi"
+```
+
+*In your view:*
+```erb
+<%= image_tag @route.gcmap(:width => "600") %>
+```
+
+#### Notes:
+
+* the `route` string can be constructed from either ICAO or IATA airport codes; both types are recognized
+* the `route` string is **not case sensitive**, so for example `lgav-lqsa` will be recognized as well
+* layover routes that chain multiple airports (more than 2) are also supported
+* default image parameters are: width 720px, width: 360px, terrain not shown
+* when passing the `width` and `height` hash options the values can be put in quotes or not, either way works
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gcmapper.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gcmapper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Svilen Vassilev"]
+  gem.email         = ["svilen@rubystudio.net"]
+  gem.description   = %q{Easily generate Great Circle maps between 2 or more airports. The gem provides an API for constructing the image URLs, the maps themselves are pulled from gcmap.com.}
+  gem.summary       = %q{A Ruby gem for easy generation of Great Circle Map images}
+  gem.homepage      = "https://github.com/tarakanbg/gcmapper"
+
+  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          = "gcmapper"
+  gem.require_paths = ["lib"]
+  gem.version       = Gcmapper::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

data/lib/gcmapper.rb

@@ -0,0 +1,18 @@
+require "gcmapper/version"
+
+class String
+  def gcmap(args={})
+    Gcmapper.gcmap(self, args)
+  end
+end
+
+module Gcmapper
+  def self.gcmap(route, args)
+    args[:terrain].nil? || args[:terrain] == false  ? tr="wls" : tr="bm"
+    args[:width].nil? ? width="720" : width=args[:width]
+    args[:height].nil? ? height="360" : height=args[:height]
+
+    url = "http://www.gcmap.com/map?P=#{route}%0d%0a&MS=#{tr}&MR=120&MX=#{width}x#{height}&PM=b:disc7%2b%22%25i%25+%28N%22"
+  end
+end
+

data/lib/gcmapper/version.rb

@@ -0,0 +1,3 @@
+module Gcmapper
+  VERSION = "0.1"
+end

data/spec/gcmapper_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper.rb'
+
+describe String do
+
+  describe "route" do
+    it "is a string" do
+      input = "egll-lbsf"
+      input.class.should eq(String)
+    end
+  end
+
+  describe ".gcmap" do
+
+    it "should return a valid full url" do
+      route = "egll-lbsf"
+      route.gcmap[0..6].should eq("http://")
+    end
+
+    it "should integrate the route correctly in the url" do
+      route = "egll-lowi"
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret default width" do
+      route = "egll-lowi"
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret default height" do
+      route = "egll-lowi"
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should be applicable directly to a string" do
+      "egll-lowi".gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret non-default width" do
+      route = "egll-lowi"
+      route.gcmap(:width=>"600").should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=600x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret simplified non-default width" do
+      route = "egll-lowi"
+      route.gcmap(:width=>600).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=600x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret non-default height" do
+      route = "egll-lowi"
+      route.gcmap(:height=>"600").should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x600&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret simplified non-default height" do
+      route = "egll-lowi"
+      route.gcmap(:height=>600).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x600&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret non-default width and height" do
+      route = "egll-lowi"
+      route.gcmap(:width=>"800", :height=>"400").should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=800x400&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should interpret non-default simplified width and height" do
+      route = "egll-lowi"
+      route.gcmap(:width => 800, :height => 400).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=800x400&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should support layover routes" do
+      route = "egll-lowi-lqsa"
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi-lqsa%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should display terrain if needed" do
+      route = "egll-lowi"
+      route.gcmap(:terrain=>true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should accept false option for terrain" do
+      route = "egll-lowi"
+      route.gcmap(:terrain=>false).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+    it "should allow random combination of arguments" do
+      route = "egll-lowi"
+      route.gcmap(:width=>800, :height=>400, :terrain=>true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=800x400&PM=b:disc7%2b%22%25i%25+%28N%22")
+      route.gcmap(:width=>800, :terrain => true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=800x360&PM=b:disc7%2b%22%25i%25+%28N%22")
+      route.gcmap(:height=>800, :terrain=>true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=720x800&PM=b:disc7%2b%22%25i%25+%28N%22")
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'gcmapper'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: gcmapper
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Svilen Vassilev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily generate Great Circle maps between 2 or more airports. The gem
+  provides an API for constructing the image URLs, the maps themselves are pulled
+  from gcmap.com.
+email:
+- svilen@rubystudio.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gcmapper.gemspec
+- lib/gcmapper.rb
+- lib/gcmapper/version.rb
+- spec/gcmapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tarakanbg/gcmapper
+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.24
+signing_key: 
+specification_version: 3
+summary: A Ruby gem for easy generation of Great Circle Map images
+test_files:
+- spec/gcmapper_spec.rb
+- spec/spec_helper.rb