buoy_data 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam Weller
+
+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.markdown

@@ -0,0 +1,32 @@
+# buoy_data
+
+The goal of this gem is to provide marine buoy data from a variety of sources.
+
+## Install
+
+<pre>
+gem install buoy_data
+</pre>
+
+## Usage
+
+<pre>
+require 'buoy_data'
+noaa_buoy = BuoyData::NoaaBuoy.new(41114)
+noaa_buoy.get
+noaa_buoy.WVHT
+</pre>
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Adam Weller. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "buoy_data"
+    gem.summary = %Q{Fetch marine buoy data from various sources}
+    gem.description = %Q{The goal of this gem is to provide marine buoy data from a variety of sources}
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "buoy_data #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/buoy_data.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{buoy_data}
+  s.version = "0.1.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.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 = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "buoy_data.gemspec",
+     "lib/buoy_data.rb",
+     "lib/buoy_data/buoy.rb",
+     "lib/buoy_data/noaa_buoy.rb",
+     "spec/noaa_buoy_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/minch/buoy_data}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Fetch marine buoy data from various sources}
+  s.test_files = [
+    "spec/noaa_buoy_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end
+

data/lib/buoy_data/buoy.rb

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

data/lib/buoy_data/noaa_buoy.rb

@@ -0,0 +1,70 @@
+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
+end

data/lib/buoy_data.rb

@@ -0,0 +1,3 @@
+require 'httparty'
+require 'buoy_data/buoy'
+require 'buoy_data/noaa_buoy'

data/spec/noaa_buoy_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe BuoyData::NoaaBuoy do
+  before(:each) do
+    #WebMock.allow_net_connect! # 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
+    end
+
+		it 'should respond to noaa fields' do
+			@noaa_buoy.get
+			@noaa_buoy.should respond_to :WVHT
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+class String
+  def /(other)
+    File.join(self, other)
+  end
+end
+
+class File
+  def self.here
+    dirname(__FILE__)
+  end
+end
+
+require File.here / '..' / 'lib' / 'buoy_data'
+
+# TODO:  add webmock

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: buoy_data
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Weller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: The goal of this gem is to provide marine buoy data from a variety of sources
+email: minch@trazzler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- buoy_data.gemspec
+- lib/buoy_data.rb
+- lib/buoy_data/buoy.rb
+- lib/buoy_data/noaa_buoy.rb
+- spec/noaa_buoy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/minch/buoy_data
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fetch marine buoy data from various sources
+test_files: 
+- spec/noaa_buoy_spec.rb
+- spec/spec_helper.rb