buoy_data 0.1.0 → 0.2.0

data/README.markdown

@@ -1,6 +1,13 @@
 # buoy_data
 
-The goal of this gem is to provide marine buoy data from a variety of sources.
+## Description
+
+The goal of this gem is to provide a super simple interface to marine buoy data
+from a variety of sources.
+
+Currently only [NOAA buoys](http://www.ndbc.noaa.gov/) are supported but adding more is
+planned.
+
 
 ## Install
 
@@ -10,13 +17,51 @@ gem install buoy_data
 
 ## Usage
 
+The basic flow is:
+
+- instantiate a buoy_data object that will represent the target buoy
+- call its :get method
+- reference the given fields - for the latest reading - via convenient dot notation
+
 <pre>
+require 'rubygems'
 require 'buoy_data'
-noaa_buoy = BuoyData::NoaaBuoy.new(41114)
+noaa_buoy = BuoyData::NoaaBuoy.new(41012) # St Augustine, FL
 noaa_buoy.get
 noaa_buoy.WVHT
+ => "1.4" 
+noaa_buoy.APD
+ => "4.6"
+# Wow the swell is pumping, I'm moving ;)!
+</pre>
+
+All of the historical data for the given station can be obtained via
+(continuing from the above):
+
+<pre>
+noaa_buoy.get_all
 </pre>
 
+Which will provide an array of arrays (one array of the fields per row) for all the
+historical data available for the given station.  In other words, for the station
+in the example above, 41012, you'd get all the data at:
+
+http://www.ndbc.noaa.gov/data/realtime2/41012.spec
+
+as an array of arrays.
+
+Get a graph of the 5-day trend of Wave Height (WVHT) for the given station (google chart
+api):
+
+<pre>
+noaa_buoy.google_chart_url
+</pre>
+
+## TODO
+
+- Add friendly / convenient methods for historical station data
+- Webmock for the specs
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -10,9 +10,9 @@ begin
     gem.email = "minch@trazzler.com"
     gem.homepage = "http://github.com/minch/buoy_data"
     gem.authors = ["Adam Weller"]
-		gem.add_development_dependency 'rspec'
-		gem.add_dependency 'httparty'
-		gem.files.include 'lib/buoy_data/*.rb'
+    gem.add_development_dependency 'rspec'
+    gem.add_dependency 'httparty'
+    gem.files.include 'lib/buoy_data/*.rb'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/buoy_data.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{buoy_data}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Weller"]
-  s.date = %q{2010-10-26}
+  s.date = %q{2010-11-22}
   s.description = %q{The goal of this gem is to provide marine buoy data from a variety of sources}
   s.email = %q{minch@trazzler.com}
   s.extra_rdoc_files = [

data/lib/buoy_data/buoy.rb

@@ -1,7 +1,7 @@
 module BuoyData
-	class Buoy
-		include HTTParty
+  class Buoy
+    include HTTParty
 
-		GET_SUCCESS = 200
-	end
+    GET_SUCCESS = 200
+  end
 end

data/lib/buoy_data/noaa_buoy.rb

@@ -1,70 +1,125 @@
 module BuoyData
-	class NoaaBuoy < Buoy
-		format :plain
-
-		attr_accessor :buoy_id, :url, :response
-
-		def initialize(buoy_id)
-			@url = base_url(buoy_id)
-		end
-
-		def metaclass
-			class << self
-				self
-			end
-		end
-
-		def get(raw = false)
-			response = self.class.get(@url)
-			return unless response and response.code == GET_SUCCESS
-			return response if raw
-
-			@response = response
-			parse_response
-		end
-
-		def base_url(buoy_id = @buoy_id)
-			@buoy_id ||= buoy_id
-
-			# The following didn't work as the :description field contains markup we'd have
-			# to parse
-			#"http://www.ndbc.noaa.gov/data/latest_obs/#{id}.rss"
-			
-			# TODO:  get historical data from:
-			"http://www.ndbc.noaa.gov/data/realtime2/#{buoy_id}.spec"
-		end
-
-		def self.source
-			:noaa
-		end
-
-		def parse_response
-			# Get all readings
-			response = @response.parsed_response.split(/\n/)
-
-			# The first line are the fields
-			fields = response.first.sub(/^#/, '').split
-
-			# The second line are different names of the fields
-			
-			# The third line is the most recent reading
-			response = response[2].split rescue nil
-			return unless response
-
-			# Set instance vars per field so we can use dot notation to reference each
-			hash = {}
-			fields.each_with_index do |field, index|
-				hash.store(field, response[index])
-			end
-
-			define_attributes(hash)
-		end
-
-		def define_attributes(hash)
-			hash.each_pair { |key, value|
-				metaclass.send :attr_accessor, key
-				send "#{key}=".to_sym, value
-			}
-		end
-	end
+  class NoaaBuoy < Buoy
+    format :plain
+
+    attr_accessor :buoy_id, :url, :response
+
+    def initialize(buoy_id, unit_system = self.class.default_unit_system)
+      @url = base_url(buoy_id)
+      @unit_system = unit_system
+    end
+
+    def metaclass
+      class << self
+        self
+      end
+    end
+
+    def get(raw = false)
+      response = self.class.get(@url)
+      return unless response and response.code == GET_SUCCESS
+      return response if raw
+
+      @response = response
+      parse_response
+    end
+
+    def get_all
+      response = get(true)
+      return unless response
+
+      response.parsed_response.split(/\n/)
+    end
+
+    #
+    # Get a graph of the historical data for the given buoy.
+    #
+    # Inspired by:
+    #
+    # https://github.com/thepug/nbdc_graph/blob/master/generate_graphs.py
+    #
+    def google_chart_url
+      max = 120
+      response = get_all
+      return unless response
+
+      historical_data = []
+      response.each_with_index do |row, index|
+        break if index >= max
+        next if row.match(/^#/)
+
+        row = row.split(/  ?/)
+        historical_data << row[5]
+      end
+      return if historical_data.blank?
+      historical_data = historical_data.join(',')
+
+      [ self.class.google_chart_base(@buoy_id), '&chd=t:', historical_data ].join
+    end
+
+    def base_url(buoy_id = @buoy_id)
+      @buoy_id ||= buoy_id
+
+      # The following didn't work as the :description field contains markup we'd have
+      # to parse
+      #"http://www.ndbc.noaa.gov/data/latest_obs/#{id}.rss"
+      #
+      # Could also consider:
+      #
+      # http://www.ndbc.noaa.gov/data/5day2/41012_5day.txt
+      #
+      # It has more fields but seems to be an hour hehind the below.
+
+      "http://www.ndbc.noaa.gov/data/realtime2/#{buoy_id}.spec"
+    end
+
+    def self.source
+      :noaa
+    end
+
+    def self.google_chart_base(buoy_id)
+      url = [ "http://chart.apis.google.com/chart?cht=lc" ]
+      url << "chtt=#{buoy_id}"
+      url << "chts=666666,12"
+      url << "chco=3366FF"
+      url << "chs=250x100"
+      url << "chds=0,10"
+      url << "chl=WVHT".gsub(/ /, '%20')
+      url.join('&')
+    end
+
+
+    def self.default_unit_system
+      :metric
+    end
+
+    def parse_response
+      # Get all readings
+      response = @response.parsed_response.split(/\n/)
+
+      # The first line are the fields
+      fields = response.first.sub(/^#/, '').split
+
+      # The second line are different names of the fields
+
+      # The third line is the most recent reading
+      response = response[2].split rescue nil
+      return unless response
+
+      # Set instance vars per field so we can use dot notation to reference each
+      hash = {}
+      fields.each_with_index do |field, index|
+        hash.store(field, response[index])
+      end
+
+      define_attributes(hash)
+    end
+
+    def define_attributes(hash)
+      hash.each_pair { |key, value|
+        metaclass.send :attr_accessor, key
+        send "#{key}=".to_sym, value
+      }
+    end
+  end
 end

data/spec/noaa_buoy_spec.rb

@@ -2,19 +2,27 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe BuoyData::NoaaBuoy do
   before(:each) do
-    #WebMock.allow_net_connect! # TODO
+    #FakeWeb.allow_net_connect = false # TODO
     @noaa_buoy = BuoyData::NoaaBuoy.new(41114)
   end
-  
+
   context 'get' do
     it 'should get buoy data' do
-			@noaa_buoy.get
-			@noaa_buoy.response.code.should == BuoyData::NoaaBuoy::GET_SUCCESS
+      @noaa_buoy.get
+      @noaa_buoy.response.code.should == BuoyData::NoaaBuoy::GET_SUCCESS
+    end
+
+    it 'should respond to noaa fields' do
+      @noaa_buoy.get
+      @noaa_buoy.should respond_to :WVHT
     end
 
-		it 'should respond to noaa fields' do
-			@noaa_buoy.get
-			@noaa_buoy.should respond_to :WVHT
-		end
-	end
+    it 'should get all buoy data' do
+      @noaa_buoy.get_all.size.should >= 1
+    end
+
+    it 'should get all buoy data' do
+      @noaa_buoy.google_chart_url.should match(/chart.apis.google.com/)
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Adam Weller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 -04:00
+date: 2010-11-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency