live_f1-core 0.0.1 → 0.0.2

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+= LiveF1 Changelog
+
+== 0.0.2
+
+* Removed example binary to separate repo at http://github.com/gareth/live_f1-stream
+* Fixed data logging issue so data will be saved into a replayable file if Source::LiveF1#log_dir is set
+* Handled error which appeared when streaming in the run-up to a session
+* Other bugfixes and refactoring
+
+== 0.0.1
+
+* Birthday!

data/Gemfile

@@ -1,3 +1,15 @@
 source :gemcutter
 
 gemspec
+
+# Guard dependencies are here rather than in the gemspec, as gemspec doesn't
+# offer a way to conditionally require gems per platform, like below
+#
+# They aren't development-critical enough to worry about, anyway
+gem 'guard-rspec'
+gem 'guard-cucumber'
+
+# `:require => ...` will evaluate to either `false` or the correct library string depending on the platform
+gem 'growl', :require => RUBY_PLATFORM.include?('darwin') && 'growl'
+gem 'rb-fsevent', :require => RUBY_PLATFORM.include?('darwin') && 'rb-fsevent'
+gem 'rb-inotify', :require => RUBY_PLATFORM.include?('linux') && 'rb-inotify'

data/Gemfile.lock

@@ -15,6 +15,7 @@ GEM
       json (>= 1.4.6)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
+    ffi (1.1.5)
     gherkin (2.11.5)
       json (>= 1.4.6)
     growl (1.0.3)
@@ -29,7 +30,6 @@ GEM
     guard-rspec (2.1.0)
       guard (>= 1.1)
       rspec (~> 2.11)
-    hpricot (0.8.6)
     json (1.7.5)
     listen (0.5.3)
     lumberjack (1.0.2)
@@ -38,7 +38,10 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.3.1)
+    rake (0.9.2.2)
     rb-fsevent (0.9.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -54,12 +57,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  cucumber
-  fakeweb
+  cucumber (~> 1.0)
+  fakeweb (~> 1.2, >= 1.2.4)
   growl
   guard-cucumber
   guard-rspec
-  hpricot
   live_f1-core!
+  rake (>= 0.9)
   rb-fsevent
-  rspec
+  rb-inotify
+  rspec (~> 2.7)

data/README.rdoc

@@ -24,10 +24,6 @@ The project uses Bundler, so get all the development dependencies with a simple
 
   $ bundle install
 
-== KNOWN ISSUES
-
-* Currently live binary data is not being logged for playback
-
 == LICENSE
 
 (The MIT License)

data/Rakefile

@@ -1,6 +1,9 @@
+require 'bundler'
 require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 
+Bundler::GemHelper.install_tasks
+
 Cucumber::Rake::Task.new(:features) do |t|
     t.cucumber_opts = "--format progress"
 end

data/lib/live_f1/packet/header.rb

@@ -20,7 +20,7 @@ module LiveF1
 
       def self.from_source source, event_type
         bytes = source.read_bytes(2)
-        raise "No data from #{source.inspect}" unless bytes.to_s.length == 2
+        raise MissingData, "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) }
 
@@ -122,6 +122,9 @@ module LiveF1
       # 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
+
+      class MissingData < EOFError
+      end
     end
   end
 end

data/lib/live_f1/source/live.rb

@@ -25,7 +25,6 @@ module LiveF1
             socket.read(num) or raise EOFError
           end
         rescue Timeout::Error, Errno::ETIMEDOUT => e
-          log.flush
           socket.write("\n")
           socket.flush
           retry
@@ -35,6 +34,7 @@ module LiveF1
       def keyframe number = nil
         io = open("http://#{HOST}/#{keyframe_filename(number)}")
         log.keyframe(number, io.read) if number
+        log.flush
         io.rewind
         Source::Keyframe.new io, self
       rescue SocketError
@@ -42,6 +42,7 @@ module LiveF1
       end
 
       def decryption_key session_number
+        return if session_number.zero?
         key = open("http://#{HOST}/reg/getkey/#{session_number}.asp?auth=#{auth}").read.to_i(16)
         raise ConnectionError, "Unable to access session key for session #{session_number}. This could indicate incorrect credentials or an issue with the formula1.com key server" if key.zero?
         key
@@ -67,10 +68,10 @@ module LiveF1
           yield packet
         end
       rescue Errno::ECONNRESET
-        log.flush
+        log.reset
         retry
       rescue Exception
-        log.flush
+        log.reset
         raise
       end
 
@@ -96,11 +97,13 @@ module LiveF1
         "keyframe#{ "_%05d" % number if number}.bin"
       end
 
-      class LogProxy
+      # Wraps a logfile in methods which mean the caller doesn't need to know
+      # if a log is currently open or not
+      class LogProxy # :nodoc:
         class << self
           def start session_number
-            flush
-            @log = Log.new session_number
+            reset
+            @log = Log.new session_number unless session_number.zero?
           end
 
           [:key, :packet, :keyframe].each do |m|
@@ -109,8 +112,14 @@ module LiveF1
             end
           end
 
+          # Writes the current logfile to disk
           def flush
             @log.flush if @log
+          end
+
+          # Writes the current logfile to disk and then closes the log
+          def reset
+            flush
             @log = nil
           end
         end
@@ -118,13 +127,14 @@ module LiveF1
 
       class Log
         class << self
-          attr_reader :dir
+          attr_accessor :dir
 
           def dir= log_directory
             @dir = Pathname.new(log_directory).join(Date.today.strftime("%Y%m%d"))
             FileUtils.mkdir_p(@dir)
           end
 
+          # Has logging been set up (do we have a log directory to write to)?
           def active?
             !!@dir
           end
@@ -139,18 +149,22 @@ module LiveF1
           }
         end
 
