cinch-forecast 0.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonah Ruiz
+
+MIT License
+
+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.md

@@ -0,0 +1,55 @@
+Cinch::Forecast
+=================
+
+Forecast is a Cinch plugin for getting the weather forecast.
+
+Installation
+---------------------
+
+    $ gem install cinch-forecast
+
+Setup
+-------
+
+You will need a Wunderground API key. You can sign-up for a free one at
+[Wunderground](http://www.wunderground.com/weather/api/)
+
+#### Configuration ####
+
+Set your key as an environment variable:
+
+    $ export WUNDERGROUND_KEY='your_api_key_here'
+
+You could also save it in your ~/.bash_profile
+
+#### Command ####
+
+  * !forecast [zipcode]    - Fetches the weather forecast for zipcode.
+
+## Integration with Cinch ##
+
+```ruby
+require 'cinch'
+require 'cinch/plugins/forecast'
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = 'irc.freenode.net'
+    c.nick   = 'Tabin_Pumarejo'
+    c.channels = ['#RubyOnADHD']
+    c.plugins.plugins = [Cinch::Plugins::Forecast]
+  end
+end
+
+bot.start
+```
+
+Enjoy!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/cinch-forecast.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cinch-forecast'
+  spec.version       = File.new('VERSION', 'r').read.chomp
+  spec.authors       = ['Jonah Ruiz']
+  spec.email         = ['jonah@pixelhipsters.com']
+  spec.description   = %q{Forecast is a Cinch plugin for getting the weather forecast}
+  spec.summary       = %q{Cinch plugin for getting the weather forecast by zipcode}
+  spec.homepage      = 'https://github.com/jonahoffline/cinch-forecast'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['{lib}/**/*','LICENSE.txt', 'README.md', 'cinch-forecast.gemspec']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'cinch', '~> 2.0.4'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cinch/plugins/forecast.rb

@@ -0,0 +1,115 @@
+require 'cinch'
+require 'ostruct'
+require 'open-uri'
+require 'json'
+
+module Cinch
+  module Plugins
+    class Forecast
+      include Cinch::Plugin
+
+      API_KEY  = ENV['WUNDERGROUND_KEY']
+      BASE_URL = "http://api.wunderground.com/api/#{API_KEY}/"
+
+
+      match /forecast (.+)/
+
+      attr_accessor :location, :conditions
+
+      def execute(m, query)
+        @location, @conditions = nil, {}
+
+        geolookup(query)
+        get_conditions
+
+        ##
+        # Reply with the Weather Summary
+        m.reply(weather_summary)
+      end
+
+      def geolookup(zipcode)
+        results = open("#{BASE_URL}geolookup/q/#{zipcode}.json").read
+        data = JSON.parse(results)
+        @location = data['location']['l']
+      rescue
+        "No results found for #{zipcode}"
+      end
+
+      def get_conditions
+        results = open("#{BASE_URL}conditions#{@location}.json").read
+
+        ##
+        # Cleanup and store into Hash
+        clean_up(JSON.parse(results))
+      rescue
+        'No weather data was found.'
+      end
+
+      def clean_up(data)
+        ##
+        # County, State & Country
+        @conditions.store(:county, data['current_observation']['display_location']['full'])
+        @conditions.store(:country, data['current_observation']['display_location']['country'])
+
+        ##
+        # Latitude and Longitude
+        @conditions.store(:lat, data['current_observation']['display_location']['latitude'])
+        @conditions.store(:lng, data['current_observation']['display_location']['longitude'])
+
+        ##
+        # Observation Time
+        @conditions.store(:observation_time, data['current_observation']['observation_time'])
+
+        ##
+        # General Weather Information
+        @conditions.store(:weather, data['current_observation']['weather'])
+        @conditions.store(:temp_fahrenheit, data['current_observation']['temp_f'])
+        @conditions.store(:temp_celcius, data['current_observation']['temp_c'])
+        @conditions.store(:relative_humidity, data['current_observation']['relative_humidity'])
+        @conditions.store(:feels_like, data['current_observation']['feelslike_string'])
+        @conditions.store(:uv, data['current_observation']['UV'])
+
+        ##
+        # Wind Related Data
+        @conditions.store(:wind, data['current_observation']['wind_string'])
+        @conditions.store(:wind_direction, data['current_observation']['wind_dir'])
+        @conditions.store(:wind_degrees, data['current_observation']['wind_degrees'])
+        @conditions.store(:wind_mph, data['current_observation']['wind_mph'])
+        @conditions.store(:wind_gust_mph, data['current_observation']['wind_gust_mph'])
+        @conditions.store(:wind_kph, data['current_observation']['wind_kph'])
+        @conditions.store(:pressure_mb, data['current_observation']['pressure_mb'])
+
+        ##
+        # Forecast URL
+        @conditions.store(:forecast_url, data['current_observation']['forecast_url'])
+        @conditions.store(:fetched_from, "#{BASE_URL}conditions#{@location}.json")
+
+        @conditions = OpenStruct.new(@conditions)
+      rescue
+        'Problem getting data.'
+      end
+
+      def weather_summary
+        ##
+        # Sample Summary using geolookup('00687')
+        # Weather for: Morovis, PR, US
+        # Party Cloudy, feels like 85 F (27.1 C)
+        # UV: 9.5, Humidity: 78%
+        # Wind: From the SE at 1.0 MPH Gusting to 5.0 MPH
+        # Direction: East, Degrees: 90
+        # Last Updated on June 4, 11:25 PM AST
+        # More Info: http://www.wunderground.com/US/PR/Morovis.html
+
+        %Q{Weather for: #{@conditions.county}, #{@conditions.country}
+        #{@conditions.weather}, #{@conditions.feels_like}
+        UV: #{@conditions.uv}, Humidity: #{@conditions.relative_humidity}
+        Wind: #{@conditions.wind}
+        Direction: #{@conditions.wind_direction}, Degrees: #{@conditions.wind_degrees},
+        #{@conditions.observation_time}
+        More Info: #{@conditions.forecast_url}}
+      rescue
+        'Problem fetching the weather summary.'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cinch-forecast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonah Ruiz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Forecast is a Cinch plugin for getting the weather forecast
+email:
+- jonah@pixelhipsters.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cinch/plugins/forecast.rb
+- LICENSE.txt
+- README.md
+- cinch-forecast.gemspec
+homepage: https://github.com/jonahoffline/cinch-forecast
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2530530863438312584
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Cinch plugin for getting the weather forecast by zipcode
+test_files: []