lita-github 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bfd623a40a5a5b1c9fbc462dc72f0b286a43dfd
-  data.tar.gz: 84b1958cb141a7295fb744de2ee3d3e6dd2dc798
+  metadata.gz: 0349ebd1948d263860af6b90c1a24447a6408aea
+  data.tar.gz: a4e1279c91922ce93c18519701a91dca1f2ce76e
 SHA512:
-  metadata.gz: a82a4d278f7c38781903bd5d9547ed5e784532e96d3243cbc0c066c48f71ed2360044f275b3dd3e4725ae3a68f651ffa1161a9658ba1bbe560fc05b8215fefb6
-  data.tar.gz: 1f454fe23289fa3c0763fa4e889bb09767c80ee6b9203bbdad83810de3fd5fe279b7ce8885df1e3548bfe4a1861606bf1edd9f62a58f0162ee88e4ce2fbec11e
+  metadata.gz: 19e4723298203e74eb221818523164fa6e54d7e2c4d92bbf6474c1f7cbb8c7751c2c457f2752780957bebbd28a3c221445477140363775dedd6210b71912f504
+  data.tar.gz: 2d3b335bfa654197c4118bdd77b1d91e596e62b6701936dac401b692dab8ef5f8f79bc0c106d1c2be25d97a73cfdc938e6c603573dbfcb532763cd3dd8cb4504

data/README.md

@@ -49,6 +49,8 @@ Here is the current functionality:
   * get the version of handler
 * `!gh token`
   * generate a TOTP token if `config.handlers.github.totp_secret` is set in the config
+* `!gh whois theckman`
+  * show some information about a GitHub user
 
 ### GitHub Repository Handler
 * `!gh repo create PagerDuty/lita-github private:true team:<team_slug>`

data/lib/lita-github/version.rb

@@ -21,7 +21,7 @@
 # @author Tim Heckman <tim@pagerduty.com>
 module LitaGithub
   # lita-github version
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 
   # lita-github version split amongst different revisions
   MAJ, MIN, REV = VERSION.split('.').map(&:to_i)

data/lib/lita/handlers/github.rb

@@ -56,6 +56,15 @@ module Lita
         }
       )
 
+      route(
+        /#{LitaGithub::R::A_REG}(?:whois|user)\s+(?<username>[a-zA-Z0-9_\-]+)/,
+        :whois,
+        command: true,
+        help: {
+          'gh whois theckman' => 'show some information about that GitHub user'
+        }
+      )
+
       def self.default_config(config)
         # when setting default configuration values please remember one thing:
         # secure and safe by default
@@ -102,6 +111,48 @@ module Lita
           response.reply(t('token_generate.no_secret'))
         end
       end
+
+      def whois(response)
+        username = response.match_data['username'].strip
+
+        begin
+          user = octo.user(username)
+        rescue Octokit::NotFound
+          return response.reply(t('whois.user_not_found', username: username))
+        end
+
+        orgs = octo.organizations(username).map { |o| o[:login] }
+        reply = whois_reply(user, orgs)
+
+        response.reply(reply)
+      end
+
+      private
+
+      def key_valid?(val)
+        (val.nil? || val.empty?) ? false : true
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def whois_reply(user, orgs)
+        name = user.key?(:name) && !user[:name].nil? ? " (#{user[:name]})" : ''
+
+        reply = "#{user[:login]}#{name} :: #{user[:html_url]}\n"
+
+        reply << t('whois.location', l: user[:location]) if key_valid?(user[:location])
+        reply << t('whois.company', c: user[:company]) if key_valid?(user[:company])
+        reply << t('whois.orgs', o: orgs.join(', ')) unless orgs.empty?
+
+        reply << t('whois.id', i: user[:id])
+        key_valid?(user[:email]) ? reply << ", #{t('whois.email', e: user[:email])}\n" : reply << "\n"
+
+        reply << t('whois.account_info', user.to_h)
+        reply << t('whois.user_info', user.to_h)
+        reply
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
     end
 
     Lita.register_handler(Github)

data/locales/en.yml

@@ -9,6 +9,15 @@ en:
         token_generate:
           no_secret: "'totp_secret' has not been provided in the config, unable to generate TOTP"
           totp: "%{token}"
+        whois:
+          user_not_found: "Sorry, unable to locate the GitHub user %{username}"
+          id: "ID: %{i}"
+          orgs: "Orgs: %{o}\n"
+          email: "Email: %{e}"
+          company: "Company: %{c}\n"
+          location: "Located: %{l}\n"
+          account_info: "GitHub Admin: %{site_admin}, Repos: %{public_repos}, Gists: %{public_gists}\n"
+          user_info: "Following: %{following}, Followers: %{followers}, Created: %{created_at}"
       github_repo:
         method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         not_found: "That repo (%{org}/%{repo}) was not found"

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

@@ -19,11 +19,20 @@ require 'spec_helper'
 describe Lita::Handlers::Github, lita_handler: true do
   let(:github) { Lita::Handlers::Github.new('robot') }
 
+  # status routing
   it { routes_command('gh status').to(:status) }
   it { routes_command('github status').to(:status) }
+
+  # version routing
   it { routes_command('gh version').to(:version) }
+
+  # token routing
   it { routes_command('gh token').to(:token_generate) }
 
+  # whois routing
+  it { routes_command('gh whois theckman').to(:whois) }
+  it { routes_command('gh user theckman').to(:whois) }
+
   describe '#default_config' do
     it 'should set default team to nil' do
       expect(Lita.config.handlers.github.default_team_slug).to be_nil
@@ -74,6 +83,138 @@ describe Lita::Handlers::Github, lita_handler: true do
     end
   end
 
+  ####
+  # Helper Methods
+  ####
+  describe '.key_valid?' do
+    context 'when value is nil' do
+      it 'should be false' do
+        expect(github.send(:key_valid?, nil)).to be_falsey
+      end
+    end
+
+    context 'when value is empty String ("")' do
+      it 'should be false' do
+        expect(github.send(:key_valid?, '')).to be_falsey
+      end
+    end
+
+    context 'when value is a String' do
+      it 'should be true' do
+        expect(github.send(:key_valid?, 'something')).to be_truthy
+      end
+    end
+  end
+
+  describe '.whois_reply' do
+    before do
+      @user_obj = {
+        name: 'Tim Heckman',
+        login: 'theckman',
+        location: 'San Francisco, CA',
+        company: 'PagerDuty, Inc.',
+        id: 787_332,
+        email: 'tim@pagerduty.com',
+        html_url: 'https://github.com/theckman',
+        site_admin: false,
+        public_repos: 42,
+        public_gists: 1,
+        following: 20,
+        followers: 10,
+        created_at: Time.parse('2011-05-14 04:16:33 UTC')
+      }
+      @orgs = %w(PagerDuty GrapeDuty)
+    end
+
+    context 'when all fields are there' do
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman (Tim Heckman) :: https://github.com/theckman
+Located: San Francisco, CA
+Company: PagerDuty, Inc.
+Orgs: PagerDuty, GrapeDuty
+ID: 787332, Email: tim@pagerduty.com
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+
+    context 'when name is unset' do
+      before { @user_obj.delete(:name) }
+
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman :: https://github.com/theckman
+Located: San Francisco, CA
+Company: PagerDuty, Inc.
+Orgs: PagerDuty, GrapeDuty
+ID: 787332, Email: tim@pagerduty.com
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+
+    context 'when location is unset' do
+      before { @user_obj.delete(:location) }
+
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman (Tim Heckman) :: https://github.com/theckman
+Company: PagerDuty, Inc.
+Orgs: PagerDuty, GrapeDuty
+ID: 787332, Email: tim@pagerduty.com
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+
+    context 'when company is unset' do
+      before { @user_obj.delete(:company) }
+
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman (Tim Heckman) :: https://github.com/theckman
+Located: San Francisco, CA
+Orgs: PagerDuty, GrapeDuty
+ID: 787332, Email: tim@pagerduty.com
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+
+    context 'when orgs is empty' do
+      before { @orgs.clear }
+
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman (Tim Heckman) :: https://github.com/theckman
+Located: San Francisco, CA
+Company: PagerDuty, Inc.
+ID: 787332, Email: tim@pagerduty.com
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+
+    context 'when email is empty string' do
+      before { @user_obj[:email] = '' }
+
+      it 'should reply with the proper response' do
+        r = github.send(:whois_reply, @user_obj, @orgs)
+        expect(r).to eql 'theckman (Tim Heckman) :: https://github.com/theckman
+Located: San Francisco, CA
+Company: PagerDuty, Inc.
+Orgs: PagerDuty, GrapeDuty
+ID: 787332
+GitHub Admin: false, Repos: 42, Gists: 1
+Following: 20, Followers: 10, Created: 2011-05-14 04:16:33 UTC'
+      end
+    end
+  end
+
+  ####
+  # Handlers
+  ####
   describe '.status' do
     context 'when GitHub status is good' do
       before do
@@ -171,4 +312,47 @@ describe Lita::Handlers::Github, lita_handler: true do
       end
     end
   end
+
+  describe '.whois' do
+    before do
+      @user_obj = {
+        name: 'Tim Heckman',
+        login: 'theckman',
+        location: 'San Francisco, CA',
+        company: 'PagerDuty, Inc.',
+        id: 787_332,
+        email: 'tim@pagerduty.com',
+        html_url: 'https://github.com/theckman',
+        site_admin: false,
+        public_repos: 42,
+        public_gists: 1,
+        following: 20,
+        followers: 10,
+        created_at: Time.parse('2011-05-14 04:16:33 UTC')
+      }
+      @orgs = [{ login: 'PagerDuty' }, { login: 'GrapeDuty' }]
+      @octo_obj = double('Octokit::Client', user: @user_obj, organizations: @orgs)
+      allow(github).to receive(:octo).and_return(@octo_obj)
+      allow(github).to receive(:whois_reply).and_return('StubbedResponse')
+    end
+
+    context 'when all goes well' do
+      it 'should return the response from whois_reply' do
+        expect(@octo_obj).to receive(:user).with('theckman').and_return(@user_obj)
+        expect(@octo_obj).to receive(:organizations).with('theckman').and_return(@orgs)
+        expect(github).to receive(:whois_reply).with(@user_obj, %w(PagerDuty GrapeDuty)).and_return('StubbedResponse')
+        send_command('gh whois theckman')
+        expect(replies.last).to eql 'StubbedResponse'
+      end
+    end
+
+    context 'when user can not be found' do
+      before { allow(@octo_obj).to receive(:user).with('theckman').and_raise(Octokit::NotFound.new) }
+
+      it 'should return the response from whois_reply' do
+        send_command('gh whois theckman')
+        expect(replies.last).to eql 'Sorry, unable to locate the GitHub user theckman'
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-github
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Tim Heckman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler