live_f1-core 0.0.1

data/features/fixtures/sessions/2012.05.bahrain.race.post/7167/session.key

@@ -0,0 +1 @@
+AF661706

data/features/live_f1.feature

@@ -0,0 +1,14 @@
+Feature: Live timing connection
+  In order to follow a Formula 1 race live
+  As a user of the LiveF1 library
+  I want to receive packets of data
+
+  Scenario: Connecting before the session has started
+    Given the live timing session is about to start
+    When I successfully connect to the live timing service
+    Then I should receive packets of data
+
+  Scenario: Connecting after the session has completed
+    Given the live timing session has been completed
+    When I successfully connect to the live timing service
+    Then I should receive packets of data

data/features/step_definitions/live_f1_steps.rb

@@ -0,0 +1,69 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'live_f1'
+require 'cucumber/rspec/doubles'
+
+Given /^the live timing session is about to start$/ do
+  # fixture_session '2012.04.bahrain.practice.2'
+  fixture_session '2012.03.china.qualifying'
+end
+
+Given /^the live timing session has been completed$/ do
+  fixture_session '2012.05.bahrain.race.post'
+end
+
+When /^I successfully connect to the live timing service$/ do
+  @stream = LiveF1::Source::Live.new 'gareth@example.com', 'swordfish'
+end
+
+Then /^I should receive packets of data$/ do
+  packets = []
+  @stream.run do |packet|
+    packets << packet
+  end
+  packets.should include_a(LiveF1::Packet::Sys::SessionStart)
+end
+
+def fixture_session name
+  fixture_base = File.expand_path(File.join(File.dirname(__FILE__),'../fixtures/sessions',name))
+
+  stream_filename = File.join(fixture_base,'session.bin')
+  # Stubbing a Socket with a File may have consequences
+  TCPSocket.stub(:open) { File.open(stream_filename) }
+
+  sessions = Dir[File.join(fixture_base,'*')].select { |f| File.directory? f }
+  sessions.each do |session|
+    keyframe_data = YAML.load(File.read(File.join(session, "keyframes.yaml")))
+    keyframe_data.each do |filename, data|
+      url = "http://80.231.178.249/#{filename}"
+      FakeWeb.register_uri(:get, url, :body => data)
+    end
+
+    session_number = File.basename(session)
+    keyfile = File.join(session,'session.key')
+    FakeWeb.register_uri(:post, 'http://80.231.178.249/reg/login', :set_cookie => "USER=abc123def")
+    FakeWeb.register_uri(:get,  "http://80.231.178.249/reg/getkey/#{session_number}.asp?auth=abc123def", :body => keyfile)
+  end
+end
+
+# def live_timing_session &block
+#   receiver = Object.new
+#   class << receiver
+#     attr_writer :packets
+#
+#     def packets
+#       @packets ||= []
+#     end
+#
+#     def method_missing m, *args
+#       self.packets += MockPacket.send(m, *args)
+#     end
+#   end
+#
+#   yield receiver
+#
+#   receiver.packets << nil
+#
+#   socket = mock("socket")
+#   socket.stub(:read) { receiver.packets.shift }
+#   TCPSocket.stub(:open) { socket }
+# end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'fakeweb'
+
+RSpec::Matchers.define :include_a do |klass|
+  match do |actual|
+    actual.any? { |item| klass === item }
+  end
+end
+
+FakeWeb.allow_net_connect = false

data/lib/live_f1/debug.rb

@@ -0,0 +1,6 @@
+module LiveF1
+  # Adds a debug accessor to trigger extra debugging within the module
+  class << self
+    attr_accessor :debug
+  end
+end

data/lib/live_f1/enum.rb

@@ -0,0 +1,9 @@
+module LiveF1
+  # Adds a convenience method for converting between constant values and names
+  module Enum
+    # Returns the first constant (in definition order) matching the given value
+    def name_for value
+      constants.detect { |c| const_get(c) == value }
+    end
+  end
+end

data/lib/live_f1/event.rb

@@ -0,0 +1,23 @@
+require 'live_f1/enum'
+
+module LiveF1
+  # An Event represents a usable metric relating to a car or live session.
+  class Event
+    module Type
+      extend LiveF1::Enum
+      RACE = 1
+      PRACTICE = 2
+      QUALIFYING = 3
+    end
+    include Type
+
+    module TrackStatus
+      extend LiveF1::Enum
+    	GREEN_FLAG          = 1
+    	YELLOW_FLAG         = 2
+    	SAFETY_CAR_STANDBY  = 3
+    	SAFETY_CAR_DEPLOYED = 4
+    	RED_FLAG            = 5
+    end
+  end
+end

data/lib/live_f1/packet/car/best_lap_time.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class BestLapTime < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/driver.rb

@@ -0,0 +1,14 @@
+module LiveF1
+  class Packet
+    class Car
+      class Driver < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        
+        def to_s
+          data
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/gap.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class Gap < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/interval.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class Interval < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/lap_count.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class LapCount < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/lap_time.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class LapTime < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/num_pits.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class NumPits < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/number.rb

