lita-kegbot 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f377744672faacfb1dd8eb24044eeb4051a7f033
-  data.tar.gz: d6b41a95f2e133eee66e5767987e550fe6d8dc81
+  metadata.gz: 351fd2596c187b9739412825dd59ed3d4528b0a7
+  data.tar.gz: 5b177d8c0d54a17fca2c3aedf8d4258f52fa5620
 SHA512:
-  metadata.gz: bc8141444f4cbbb04de03fc93990a1c08824d24dcf25c2b737552ba0da0f7dcbfda6f30c29c3f93100b3378665e9e9f709b3f00b591c22d48e31095f8412347b
-  data.tar.gz: e784489a0972fb0f3eebd5e7d33ddc01ed11895051349a886e615cbaf0b837186c67a12dbb3fce73b95420bf0e43afbcb51c4de5ddda0410fe4b118227578bf1
+  metadata.gz: 98efc4a96b7d2bdb0e60a0c3fb830b75aeb9b679ad5ee75b1ba4d03829d43aff7210cb38b728616b9903f29d0ce104e445225d83c8ca21e2e85915b2139ed6b1
+  data.tar.gz: d458e6d9377e2a85561b39dd370fec4441323b244662d6f3095348a43b53ae6fdf42d5d71ccd957d2cf36e108312be61671cf39b8b8acb9f1fd41be6058dbeaa

data/.rubocop.yml

@@ -1,11 +1,10 @@
 ClassLength:
-  Max: 300
+  Max: 130
 
 Documentation:
-  Enabled: false
+  Exclude:
+    - lib/lita/handlers/kegbot.rb
 
 FileName:
-  Enabled: false
-
-MethodLength:
-  Max: 20
+  Exclude:
+    - lib/lita-kegbot.rb

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.1
 script: bundle exec rake
 before_install:
   - gem update --system

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Pull requests are awesome!  Pull requests with tests are even more awesome!
+
+## Quick steps
+
+1. Fork the repo.
+2. Run the tests: `bundle && rake`
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, it needs a test!
+4. Make the test pass.
+5. Push to your fork and submit a pull request.

data/Gemfile

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

data/README.md

