notams 0.0.1 → 0.1

data/README.md

@@ -1,8 +1,12 @@
-# Notams [![Build Status](https://secure.travis-ci.org/tarakanbg/notams.png)](http://travis-ci.org/tarakanbg/notams)
+# Notams
 
 A ruby gem for retrieving the currently active NOTAMs for an airport or a region.
-Supports multiple airports/regions in one request. Pulls data from [FAA](http://www.faa.gov/) website.
-Depends on `nokogiri` for the heavy lifting.
+Supports multiple airports/regions in one request. Pulls data from
+[FAA](http://www.faa.gov/) website. Depends on `nokogiri` for the heavy lifting.
+
+[![Build Status](https://secure.travis-ci.org/tarakanbg/notams.png)](http://travis-ci.org/tarakanbg/notams)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tarakanbg/notams)
+[![Gemnasium](https://gemnasium.com/tarakanbg/notams.png?travis)](https://gemnasium.com/tarakanbg/notams)
 
 ## Installation
 
@@ -20,10 +24,14 @@ Or install it yourself as:
 
 ## Usage
 
-The `.notams` method can be applied to any string (or variable containing a string), representing a valid
-ICAO code of an airport or FIR, or a comma-separated list of airports/regions. It will return an array,
-containing all the **currently active** NOTAMs for your selection. You can loop through the array to display or
-parse individual notams.
+### Easy mode
+
+The `.notams` method can be applied to any string literal or variable,
+representing a valid ICAO code of an airport or FIR, or a comma-separated list
+of airports/regions. It will return an array, containing all the **currently
+active** NOTAMs for your selection. You can loop through the array to display or
+parse individual notams. I figured this would be the most common use case. For
+advanced usage and possible customizations [see below](#advanced-usage).
 
 ```ruby
 icao = "lowi"
@@ -32,13 +40,84 @@ icao.notams # => returns an array containing all NOTAMs for Innsbruck airport
 "lowi".notams # => same as above
 
 icao = "lqsa,lqsb"
-icao.notams # => returns an array containing all NOTAMs for Sarajevo Airport and Bosnia and Herzegovina FIR
+icao.notams # => returns an array containing all NOTAMs for Sarajevo Airport
+            #    and Bosnia and Herzegovina FIR
 ```
 
+### Advanced usage
+
+The `.notams` method can be customized by passing an optional hash of arguments.
+
+The `:objects => true` option will cause the `.notams` method to return an array
+of notam **objects** instead of strings. Thus each notam is parsed and
+encapuslated in an instance of the `Notam` class and exposes a number of
+**attributes**:
+
+```ruby
+icao = "lqsa"
+icao.notams(:objects => true) # => returns an array of notam objects
+
+notam = icao.notams.first # => returns the first notam as an object
+
+# Notam object attributes
+
+notam.raw       # => returns the raw (unprocessed) notam as a string
+notam.icao      # => returns the icao code of the airport or area, covered by the notam;
+                #    useful when iterating over multiple notams, covering a collection of airports or areas
+notam.message   # => returns the actual information message of the notam as a string
+```
+
+### Example Ruby on Rails implementation
+
+Here's a possible scenario of using this gem in a Ruby on Rails application.
+Verbosity is kept on purpose for clarity.
+
+**In your controller:**
+```ruby
+def action
+
+ # We define the airpots and/or areas that we're interested in.
+ # In this case this is Sarajevo Airport and the entire Bosnia & Herzegovina FIR
+
+ icao = "lqsa, lqsb"
+
+ # Now we want to pull all the latest notams for both these areas.
+ # We also want to pull them as objects, so that we can process their attributes
+ # separately in our views. We're assigning the result to the @notams instance
+ # variable which we will use in our views
+
+ @notams = icao.notams(:objects => true)
+
+end
+```
+
+**In your view (HAML is used for clarity):**
+
+```haml
+// We could play with the attributes individually if we need to:
+- for notam in @notams
+  %li
+   = notam.icao
+   = notam.message
+
+// Or we could just loop through the raw notams:
+- for notam in @notams
+  %li= notam.raw
+```
+
+## Changelog
+
+### v. 0.1 28 July 2012
+
+* added optional arguments customization to the `.notams` method (see [Advanced Usage](#advanced-usage))
+* code refactored into classes for flexibility
+
+
 ## 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
+4. Make sure all tests are passing
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/notams.rb

@@ -1,25 +1,82 @@
 require "notams/version"
-require 'nokogiri'
-require 'open-uri'
-
 
 class String
-  def notams
-    Notams.notams(self)
+  def notams(args={})
+    Notams.notams(self, args)
   end
 end
 
 module Notams
-  def self.notams(icao)
-    notams = []
-    get_raw_page(icao).css("pre").each {|n| notams << n.text }
-    return notams
+  def self.notams(icao, args)
+    NotamFetcher.new(icao, args).fetch
+  end
+
+  class NotamFetcher
+    require 'nokogiri'
+    require 'open-uri'
+
+    attr_accessor :icao, :obj_list, :notams, :string_notams
+
+    def initialize(icao, args = nil)
+      @icao = icao
+      process_arguments(args) if args.class == Hash
+      @notams = []; @string_notams = []
+      notams_object_list
+      notams_string_list
+    end
+
+    def raw_list
+      Nokogiri::HTML(open("https://pilotweb.nas.faa.gov/PilotWeb/notamRetrievalByICAOAction.do?method=displayByICAOs&reportType=RAW&formatType=DOMESTIC&retrieveLocId=#{@icao}&actionType=notamRetrievalByICAOs"))
+    end
+
+    def fetch
+      @obj_list == true ? @notams : @string_notams
+    end
+
+    private
+
+    def notams_string_list
+      @notams.each {|n| @string_notams << n.to_s}
+    end
+
+    def notams_object_list
+      raw_list.css("pre").each {|n| @notams << Notam.new(n.text)}
+    end
+
+    def process_arguments(args)
+      args[:objects] == true ? @obj_list = true : @obj_list = false
+    end
+
   end
 
-private
+  class Notam
+
+    attr_accessor :raw, :message, :icao
+
+    def initialize(text)
+      @raw = text
+      @message = get_message
+      @icao = get_icao
+    end
+
+    def to_s
+      @raw
+    end
+
+    private
+
+    def get_message
+      starts = @raw.index('E)') + 3
+      @raw.index('F)') ? ends = @raw.index('F)') : ends = @raw.length
+      @raw[starts..ends]
+    end
+
+    def get_icao
+      starts = @raw.index('A)') + 3
+      ends = @raw.index('B)') - 2
+      @raw[starts..ends]
+    end
 
-  def self.get_raw_page(icao)
-    Nokogiri::HTML(open("https://pilotweb.nas.faa.gov/PilotWeb/notamRetrievalByICAOAction.do?method=displayByICAOs&reportType=RAW&formatType=DOMESTIC&retrieveLocId=#{icao}&actionType=notamRetrievalByICAOs"))
   end
 
 end

data/lib/notams/version.rb

@@ -1,3 +1,3 @@
 module Notams
-  VERSION = "0.0.1"
+  VERSION = "0.1"
 end

data/notams.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "guard"
   gem.add_development_dependency "libnotify"
   gem.add_development_dependency "guard-rspec"
-  gem.add_dependency "nokogiri"
+  gem.add_dependency "nokogiri", "~> 1.5.5"
 
 end

data/spec/notams_spec.rb

@@ -36,15 +36,46 @@ describe String do
       "lqsa".notams.length.should_not eq("lqsa,lqsb".notams.length)
     end
 
+    it "should process params" do
+      "lqsa".notams(:objects => false).should eq("lqsa".notams)
+      "lqsa".notams(:objects => false).should_not eq("lqsa".notams(:objects => true))
+    end
+
+    it "should return objects when argument is set" do
+      icao = "lqsa"
+      icao.notams(:objects => true).class.should eq(Array)
+      Notams::NotamFetcher.new(icao, :objects => true).obj_list.should eq(true)
+      Notams::NotamFetcher.new(icao, :objects => true).notams.should_not eq(Notams::NotamFetcher.new(icao, :objects => true).string_notams)
+      icao.notams(:objects => true).first.class.should_not eq(String)
+      icao.notams(:objects => true).first.class.should eq(Notams::Notam)
+    end
+
+    it "should properly return the notam object message" do
+      icao = "lqsa"
+      Notams::NotamFetcher.new(icao, :objects => true).fetch.first.message.should eq(icao.notams(:objects => true).first.message)
+      icao.notams(:objects => true).first.message.class.should eq(String)
+      # "lqsb".notams(:objects => true).first.message.should eq("moo")
+    end
+
+    it "should properly return the notam object icao" do
+      icao = "lqsa"
+      Notams::NotamFetcher.new(icao, :objects => true).fetch.first.icao.should eq(icao.notams(:objects => true).first.icao)
+      icao.notams(:objects => true).first.icao.class.should eq(String)
+      icao.notams(:objects => true).first.icao.should eq("LQSA")
+      icao.notams(:objects => true).first.icao.should eq(icao.upcase)
+      "lqsb".notams(:objects => true).first.icao.should eq("LQSB")
+    end
+
+
   end
 
-describe Notams do
+describe Notams::NotamFetcher do
 
-  describe "get_raw_page" do
+  describe "raw_list" do
     it "should execute open uri request via Nokogiri" do
       icao = "lqsa"
-      Notams.get_raw_page(icao).class.should eq(Nokogiri::HTML::Document)
-      Notams.get_raw_page(icao).css("title").text.should eq("PilotWeb: Results Page ")
+      Notams::NotamFetcher.new(icao).raw_list.class.should eq(Nokogiri::HTML::Document)
+      Notams::NotamFetcher.new(icao).raw_list.css("title").text.should eq("PilotWeb: Results Page ")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notams
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,17 +96,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.5
 description: Retrieves the currently active NOTAMs for an airport or a region. Supports
   multiple airports/regions in one request. Pulls data from FAA website.
 email: