weather-underground 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,13 @@
+=== 1.1.0 2011-03-04
+
+* 3 major enhancements:
+  * Access Current Observation data
+  * Access Forecast data
+  * Access Alers data
+
+=== 1.0.1 ...
+* fix it so that rakefile correctly understands readme
+
 === 1.0.0 2010-03-13
 
 * 1 major enhancement:

data/README.rdoc

@@ -4,9 +4,7 @@
 
 == DESCRIPTION:
 
-Modules for interacting with Weather Underground website.  Right now
-the focus is on the data upload for their personal weather station
-reporting interface.
+Modules for interacting with Weather Underground website.  
 
 == FEATURES/PROBLEMS:
 
@@ -14,6 +12,22 @@ This currently uses the standard upload interface, it doesn't yet use
 the real time interface.
 
 == SYNOPSIS:
+  
+  w = WeatherUnderground::Base.new
+  w.Alerts( '90210' )
+  w.CurrentObservations( '90210' )
+  w.SimpleForecast( '90210' )
+  w.TextForecast( '90210' )
+
+  The location for your query can be any of the following:
+    * zipcode (US or Canadian)
+    * city state; city, state
+    * city
+    * state
+    * country
+    * airport code (3-letter or 4-letter)
+    * lat,lon
+
 
   w = WeatherUndergound::Uploader(station_id, password)
   w.update(:tempf => 72.1, :humidity => 40, :dewptf => 46.67)
@@ -26,6 +40,9 @@ sudo gem install weather-underground
 
 == LICENSE:
 
+Use of the API Subject to Terms and Conditions as specified on 
+http://wiki.wunderground.com/index.php/API_-_XML#API_Terms_Of_Service
+
 (The MIT License)
 
 Copyright (c) 2010 Sean Dague
@@ -47,4 +64,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -14,8 +14,12 @@ Hoe.plugin :website
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.spec 'weather-underground' do
   self.developer 'Sean Dague', 'sean@dague.net'
+  self.developer 'Jeff McFadden', 'jeff.mcfadden@gmail.com'
   self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
   self.rubyforge_name       = 'sdaguegems' # self.name # TODO this is default value
+  self.extra_rdoc_files = ["README.rdoc"]
+  self.readme_file = "README.rdoc"
+  self.extra_deps = [['temperature', '>= 1.0.0'], 'rest-client', 'happymapper']
   # self.extra_deps         = [['activesupport','>= 2.0.2']]
 
 end

data/lib/weather-underground.rb

@@ -1,8 +1,14 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require "weather-underground/utils"
+require "weather-underground/base"
+require "weather-underground/alerts"
+require "weather-underground/current_observation"
+require "weather-underground/forecast"
+require "weather-underground/geo_lookup"
 require "weather-underground/uploader"
 
 module WeatherUnderground
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/weather-underground/uploader.rb

@@ -1,16 +1,30 @@
 module WeatherUnderground
-        
+    # This is an uploader for the weather underground personal weather
+    # station service, as found at http://wunderground.com.  This
+    # makes it easier to build custom software to upload to the
+    # service allowing greater flexibility in the number of different
+    # weather sensors you can use.
+    #
+    # It is build from the documentation provided at
+    # http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol
     class Uploader
         require "uri"
         require "open-uri"
         
+        # This is the base url for uploading
         BaseURL = "http://weatherstation.wunderground.com/weatherstation/updateweatherstation.php"
         
+        # Create an uploader object.  Station is your registered
+        # station id from wunderground, password is the password you
+        # created for it.
         def initialize(station, passwd)
             @station = station
             @passwd = passwd
         end
-        
+
+        # Build the url to use for the upload.  You probably don't
+        # want to call this directly, though there is no harm in doing
+        # so.
         def url(params = {})
             base = "#{BaseURL}?ID=#{@station}&PASSWORD=#{@passwd}"
             base += "&dateutc=#{URI.escape(Time.now.utc.strftime("%Y-%m-%d %H:%M:%S"))}"
@@ -22,9 +36,17 @@ module WeatherUnderground
             return base
         end
         
+        # Update with data.  Data is of the form of :name => value for
+        # the parameters shown here:
+        # http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol.
+        #
+        # The required parameters are automatically filled in by the
+        # module, just provide the data that you want to upload.
+        #
+        #  w.update(:temp => 67.5, :humidity => 40)
         def update(data = {})
             open(url(data)) do |f|
-                # we should really do something with the response
+                # TODO: check the response
                 
             end
         end

metadata

@@ -1,53 +1,120 @@
 --- !ruby/object:Gem::Specification 
 name: weather-underground
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sean Dague
+- Jeff McFadden
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-03-13 23:00:00 -05:00
+date: 2011-03-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: temperature
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: happymapper
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rubyforge
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 0
+        - 3
         version: 2.0.3
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: gemcutter
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
         version: 0.3.0
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
-    version: 
-description: |-
-  Modules for interacting with Weather Underground website.  Right now
-  the focus is on the data upload for their personal weather station
-  reporting interface.
+  type: :development
+  version_requirements: *id006
+description: Modules for interacting with Weather Underground website.
 email: 
 - sean@dague.net
+- jeff.mcfadden@gmail.com
 executables: []
 
 extensions: []
@@ -56,6 +123,7 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - PostInstall.txt
+- README.rdoc
 files: 
 - History.txt
 - Manifest.txt
@@ -82,24 +150,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: sdaguegems
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Modules for interacting with Weather Underground website
+summary: Modules for interacting with Weather Underground website.
 test_files: 
 - test/test_uploader.rb
 - test/test_weather-underground.rb