@@ -7,7 +7,7 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/esigler/lita-kegbot.svg)](https://codeclimate.com/github/esigler/lita-kegbot)
 [![Gemnasium](https://img.shields.io/gemnasium/esigler/lita-kegbot.svg)](https://gemnasium.com/esigler/lita-kegbot)
 
-A Kegbot (https://kegbot.org) handler for checking what's on tap, how much is left, etc.
+A [Kegbot](https://kegbot.org) plugin for [Lita](https://github.com/jimmycuadra/lita).
 
 ## Installation
 

data/Rakefile

@@ -3,6 +3,6 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: [ :spec, :rubocop ]
+task default: [:spec, :rubocop]

data/lib/lita/handlers/kegbot.rb

@@ -1,8 +1,11 @@
 module Lita
   module Handlers
     class Kegbot < Handler
+      config :api_key, required: true
+      config :api_url, required: true
+
       route(
-        /^(?:kegbot|kb)\s(?:drink|drinks)\slist(\s\d+)*$/,
+        /^(?:kegbot|kb)\s(?:drink|drinks)\slist(?<c>\s\d+)?$/,
         :drink_list,
         command: true,
         help: {
@@ -46,89 +49,70 @@ module Lita
         }
       )
 
-      def self.default_config(config)
-        config.api_key = nil
-        config.api_url = nil
-      end
-
+      # rubocop:disable Metrics/AbcSize
       def drink_list(response)
-        count_match = response.matches[0][0]
-        count_match ? count = count_match.to_i : count = 5
-        current = 0
+        count = response.match_data['c'] ? response.match_data['c'].to_i : 5
         drinks = fetch_drinks
-        if drinks
-          response.reply(t('drinks.none')) unless drinks.count > 0
-          drinks.each do |drink|
-            if current < count
-              formatted_date = drink['session']['start_time']
-              beer = drink['keg']['beverage']['name']
-              response.reply(t('drinks.info', user: drink['user_id'],
-                                              beer: beer,
-                                              date: formatted_date))
-              current += 1
-            end
-          end
-        else
-          response.reply(t('error.request'))
+
+        return response.reply(t('error.request')) unless drinks
+        return response.reply(t('drinks.none')) unless drinks.count > 0
+
+        count.times do |i|
+          response.reply(format_drink(drinks[i])) if drinks[i]
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       def tap_status_all(response)
         taps = fetch_taps
-        if taps
-          response.reply(t('taps.none')) unless taps.count > 0
-          taps.each do |tap|
-            response.reply(t('taps.info', id: tap['id'], name: tap['name']))
-          end
-        else
-          response.reply(t('error.request'))
+        return response.reply(t('error.request')) unless taps
+        return response.reply(t('taps.none')) unless taps.count > 0
+        taps.each do |tap|
+          response.reply(t('taps.info', id: tap['id'], name: tap['name']))
         end
       end
 
       def tap_status_id(response)
         tap = fetch_tap(response.matches[0][0].to_i)
-        if tap
-          response.reply(t('taps.info', id: tap['id'], name: tap['name']))
-        else
-          response.reply(t('error.request'))
-        end
+        return response.reply(t('error.request')) unless tap
+        response.reply(t('taps.info', id: tap['id'], name: tap['name']))
       end
 
       def keg_status_all(response)
         kegs = fetch_kegs
-        if kegs
-          response.reply(t('kegs.none')) unless kegs.count > 0
-          kegs.each do |keg|
-            if keg['online']
-              keg['online'] ? status = 'online' : status = 'offline'
-              pct = format('%3.2f', keg['percent_full'])
-              response.reply(t('kegs.info', id: keg['id'],
-                                            beer: keg['beverage']['name'],
-                                            status: status,
-                                            pct: pct))
-            end
-          end
-        else
-          response.reply(t('error.request'))
+        return response.reply(t('error.request')) unless kegs
+        return response.reply(t('kegs.none')) unless kegs.count > 0
+        kegs.each do |keg|
+          next unless keg['online']
+          response.reply(format_keg(keg))
         end
       end
 
       def keg_status_id(response)
         keg = fetch_keg(response.matches[0][0].to_i)
-        if keg
-          keg['online'] ? status = 'online' : status = 'offline'
-          pct = format('%3.2f', keg['percent_full'])
-          response.reply(t('kegs.info', id: keg['id'],
-                                        beer: keg['beverage']['name'],
-                                        status: status,
-                                        pct: pct))
-        else
-          response.reply(t('error.request'))
-        end
+        return response.reply(t('error.request')) unless keg
+        response.reply(format_keg(keg))
       end
 
       private
 
+      def format_drink(drink)
+        formatted_date = drink['session']['start_time']
+        beer = drink['keg']['beverage']['name']
+        t('drinks.info', user: drink['user_id'],
+                         beer: beer,
+                         date: formatted_date)
+      end
+
+      def format_keg(keg)
+        keg['online'] ? status = 'online' : status = 'offline'
+        pct = format('%3.2f', keg['percent_full'])
+        t('kegs.info', id: keg['id'],
+                       beer: keg['beverage']['name'],
+                       status: status,
+                       pct: pct)
+      end
+
       def fetch_drinks
         result = api_request('get', 'drinks/')
         result['objects'] if result && result['objects']
@@ -154,31 +138,21 @@ module Lita
         result['objects'] if result && result['objects']
       end
 
+      # rubocop:disable Metrics/AbcSize
       def api_request(method, path, args = {})
-        if Lita.config.handlers.kegbot.api_key.nil? ||
-           Lita.config.handlers.kegbot.api_url.nil?
-          Lita.logger.error('Missing API key or Page ID for Kegbot')
-          fail 'Missing config'
-        end
-
-        url = "#{Lita.config.handlers.kegbot.api_url}/api/#{path}"
-
         http_response = http.send(method) do |req|
-          req.url url, args
-          req.headers['X-Kegbot-Api-Key'] = \
-            Lita.config.handlers.kegbot.api_key
+          req.url "#{config.api_url}/api/#{path}", args
+          req.headers['X-Kegbot-Api-Key'] = config.api_key
         end
 
-        if http_response.status == 200 ||
-           http_response.status == 201
-          MultiJson.load(http_response.body)
-        else
-          Lita.logger.error("HTTP #{method} for #{url} with #{args} " \
-                            "returned #{http_response.status}")
-          Lita.logger.error(http_response.body)
-          nil
+        unless http_response.status == 200 || http_response.status == 201
+          log.error("#{method}:#{path}:#{args}:#{http_response.status}")
+          return nil
         end
+
+        MultiJson.load(http_response.body)
       end
+      # rubocop:enable Metrics/AbcSize
     end
 
     Lita.register_handler(Kegbot)

data/lita-kegbot.gemspec

@@ -1,24 +1,24 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-kegbot'
-  spec.version       = '0.3.0'
+  spec.version       = '1.0.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
-  spec.description   = %q{A Kegbot handler for Lita.io}
-  spec.summary       = %q{A Kegbot handler for Lita.io}
+  spec.description   = 'A Kegbot plugin for Lita'
+  spec.summary       = 'A Kegbot plugin for Lita'
   spec.homepage      = 'https://github.com/esigler/lita-kegbot'
   spec.license       = 'MIT'
   spec.metadata      = { 'lita_plugin_type' => 'handler' }
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'lita', '>= 3.0'
+  spec.add_runtime_dependency 'lita', '>= 4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 3.0.0.beta2'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'coveralls'

data/spec/lita/handlers/kegbot_spec.rb

@@ -33,19 +33,16 @@ describe Lita::Handlers::Kegbot, lita_handler: true do
     File.read('spec/files/keg.json')
   end
 
-  it { routes_command('kegbot drink list').to(:drink_list) }
-  it { routes_command('kegbot drink list 10').to(:drink_list) }
-  it { routes_command('kegbot tap status').to(:tap_status_all) }
-  it { routes_command('kegbot tap status 1').to(:tap_status_id) }
-  it { routes_command('kegbot keg status').to(:keg_status_all) }
-  it { routes_command('kegbot keg status 1').to(:keg_status_id) }
-
-  it { routes_command('kb drink list').to(:drink_list) }
-  it { routes_command('kb drink list 10').to(:drink_list) }
-  it { routes_command('kb tap status').to(:tap_status_all) }
-  it { routes_command('kb tap status 1').to(:tap_status_id) }
-  it { routes_command('kb keg status').to(:keg_status_all) }
-  it { routes_command('kb keg status 1').to(:keg_status_id) }
+  %w(kegbot kb).each do |name|
+    it do
+      is_expected.to route_command("#{name} drink list").to(:drink_list)
+      is_expected.to route_command("#{name} drink list 10").to(:drink_list)
+      is_expected.to route_command("#{name} tap status").to(:tap_status_all)
+      is_expected.to route_command("#{name} tap status 1").to(:tap_status_id)
+      is_expected.to route_command("#{name} keg status").to(:keg_status_all)
+      is_expected.to route_command("#{name} keg status 1").to(:keg_status_id)
+    end
+  end
 
   def grab_request(method, status, body)
     response = double('Faraday::Response', status: status, body: body)
@@ -53,27 +50,6 @@ describe Lita::Handlers::Kegbot, lita_handler: true do
       receive(method.to_sym).and_return(response)
   end
 
-  describe 'without valid config' do
-    before do
-      Lita.config.handlers.kegbot.api_key = nil
-      Lita.config.handlers.kegbot.api_url = nil
-    end
-
-    describe '.default_config' do
-      it 'sets api_key to nil' do
-        expect(Lita.config.handlers.kegbot.api_key).to be_nil
-      end
-
-      it 'sets api_url to nil' do
-        expect(Lita.config.handlers.kegbot.api_url).to be_nil
-      end
-    end
-
-    it 'should error out on any command' do
-      expect { send_command('kb tap status') }.to raise_error('Missing config')
-    end
-  end
-
   before do
     Lita.config.handlers.kegbot.api_key = 'foo'
     Lita.config.handlers.kegbot.api_url = 'https://example.com'

data/spec/spec_helper.rb

@@ -8,3 +8,5 @@ SimpleCov.start { add_filter '/spec/' }
 
 require 'lita-kegbot'
 require 'lita/rspec'
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-kegbot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Kegbot handler for Lita.io
+description: A Kegbot plugin for Lita
 email:
 - me@esigler.com
 executables: []
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -162,7 +163,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A Kegbot handler for Lita.io
+summary: A Kegbot plugin for Lita
 test_files:
 - spec/files/drinks.json
 - spec/files/drinks_empty.json