lita-forecast 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 818e612a4379d01e51b89a449d6c594c93484844
+  data.tar.gz: 4d082b73283ba8bc5618064543d8cfd9a6cb74df
+SHA512:
+  metadata.gz: ffe26f94a9f842179ee7abf1524029fa5e711d6511282c68b113320cf82ad8d57d792633cf470b6394cfb70327f53a3c5dee164b2a16d72b825e56d422ef3480
+  data.tar.gz: be690554ce1e9acdbd1574590cf8693a60aebdbc336624b0ed8a06b3a12bcfe58104e0874daeb470ea94677ffac4943e459f503fbc2b79b6a0588072e5f8b171

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fuubar

data/.rubocop.yml

@@ -0,0 +1,6 @@
+FileName:
+  Exclude:
+    - Rakefile
+    - Gemfile
+    - lib/lita-forecast.rb
+    - lita-forecast.gemspec

data/.travis.yml

@@ -0,0 +1,10 @@
+branches:
+  only:
+    - master
+services:
+  - redis-server
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Heckman
+
+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,100 @@
+lita-forecast
+=============
+[![Build Status](https://img.shields.io/travis/theckman/lita-forecast/master.svg)](https://travis-ci.org/theckman/lita-forecast)
+[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![RubyGems :: RMuh Gem Version](http://img.shields.io/gem/v/lita-forecast.svg)](https://rubygems.org/gems/lita-forecast)
+[![Coveralls Coverage](https://img.shields.io/coveralls/theckman/lita-forecast/master.svg)](https://coveralls.io/r/theckman/lita-forecast)
+[![Code Climate](https://img.shields.io/codeclimate/github/theckman/lita-forecast.svg)](https://codeclimate.com/github/theckman/lita-forecast)
+[![Gemnasium](https://img.shields.io/gemnasium/theckman/lita-forecast.svg)](https://gemnasium.com/theckman/lita-forecast)
+
+Forecast.io plugin for Lita
+
+LICENSE
+-------
+[lita-forecast](https://github.com/theckman/lita-forecast) is released under
+the [MIT](http://opensource.org/licenses/MIT) license. The full license is
+provided in the `LICENSE` file.
+
+CONTRIBUTING
+------------
+Something wrong or you want to submit an improvement? Fork the repo, make your
+changes on a feature branch, write some tests, and submit a pull request. I
+only ask that the commits have useful information and use proper/complete
+sentences.
+
+INSTALLATION
+------------
+Simply add `lita-forecast` to the `Gemfile` for your Lita instance.
+
+```Ruby
+gem 'lita-forecast'
+```
+
+CONFIGURATION
+-------------
+There is only one required configuration option for this plugin, and that's
+your Forecast.io API key
+[Forecast.io Developer Site](https://developer.forecast.io/register)
+
+```Ruby
+config.handlers.forecast.api_key = '<API_KEY>'
+```
+
+COMMANDS
+-----
+* `wx <alias/location>` - get the weather forecast for a location in US units.
+* `wc <alias/location>` - get the weather forecast for a location in CA units.
+* `ws <location>` - returns the lat. and long. for your search string so that
+  you can add a weather alias
+* `wl` - list known weather aliases
+* `wadd <alias> <lat> <long> [<description>]` - add an alias to your bot
+* `wrm alias` - remove an alias added to your bot
+
+USAGE
+-----
+```
+>> Lita wx San Francisco, CA
+San Francisco, CA:
+
+Now: 55.5F (feels like 55.5F) Mostly Cloudy; Winds WSW 8.6mph; Humidity 66%; Dew Pt 44.2F; Pressure 1019.2mb; Cloud cover 82%.
+Next hour: Mostly cloudy for the hour. Next 24h: Rain throughout the day.
+
+Summary: Light rain today through Thursday, with temperatures bottoming out at 52°F on Tuesday.
+Today: Mostly cloudy throughout the day. High 57F, Low 51F. 90% chance of rain. Winds W 7mph.
+Tomorrow: Rain throughout the day. High 55F, Low 51F. 100% chance of rain. Winds SSW 9mph.
+
+>> Lita wc San Francisco, CA
+San Francisco, CA:
+
+Now: 13.1C (feels like 13.1C) Mostly Cloudy; Winds WSW 12.6kmph; Humidity 65%; Dew Pt 6.7C; Pressure 1019.2mb; Cloud cover 82%.
+Next hour: Mostly cloudy for the hour. Next 24h: Rain throughout the day.
+
+Summary: Light rain today through Thursday, with temperatures bottoming out at 11°C on Tuesday.
+Today: Mostly cloudy throughout the day. High 14C, Low 10C. 90% chance of rain. Winds W 11kmph.
+Tomorrow: Rain throughout the day. High 13C, Low 10C. 100% chance of rain. Winds SSW 15kmph.
+
+>> Lita wl
+There are no weather aliases
+
+>> Lita ws 501 2nd St, 94107
+San Francisco, CA: 37.7830503, -122.3933962 :: !wadd <alias> 37.7830503 -122.3933962 <description/city name>
+
+>> Lita wadd sf 37.7749295 -122.4194155 PagerDuty San Francisco
+sf added to the cache at [37.7749295, -122.4194155]
+
+>> Lita wx sf
+PagerDuty San Francisco:
+
+Now: 55.6F (feels like 55.6F) Mostly Cloudy; Winds WSW 7.8mph; Humidity 65%; Dew Pt 44.0F; Pressure 1019.2mb; Cloud cover 82%.
+Next hour: Mostly cloudy for the hour. Next 24h: Rain throughout the day.
+
+Summary: Light rain today through Thursday, with temperatures bottoming out at 52°F on Tuesday.
+Today: Mostly cloudy throughout the day. High 57F, Low 51F. 90% chance of rain. Winds W 7mph.
+Tomorrow: Rain throughout the day. High 55F, Low 51F. 100% chance of rain. Winds SSW 9mph.
+
+>> Lita wl
+Known weather aliases: sf
+
+>> Lita wrm sf
+Alias removed!
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- coding: UTF-8 -*_
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rubocop::RakeTask.new(:rubocop) do |t|
+  t.patterns =
+    %w( Rakefile Gemfile lita-forecast.gemspec lib/**/*.rb spec/*_spec.rb )
+  t.fail_on_error = true
+end
+
+task default: [:rubocop, :spec]

data/lib/lita/handlers/forecast/current.rb

@@ -0,0 +1,65 @@
+# -*- coding: UTF-8 -*-
+require 'lita/handlers/forecast/mixins'
+
+module LitaForecast
+  # LitaForecast::Current
+  #
+  class Current
+    include LitaForecast::Mixins
+
+    def initialize(forecast)
+      @f = forecast
+    end
+
+    def conditions
+      c = currently
+      "#{temp} (feels like #{feels}) #{c['summary']}; Winds #{wind}; " \
+      "Humidity #{humidity}; Dew Pt #{dew_pt}; Pressure #{pressure}; Cloud " \
+      "cover #{clouds}.\n" \
+      "Next hour: #{next_hour} Next 24h: #{today}"
+    end
+
+    private
+
+    def currently
+      @f['currently']
+    end
+
+    def temp
+      "#{currently['temperature'].round(1)}#{units(@f)[:t]}"
+    end
+
+    def feels
+      "#{currently['apparentTemperature'].round(1)}#{units(@f)[:t]}"
+    end
+
+    def wind
+      direction = Compass::Rose.direction(currently['windBearing'], 16)[:abbr]
+      "#{direction} #{currently['windSpeed'].round(1)}#{units(@f)[:w]}"
+    end
+
+    def humidity
+      "#{(currently['humidity'] * 100).round(0)}%"
+    end
+
+    def dew_pt
+      "#{currently['dewPoint'].round(1)}#{units(@f)[:t]}"
+    end
+
+    def pressure
+      "#{currently['pressure'].round(1)}mb"
+    end
+
+    def clouds
+      "#{(currently['cloudCover'] * 100).round(0)}%"
+    end
+
+    def next_hour
+      @f['minutely']['summary']
+    end
+
+    def today
+      @f['hourly']['summary']
+    end
+  end
+end

data/lib/lita/handlers/forecast/future.rb

@@ -0,0 +1,65 @@
+# -*- coding: UTF-8 -*-
+require 'English'
+require 'compass_rose'
+require 'lita/handlers/forecast/mixins'
+
+module LitaForecast
+  # LitaForecast::Future
+  #
+  class Future
+    include LitaForecast::Mixins
+
+    def method_missing(method, *args, &block)
+      super unless /^generate_(.*)$/.match(method)
+      m = $LAST_MATCH_INFO
+      super unless %w(today tomorrow).include?(m[1])
+      i = { today: 0, tomorrow: 1 }[m[1].to_sym]
+      generate_day(i, m[1])
+    end
+
+    def initialize(forecast)
+      @f = forecast
+    end
+
+    def conditions
+      future = generate_summary
+      future << generate_today
+      future << generate_tomorrow
+    end
+
+    private
+
+    def daily
+      @f['daily']['data']
+    end
+
+    def generate_summary
+      "Summary: #{@f['daily']['summary']}\n"
+    end
+
+    def generate_day(index, day)
+      @i = daily[index]
+      @d = day
+      "#{summary} #{high_low} #{precip} #{wind}\n"
+    end
+
+    def summary
+      "#{@d.capitalize}: #{@i['summary']}"
+    end
+
+    def high_low
+      "High #{@i['temperatureMax'].round(0)}#{units(@f)[:t]}, " \
+      "Low #{@i['temperatureMin'].round(0)}#{units(@f)[:t]}."
+    end
+
+    def precip
+      type = @i['precipType'] || 'precipitation'
+      "#{(@i['precipProbability'] * 100).round(0)}% chance of #{type}."
+    end
+
+    def wind
+      direction = Compass::Rose.direction(@i['windBearing'], 16)[:abbr]
+      "Winds #{direction} #{@i['windSpeed'].round(0)}#{units(@f)[:w]}."
+    end
+  end
+end

data/lib/lita/handlers/forecast/location.rb

@@ -0,0 +1,31 @@
+# -*- coding: UTF-8 -*-
+require 'geocoder'
+require 'lita/handlers/forecast/mixins'
+
+module LitaForecast
+  # LitaForecast class for determining someone's location
+  #
+  class Location
+    include LitaForecast::Mixins
+
+    attr_accessor :lita_redis
+
+    def initialize(redis)
+      @lita_redis = redis
+    end
+
+    def find_location(search)
+      loc = lita_redis.hgetall("alias:#{search}").symbolize_keys!
+
+      if loc.empty?
+        g = Geocoder.search(search)[0].data
+        gl = geo_location(g)
+        loc = { lat: g['geometry']['location']['lat'],
+                lng: g['geometry']['location']['lng'],
+                desc: "#{gl[:city]}, #{gl[:state]}" }
+      end
+
+      loc
+    end
+  end
+end

data/lib/lita/handlers/forecast/mixins.rb

@@ -0,0 +1,26 @@
+# -*- coding: UTF-8 -*-
+
+module LitaForecast
+  # The random mixins I'll need, eventually
+  #
+  module Mixins
+    def geo_location(result)
+      h = {}
+      result['address_components'].each do |a|
+        a['types'].each do |t|
+          h[:city] = a['long_name'] if t == 'locality'
+          h[:state] = a['short_name'] if t == 'administrative_area_level_1'
+        end
+      end
+      h
+    end
+
+    def units(forecast)
+      if forecast['flags']['units'] == 'us'
+        { t: 'F', w: 'mph', v: 'mi' }
+      else
+        { t: 'C', w: 'kmph', v: 'km' }
+      end
+    end
+  end
+end

data/lib/lita/handlers/forecast/persistence.rb

@@ -0,0 +1,18 @@
+# -*- coding: UTF-8 -*-
+require 'lita'
+require 'redis-namespace'
+
+# LitaForecast module
+#
+module LitaForecast
+  FORECAST_NAMESPACE = 'handlers:forecast'
+
+  class << self
+    def redis
+      @forecastredis ||= begin
+        Redis::Namespace.new(FORECAST_NAMESPACE, redis: Lita.redis)
+      end
+      @forecastredis
+    end
+  end
+end

data/lib/lita/handlers/forecast/response.rb

@@ -0,0 +1,24 @@
+# -*- coding: UTF-8 -*-
+require 'compass_rose'
+require 'lita/handlers/forecast/current'
+require 'lita/handlers/forecast/future'
+
+module LitaForecast
+  # LutaForecast::Response
+  #
+  class Response
+    def initialize(forecast, location)
+      @forecast = forecast
+      @location = location
+      @current = LitaForecast::Current.new(@forecast)
+      @future = LitaForecast::Future.new(@forecast)
+    end
+
+    def generate
+      response = "#{@location}:\n\n"
+      response << "Now: #{@current.conditions}\n\n"
+      response << @future.conditions
+      response
+    end
+  end
+end

data/lib/lita/handlers/forecast/weather.rb

@@ -0,0 +1,25 @@
+# -*- coding: UTF-8 -*-
+require 'forecast_io'
+require 'lita/handlers/forecast/location'
+require 'lita/handlers/forecast/response'
+
+# The thing
+#
+module LitaForecast
+  # Module
+  #
+  module Weather
+    def weather_forecast(api_key, l = {})
+      ForecastIO.api_key = api_key
+      l = { params: { exclude: 'alerts' } }.merge(l)
+      ForecastIO.forecast(l[:lat].to_f, l[:lng].to_f, params: l[:params])
+    end
+
+    def weather(response, api_key, units = 'us')
+      location = LitaForecast::Location.new(LitaForecast.redis)
+        .find_location(response.args.join(' '))
+      f = weather_forecast(api_key, location.merge(params: { units: units }))
+      LitaForecast::Response.new(f, location[:desc]).generate
+    end
+  end
+end

data/lib/lita/handlers/forecast.rb

@@ -0,0 +1,57 @@
+# -*- coding: UTF-8 -*-
+require 'lita/handlers/forecast/mixins'
+require 'lita/handlers/forecast/weather'
+
+module Lita
+  module Handlers
+    # Lita Forecast.io plugin!
+    # this provides handlers for US and Canadian units
+    #
+    class Forecast < Handler
+      include LitaForecast::Mixins
+      include LitaForecast::Weather
+
+      def self.default_config(config)
+        config.api_key = nil
+      end
+
+      route(
+        /^wx\s(.*)$/,
+        :weather_us,
+        command: true,
+        help: {
+          'wx san francisco' => 'Get the weather for San Francisco'
+        }
+      )
+
+      route(
+        /^wc\s(.*)$/,
+        :weather_ca,
+        command: true,
+        help: {
+          'wc toronto' => 'You want the weather for Toronto, eh?'
+        }
+      )
+
+      def weather_us(response)
+        response.reply(build_weather('us', response))
+      end
+
+      def weather_ca(response)
+        response.reply(build_weather('ca', response))
+      end
+
+      def build_weather(units, response)
+        weather(response, api_key, units)
+      end
+
+      private
+
+      def api_key
+        Lita.config.handlers.forecast.api_key
+      end
+
+      Lita.register_handler(Forecast)
+    end
+  end
+end

data/lib/lita/handlers/forecast_locations.rb

@@ -0,0 +1,97 @@
+# -*- coding: UTF-8 -*-
+require 'lita/handlers/forecast/persistence'
+
+module Lita
+  module Handlers
+    # Lita::Handlers::ForecastLocations
+    #
+    class ForecastLocations < Handler
+      route(
+        /^wadd\s(.+?)\s([0-9.,\-]+?)\s([0-9.,\-]+)\s*(.*)$/,
+        :location_add,
+        command: true,
+        help: {
+          'wadd sf 37.78439928029 -122.39204721970 PagerDuty San Francisco' =>
+            'Add the lat and long of the office with the alias "sf"'
+        }
+      )
+
+      route(
+        /^wrm\s(.+?)$/,
+        :location_rm,
+        command: true,
+        help: {
+          'wrm sf' =>
+            'Remove the specified alias, in this case "sf"'
+        }
+      )
+
+      route(
+        /^wl$/,
+        :locations,
+        command: true,
+        help: {
+          'wl' => 'List known weather aliases'
+        }
+      )
+
+      def self.default_config(config)
+        config.api_key = nil
+      end
+
+      def location_add(response)
+        r = response.matches[0]
+        return response.reply('Already there!') if alias_exists?(r[0])
+
+        d = saved_location_hash(r)
+        add_to_cache(d)
+
+        response.reply("#{r[0]} added to the cache at [#{r[1]}, #{r[2]}]")
+      end
+
+      def location_rm(response)
+        key = "alias:#{response.matches[0][0]}"
+        return response.reply('Alias not found') unless alias_exists?(key)
+        rm_from_cache(key)
+        if LitaForecast.redis.keys(key).empty?
+          return response.reply('Alias removed!')
+        else
+          return response.reply('Somehow that failed... I need an adult!')
+        end
+      end
+
+      def locations(response)
+        k = LitaForecast.redis.keys('alias:*').map { |v| v.gsub('alias:', '') }
+        return response.reply('There are no weather aliases') if k.empty?
+        response.reply("Known weather aliases: #{k.join(', ')}")
+      end
+
+      private
+
+      def alias_exists?(key)
+        return true unless LitaForecast.redis.hgetall(key).empty?
+        false
+      end
+
+      def add_to_cache(location)
+        key = "alias:#{location[:name]}"
+        LitaForecast.redis.pipelined do
+          [:lat, :lng, :desc].each do |k|
+            LitaForecast.redis.hset(key, k.to_s, location[k])
+          end
+        end
+      end
+
+      def rm_from_cache(key)
+        LitaForecast.redis.del(key)
+      end
+
+      def saved_location_hash(r)
+        d = (r[3].nil? || r[3].empty?) ? r[0] : r[3].slice(0..29)
+        { name: r[0], lat: r[1], lng: r[2], desc: d }
+      end
+
+      Lita.register_handler(ForecastLocations)
+    end
+  end
+end

data/lib/lita/handlers/location_search.rb

@@ -0,0 +1,44 @@
+# -*- coding: UTF-8 -*-
+require 'geocoder'
+require 'lita/handlers/forecast/mixins'
+
+module Lita
+  module Handlers
+    # Lita::Handlers::LocationSearch
+    #
+    class LocationSearch < Handler
+      include LitaForecast::Mixins
+
+      route(
+        /^ws\s(.*)$/,
+        :search,
+        command: true,
+        help: { 'ws san francisco' =>
+          'find the lat and long for the location' }
+      )
+
+      def search(response)
+        s = response.args.join(' ')
+        r = search_geocoder(s)
+        return response.reply('You made that up...') if r.empty?
+        response.reply(generate_response(r))
+      end
+
+      private
+
+      def search_geocoder(search)
+        Geocoder.search(search)[0].data
+      end
+
+      def generate_response(result)
+        l = geo_location(result)
+        lat = result['geometry']['location']['lat']
+        lng = result['geometry']['location']['lng']
+        "#{l[:city]}, #{l[:state]}: #{lat}, #{lng} :: "\
+        "!wadd <alias> #{lat} #{lng} <description/city name>"
+      end
+
+      Lita.register_handler(LocationSearch)
+    end
+  end
+end

data/lib/lita-forecast/version.rb

@@ -0,0 +1,7 @@
+# -*- coding: UTF-8 -*-
+
+# LitaForcast module, just for version handling
+#
+module LitaForecast
+  VERSION = '0.1.0'
+end

data/lib/lita-forecast.rb

@@ -0,0 +1,6 @@
+# -*- coding: UTF-8 -*-
+
+require 'lita'
+require 'lita/handlers/forecast'
+require 'lita/handlers/forecast_locations'
+require 'lita/handlers/location_search'