vatbook 0.1.0

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/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing to vatbook
+
+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. Make sure all tests are passing!
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -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,143 @@
+# Vatbook
+
+Ruby API to the Vatbook service for reading and parsing Vatsim pilot and ATC bookings.
+Booking query requests are made by FIR and individual bookings are returned as
+objects, exposing a rich set of attributes. Supports excluding enroute pilot bookings.
+Supports pulling pilot and atc bookings separately or as a combined hash.
+
+[![Build Status](https://secure.travis-ci.org/tarakanbg/vatbook.png?branch=master)](http://travis-ci.org/tarakanbg/vatbook)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tarakanbg/vatbook)
+<!-- [![Gemnasium](https://gemnasium.com/tarakanbg/vatbook.png?travis)](https://gemnasium.com/tarakanbg/vatbook) -->
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vatbook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vatbook
+
+## Usage
+
+This gem provides one public method: `vatbook`, which can be applied to
+any string (or variable containing a string) representing a full or partial FIR
+ICAO code.
+
+For example if you want to retrieve all active stations (ATC positions and pilots)
+for Bosnia-Herzegovina FIR (ICAO: LQSB), then you can use:
+
+```ruby
+# Attaching the method directly to a string:
+"LQSB".vatbook
+
+# Attaching the method to a variable containing a string:
+fir = "LQSB"
+fir.vatbook
+```
+
+### Anatomy of method returns
+
+The `vatbook` method returns a **hash** of 2 elements: 1) the matching *atc*
+bookings, 2) all matching *pilots* bookings. Each of those is an **array**, cosnsisting of
+station **objects**. Each of these objects includes a number of **attributes**:
+
+```ruby
+fir.vatbook # => {:atc => [a1, a2, a3 ...], :pilots => [p1, p2, p3, p4 ...]}
+
+fir.vatbook[:atc] #=> [a1, a2, a3 ...]
+fir.vatbook[:pilots] #=> [p1, p2, p3 ...]
+
+fir.vatbook[:atc].first #=> a1
+fir.vatbook[:pilots].first #=> p1
+
+a1.callsign #=> "LQSA_APP"
+a1.name #=> "Svilen Vassilev"
+a1.cid #=> "1175035"
+a1.start #=> "2012-10-08 08:00:00"
+a1.end #=> "2012-10-08 10:00:00"
+
+...
+
+p1.callsign #=> "ACH217S"
+p1.name #=> "Dragomir Andonovic"
+p1.cid #=> "931960"
+p1.dep #=> "LQSA"
+p1.arr #=> "LDSP"
+p1.route #=> "VRANA L5 KENEM"
+p1.aircraft #=> "AT72"
+...
+```
+
+### Station attributes
+
+Here's a complete list of the station object attributes that can be accessed:
+
+#### Common attributes for atc and pilots:
+
+* `cid` (VATSIM ID)
+* `callsign`
+* `name`
+* `role` (atc or pilot)
+* `fir` (the FIR ICAO used in the request)
+* `start` (planned start time)
+* `end` (planned end time)
+
+#### Pilot specific attributes
+
+* `dep` (planned departure airport)
+* `arr` (planned destination airport)
+* `route` (planned route)
+* `aircraft` (planned aircraft type)
+* `enroute` (boolean, whether or not the flight is enroute for the FIR)
+
+### Customizing the request
+
+The `vatbook` method can be customized by passing in a hash-style collection
+of arguments. The currently supported arguments and their defaults are:
+
+```ruby
+:enroute => true     # Possible values: true, false. Default: true
+```
+The `:enroute => false` option can be used to exclude all booked flights that
+are enroute for the selected FIR, i.e. don't originate or end on one of the FIR's
+airports. Example:
+
+```ruby
+# Lets exclude all enroute pilot bookings for LQSB FIR and only display bookings
+# that are outbound/inbound one of Bosnia-Herzegovina airports:
+
+"LQSB".vatbook(:enroute => false) #=> [pilot1, pilot2, pilot3...]
+```
+
+## Changelog
+
+### v. 0.1 - 22 October 2012
+
+* Initial release
+
+## 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. Make sure all tests pass
+6. Create new Pull Request
+
+## Credits
+
+Copyright © 2012 [Svilen Vassilev](http://about.me/svilen)
+
+*If you find my work useful or time-saving, you can endorse it or buy me a beer:*
+
+[![endorse](http://api.coderwall.com/svilenv/endorse.png)](http://coderwall.com/svilenv)
+[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5FR7AQA4PLD8A)
+
+Released under the [MIT LICENSE](https://github.com/tarakanbg/vatbook/blob/master/LICENSE.txt)

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/lib/vatbook.rb

@@ -0,0 +1,119 @@
+require "vatbook/version"
+
+class String
+  def vatbook(args={})
+    Vatbook.bookings(self, args)
+  end
+end
+
+module Vatbook
+  def self.bookings(fir, args)
+    BookFetcher.new(fir, args).fetch
+  end
+
+  class BookFetcher
+    require 'nokogiri'
+    require 'open-uri'
+
+    attr_accessor :fir, :atc_bookings, :pilot_bookings, :enroute, :doc
+
+    def initialize(fir, args = nil)
+      @fir = fir.upcase
+      @enroute = true
+      process_arguments(args) if args.class == Hash
+      @atc_bookings = []; @pilot_bookings = [];
+      @doc = raw_list
+      atcs
+      pilots
+    end
+
+    def raw_list
+      Nokogiri::XML(open("http://vatbook.euroutepro.com/xml2.php?fir=#{@fir}"))
+    end
+
+    def fetch
+       {:atc => atc_bookings, :pilots => pilot_bookings}
+    end
+
+    def atc_bookings
+      @atc_bookings
+    end
+
+    def pilot_bookings
+      @pilot_bookings
+    end
+
+    def atcs_count
+      @doc.css("atcs booking").count
+    end
+
+    def pilots_count
+      @doc.css("pilots booking").count
+    end
+
+    private
+
+    def atcs
+      @doc.css("atcs booking").each do |booking|
+        @atc_bookings << Booking.new(booking, role = "atc", @fir)
+      end
+    end
+
+    def pilots
+      @doc.css("pilots booking").each do |booking|
+        if @enroute == false
+          bk = Booking.new(booking, role = "pilot", @fir)
+          if bk.enroute == false
+            @pilot_bookings << bk
+          end
+        else
+          @pilot_bookings << Booking.new(booking, role = "pilot", @fir)
+        end
+      end
+    end
+
+    def process_arguments(args)
+      args[:enroute] == false ? @enroute = false : @enroute = true
+    end
+
+  end
+
+   class Booking
+    require 'nokogiri'
+
+    attr_accessor :role, :callsign, :name, :cid, :start, :end, :dep, :arr
+    attr_accessor :aircraft, :route, :enroute, :fir
+
+
+    def initialize(booking, role, fir)
+      @fir = fir
+      @role = role
+      @callsign = booking.children.css("callsign").first.children.to_s
+      @name = booking.children.css("name").first.children.to_s
+      @role == "atc" ? @cid = booking.children.css("cid").first.children.to_s : @cid = booking.children.css("pid").first.children.to_s
+      if @role == "atc"
+        @start = booking.children.css("time_start").first.children.to_s
+        @end = booking.children.css("time_end").first.children.to_s
+      elsif @role == "pilot"
+        @dep = booking.children.css("dep").first.children.to_s
+        @arr = booking.children.css("arr").first.children.to_s
+        @route = booking.children.css("route").first.children.to_s.gsub(/[\n]/, ' ').strip
+        @start = booking.children.css("from").first.children.to_s
+        @end = booking.children.css("to").first.children.to_s
+        @aircraft = booking.children.css("actype").first.children.to_s
+        check_enroute
+      end
+    end
+
+  private
+    def check_enroute
+      if @fir[0..1] == @dep[0..1] or @fir[0..1] == @arr[0..1]
+        @enroute = false
+      else
+        @enroute = true
+      end
+    end
+
+  end
+
+end

data/lib/vatbook/version.rb

@@ -0,0 +1,3 @@
+module Vatbook
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'vatbook'
+
+module Vatbook
+  class BookFetcher
+    def raw_list
+      Nokogiri::XML(open("spec/xml2.xml"))
+    end
+  end
+end

data/spec/vatbook_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper.rb'
+
+describe String do
+
+  describe "fir" do
+    it "should work :)" do
+      "LQSB".vatbook.count.should eq(2)
+      "LQSB".vatbook[:atc].count.should eq(207)
+      "LQSB".vatbook[:pilots].count.should eq(2)
+      "lqsb".vatbook[:atc].count.should eq(207)
+      "lqsb".vatbook[:pilots].count.should eq(2)
+    end
+
+    it "should contain attributes" do
+      "LQSB".vatbook[:atc].first.role.should eq("atc")
+      "LQSB".vatbook[:atc].first.callsign.should eq("LFMN_TWR")
+      "LQSB".vatbook[:atc].first.name.should eq("Tomba Quentin")
+      "LQSB".vatbook[:atc].first.cid.should eq("1227003")
+      "LQSB".vatbook[:atc].first.start.should eq("2012-10-08 08:00:00")
+      "LQSB".vatbook[:atc].first.end.should eq("2012-10-08 10:00:00")
+      "LQSB".vatbook[:pilots].first.role.should eq("pilot")
+      "LQSB".vatbook[:pilots].first.callsign.should eq("KLM112")
+    end
+  end
+
+end
+
+describe Vatbook do
+
+  describe "vatsim_online" do
+    it "should work :)" do
+    end
+  end
+
+end
+
+
+describe Vatbook::BookFetcher do
+  describe "atcs count" do
+    it "should return correct count" do
+      icao = "LQSB"
+      Vatbook::BookFetcher.new(icao).atcs_count.should eq(207)
+      Vatbook::BookFetcher.new(icao).pilots_count.should eq(2)
+    end
+  end
+
+  describe "pilot bookings" do
+    it "should parse pilot attributes" do
+      icao = "LQSB"
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.role.should eq("pilot")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.callsign.should eq("KLM112")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.name.should eq("Edwin Middelaar EHAM")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.cid.should eq("931960")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.route.should eq("OTREX UM872 PLH UB1 DDM UM619 YNN UL604 BIGGE T281 NORKU")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.dep.should eq("LGIR")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.arr.should eq("EHAM")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.aircraft.should eq("B738")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.fir.should eq("LQSB")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.first.enroute.should eq(true)
+    end
+
+    it "should identify enroutes" do
+      icao = "LQSB"
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.role.should eq("pilot")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.callsign.should eq("KLM113")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.name.should eq("Edwin Middelaar EHAM")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.cid.should eq("931960")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.route.should eq("OTREX UM872 PLH UB1 DDM UM619 YNN UL604 BIGGE T281 NORKU")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.dep.should eq("LGIR")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.arr.should eq("LQSA")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.aircraft.should eq("B738")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.fir.should eq("LQSB")
+      Vatbook::BookFetcher.new(icao).pilot_bookings.last.enroute.should eq(false)
+    end
+
+    it "should handle enroute hash options" do
+      icao = "LQSB"
+      args = {:enroute => true}
+      Vatbook::BookFetcher.new(icao, args).pilot_bookings.count.should eq(2)
+      Vatbook::BookFetcher.new(icao, args).pilot_bookings.first.arr.should eq("EHAM")
+      args = {:enroute => false}
+      Vatbook::BookFetcher.new(icao, args).pilot_bookings.count.should eq(1)
+      Vatbook::BookFetcher.new(icao, args).pilot_bookings.first.arr.should eq("LQSA")
+    end
+  end
+
+  describe "atc bookings" do
+    it "should parse atc attributes" do
+      icao = "LQSB"
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.role.should eq("atc")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.fir.should eq("LQSB")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.callsign.should eq("LFMN_TWR")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.name.should eq("Tomba Quentin")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.cid.should eq("1227003")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.start.should eq("2012-10-08 08:00:00")
+      Vatbook::BookFetcher.new(icao).atc_bookings.first.end.should eq("2012-10-08 10:00:00")
+    end
+  end
+end