-        def key k
-          @data[:key] = k
+        # Adds a decryption key to this log
+        def key key
+          @data[:key] = key
         end
 
-        def packet p
-          @data[:bytes] << p.header.bytes << p.bytes
+        # Adds a packet to this log's bytestream
+        def packet packet
+          @data[:bytes] << packet.header.bytes << packet.bytes
         end
 
-        def keyframe n, k
-          @data[:keyframes][n] = k
+        # Adds keyframe `n` to this log
+        def keyframe number, keyframe_bytes
+          @data[:keyframes][number] = keyframe_bytes
         end
 
+        # Writes this logfile to disk
         def flush
           File.open(@filename, "w") { |f| f.write YAML.dump(@data) } if @filename
         end

data/lib/live_f1/source/session.rb

@@ -27,6 +27,9 @@ module LiveF1
       # Decrypts the given string using this session's decryption_key and the
       # current state of the decryption_salt.
       def decrypt input
+        # Sometimes we don't have a decryption key, e.g. Notice is a
+        # decryptable packet but sometimes appears between sessions
+        return input unless decryption_key
         input.bytes.map do |b|
           self.decryption_salt = (decryption_salt >> 1) ^ ((decryption_salt & 0x01).zero? ? 0 : decryption_key)
           b ^ (decryption_salt & 0xff)

data/lib/live_f1/version.rb

@@ -1,3 +1,3 @@
 module LiveF1
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/live_f1-core.gemspec

@@ -15,12 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = LiveF1::VERSION
 
-  gem.add_development_dependency "hpricot"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "cucumber"
-  gem.add_development_dependency "guard-rspec"
-  gem.add_development_dependency "guard-cucumber"
-  gem.add_development_dependency "growl"
-  gem.add_development_dependency "fakeweb"
-  gem.add_development_dependency "rb-fsevent"
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'cucumber', '~> 1.0'
+
+  gem.add_development_dependency 'rake', '>= 0.9'
+  gem.add_development_dependency 'fakeweb', '~> 1.2', '>= 1.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_f1-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,96 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hpricot
-  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: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: cucumber
   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: guard-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: guard-cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: growl
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,56 +58,45 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   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: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+        version: '1.2'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.4
 description: Parses raw events from the Formula1.com live timing stream
 email:
 - g@rethada.ms
-executables:
-- live_f1_example
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .autotest
 - .gitignore
 - .rspec
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - README.rdoc
 - Rakefile
-- bin/live_f1_example
 - features/fixtures/sessions/2012.03.china.qualifying/7136/keyframes.yaml
 - features/fixtures/sessions/2012.03.china.qualifying/7136/session.key
 - features/fixtures/sessions/2012.03.china.qualifying/session.bin
@@ -334,4 +275,3 @@ test_files:
 - spec/live_f1/source_spec.rb
 - spec/spec_helper.rb
 - spec/support/packet_type_examples.rb
-has_rdoc: 

data/bin/live_f1_example

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require 'optparse'
-require 'highline'
-
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-require 'live_f1'
-
-options = {}
-OptionParser.new do |opts|
-  opts.separator ""
-  opts.separator "Specific options:"
-
-  opts.on("-f LOGFILE", "--file", "Replays the given previously recorded .f1 data file (if not specified, will attempt to connect to the live timing server)") do |logfile|
-    options[:logfile] = logfile
-  end
-  opts.on("-u USERNAME", "--username", "For live connections, specify the formula1.com live timing username") do |username|
-    options[:username] = username
-  end
-  opts.on("-p [PASSWORD]", "--password", "For live connections, specify the formula1.com live timing password. Omitting the password will cause live-f1 to prompt for it.") do |password|
-    unless password
-      prompt = HighLine.new
-      password = prompt.ask("Password: ") { |q| q.echo = false }
-    end
-    options[:password] = password
-  end
-  opts.on("-d", "--debug", "Display bit data from each data packet's header") do
-    LiveF1.debug = true
-  end
-
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-
-end.parse!
-
-if options[:logfile]
-
-  timestamp = nil
-  packets = []
-
-  source = LiveF1::Source::Log.new(File.open(options[:logfile]))
-  source.run do |packet|
-    packets << packet
-    case packet
-    when LiveF1::Packet::Sys::Timestamp
-      t_start = timestamp || packet.number
-      t_end = packet.number
-      t_diff = t_end - t_start
-
-      # The interval is the difference in time between the last 2 timestamps, divided
-      # by the number of packets between the timestamps. This is then divided by 4 to
-      # speed up the replay
-      interval = t_diff.to_f / (packets.length) / 8
-      packets.pop # Remove the timestamp packet from the output queue
-      while p = packets.shift
-        puts p.inspect
-        sleep interval
-      end
-      timestamp = packet.number
-    end
-  end
-
-else
-
-  source = LiveF1::Source::Live.new(options[:username], options[:password])
-  source.log_dir = "./data"
-  source.run do |packet|
-    puts packet.inspect
-  end
-
-end
-