@@ -0,0 +1,14 @@
+module LiveF1
+  class Packet
+    class Car
+      class Number < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        
+        def to_s
+          "%02d" % data.to_i unless data == ""
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/period_1.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Period1 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/period_2.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Period2 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/period_3.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Period3 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/pit_count.rb

@@ -0,0 +1,18 @@
+module LiveF1
+  class Packet
+    class Car
+      class PitCount < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        
+        def number
+          data.to_i
+        end
+        
+        def to_s
+          number
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/pit_lap_1.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class PitLap1 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/pit_lap_2.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class PitLap2 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/pit_lap_3.rb

@@ -0,0 +1,10 @@
+module LiveF1
+  class Packet
+    class Car
+      class PitLap3 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/position.rb

@@ -0,0 +1,14 @@
+module LiveF1
+  class Packet
+    class Car
+      class Position < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        
+        def to_s
+          data.to_s
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/position_history.rb

@@ -0,0 +1,14 @@
+module LiveF1
+  class Packet
+    class Car
+      class PositionHistory < Car
+        include Packet::Type::Long
+        include Packet::Decryptable
+
+        def to_s
+          data.bytes.map(&:to_i).inspect
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/position_update.rb

@@ -0,0 +1,13 @@
+module LiveF1
+  class Packet
+    class Car
+      class PositionUpdate < Car
+        include Packet::Type::Special
+
+        def to_s
+          header.data.to_s
+        end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/sector_1.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Sector1 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/sector_2.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Sector2 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car/sector_3.rb

@@ -0,0 +1,11 @@
+module LiveF1
+  class Packet
+    class Car
+      class Sector3 < Car
+        include Packet::Type::Short
+        include Packet::Decryptable
+        include Packet::SectorTime
+      end
+    end
+  end
+end

data/lib/live_f1/packet/car.rb

@@ -0,0 +1,13 @@
+module LiveF1
+  class Packet
+    class Car < Packet
+      def leader
+        super.gsub(/Car/) { "Car(%02d)" % header.car }
+      end
+    end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__),'car','*')].each do |file|
+  require file
+end

data/lib/live_f1/packet/decryptable.rb

@@ -0,0 +1,22 @@
+module LiveF1
+  class Packet
+    # Packets which mixin the Decryptable module represent data that is encrypted
+    # in the data stream.
+    #
+    # When setting the packet data we transparently decrypt the data, and also
+    # set a raw_data containing the original, encrypted bytes in case they are
+    # useful
+    module Decryptable
+      attr_reader :raw_data
+
+      def data= bytes
+        @raw_data = bytes
+        @data = source.decrypt(bytes)
+      end
+
+      def bytes
+        @raw_data
+      end
+    end
+  end
+end

data/lib/live_f1/packet/header.rb

