traffic 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+coverage
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p0@traffic

data/Gemfile

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

data/README.md

@@ -0,0 +1,46 @@
+Traffic: the traffic information gem
+====================================
+
+Traffic is a gem that supplies traffic information from multiple data providers
+
+Installation
+------------
+	gem install traffic
+
+Usage Examples
+--------------
+	require "traffic"
+
+	info = Traffic.from(:file_index)
+	
+	puts info.count
+	 #=> 15
+	puts "#{info.size} km"
+	 #=> "45 km"
+
+	info_item = info.items.first
+	
+	puts "#{info_item.from} to #{info_item.to}
+	 #=> "Amsterdam to Amersfoort"
+	puts info_item.road
+	 #=> "A1"
+	puts "#{info_item.length} km"
+	 #=> "2.8 km"
+	puts "#{info_item.description} - #{info_item.location} - #{info_item.cause}"
+	 #=> "stilstaand verkeerd - Eemnes en Eembrugge - defecte vrachtwagen"
+	puts "#{info_item.from_location} - #{info_item.to_location}"
+	 #=> "40.0 - 42.8"
+ 	 
+Providers
+---------
+For now it only includes a provider for the Dutch traffic information from [fileindex.nl](http://www.fileindex.nl/).
+
+Testing
+-------
+Run all tests:
+
+	rspec spec/
+
+Copyright
+---------
+Copyright (c) 2011 Daniël van Hoesel.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/traffic/info.rb

@@ -0,0 +1,21 @@
+module Traffic
+  MAIN_ATTRIBUTES = [:timestamp, :count, :size, :traffic]
+  Info = Struct.new(*MAIN_ATTRIBUTES) do
+    def traffic?
+      !traffic
+    end
+    
+    def items
+      @items ||= []
+    end
+  end
+  
+  ITEM_ATTRIBUTES = [:road, :from, :to, :from_location, :to_location, :location, :length, :description, :cause, :status]
+  InfoItem = Struct.new(*ITEM_ATTRIBUTES) do
+    ITEM_ATTRIBUTES.each do |attr|
+      define_method "#{attr}?" do
+        !!self.send(attr)
+      end
+    end
+  end
+end

data/lib/traffic/provider.rb

@@ -0,0 +1,12 @@
+# require all provider source files
+Dir[File.expand_path("../providers/**/*.rb", __FILE__)].each {|f| require f}
+
+module Traffic
+  def self.Provider(name)
+    # camelcase the name
+    Traffic::Providers.const_get "#{name.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }}"
+  rescue NameError => e
+    raise "unknown provider: #{name}"
+  end
+end
+

data/lib/traffic/providers/file_index.rb

@@ -0,0 +1,51 @@
+require 'feedzirra'
+
+module Traffic
+  module Providers
+    class FileIndex
+      RSS_FEED = "http://www.fileindex.nl/rss.php"
+      
+      def traffic
+        rss.description =~ /Er zijn geen files./
+      end
+      
+      def timestamp
+        Time.parse(rss.title.gsub(/Fileindex.nl actuele files /, ""))
+      end
+      
+      def count
+        rss.description[/(\d+) files?.+van .+ km./, 1].to_i
+      end
+      
+      def size
+        rss.description[/\d+ files?.+van (.+) km./, 1].to_i
+      end
+      
+      def each_item(&block)
+        rss.entries.each do |entry|
+          item = Struct.new(:road, :from, :to, :from_location, :to_location, :location, :length, :description, :cause, :status).new
+          data = entry.title.match /(.+?) van (.+) richting (.+) (.+) km/
+          item.road = data[1]
+          item.from = data[2]
+          item.to = data[3]
+          item.length = data[4].to_f
+
+          data = entry.summary.match /\b(.+)\b tussen \b(.+)\b( door (.*))? HMP([\d\.]+) .+ HMP([\d\.]+)\s*(.*)/
+          item.description = data[1]
+          item.location = data[2]
+          item.cause = data[4]
+          item.from_location = data[5].to_f
+          item.to_location = data[6].to_f
+          item.status = data[7]
+          
+          yield item
+        end
+      end
+      
+      private
+        def rss
+          @data ||= Feedzirra::Feed.fetch_and_parse(RSS_FEED)
+        end
+    end
+  end
+end

data/lib/traffic/version.rb

@@ -0,0 +1,3 @@
+module Traffic
+  VERSION = "0.0.1"
+end

data/lib/traffic.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../traffic/version", __FILE__)
+require File.expand_path("../traffic/provider", __FILE__)
+require File.expand_path("../traffic/info", __FILE__)
+
+module Traffic
+  def self.from(provider_name)
+    provider = Provider(provider_name).new
+    info = Info.new
+    
+    MAIN_ATTRIBUTES.each do |attr|
+      if provider.respond_to?(attr)
+        info.send("#{attr}=", provider.send(attr))
+      else
+        raise "attribute missing: #{attr}. the selected provider ('#{provider_name}') does not supply all required attributes"
+      end
+    end
+    
+    provider.each_item do |item|
+      info_item = InfoItem.new
+      ITEM_ATTRIBUTES.each do |attr|
+        if item.respond_to?(attr)
+          info_item.send("#{attr}=", item.send(attr))
+        else
+          raise "attribute missing: #{attr}. the selected provider item ('#{provider_name}') does not supply all required attributes"
+        end
+      end
+      info.items << info_item
+    end
+    
+    info
+  end
+end

data/spec/fixtures/file_index/empty_rss.xml

@@ -0,0 +1 @@
+<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>Fileindex.nl actuele files 22-dec-2011 22:11:46</title><link>http://www.fileindex.nl/meldingenRSS.aspx</link><description>Er zijn geen files.</description><language>en-us</language></channel></rss>

data/spec/fixtures/file_index/rss.xml

@@ -0,0 +1,23 @@
+
+<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>Fileindex.nl actuele files 22-dec-2011 16:15:52</title><link>http://www.fileindex.nl/meldingenRSS.aspx</link><description>Er zijn 14 files met een totale lengte van 45 km.</description><language>en-us</language><item><title>A1 van Amsterdam richting Amersfoort 2.6 km                   
+        </title><description>Langzaam rijdend verkeer tussen Eemnes en Eembrugge door Ongeval(len) HMP30.2 --&gt; HMP32.8 Deze file wordt langer.</description></item><item><title>A4 van Amsterdam richting Delft 7.3 km                   
+        </title><description>Stilstaand verkeer tussen Burgerveen en Brug over de Oude Rijn HMP22.6 --&gt; HMP29.9 Deze file wordt korter.
+          </description></item><item><title>A10 van De Nieuwe Meer richting Coenplein 3.4 km                   
+        </title><description>Stilstaand verkeer tussen Geuzenveld en Coenplein HMP25.7 --&gt; HMP29.1 Deze file wordt korter.
+          </description></item><item><title>A13 van Rijswijk richting Rotterdam 2.2 km                   
+        </title><description>Langzaam rijdend verkeer tussen TU Delft en Berkel en Rodenrijs HMP13.5 --&gt; HMP15.7</description></item><item><title>A15 van Ridderkerk richting Rozenburg 4 km                   
+        </title><description>Stilstaand verkeer tussen Hoogvliet en Spijkenisse HMP47.1 --&gt; HMP43.1 Deze file wordt korter.
+          </description></item><item><title>A15 van Ridderkerk richting Gorinchem 3.2 km                   
+        </title><description>Stilstaand verkeer tussen Alblasserdam en Sliedrecht-West HMP77.9 --&gt; HMP81.1 Deze file wordt langer.</description></item><item><title>A15 van Ridderkerk richting Gorinchem 1.5 km                   
+        </title><description>Stilstaand verkeer tussen Sliedrecht-Oost en Hardinxveld-Giessendam HMP85.5 --&gt; HMP87 Deze file wordt langer.</description></item><item><title>A16 van Breda richting Rotterdam 2.6 km                   
+        </title><description>Stilstaand verkeer tussen Feijenoord en Terbregseplein HMP20 --&gt; HMP17.4 Deze file wordt korter.
+          </description></item><item><title>A20 van Hoek van Holland richting Gouda 3.1 km                   
+        </title><description>Langzaam rijdend verkeer tussen Spaansepolder en Terbregseplein HMP28.5 --&gt; HMP31.6 Deze file wordt korter.
+          </description></item><item><title>A20 van Gouda richting Hoek van Holland 0 km                   
+        </title><description>Drie rijstroken afgesloten tussen Prins Alexander en Terbregseplein door Ongeval(len) HMP37.3 --&gt; HMP37.3 Deze file wordt langer.</description></item><item><title>A20 van Gouda richting Hoek van Holland 6.5 km                   
+        </title><description>Stilstaand verkeer tussen Moordrecht en Terbregseplein door Ongeval(len) HMP43.3 --&gt; HMP36.8 Deze file wordt langer.</description></item><item><title>A28 van Utrecht richting Amersfoort 3.1 km                   
+        </title><description>Stilstaand verkeer tussen De Uithof en Den Dolder HMP5.8 --&gt; HMP8.9 Deze file wordt korter.
+          </description></item><item><title>A28 van Utrecht richting Amersfoort 2.8 km                   
+        </title><description>Langzaam rijdend verkeer tussen Maarn en Leusden HMP16.2 --&gt; HMP19 Deze file wordt korter.
+          </description></item><item><title>A50 van Arnhem richting Oss 2.7 km                   
+        </title><description>Langzaam rijdend verkeer tussen Valburg en Ewijk HMP154.6 --&gt; HMP151.9</description></item></channel></rss>

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require 'simplecov'
+require 'fakeweb'
+require 'pp'
+
+SimpleCov.start do
+  add_group 'Traffic', 'lib/traffic'
+  add_group 'Specs', 'spec'
+  add_filter __FILE__
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  
+  config.before :each do
+    FakeWeb.allow_net_connect = false
+    Feedzirra::Feed.stubs(:fetch_and_parse).raises("do not connect to feed, stub this method")
+  end
+end
+
+
+def stub_feed(fixture)
+  stub = Feedzirra::Feed.parse(File.read(File.expand_path("../fixtures/#{fixture}", __FILE__)))
+  Feedzirra::Feed.stubs(:fetch_and_parse).returns(stub)
+end
+
+load File.expand_path('../../lib/traffic.rb', __FILE__)

data/spec/traffic/info_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Traffic do
+  describe "InfoItem" do
+    
+    it "should have presence testers" do
+      item = Traffic::InfoItem.new
+      Traffic::ITEM_ATTRIBUTES.each do |attr|
+        item.send("#{attr}=", "foobar")
+        item.send("#{attr}?").should be_true
+        item.send("#{attr}=", nil)
+        item.send("#{attr}?").should be_false
+      end
+    end
+    
+  end
+end

data/spec/traffic/providers_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Traffic do
+  
+  describe "::Provider" do
+    it "should return a provider class based on a name" do
+      Traffic::Provider(:file_index).should == Traffic::Providers::FileIndex
+    end
+    
+    it "should raise an exception when an unknown provider is specified" do
+      lambda { Traffic::Provider(:foobar) }.should raise_error
+    end
+  end
+  
+end

data/spec/traffic_spec.rb

@@ -0,0 +1,123 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Traffic do
+  
+  describe ".from" do
+    it "should raise an exception when using an unknown provider" do
+      lambda { Traffic.from(:foobar) }.should raise_error
+    end
+    
+    it "should raise an exception when using an provider with incomplete main attributes" do
+      module Traffic
+        module Providers
+          class EmptyProvider
+          end
+        end
+      end
+      lambda { Traffic.from(:empty_provider) }.should raise_error
+    end
+    
+    it "should raise an exception when using an provider with incomplete item attributes" do
+      module Traffic
+        module Providers
+          class EmptyProvider
+            attr_accessor *Traffic::MAIN_ATTRIBUTES
+            def each_item(&block)
+              yield
+            end
+          end
+        end
+      end
+      lambda { Traffic.from(:empty_provider) }.should raise_error
+    end
+    
+    context "when there is no traffic" do
+      before :each do
+        stub_feed "file_index/empty_rss.xml"
+        @info = Traffic.from(:file_index)
+      end
+      
+      it "should indicate that there is no traffic" do
+        @info.should_not be_traffic
+      end
+    end
+    
+    context "when there is traffic" do
+      before :each do
+        stub_feed "file_index/rss.xml"
+        @info = Traffic.from(:file_index)
+      end
+      
+      it "should indicate that there is traffic" do
+        @info.should be_traffic
+      end
+      
+      it "should return an info object" do
+        @info.class.should == Traffic::Info
+      end
+      
+      it "should be able to return the total size" do
+        @info.size.should == 45
+      end
+      
+      it "should be able to return the total count" do
+        @info.count.should == 14
+      end
+      
+      it "should return a list with info items with the same length as count" do
+        @info.items.size.should == @info.count
+      end
+      
+      it "should return a list with info items" do
+        @info.items.each { |i| i.class.should == Traffic::InfoItem }
+      end
+      
+      context "the info items in the list" do
+        before :each do
+          @info_item = @info.items.first
+        end
+        
+        it "should include a from" do
+          @info_item.from.should == "Amsterdam"
+        end
+        
+        it "should include a to" do
+          @info_item.to.should == "Amersfoort"
+        end
+        
+        it "should include a road number" do
+          @info_item.road.should == "A1"
+        end
+        
+        it "should include a length in km" do
+          @info_item.length.should == 2.6
+        end
+        
+        it "should include a description" do
+          @info_item.description.should == "Langzaam rijdend verkeer"
+        end
+        
+        it "should include a location" do
+          @info_item.location.should == "Eemnes en Eembrugge"
+        end
+                
+        it "should include a cause" do
+          @info_item.cause.should == "Ongeval(len)"
+        end        
+                
+        it "should include a status" do
+          @info_item.status.should == "Deze file wordt langer."
+        end
+        
+        it "should include a from location (hecto markers)" do
+          @info_item.from_location.should == 30.2
+        end
+        
+        it "should include a to location" do
+          @info_item.to_location.should == 32.8
+        end
+      end
+    end
+  end
+  
+end

data/traffic.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "traffic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "traffic"
+  s.version     = Traffic::VERSION
+  s.authors     = ["Daniel van Hoesel"]
+  s.email       = ["daniel@danielvanhoesel.nl"]
+  s.homepage    = ""
+  s.summary     = %q{Traffic: the traffic information gem}
+  s.description = %q{Traffic is a gem that supplies traffic information from multiple data providers}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('bundler', '~> 1.0')
+  s.add_development_dependency('rake', '~> 0.9')
+  s.add_development_dependency('rspec', '~> 2.7')
+  s.add_development_dependency('mocha', '~> 0.10')
+  s.add_development_dependency('simplecov', '~> 0.5')
+  s.add_development_dependency('fakeweb', '~> 1.3')
+  s.add_dependency('feedzirra', '~> 0.1.1')
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: traffic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel van Hoesel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70310037002700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70310037002700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70310037001620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70310037001620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70310037000800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70310037000800
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70310036999020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70310036999020
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70310036998040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70310036998040
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70310036997360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70310036997360
+- !ruby/object:Gem::Dependency
+  name: feedzirra
+  requirement: &70310036996600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310036996600
+description: Traffic is a gem that supplies traffic information from multiple data
+  providers
+email:
+- daniel@danielvanhoesel.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/traffic.rb
+- lib/traffic/info.rb
+- lib/traffic/provider.rb
+- lib/traffic/providers/file_index.rb
+- lib/traffic/version.rb
+- spec/fixtures/file_index/empty_rss.xml
+- spec/fixtures/file_index/rss.xml
+- spec/spec_helper.rb
+- spec/traffic/info_spec.rb
+- spec/traffic/providers_spec.rb
+- spec/traffic_spec.rb
+- traffic.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ! 'Traffic: the traffic information gem'
+test_files:
+- spec/fixtures/file_index/empty_rss.xml
+- spec/fixtures/file_index/rss.xml
+- spec/spec_helper.rb
+- spec/traffic/info_spec.rb
+- spec/traffic/providers_spec.rb
+- spec/traffic_spec.rb