tikaro-sandex 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Young
+
+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,43 @@
+= sandex
+
+* http://github.com/tikaro/sandex
+
+== Description
+
+The sandex is an index of awesome your weather is, compared to the current weather in San Diego, CA.  The highest possible sandex is 100%.
+
+This score is used to answer the question: "Is it nice enough to work outside today?"  If the sandex is high, yes: go work outside. That's because EVERY day is a work-outside day in San Diego.
+
+Thanks to @r38y for the concept and the name.
+
+== Features
+
+- Given a NOAA station ID, calculate the sandex.
+- Currently, the sandex is a stub: 100% MINUS one percent for every degree difference (positive or negative) between your station and KSAN in San Diego.
+- Defaults to station KILG, near West Chester, Pennsilvania.
+
+== Requirements
+
+- libxml-ruby >= 0.9.7
+- andre-geokit >= 1.2.0
+- outoftime-noaa >= 0.2.2
+
+== Installation
+
+Note that the NOAA gem has some separate install requirements, and must update its station list.  Once I get that figured out, I'll add that here.
+
+* sudo gem sources --add http://gems.github.com (only if you haven't done this before)
+* sudo gem install tikaro-sandex
+
+== Usage
+
+Get the current sandex score for your location:
+Sandex.calculate(station_id)
+
+== Contact
+
+John Young (john@tikaro.net)
+
+== Copyright
+
+Copyright (c) 2009 John Young. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 0

data/lib/sandex.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'libxml-ruby', '>= 0.9.7'
+gem 'andre-geokit', '>= 1.2.0'
+gem 'outoftime-noaa', '>= 0.2.2'
+
+require 'time'
+require 'libxml'
+require 'geokit'
+require 'noaa'
+
+module Sandex
+  def self.calculate(local_station='KILG')
+    local_conditions = NOAA.current_conditions_at_station(local_station)
+    ksan_conditions  = NOAA.current_conditions_at_station('KSAN')
+    
+    local_temperature = local_conditions.temperature
+    ksan_temperature  = ksan_conditions.temperature
+    
+    temperature_delta = ( ksan_temperature - local_temperature ).abs
+    
+    sandex_score = ( 100 - temperature_delta.to_f ) / 100
+    
+    sandex_score
+  end
+end

data/test/sandex_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SandexTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sandex'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: tikaro-sandex
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- tikaro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: john@tikaro.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/sandex.rb
+- test/sandex_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/tikaro/sandex
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+