fonecal 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1fc6ce41a3fc30629c84f13f5e30efd7a818dea
-  data.tar.gz: 7c1b8008deaa54272b458728323753bfec041e7c
+  metadata.gz: 29ab1f8513997afc142589ccbc8caef9493ebf6e
+  data.tar.gz: da8893c965adee5e6b737d51ffc190a983269d7b
 SHA512:
-  metadata.gz: 2ed0c7605dd37c7e448c805ffa974e033448abc3fa56ec6e6455714a5108e9f52c867fc60cb19fbaf9dfa638c1287933724e340bb4d34746192384b1560ca237
-  data.tar.gz: 0961b72dc47db6b73e84e5522fabfcf02379477e9eaba9f5e5a6e4f71da52ddb376a67490a1cb52e4853a17c7014836b9071f808add855f0a2ae9b27b3a7c4de
+  metadata.gz: ef0e2346e4ad38d7b1c68b4a58f9f8ea776cf6de54d20a427c8c496b53fd9e5e31ccba3c3de4626a468851e689538312f72ce8a17ded68b3ec63258a0b2c467c
+  data.tar.gz: e0c97a24373fd76265b29ad3463eb0f729644a09bb9c6837942f68d420787919aa754f635b0d86fca77b4695b24b078c306836071759e7680aaae0137d0144c5

data/README.md

@@ -1,6 +1,10 @@
 # Fonecal
 
-TODO: Write a gem description
+Fonecal parses [formula1.com](http://www.formula1.com/) for each Grand Prix and outputs an iCalendar file with every qualifying, practice, and race session for this year's 2014 Formula One season. All event times are converted to UTC time, allowing calendars to convert the event time to the user's current timezone.
+
+The latest version of the calendar is hosted here: [martinbmadsen.dk/files/f1cal.ics](http://martinbmadsen.dk/files/f1cal.ics), and can be subscribed to in most calendar applications.
+
+Note: Most users do not need to read past this point.
 
 ## Installation
 
@@ -14,11 +18,22 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install fonecal
+   	$ gem install fonecal
 
 ## Usage
 
-TODO: Write usage instructions here
+Simply ``require 'fonecal'`` and call
+
+		$ Fonecal.create_ical
+
+To create an iCalendar file in the current directory, readable by your favorite text editor. It is then ready to be imported in a calendar application.
+
+## TODO
+A list of stuff I (might) eventually do.
+
+- [ ] fix tests
+- [ ] create a better CLI exposing more features
+- [ ] add documentation
 
 ## Contributing
 

data/fonecal.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fonecal/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fonecal"
+  spec.name          = 'fonecal'
   spec.version       = Fonecal::VERSION
-  spec.authors       = ["Martin Madsen"]
-  spec.email         = ["martin2madsen@gmail.com"]
-  spec.description   = %q{f1cal generates an iCalendar file for the 2014 Formula 1 season.}
+  spec.authors       = ['Martin Bjeldbak Madsen']
+  spec.email         = ['martinbmadsen@gmail.com']
+  spec.description   = %q{fonecal generates an iCalendar file for the 2014 Formula 1 season.}
   spec.summary       = %q{Crawls the Grand Prix list at formula1.com and builds an iCalendar file with events in UTC}
-  spec.homepage      = "https://github.com/Fapper/f1cal"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/Fapper/f1cal'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.1"
-  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.3.2'
+  spec.add_development_dependency 'rspec', '~> 2.14'
 
-  spec.add_dependency "timezone", "~> 0.3"
-  spec.add_dependency "activesupport", "~> 4.0"
-  spec.add_dependency 'nokogiri', "~> 1.6"
-  spec.add_dependency 'geocoder', "~> 1.1"
-  spec.add_dependency 'i18n', "~> 0.6"
+  spec.add_dependency 'timezone', '~> 0.3'
+  spec.add_dependency 'activesupport', '~> 4.0'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'geocoder', '~> 1.1'
+  spec.add_dependency 'i18n', '~> 0.6'
 end

data/lib/fonecal/calendar.rb

@@ -3,7 +3,7 @@ module Fonecal
     attr_accessor :calendar
 
     def initialize(gps)
-      self.calendar = File.new('f1cal.ical', 'w')
+      @calendar = File.new('fonecal.ics', 'w')
 
       @calendar.puts "BEGIN:VCALENDAR"
       @calendar.puts "VERSION:2.0"
@@ -27,7 +27,7 @@ module Fonecal
 
       @calendar.puts "SUMMARY:#{gp.grandPrix}: #{event.name}"
       @calendar.puts "DESCRIPTION:#{gp.raceTitle}: #{event.name}"
-      @calendar.puts "DTSTAMP:#{Util.dtToUTC(DateTime.now)}Z"
+      @calendar.puts "DTSTAMP:#{Util.dtToUTC(Time.now)}Z"
       @calendar.puts "LOCATION:#{gp.city}, #{gp.country}"
       @calendar.puts "DTSTART:#{Util.dtToUTC(event.start)}Z"
       puts "#{gp.grandPrix}: #{event.name} starts #{event.start} UTC: #{event.start.utc}"

data/lib/fonecal/crawler.rb

@@ -6,7 +6,7 @@ module Fonecal
     attr_accessor :site, :root
 
     def initialize(site)
-      self.site = Nokogiri::HTML(open(site))
+      self.site = Nokogiri::HTML(open(site), nil, 'utf-8')
       self.root = Util.getRootUrl(site)
     end
   end

data/lib/fonecal/event.rb

@@ -1,24 +1,35 @@
-require 'active_support/all'
+require 'active_support/time'
 
 module Fonecal
   class Event
     attr_accessor :name, :start, :end 
 
     def initialize(event, timezone)
-      # UTC offset in hours, explicitely add +
-      if (timezone.utc_offset / 60 / 60) > 0
-        offset = "+#{timezone.utc_offset / 60 / 60}"
-      else
-        offset = offset.to_s
-      end
-      
       self.name = event[:type]
-      self.start = DateTime.parse("#{event[:date]}T#{event[:start]} #{offset}")
 
-      if event[:end]
-        self.end = DateTime.parse("#{event[:date]}T#{event[:end]} #{offset}") 
-      else
-        self.end = self.start + 4.hours
+      # Extract info from date string
+      date,month,year = event[:date].split(' ')[1..-1]
+
+      # Convert month from string to integer
+      month = Date::MONTHNAMES.index(month)
+
+      # Parse and set starting time
+      start_hr, start_m = event[:start].split(':')
+
+      # Set timezone to what was given
+      Time.zone = timezone.zone
+
+      # Look up timezone in day, taking dst into account
+      @start = Time.zone.local(year, month, date, start_hr, start_m, 0)
+
+      # Parse and set ending time
+      if event[:end] # a practice sessions
+        end_hr, end_m = event[:end].split(':')
+        @end = Time.zone.local(year, month, date, end_hr, end_m, 0)
+      elsif self.class == Qualifying
+        @end = @start + (1.hour + 30.minutes)
+      else # race
+        @end = @start + 4.hours
       end
     end
   end

data/lib/fonecal/grand_prix.rb

@@ -23,8 +23,6 @@ module Fonecal
       else
         @res
       end
-
-      #@location ||= Geocoder.search("#{@circuit.name}, #{@circuit.city}").first
     end
 
     def city
@@ -40,7 +38,11 @@ module Fonecal
     end
 
     def raceTitle 
-      @crawler.gp.gsub(/\w+/).map(&:capitalize).join(' ')
+      title = @crawler.gp.split(/(\W)/).map(&:capitalize).join
+
+      # Dirty decapitalization hack
+      title = title.gsub(/Í/, 'í')
+      title = title.gsub(/J/, 'j')
     end
 
     def grandPrix
@@ -53,14 +55,14 @@ module Fonecal
     def createEvents
       @crawler.timeTables.each do |day|
         day[:sessions].each do |event|
-        type = event[:type]
+          type = event[:type]
           event[:date] = day[:date]
 
-          if(type.include? "Practice")
+          if ['practice 1', 'practice 2', 'practice 3'].include?(type.downcase)
             @events << Practice.new(event, timezone)
-          elsif(type.include? "Qualifying")
+          elsif type == "Qualifying"
             @events << Qualifying.new(event, timezone)
-          elsif(type.include? "Race")
+          elsif type == "Race"
             @events << Race.new(event, timezone)
           end
         end

data/lib/fonecal/version.rb

@@ -1,3 +1,3 @@
 module Fonecal
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/spec/abu_dabi_gp_spec.rb

@@ -0,0 +1,124 @@
+require 'fonecal'
+
+describe Fonecal::GrandPrix do
+
+  describe "Abu Dhabi GP" do
+    subject(:abudabiGP) { Fonecal::GrandPrix.new('http://www.formula1.com/races/in_detail/abu_dhabi_932/circuit_diagram.html') }
+
+    it "should have the correct race title" do
+      expect(abudabiGP.raceTitle).to eql "2014 Formula 1 Etihad Airways Abu Dhabi Grand Prix"
+    end 
+
+    it "should be in Canada" do
+      expect(abudabiGP.country).to eql "United Arab Emirates"
+    end
+
+    it "should be in Montreal" do
+      expect(abudabiGP.city).to eql "Yas Marina"
+    end
+
+    it "should be in the EST timezone" do
+      gts = Timezone::Zone.new(zone: "Etc/GMT+4")
+      abuTS = Timezone::Zone.new(zone: "Asia/Dubai")
+      now = Time.now
+
+      expect(abudabiGP.timezone.time(now).to_i).to eq gts.time(now).to_i
+      expect(abudabiGP.timezone.time(now).to_i).to eq abuTS.time(now).to_i
+    end
+
+    it "should have 5 events" do
+      expect(abudabiGP.events.count).to eql 5
+    end
+
+    context "practice 1" do
+      subject(:p1) { abudabiGP.events.first }
+
+      it "should be of type Practice" do
+        expect(p1.class).to eql Fonecal::Practice
+      end
+
+      it "should start at 13:00 CET on friday" do
+        expect(p1.start).to eql Time.new(2014, 11, 21, 13, 0, 0, '+04:00')
+        puts p1.start.utc
+        expect(p1.start).to eql Time.new(2014, 11, 21, 10, 0, 0, '+01:00')
+      end
+
+      it "should end at 11:30 CET on friday" do
+        expect(p1.end).to eql Time.new(2014, 11, 21, 14, 30, 0, '+04:00')
+        expect(p1.end).to eql Time.new(2014, 11, 21, 11, 30, 0, '+01:00')
+      end
+    end
+
+    #context "practice 2" do
+    #  subject(:p2) { abudabiGP.events[1] }
+
+    #  it "should be of type Practice" do
+    #    expect(p2.class).to eql Fonecal::Practice
+    #  end
+
+    #  it "should start at 20:00 on friday" do
+    #    expect(p2.start).to eql Time.new(2014, 6, 6, 20, 0, 0, '+02:00')
+    #    expect(p2.start).to eql Time.new(2014, 6, 6, 14, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 21:30 on friday" do
+    #    expect(p2.end).to eql Time.new(2014, 6, 6, 21, 30, 0, '+02:00')
+    #    expect(p2.end).to eql Time.new(2014, 6, 6, 15, 30, 0, '+10:00')
+    #  end
+    #end
+
+    #context "practice 3" do
+    #  subject(:p3) { abudabiGP.events[2] }
+
+    #  it "should be of type Practice" do
+    #    expect(p3.class).to eql Fonecal::Practice
+    #  end
+
+    #  it "should start at 16:00 on saturday" do
+    #    expect(p3.start).to eql Time.new(2014, 6, 7, 16, 0, 0, '+02:00')
+    #    expect(p3.start).to eql Time.new(2014, 6, 7, 10, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 17:00 on saturday" do
+    #    expect(p3.end).to eql Time.new(2014, 6, 7, 17, 0, 0, '+02:00')
+    #    expect(p3.end).to eql Time.new(2014, 6, 7, 11, 0, 0, '+10:00')
+    #  end
+    #end
+
+    #context "qualifying" do
+    #  subject(:q) { abudabiGP.events[3] }
+
+    #  it "should be of type Practice" do
+    #    expect(q.class).to eql Fonecal::Qualifying
+    #  end
+
+    #  it "should start at 19:00 on saturday" do
+    #    expect(q.start).to eql Time.new(2014, 6, 7, 19, 0, 0, '+02:00')
+    #    expect(q.start).to eql Time.new(2014, 6, 7, 13, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 20:30 on saturday" do
+    #    expect(q.end).to eql Time.new(2014, 6, 7, 20, 30, 0, '+02:00')
+    #    expect(q.end).to eql Time.new(2014, 6, 7, 14, 30, 0, '+10:00')
+    #  end
+    #end
+
+    #context "race" do
+    #  subject(:race) { abudabiGP.events[4] }
+
+    #  it "should be of type Practice" do
+    #    expect(race.class).to eql Fonecal::Race
+    #  end
+
+    #  it "should start at 20:00 on sunday" do
+    #    expect(race.start).to eql Time.new(2014, 6, 8, 20, 0, 0, '+02:00')
+    #    expect(race.start).to eql Time.new(2014, 6, 8, 14, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 24:00 on sunday" do
+    #    expect(race.end).to eql Time.new(2014, 6, 8, 24, 0, 0, '+02:00')
+    #    expect(race.end).to eql Time.new(2014, 6, 8, 18, 0, 0, '+10:00')
+    #  end
+    #end
+  end
+end

data/spec/australian_gp_spec.rb

@@ -0,0 +1,123 @@
+require 'fonecal'
+
+describe Fonecal::GrandPrix do
+
+  describe "Australian GP" do
+    subject(:australianGP) { Fonecal::GrandPrix.new('http://www.formula1.com/races/in_detail/australia_914/circuit_diagram.html') }
+
+    it "should have the correct race title" do
+      expect(australianGP.raceTitle).to eql "2014 Formula 1 Rolex Australian Grand Prix"
+    end 
+
+    it "should be in Canada" do
+      expect(australianGP.country).to eql "Australia"
+    end
+
+    it "should be in Montreal" do
+      expect(australianGP.city).to eql "Melbourne"
+    end
+
+    it "should be in the EST timezone" do
+      aestTS = Timezone::Zone.new(zone: "Etc/GMT+10")
+      melbourneTS = Timezone::Zone.new(zone: "Australia/Melbourne")
+      now = Time.now
+
+      #expect(australianGP.timezone.time(now).to_i).to eq estTS.time(now).to_i
+      expect(australianGP.timezone.time(now).to_i).to eq melbourneTS.time(now).to_i
+    end
+
+    it "should have 5 events" do
+      expect(australianGP.events.count).to eql 5
+    end
+
+    context "practice 1" do
+      subject(:p1) { australianGP.events.first }
+
+      it "should be of type Practice" do
+        expect(p1.class).to eql Fonecal::Practice
+      end
+
+      it "should start at 2:30 CET on friday" do
+        expect(p1.start).to eql Time.new(2014, 3, 14, 12, 30, 0, '+10:00')
+        expect(p1.start).to eql Time.new(2014, 3, 14, 2, 30, 0, '+01:00')
+      end
+
+      it "should end at 4:30 CET on friday" do
+        expect(p1.end).to eql Time.new(2014, 3, 14, 14, 0, 0, '+10:00')
+        expect(p1.end).to eql Time.new(2014, 3, 14, 4, 0, 0, '+01:00')
+      end
+    end
+
+    #context "practice 2" do
+    #  subject(:p2) { australianGP.events[1] }
+
+    #  it "should be of type Practice" do
+    #    expect(p2.class).to eql Fonecal::Practice
+    #  end
+
+    #  it "should start at 20:00 on friday" do
+    #    expect(p2.start).to eql Time.new(2014, 6, 6, 20, 0, 0, '+02:00')
+    #    expect(p2.start).to eql Time.new(2014, 6, 6, 14, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 21:30 on friday" do
+    #    expect(p2.end).to eql Time.new(2014, 6, 6, 21, 30, 0, '+02:00')
+    #    expect(p2.end).to eql Time.new(2014, 6, 6, 15, 30, 0, '+10:00')
+    #  end
+    #end
+
+    #context "practice 3" do
+    #  subject(:p3) { australianGP.events[2] }
+
+    #  it "should be of type Practice" do
+    #    expect(p3.class).to eql Fonecal::Practice
+    #  end
+
+    #  it "should start at 16:00 on saturday" do
+    #    expect(p3.start).to eql Time.new(2014, 6, 7, 16, 0, 0, '+02:00')
+    #    expect(p3.start).to eql Time.new(2014, 6, 7, 10, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 17:00 on saturday" do
+    #    expect(p3.end).to eql Time.new(2014, 6, 7, 17, 0, 0, '+02:00')
+    #    expect(p3.end).to eql Time.new(2014, 6, 7, 11, 0, 0, '+10:00')
+    #  end
+    #end
+
+    #context "qualifying" do
+    #  subject(:q) { australianGP.events[3] }
+
+    #  it "should be of type Practice" do
+    #    expect(q.class).to eql Fonecal::Qualifying
+    #  end
+
+    #  it "should start at 19:00 on saturday" do
+    #    expect(q.start).to eql Time.new(2014, 6, 7, 19, 0, 0, '+02:00')
+    #    expect(q.start).to eql Time.new(2014, 6, 7, 13, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 20:30 on saturday" do
+    #    expect(q.end).to eql Time.new(2014, 6, 7, 20, 30, 0, '+02:00')
+    #    expect(q.end).to eql Time.new(2014, 6, 7, 14, 30, 0, '+10:00')
+    #  end
+    #end
+
+    #context "race" do
+    #  subject(:race) { australianGP.events[4] }
+
+    #  it "should be of type Practice" do
+    #    expect(race.class).to eql Fonecal::Race
+    #  end
+
+    #  it "should start at 20:00 on sunday" do
+    #    expect(race.start).to eql Time.new(2014, 6, 8, 20, 0, 0, '+02:00')
+    #    expect(race.start).to eql Time.new(2014, 6, 8, 14, 0, 0, '+10:00')
+    #  end
+
+    #  it "should end at 24:00 on sunday" do
+    #    expect(race.end).to eql Time.new(2014, 6, 8, 24, 0, 0, '+02:00')
+    #    expect(race.end).to eql Time.new(2014, 6, 8, 18, 0, 0, '+10:00')
+    #  end
+    #end
+  end
+end