lita-timezone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ffb017cd1a0fde029dfecf4a69417ecddd79af3
+  data.tar.gz: 6652bd83207cea84286f3e6324ef48d426da2336
+SHA512:
+  metadata.gz: e5273b76078b003c1ad63324508c16cfc2467a8fca2a849c6e4f841cf2d7b0e1c76b0816ea4702a104f2000b4a8e0dab39c9e7c8e91cd98dca9c5fc3e9381416
+  data.tar.gz: 0dc0c823013dae85b469b5a5446bca998312e83c7c183bbc4c0c114f02186b145443a27a826d20b1c193663ffbd26155f492b9e23771befa70888250228e77fa

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+script: bundle exec rake
+before_install:
+  - gem update --system
+  - gem update bundler
+services:
+  - redis-server

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+We follow [Keep a Changelog](http://keepachangelog.com/) format.
+
+## 0.1.0 - 2015-12-24
+### Added
+- Initial plugin import with support for the following commands:
+  * lita time 12:00 in X
+  * lita time now in X
+  * lita time 09:00 from X to Y
+  * lita time now from X to Y
+  * lita available timezones
+  * lita available timezones containing X
+- RSpec, Travis CI and Coveralls support

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Resultados Digitais
+
+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,44 @@
+# lita-timezone
+
+[![Build Status](https://travis-ci.org/ResultadosDigitais/lita-timezone.png?branch=master)](https://travis-ci.org/ResultadosDigitais/lita-timezone)
+[![Coverage Status](https://coveralls.io/repos/ResultadosDigitais/lita-timezone/badge.png)](https://coveralls.io/r/ResultadosDigitais/lita-timezone)
+[![Code
+Climate](https://codeclimate.com/github/ResultadosDigitais/lita-timezone/badges/gpa.svg)](https://codeclimate.com/github/ResultadosDigitais/lita-timezone)
+
+Lita handler to convert time between timezones.
+
+## Installation
+
+Add lita-timezone to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-timezone"
+```
+
+## Configuration
+
+Setup your default timezone
+
+``` ruby
+config.handlers.timezone.default_zone = 'Brasilia'
+```
+Tip: See in the `initialize` method of the handler how to get all available timezones of your machine.
+## Usage
+
+`lita time now in Beijing`
+- Returns the time in Beijing for current time
+
+`lita time 14:00 in Beijing`
+- Returns the time in Beijing for 14:00 in the default_zone
+
+`lita time now from Buenos Aires to Beijing`
+- Returns the time in Beijing for current time in Buenos Aires
+
+`lita time 14:00 from Buenos Aires to Beijing`
+- Returns the time in Beijing for 14:00 in Buenos Aires
+
+`lita available timezones`
+- Returns all timezones names available for use
+
+`lita available timezones containing Pacific`
+- Returns all timezones that contains Pacific in the name

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-timezone.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+require 'active_support/core_ext/time'
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/timezone'
+
+Lita::Handlers::Timezone.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/handlers/timezone.rb

@@ -0,0 +1,98 @@
+module Lita
+  module Handlers
+    class Timezone < Handler
+      config :default_zone, type: String, required: true
+
+      route(/^time (?<time>([\d]{1,2}:[\d]{1,2})|now) in (?<zone1>.*)$/,
+            :time_in_other_timezone, command: :true, help:
+            { 'time 10:00 in Brasilia' => 'Time in Brasilia for 10:00 in the default_zone',
+              'time now in Brasilia' => 'Time in Brasilia for current time' })
+
+      route(/^time (?<time>([\d]{1,2}:[\d]{1,2})|now) from (?<zone1>.*) to (?<zone2>.*)$/,
+            :time_between_locations, command: :true, help:
+            { 'time 10:00 from Brasilia to Beijing' => 'Time in Beijing for 10:00 in Brasilia',
+              'time now from Brasilia to Beijing' => 'Time in Beijing for current time in Brasilia' })
+
+      route(/^available timezones( containing (?<filter>\w+))?$/,
+            :list_timezones, command: :true, help:
+            { 'available timezones' => 'All timezones names available for use',
+              'available timezones containing Pacific' => 'Timezones that contains Pacific in the name' })
+
+      def initialize(robot)
+        super
+        Time.zone = config.default_zone
+        @all_zones = ActiveSupport::TimeZone.zones_map.keys + TZInfo::Timezone.all_identifiers
+      end
+
+      def time_in_other_timezone(response)
+        requested_time = time_from_response(response)
+        requested_zone = ActiveSupport::TimeZone[response.match_data[:zone1]]
+
+        if requested_time.blank?
+          response.reply t('messages.invalid_time')
+        elsif requested_zone.blank?
+          response.reply t('messages.invalid_zone')
+        else
+          time_in_new_time_zone = requested_time.in_time_zone(requested_zone)
+          response.reply t('messages.response_in_zone', time: format_time(time_in_new_time_zone))
+        end
+      end
+
+      def time_between_locations(response)
+        requested_time = time_from_response(response)
+        first_zone = ActiveSupport::TimeZone[response.match_data[:zone1]]
+        second_zone = ActiveSupport::TimeZone[response.match_data[:zone2]]
+
+        if requested_time.blank?
+          response.reply t('messages.invalid_time')
+        elsif first_zone.blank?
+          response.reply t('messages.invalid_first_zone')
+        elsif second_zone.blank?
+          response.reply t('messages.invalid_second_zone')
+        else
+          original_time = first_zone.parse(requested_time.asctime)
+          time_in_new_time_zone = original_time.in_time_zone(second_zone)
+
+          response.reply t('messages.response_from_to_zone',
+                            time: format_time(time_in_new_time_zone),
+                            zone1: first_zone.name,
+                            zone2: second_zone.name
+                          )
+        end
+      end
+
+      def list_timezones(response)
+        zone_filter = (response.match_data[:filter] rescue nil)
+        zones = zone_filter ? @all_zones.select { |name| name.include? zone_filter } : @all_zones
+
+        if zones.empty?
+          response.reply t('messages.no_zones_found', zone: zone_filter)
+        else
+          response.reply render_template('available_timezones', zones: zones)
+        end
+      end
+
+      private
+
+      def time_from_response(response)
+        time = response.match_data[:time]
+        return Time.current if time == 'now'
+
+        parse_time(time)
+      end
+
+      def format_time(time_response)
+        time_format = time_response.today? ? '%R' : '%F %R'
+        time_response.strftime(time_format)
+      end
+
+      def parse_time(time, default = nil)
+        Time.zone.parse(time)
+      rescue ArgumentError
+        default
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-timezone.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-timezone'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Thiago von Sydow']
+  spec.email         = ['dev@resultadosdigitais.com.br']
+  spec.description   = 'Lita handler to convert time between timezones'
+  spec.summary       = 'Lita handler to convert time between timezones'
+  spec.homepage      = 'https://github.com/ResultadosDigitais/lita-timezone'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'lita', '~> 4.6'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+  spec.add_runtime_dependency 'tzinfo', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'timecop'
+end

data/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  lita:
+    handlers:
+      timezone:
+        messages:
+          invalid_time: 'You must inform a valid time in the hh:mm format'
+          invalid_zone: 'You must inform a valid timezone'
+          invalid_first_zone: 'You must inform a valid "from" timezone'
+          invalid_second_zone: 'You must inform a valid "to" timezone'
+          response_in_zone: "Right now it's %{time}"
+          response_from_to_zone: "Right now it's %{time} in %{zone2} using %{zone1} as reference"
+          no_zones_found: 'No timezones found containing %{zone}'

data/spec/lita/handlers/timezone_spec.rb

@@ -0,0 +1,132 @@
+require "spec_helper"
+
+describe Lita::Handlers::Timezone, lita_handler: true do
+
+  # Routes
+  it { is_expected.to route_command('time 12:00 in Brasilia').to(:time_in_other_timezone) }
+  it { is_expected.to route_command('time 14:00 in Pacific Time (US & Canada)').to(:time_in_other_timezone) }
+
+  it { is_expected.to route_command('time 09:00 from Brasilia to Pacific Time (US & Canada)').to(:time_between_locations) }
+  it { is_expected.to route_command('time 09:00 from Pacific Time (US & Canada) to Brasilia').to(:time_between_locations) }
+
+  let(:room) { Lita::Room.new(1, name: 'my-channel') }
+
+  before { Lita.config.handlers.timezone.default_zone = 'Pacific Time (US & Canada)' }
+
+  # Commands
+  describe '#time_in_other_timezone' do
+    context 'with valid parameters' do
+      it 'replies with correct time in the specified timezone' do
+        send_command('time 10:00 in Brasilia', from: room)
+        expect(replies.last).to include '16:00'
+      end
+    end
+
+    context 'when time is invalid' do
+      it 'replies with a message telling to send a time in correct format' do
+        send_command('time 25:01 in Brasilia', from: room)
+        expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.invalid_time')
+      end
+    end
+
+    context 'when specified TimeZone is invalid' do
+      it 'replies with a message telling to send a valid Timezone' do
+        send_command('time 10:00 in Xunda', from: room)
+        expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.invalid_zone')
+      end
+    end
+
+    context 'when result is in another day' do
+      it 'replies with a message including the date' do
+        send_command('time 10:00 in Beijing', from: room)
+        date = Time.current.tomorrow.strftime('%F')
+        expect(replies.last).to include "#{date} 02:00"
+      end
+    end
+
+    context 'when time is now' do
+      it 'replies with correct time in the specified timezone' do
+        Timecop.freeze(Time.zone.parse('10:00')) do
+          send_command('time now in Beijing', from: room)
+          date = Time.current.tomorrow.strftime('%F')
+          expect(replies.last).to include "#{date} 02:00"
+        end
+      end
+    end
+  end
+
+  describe '#time_between_locations' do
+    context 'with valid parameters' do
+      it 'replies with correct time using "from" as base Timezone' do
+        send_command('time 10:00 from Buenos Aires to Berlin', from: room)
+        expect(replies.last).to include '14:00'
+      end
+    end
+
+    context 'when time is invalid' do
+      it 'replies with a message telling to send a time in correct format' do
+        send_command('time 25:00 from Brasilia to Berlin', from: room)
+        expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.invalid_time')
+      end
+    end
+
+    context 'when first TimeZone is invalid' do
+      it 'replies with a message telling to send a valid first Timezone' do
+        send_command('time 10:00 from Xunda to Berlin', from: room)
+        expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.invalid_first_zone')
+      end
+    end
+
+    context 'when second TimeZone is invalid' do
+      it 'replies with a message telling to send a valid second Timezone' do
+        send_command('time 10:00 from Berlin to Xunda', from: room)
+        expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.invalid_second_zone')
+      end
+    end
+
+    context 'when result is in another day' do
+      it 'replies with a message including the date' do
+        send_command('time 15:00 from Brasilia to Beijing', from: room)
+        date = Time.current.in_time_zone('Brasilia').tomorrow.strftime('%F')
+        expect(replies.last).to include "#{date} 01:00"
+      end
+    end
+
+    context 'when time is now' do
+      it 'replies with correct time in the specified timezone' do
+        Timecop.freeze(Time.zone.parse('16:00')) do
+          send_command('time now from Brasilia to Beijing', from: room)
+          date = Time.current.in_time_zone('Brasilia').tomorrow.strftime('%F')
+          expect(replies.last).to include "#{date} 02:00"
+        end
+      end
+    end
+  end
+
+  describe '#list_timezones' do
+    context 'without filtering results' do
+      it 'replies with all timezones' do
+        send_command('available timezones', from: room)
+        expect(replies.last.lines).to_not be_empty
+      end
+    end
+
+    context 'filtering results' do
+      context 'when filter matches something' do
+        it 'replies only with timezones that matches the filter' do
+          send_command('available timezones containing Pacific', from: room)
+          pacific_lines = replies.last.lines.select { |line| line.include? 'Pacific' }
+          expect(replies.last.lines.size).to eq pacific_lines.size
+        end
+      end
+
+      context 'when filter matches nothing' do
+        it 'replies with a zero zones message' do
+          send_command('available timezones containing Xunda', from: room)
+          expect(replies.last).to eq I18n.t('lita.handlers.timezone.messages.no_zones_found', zone: 'Xunda')
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-timezone'
+require 'lita/rspec'
+require 'timecop'
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

data/templates/available_timezones.erb

@@ -0,0 +1,3 @@
+<% @zones.each do |zone| %>
+- <%= zone %>
+<% end %>

data/templates/available_timezones.slack.erb

@@ -0,0 +1,5 @@
+```
+<% @zones.each do |zone| %>
+- <%= zone %>
+<% end %>
+```

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: lita-timezone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thiago von Sydow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lita handler to convert time between timezones
+email:
+- dev@resultadosdigitais.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-timezone.rb
+- lib/lita/handlers/timezone.rb
+- lita-timezone.gemspec
+- locales/en.yml
+- spec/lita/handlers/timezone_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+- templates/available_timezones.erb
+- templates/available_timezones.slack.erb
+homepage: https://github.com/ResultadosDigitais/lita-timezone
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Lita handler to convert time between timezones
+test_files:
+- spec/lita/handlers/timezone_spec.rb
+- spec/spec_helper.rb
+has_rdoc: