lita-github 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc46959df4d539d8ae57127dc70528eb0f8c693
-  data.tar.gz: d1a064ef57e8a8dd86e72cb4336b93f221ced29a
+  metadata.gz: 84ebbc2e578a216a3e4e15fa00011549924cb610
+  data.tar.gz: 700ad40378f13ab0d10b1775a361ccbca3aca5a1
 SHA512:
-  metadata.gz: 3e9d24e71ecc36a25262e459c924c60ed4f0c2667a0008a6122fe2fbde1ea23628c91620280677f28dadc2b48685ff43365ac247774b7d06a627dad867d10300
-  data.tar.gz: 0368bb271581c4aa7939a423c1cd16e62d6ec795d2f1df84701aed8bc7bc5c6e33bde356bb74f3d9d13e7e2f491fffd1b05f04d9b0ed2c23e864fac456919289
+  metadata.gz: 9b7c3e7b9a3db900ad5033f72d44078935c1e11265764e3be9ead51ba9f1d2422a7100416c0897af2ac0c1b3127b7a8d9f20ef89be7ee563027dbdf3a7f8103f
+  data.tar.gz: af6d62477813175ea4abc97117f4169ff4cd1f64da4028ab129e961fd023745ef38a8f4dcd6279623870cad641cf605832b3b63229b8424042e47f918bf2290e

data/README.md

@@ -1,9 +1,9 @@
 lita-github
 ===========
 [![Build Status](https://img.shields.io/travis/PagerDuty/lita-github/master.svg)](https://travis-ci.org/PagerDuty/lita-github)
-[![MIT License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
-[![RubyGems :: lita-github Gem Version](http://img.shields.io/gem/v/lita-github.svg)](https://rubygems.org/gems/lita-github)
 [![Code Climate Coverage](http://img.shields.io/codeclimate/coverage/github/PagerDuty/lita-github.svg)](https://codeclimate.com/github/PagerDuty/lita-github)
+[![RubyGems :: lita-github Gem Version](http://img.shields.io/gem/v/lita-github.svg)](https://rubygems.org/gems/lita-github)
+[![MIT License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
 
 Copyright 2014 PagerDuty, Inc.
 
@@ -46,6 +46,8 @@ Here is the current functionality:
   * get the current system status for GitHub
 * `!gh version`
   * get the version of handler
+* `!gh token`
+  * generate a TOTP token if `config.handlers.github.totp_secret` is set in the config
 
 ### GitHub Repository Handler
 * `!gh repo create PagerDuty/lita-github private:true team:<team_slug>`

data/lib/lita-github/octo.rb

@@ -27,6 +27,7 @@ module LitaGithub
     # set up the Octokit client
     def setup_octo(_)
       @@octo ||= Octokit::Client.new(access_token: access_token)
+      @@octo.auto_paginate = true
     end
 
     # object access method for Octokit client

data/lib/lita-github/version.rb

@@ -16,6 +16,6 @@
 
 # Administer your Hub of Gits with Lita!
 module LitaGithub
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
   MAJ, MIN, REV = VERSION.split('.').map(&:to_i)
 end

data/lib/lita/handlers/github.rb

@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'rotp'
 require 'lita-github/version'
 require 'lita-github/r'
 require 'lita-github/config'
@@ -47,6 +48,14 @@ module Lita
         }
       )
 
+      route(
+        /#{LitaGithub::R::A_REG}(?:token|2fa|tfa)/, :token_generate,
+        command: true,
+        help: {
+          'gh token' => 'generate a Time-based One-Time Password (TOTP) using provided secret'
+        }
+      )
+
       def self.default_config(config)
         # when setting default configuration values please remember one thing:
         # secure and safe by default
@@ -56,6 +65,9 @@ module Lita
         # Method Filters
         ####
 
+        # Lita::Handlers::Github
+        config.totp_secret = nil
+
         # Lita::Handlers::GithubRepo
         config.repo_create_enabled = true
         config.repo_delete_enabled = false
@@ -69,6 +81,14 @@ module Lita
         response.reply(t("status.#{status[:status]}", status))
       end
 
+      def token_generate(response)
+        if config.totp_secret.is_a?(String)
+          response.reply(t('token_generate.totp', token: ROTP::TOTP.new(config.totp_secret).now))
+        else
+          response.reply(t('token_generate.no_secret'))
+        end
+      end
+
       def gh_version(response)
         response.reply("lita-github v#{LitaGithub::VERSION}")
       end

data/lita-github.gemspec

@@ -44,5 +44,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'lita', '~> 3.3'
   s.add_runtime_dependency 'octokit', '~> 3.3'
+  s.add_runtime_dependency 'rotp', '~> 2.0'
   s.add_runtime_dependency 'lita-confirmation'
 end

data/locales/en.yml

@@ -6,6 +6,9 @@ en:
           good: "GitHub is reporting that all systems are green!"
           minor: "GitHub is reporting minor issues (status:yellow)! Last message:\n%{created_on} :: %{body}"
           major: "GitHub is reporting major issues (status:red)! Last message:\n%{created_on} :: %{body}"
+        token_generate:
+          no_secret: "'totp_secret' has not been provided in the config, unable to generate TOTP"
+          totp: "%{token}"
       github_repo:
         method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         repo_create:

data/spec/unit/lita-github/octo_spec.rb

@@ -16,14 +16,22 @@
 
 require 'spec_helper'
 
+# Dummy class for mocking Octokit::Client
+class DoubleFixer
+  class << self
+    attr_accessor :auto_paginate
+  end
+end
+
 # Dummy class for testing some mixin
 class DummyClass
   include LitaGithub::Octo
+  extend LitaGithub::Octo
 end
 
 describe LitaGithub::Octo do
   before do
-    allow(Octokit::Client).to receive(:new).with(access_token: 'abc123').and_return(:ohai)
+    allow(Octokit::Client).to receive(:new).with(access_token: 'abc123').and_return(DoubleFixer)
     @conf_obj = double('Lita::Config', access_token: 'abc123')
     allow(self).to receive(:config).and_return(@conf_obj)
     allow_any_instance_of(DummyClass).to receive(:config).and_return(@conf_obj)
@@ -41,13 +49,19 @@ describe LitaGithub::Octo do
 
   describe '.setup_octo' do
     it 'should set up the Octokit client instance' do
-      expect(DummyClass.class_variable_get(:@@octo)).to eql :ohai
+      x = DummyClass.class_variable_get(:@@octo)
+      expect(x).to eql DoubleFixer
+    end
+
+    it 'should turn on auto pagination' do
+      expect(DoubleFixer).to receive(:auto_paginate=).with(true)
+      DummyClass.setup_octo(nil)
     end
   end
 
   describe '.octo' do
     it 'should return the @@octo instance variable' do
-      expect(@dummy.octo).to eql :ohai
+      expect(@dummy.octo).to eql DoubleFixer
     end
   end
 end

data/spec/unit/lita/handlers/github_spec.rb

@@ -17,11 +17,12 @@
 require 'spec_helper'
 
 describe Lita::Handlers::Github, lita_handler: true do
-  let(:github) { Lita::Handlers::Forecast.new('robot') }
+  let(:github) { Lita::Handlers::Github.new('robot') }
 
   it { routes_command('gh status').to(:gh_status) }
   it { routes_command('github status').to(:gh_status) }
   it { routes_command('gh version').to(:gh_version) }
+  it { routes_command('gh token').to(:token_generate) }
 
   describe '#default_config' do
     it 'should set repos to private by default' do
@@ -109,4 +110,33 @@ describe Lita::Handlers::Github, lita_handler: true do
       expect(replies.last).to eql "lita-github v#{LitaGithub::VERSION}"
     end
   end
+
+  describe '.token_generate' do
+    before do
+      @secret = 'GZSDEMLDMY3TQYLG'
+      conf_obj = double('Lita::Configuration', totp_secret: @secret)
+      allow(github).to receive(:config).and_return(conf_obj)
+    end
+
+    context 'when token is set' do
+      it 'should return the correct totp token' do
+        t = ROTP::TOTP.new(@secret)
+        send_command('gh token')
+        expect(replies.last).to eql t.now
+      end
+    end
+
+    context 'when token is not set' do
+      before do
+        conf_obj = double('Lita::Configuration', totp_secret: nil)
+        allow(github).to receive(:config).and_return(conf_obj)
+      end
+
+      it 'should return the error message' do
+        send_command('gh token')
+        expect(replies.last)
+          .to eql "'totp_secret' has not been provided in the config, unable to generate TOTP"
+      end
+    end
+  end
 end

data/syntax_sketches.md

@@ -0,0 +1,61 @@
+Lita + GitHub syntax sketches
+=============================
+These sketches were originally made by Eric Sigler (@esigler) at PagerDuty. They are being added
+to the repo just for development purposes. This file will be removed later on.
+
+As a note, these are the results of brainstorming. They in no way indicate the final syntax, nor
+should they be treated as the end-all-be-all for how the commands should look. Follow convention
+and do what feels right.
+
+### Committers
+```
+github commiters <repo> - shows commiters of repository
+github commiters top <repo> - shows top commiters of repository
+```
+
+### Issues
+```
+github issues show <repo> - List all issues for given repo
+github issues show mine - List all issues for user
+github issues show all - List all issues for all followed repos
+github issues new <repo> <issue> - List all issues for given repo
+github issues delete <issue ID> - List all issues for given repo
+```
+
+### Pull Requests
+```
+github pr <pr #> merge - Merge a pull request
+shipit <pull request>  - Add a :shipit: squirrel to a PR
+```
+
+### Merging
+```
+github merge project_name/<head> into <base> - merges the selected branches or SHA commits
+```
+
+### Repositories
+```
+github repo new
+github repo add committer
+github repo show <repo> - shows activity of repository
+```
+
+### Searches
+```
+github search <query> [repo] - Search for <query> in [repo] or anywhere
+```
+
+### Github site status
+```
+github status - Returns the current system status and timestamp
+github status last - Returns the last human communication, status, and timestamp
+github status messages - Returns the most recent human communications with status and timestamp
+github status stalk [seconds] - Returns the last human communication, status, and timestamp, watches [seconds, default 60] for updates, and posts if it changes
+```
+
+### Misc.
+```
+github identify <email address>
+github whoami
+github forget
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-github
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tim Heckman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: lita-confirmation
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +195,7 @@ files:
 - spec/unit/lita/handlers/github_pr_spec.rb
 - spec/unit/lita/handlers/github_repo_spec.rb
 - spec/unit/lita/handlers/github_spec.rb
+- syntax_sketches.md
 homepage: https://github.com/PagerDuty/lita-github
 licenses:
 - Apache 2.0