gcmapper 0.1 → 0.2

data/README.md

@@ -44,8 +44,20 @@ another_route.gcmap # => Returns an image map URL for the layover route LFST-LSZ
 ```
 
 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:
+`.gcmap` method. Customizable attributes include *width, height, terrain (toggle satelite terrain
+ overlay), city label and airport name label*.
+Width, height and terrain can be combined in any way or omitted entirely. City label ad Airport name
+label are mutually exclusive.
+
+### Defaults
+
+* width: 720px
+* height: 360px
+* terrain: off
+* city label: on
+* airport name label: off
+
+### Examples:
 
 ```ruby
 # Passing width only (default is 720px):
@@ -65,6 +77,17 @@ route.gcmap(:terrain => true) # => Returns an image map URL with terrain overlay
 
 # 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
+
+# Setting width, height, enabling terrain overlay and disabling the city labels:
+"egll-lowi".gcmap(:width => 800, :height=>400, :terrain=>true, :city=>false) # => Returns an image map URL with set width, height and terrain, with city labels disabled
+
+# Setting the map to display the airports' names instead of the ICAO/IATA codes
+route = "egll-lowi"
+route.gcmap(:airport_name => true) # => Returns an image map URL with airport names displayed
+
+# Setting the map to display the airports' names and a terrain overlay
+route = "egll-lowi"
+route.gcmap(:airport_name => true, :terrain => true) # => Returns an image map URL with airport names and terrain displayed
 ```
 
 Finally, here's an example of how to use the gem in a Rails application:
@@ -86,6 +109,17 @@ Finally, here's an example of how to use the gem in a Rails application:
 * 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
+* `city` label and `airport_name` label options are mutually exclusive, i.e. you can either have the ICAO/IATA code with optional city name OR the Airport name
+
+## Changelog
+
+### v. 0.2 July 2nd 2012
+
+* [Enhancement] Maps now show the user input code (ICAO or IATA) instead of ICAO only
+* [Feature] New hash option `:city` to toggle city labels on or off (see [Usage](#usage))
+* [Feature] New hash option `:airport_name` to toggle airport name labels on or off (see [Usage](#usage))
+
+
 
 ## Contributing
 

data/lib/gcmapper.rb

@@ -11,8 +11,20 @@ module Gcmapper
     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]
+    style = parse_styles(args)
+    url = "http://www.gcmap.com/map?P=#{route}%0d%0a&MS=#{tr}&MR=120&MX=#{width}x#{height}&PM=#{style}"
+  end
+
+private
+  # disc + user code             b:disc7%2b%25U
+  # disc + user_code + city      b:disc7%2b\"%25U%25+%28N\"
+  # disc + airport_name          b:disc7+%A
 
-    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"
+  def self.parse_styles(args)
+    style = 'b:disc7%2b' #basic
+    args[:city] == false ? style += '%25U' : style += '"%25U%25+%28N"'
+    style = 'b:disc7+%A' if args[:airport_name] == true
+    return style
   end
 end
 

data/lib/gcmapper/version.rb

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

data/spec/gcmapper_spec.rb

@@ -18,73 +18,99 @@ describe String do
 
     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")
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
     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")
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
     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")
+      route.gcmap.should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
     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")
+      "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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
     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")
+      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\"%25U%25+%28N\"")
+    end
+
+    it "should disable the city label when requested" do
+      route = "egll-lowi"
+      route.gcmap(:city=>false).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b%25U")
+    end
+
+    it "should handle the city true option" do
+      route = "egll-lowi"
+      route.gcmap(:city=>true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
+    end
+
+    it "should handle the airport_name option" do
+      route = "egll-lowi"
+      route.gcmap(:airport_name=>true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7+%A")
+    end
+
+    it "should disable the airport name when requested" do
+      route = "egll-lowi"
+      route.gcmap(:airport_name=>false).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
+    end
+
+    it "should display terrain and airport names" do
+      route = "egll-lowi"
+      route.gcmap(:airport_name => true, :terrain => true).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=720x360&PM=b:disc7+%A")
     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")
+      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\"%25U%25+%28N\"")
+      route.gcmap(:width => 800, :height=>400, :terrain=>true, :city=>false).should eq("http://www.gcmap.com/map?P=egll-lowi%0d%0a&MS=bm&MR=120&MX=800x400&PM=b:disc7%2b%25U")
+      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\"%25U%25+%28N\"")
+      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\"%25U%25+%28N\"")
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcmapper
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-01 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec