tide 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  # gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+	gem "rdoc"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rdoc

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kenzie Campbell
+
+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.rdoc

@@ -0,0 +1,48 @@
+= Tide
+
+Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca
+
+Accepts options for tide zone, tide region, tide station, date and timezone. Defaults to 7 days of tide prediction data (starting from today) for Sydney, Nova Scotia in Atlantic time.
+
+Outputs a semi-colon delimited array of tides (date, time, height in meters) with Tide.new.to_csv or a formatted html table with Tide.new.to_html.
+
+== Example Output
+
+===Tide.new.to_csv
+
+	2010-02-11,00:47,0.3
+	2010-02-11,07:17,0.9
+	2010-02-11,12:23,0.6
+	...
+
+===Tide.new.to_html
+
+	<table summary="Tide tables for Sydney with columns for time of day and tide height (in meters).">
+		<thead>
+			<tr><th scope="col">Time</th><th scope="col">Height</th></tr>
+		</thead>
+		<tbody>
+			<tr><th scope="rowgroup" colspan="2">2010-02-11</th></tr>
+			<tr><td>00:47</td><td>0.3m</td></tr>
+			<tr><td>07:17</td><td>0.9m</td></tr>
+			<tr><td>12:23</td><td>0.6m</td></tr>
+			<tr><td>18:47</td><td>1.1m</td></tr>
+		</tbody>
+		...
+	</table>
+
+== Contributing to tide
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kenzie Campbell. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tide"
+  gem.homepage = "http://github.com/kenzie/tide"
+  gem.license = "MIT"
+  gem.summary = %Q{Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca}
+  gem.description = %Q{Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca
+
+  Accepts options for tide zone, tide region, tide station, date and timezone. Defaults to 7 days of tide prediction data (starting from today) for Sydney, Nova Scotia in Atlantic time.
+
+  Outputs a semi-colon delimited array of tides (date, time, height in meters) with Tide.new.to_csv or a formatted html table with Tide.new.to_html.}
+  gem.email = "kenzie@route19.com"
+  gem.authors = ["Kenzie Campbell"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tide #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/.gitignore

@@ -0,0 +1 @@
+rdoc/

data/lib/tide.rb

@@ -0,0 +1,85 @@
+
+require 'net/http'
+require 'uri'
+
+class Tide
+
+  POST_URL      = 'http://www.waterlevels.gc.ca/cgi-bin/tide-shc.cgi'
+  TIDE_REGEX    = /#\sDate;Time;Height<br>(.*)<br><\/p><\/td>/
+  STATION_REGEX = /# Station : (.*) \(\d+\).*/
+  INIT_DEFAULTS = { :zone => 27, :region => 5, :station => 610, :timezone => 'AST', :date => Time.now }
+
+  attr_reader :location
+
+  # Create new tide table.
+  def initialize(options = {})
+    options     = INIT_DEFAULTS.merge(options)
+    @zone       = options[:zone]
+    @region     = options[:region]
+    @station    = options[:station]
+    @timezone   = options[:timezone]
+    @date       = options[:date]
+    @location   = data.match(STATION_REGEX)[1]
+  end
+
+  # Downlaod raw data
+  def data
+    @data ||= download_tide_data
+  end
+
+  # Returns semi-colon delimited list of tide data.
+  def to_csv
+    @csv ||= format_csv
+  end
+
+  # Returns formatted html table of tide data.
+  def to_html
+    @html ||= format_html
+  end
+
+private
+
+  # Downloads new tide data
+  def download_tide_data(type='predict', view='text', language='english')
+    res = Net::HTTP.post_form(
+    URI.parse(POST_URL),
+      {
+        'zone'      => @zone,
+        'region'    => @region,
+        'station'   => @station,
+        'year'      => @date.year,
+        'month'     => @date.month,
+        'day'       => @date.day,
+        'TZ'        => @timezone, # TODO use supplied date for timezone
+        'queryType' => type,
+        'view'      => view,
+        'language'  => language
+      }
+    )
+    # TODO rescue request errors
+    res.body
+  end
+
+  # Formats tide data as csv.
+  def format_csv
+    data.match(TIDE_REGEX)[1].gsub('<br>', "\n").gsub(';', ',')
+  end
+
+  # Formats tide data as html table.
+  def format_html
+    formatted = "<table summary=\"Tide tables for #{location} with columns for time of day and tide height (in meters).\">\n\t<thead>\n\t\t<tr><th scope=\"col\">Time</th><th scope=\"col\">Height</th></tr>\n\t</thead>\n"
+    last_date = nil
+    to_csv.each_line do |row|
+      row = row.chomp.split(',')
+      if row[0] != last_date
+        formatted += "\t</tbody>\n" unless last_date.nil?
+        formatted += "\t<tbody>\n\t\t<tr><th scope=\"rowgroup\" colspan=\"2\">#{row[0]}</th></tr>\n"
+        last_date = row[0]
+      end
+      formatted += "\t\t<tr><td>#{row[1]}</td><td>#{row[2]}m</td></tr>\n"
+    end
+    formatted += "\t</tbody>\n</table>\n"
+    formatted
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+# require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tide'
+
+class Test::Unit::TestCase
+end

data/test/test_tide.rb

@@ -0,0 +1,39 @@
+
+require 'helper'
+
+class TideTest < Test::Unit::TestCase
+
+  # TODO fake web requests
+
+  def test_location
+    @tide = Tide.new(:zone => 27, :region => 5, :station => 610)
+    assert_match "Sydney", @tide.location
+  end
+
+  def test_to_csv
+    @tide = Tide.new
+    date_regex = /\d{4}-\d{2}-\d{2}/
+    assert_match date_regex, @tide.to_csv
+  end
+
+  def test_to_html
+    @tide = Tide.new
+    date_regex = /<tr><th scope=\"rowgroup\" colspan=\"2\">\d{4}-\d{2}-\d{2}<\/th><\/tr>/
+    assert_match date_regex, @tide.to_html
+  end
+
+  def test_specific_date
+    a_year_ago = Time.now - 60*60*24*365
+    @tide = Tide.new(:date => a_year_ago)
+    formatted_date = a_year_ago.strftime('%Y-%m-%d')
+    date_regex = /<tr><th scope=\"rowgroup\" colspan=\"2\">#{formatted_date}<\/th><\/tr>/
+    assert_match date_regex, @tide.to_html
+  end
+
+  def test_specific_timezone
+    tide_ast = Tide.new(:timezone => 'AST')
+    tide_est = Tide.new(:timezone => 'EST')
+    assert_not_equal tide_ast.to_csv, tide_est.to_csv
+  end
+
+end

data/tide.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tide}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Kenzie Campbell}]
+  s.date = %q{2011-06-09}
+  s.description = %q{Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca
+
+  Accepts options for tide zone, tide region, tide station, date and timezone. Defaults to 7 days of tide prediction data (starting from today) for Sydney, Nova Scotia in Atlantic time.
+
+  Outputs a semi-colon delimited array of tides (date, time, height in meters) with Tide.new.to_csv or a formatted html table with Tide.new.to_html.}
+  s.email = %q{kenzie@route19.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/.gitignore",
+    "lib/tide.rb",
+    "test/helper.rb",
+    "test/test_tide.rb",
+    "tide.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kenzie/tide}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: tide
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kenzie Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: |-
+  Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca
+  
+    Accepts options for tide zone, tide region, tide station, date and timezone. Defaults to 7 days of tide prediction data (starting from today) for Sydney, Nova Scotia in Atlantic time.
+  
+    Outputs a semi-colon delimited array of tides (date, time, height in meters) with Tide.new.to_csv or a formatted html table with Tide.new.to_html.
+email: kenzie@route19.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/.gitignore
+- lib/tide.rb
+- test/helper.rb
+- test/test_tide.rb
+- tide.gemspec
+homepage: http://github.com/kenzie/tide
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 537320941182422965
+      segments: 
+      - 0
+      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.5
+signing_key: 
+specification_version: 3
+summary: Tide class fetches returns Canadian tide prediction data from waterlevels.gc.ca
+test_files: []
+