@@ -0,0 +1,127 @@
+require_relative '../packet'
+require_relative '../event'
+
+module LiveF1
+  class Packet
+    # The Unknown packet is a special placeholder packet for situations where a
+    # zero-length packet is delivered but seems to have no effect on the stream
+    class Unknown < Packet
+      include Packet::Type::Special
+
+      def to_s
+        "Unknown packet type #{header.packet_type}" + (header.car > 0 ? " for car #{header.car}" : "")
+      end
+    end
+
+    # A Header uses 2 bytes of data from a live timing stream to determine all
+    # the necessary information about the packet which follows it.
+    class Header < Struct.new(:data, :packet_type, :car, :event_type)
+      attr_reader :bytes
+
+      def self.from_source source, event_type
+        bytes = source.read_bytes(2)
+        raise "No data from #{source.inspect}" unless bytes.to_s.length == 2
+        bits = bytes.to_s.reverse.unpack("B*").first
+        _, data, packet_type, car = bits.match(/^(.{7})(.{4})(.{5})$/).to_a.map { |s| s.to_i(2) }
+
+        new(data, packet_type, car, event_type).tap do |header|
+          # TODO: Maybe need a nicer way of setting this
+          header.instance_variable_set "@bytes", bytes
+        end
+      end
+
+      def car?
+        !car.zero?
+      end
+
+      def packet_klass
+        case
+        when car?
+          case event_type
+          when Event::RACE
+            case packet_type
+            when 0 then Packet::Car::PositionUpdate
+            when 1 then Packet::Car::Position
+            when 2 then Packet::Car::Number
+            when 3 then Packet::Car::Driver
+            when 4 then Packet::Car::Gap
+            when 5 then Packet::Car::Interval
+            when 6 then Packet::Car::LapTime
+            when 7 then Packet::Car::Sector1
+            when 8 then Packet::Car::PitLap1
+            when 9 then Packet::Car::Sector2
+            when 10 then Packet::Car::PitLap2
+            when 11 then Packet::Car::Sector3
+            when 12 then Packet::Car::PitLap3
+            when 13 then Packet::Car::NumPits
+            when 14 then nil
+            when 15 then Packet::Car::PositionHistory
+            end
+          when Event::PRACTICE
+            case packet_type
+            when 0 then Packet::Car::PositionUpdate
+            when 1 then Packet::Car::Position
+            when 2 then Packet::Car::Number
+            when 3 then Packet::Car::Driver
+            when 4 then Packet::Car::BestLapTime
+            when 5 then Packet::Car::Gap
+            when 6 then Packet::Car::Sector1
+            when 7 then Packet::Car::Sector2
+            when 8 then Packet::Car::Sector3
+            when 9 then Packet::Car::LapCount
+            when 10 then Packet::Car::LapCount
+            when 15 then nil
+            end
+          when Event::QUALIFYING
+            case packet_type
+            when 0 then Packet::Car::PositionUpdate
+            when 1 then Packet::Car::Position
+            when 2 then Packet::Car::Number
+            when 3 then Packet::Car::Driver
+            when 4 then Packet::Car::Period1
+            when 5 then Packet::Car::Period2
+            when 6 then Packet::Car::Period3
+            when 7 then Packet::Car::Sector1
+            when 8 then Packet::Car::Sector2
+            when 9 then Packet::Car::Sector3
+            when 10 then Packet::Car::LapCount
+            when 15 then nil
+            end
+          else
+            raise MissingEventType, "Unrecognised event type (#{event_type.inspect}), can't determine class for car packet #{packet_type.inspect}"
+          end
+        else
+          case packet_type
+          when 0 then Packet::Unknown
+          when 1 then Packet::Sys::SessionStart
+          when 2 then Packet::Sys::KeyFrame
+          when 3 then Packet::Unknown
+          when 4 then Packet::Sys::Commentary
+          when 5 then Packet::Unknown
+          when 6 then Packet::Sys::Notice
+          when 7 then Packet::Sys::Timestamp
+          when 8 then nil # Packet::Unknown
+          when 9 then Packet::Sys::Weather
+          when 10 then Packet::Sys::Speed
+          when 11 then Packet::Sys::TrackStatus
+          when 12 then Packet::Sys::Copyright
+          when 13 then nil # Packet::Unknown
+          when 14 then nil # Packet::Unknown
+          when 15 then nil # Packet::Unknown
+          end
+        end or raise UnexpectedPacket, "Unexpected #{car? ? 'car' : 'sys'} packet type #{packet_type.inspect} for #{Event::Type.name_for event_type} event"
+      end
+
+      class MissingEventType < RuntimeError
+      end
+
+      # An unexpected packet is one that we don't expect to appear in the data stream
+      class UnexpectedPacket < RuntimeError
+      end
+
+      # An unknown packet is one that we expect (from experience) to appear in the data stream but don't know its purpose
+      class UnknownPacket < RuntimeError
+      end
+    end
+  end
+end

data/lib/live_f1/packet/sector_time.rb

@@ -0,0 +1,28 @@
+module LiveF1
+  class Packet
+    module SectorTime
+
+      # Note of which bits appear in packet headers to represent different
+      # coloured sectors
+      # TODO: Use these colours somewhere
+      COLORS = {
+        0b010 => :red,
+        0b110 => :yellow,
+        0b001 => :white,
+        0b100 => :purple,
+        0b011 => :green
+      }
+
+      def seconds
+        if match = data.match(/^(?:(\d+):)?(\d+.\d+)$/)
+          _, minutes, seconds = match.to_a
+          (Rational(minutes.to_i * 60) + Rational(seconds)).to_f
+        end
+      end
+
+      def to_s
+        seconds || data
+      end
+    end
+  end
+end

data/lib/live_f1/packet/sys/commentary.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module LiveF1
+  class Packet
+    class Sys
+      class Commentary < Sys
+        include Packet::Type::Long
+        include Packet::Decryptable
+
+				# Is this the last line of this commentary string?
+				#
+				# If not, the next packet should also be a Commentary packet continuing this text
+				def terminal?
+					data.bytes.to_a[1] == 1
+				end
+
+				# Returns the line of commentary, which may only be a partial line if
+				# this commentary was split over multiple packets
+				def line
+          # The commentary packet encoding used to be all messed up. Its UTF-8
+          # characters were treated as Windows-1252 and then reconverted back
+          # to UTF-8. We used to fix that but now the issue has been
+          # corrected.
+					data[2..-1].force_encoding("UTF-8")#.encode("Windows-1252").force_encoding("UTF-8")
+				end
+
+				def to_s
+					"%s%s" % [line, (terminal? ? "" : "…")]
+				end
+      end
+    end
+  end
+end

data/lib/live_f1/packet/sys/copyright.rb

@@ -0,0 +1,9 @@
+module LiveF1
+  class Packet
+    class Sys
+      class Copyright < Sys
+        include Packet::Type::Long
+      end
+    end
+  end
+end

data/lib/live_f1/packet/sys/key_frame.rb

@@ -0,0 +1,17 @@
+module LiveF1
+  class Packet
+    class Sys
+      class KeyFrame < Sys
+        include Packet::Type::Short
+        
+        def number
+					data.reverse.unpack("B*").first.to_i(2)
+        end
+        
+        def to_s
+          "Keyframe #{number}"
+        end
+      end
+    end
+  end
+end