lita-github 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1cecdbe3d83a2b89867c6936613fca780591b2b
-  data.tar.gz: 08048f199dbf53215c03947363b2615617d24d71
+  metadata.gz: 4fb70c20f1df1ecc8a2bbab4f0d15ca99e654c88
+  data.tar.gz: 4dce6a2923469c0a456f5b47ad76867ce66b94b6
 SHA512:
-  metadata.gz: 3877f91890ca3df7238f1b01ca13361ff19314d9260f36419cae8bef99104cb556d40fb1494dea0f4417bad311e98c6ef2311a8e00262c0baf676ac84bc9cdf1
-  data.tar.gz: e29da4072f9cbca52aca950d30309700edf9686e41a6f0b87a652ea67ed8c50913dd39833b1c427d04f5abcda7fe0e911cf0507cb46a20fb7b0b1f31e79bf02f
+  metadata.gz: 22855d06a6172229a3e1f1a2edd5bf8a15521e3f317b53d1efb6b65254ff3e29c9be97e86752f04696f648796aa6007075097dc98c54f689302e11e761583eea
+  data.tar.gz: 13929d9be901a4ad208d3cdbaf1ea5a032595264760d321c48ef96a107a1549ff9fd94e5220acc7f18c43fc25f112a66a575177c4d4d0bcc94cc6492876bfa15

data/.gitignore

@@ -32,3 +32,6 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# Ignore non-example lita_config.rb while developing
+lita_config.rb

data/README.md

@@ -17,6 +17,27 @@ This Gem is currently in development, and is not suited for production use. Ther
 
 In addition, the documentation will be lacking while the development is underway.
 
+Running Locally
+---------------
+### Set Up
+You'll need to have checked out this repo and `cd` into its directory.
+Then run the following commands.
+
+```
+docker-compose run --rm lita-github bundle install --jobs=5
+cp lita_config.example.rb lita_config.rb
+```
+Edit the lita_config.rb file as needed, you'll most likely need to add your own Github Access Token.
+```
+docker-compose run --rm lita-github bundle exec rake
+```
+If the above command works and everything passes then you're good to go!
+
+### Interacting with Lita on the command line
+```
+docker-compose run --rm lita-github bundle exec lita
+```
+
 Configuration
 -------------
 The configuration options will get their own in-depth doc a little further down the line. Here are the important ones for now:
@@ -31,6 +52,16 @@ The configuration options will get their own in-depth doc a little further down
   * the default teams that should be added to a repo based on the slug name:
     * When clicking on a team in your org you can use the URL to get the slug: `https://github.com/orgs/<ORG>/teams/[slug]`
 
+### Github Enterprise configuration
+To set your github enterprise hostname you have to directly [configure
+Octokit](https://github.com/octokit/octokit.rb#working-with-github-enterprise). All you have to do is add
+the following snippet to ``lita_config.rb``.
+```ruby
+Octokit.configure do |octo_config|
+  octo_config.api_endpoint = "https://<your-api-hostname>/api/v3/"
+end
+```
+
 Commands
 --------
 Use the source, Luke. We will try to keep this list up to date, but it will be inevitably deprecated by proper documentation.
@@ -53,8 +84,8 @@ Here is the current functionality:
   * show some information about a GitHub user
 
 ### GitHub Repository Handler
-* `!gh repo create PagerDuty/lita-github private:true team:<team_slug>`
-  * This creates a new repository, sets it to private, and adds the team you've specified.
+* `!gh repo create PagerDuty/lita-github private:true team:<team_slug> admin:<username>`
+  * This creates a new repository, sets it to private, adds the team you've specified, and adds the GitHub user with <username> as admin
   * This method can be disabled by setting `config.handlers.github.repo_create_enabled = false` in your configuration file
 * `!gh repo delete PagerDuty/lita-github`
   * Deletes the repo you specify, requires confirmation before doing so

data/docker-compose.yml

@@ -0,0 +1,23 @@
+---
+version: '3'
+services:
+  lita-github:
+    image: 'ruby:2.1'
+    expose:
+      - '8080'
+    volumes:
+      - '.:/usr/src/app'
+      - 'lita-github-bundle:/usr/local/bundle'
+    working_dir: '/usr/src/app'
+    environment:
+      - 'BUNDLE_PATH=/usr/local/bundle'
+      - 'RSPEC_REDIS_HOST=redis'
+    command: 'bundle exec lita'
+    depends_on:
+      - 'redis'
+  redis:
+    image: 'redis'
+    expose:
+      - '8080'
+volumes:
+  lita-github-bundle: {}

data/lib/lita-github/version.rb

@@ -21,7 +21,7 @@
 # @author Tim Heckman <tim@pagerduty.com>
 module LitaGithub
   # lita-github version
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 
   # lita-github version split amongst different revisions
   MAJOR_VERSION, MINOR_VERSION, REVISION = VERSION.split('.').map(&:to_i)

data/lib/lita/handlers/github.rb

@@ -65,39 +65,39 @@ module Lita
         }
       )
 
-      def self.default_config(config)
-        # when setting default configuration values please remember one thing:
-        # secure and safe by default
-        config.default_team_slugs         = nil
-        config.repo_private_default       = true
-        config.org_team_add_allowed_perms = %w(pull)
-
-        ####
-        # Method Filters
-        ####
-
-        # Lita::Handlers::Github
-        config.totp_secret = nil
-
-        # Lita::Handlers::GithubRepo
-        config.repo_create_enabled              = true
-        config.repo_rename_enabled              = true
-        config.repo_delete_enabled              = false
-        config.repo_team_add_enabled            = false
-        config.repo_team_rm_enabled             = false
-        config.repo_update_description_enabled  = true
-        config.repo_update_homepage_enabled     = true
-
-        # Lita::Handlers::GithubPR
-        config.pr_merge_enabled = true
-
-        # Lita::Handlers::GithubOrg
-        config.org_team_add_enabled       = false
-        config.org_team_rm_enabled        = false
-        config.org_user_add_enabled       = false
-        config.org_user_rm_enabled        = false
-        config.org_eject_user_enabled     = false
-      end
+      # when setting default configuration values please remember one thing:
+      # secure and safe by default
+      config :access_token, default: nil
+      config :default_team_slugs, default: nil
+      config :repo_private_default, default: true
+      config :org_team_add_allowed_perms, default: %w(pull)
+
+      ####
+      # Method Filters
+      ####
+
+      # Lita::Handlers::Github
+      config :totp_secret, default: nil
+
+      # Lita::Handlers::GithubRepo
+      config :repo_create_enabled, default: true
+      config :repo_rename_enabled, default: true
+      config :repo_delete_enabled, default: false
+      config :repo_team_add_enabled, default: false
+      config :repo_team_rm_enabled, default: false
+      config :repo_update_description_enabled, default: true
+      config :repo_update_homepage_enabled, default: true
+
+      # Lita::Handlers::GithubPR
+      config :pr_merge_enabled, default: true
+
+      # Lita::Handlers::GithubOrg
+      config :default_org, default: nil
+      config :org_team_add_enabled, default: false
+      config :org_team_rm_enabled, default: false
+      config :org_user_add_enabled, default: false
+      config :org_user_rm_enabled, default: false
+      config :org_eject_user_enabled, default: false
 
       def status(response)
         status = octo.github_status_last_message

data/lib/lita/handlers/github_repo.rb

@@ -42,10 +42,11 @@ module Lita
         :repo_create,
         command: true,
         help: {
-          'gh repo create PagerDuty/lita-github private:true team:heckman' =>
-            'Create the PagerDuty/lita-github repo, make it private, use team with "heckman" slug',
+          'gh repo create PagerDuty/lita-github private:true team:heckman admin:anon' =>
+            'Create the PagerDuty/lita-github repo, make it private,'\
+            'use team with "heckman" slug, with GitHub user "anon" as repo admin',
           'gh repo new PagerDuty/lita-github' =>
-            'create new repo using the default privacy/team settings'
+            'create new repo using the default privacy, team, admin settings'
         }
       )
 
@@ -333,6 +334,7 @@ module Lita
           opts[:other_teams].each do |team_id|
             add_team_to_repo(full_name, gh_team(org, team_id))
           end if opts.key?(:other_teams)
+          add_admin_to_repo(full_name, opts[:admin]) if opts.key?(:admin)
         ensure
           if repo?(full_name)
             repo_url = "https://github.com/#{full_name}"
@@ -401,6 +403,14 @@ module Lita
           return t('repo_team_rm.fail', repo: full_name, team: team[:name])
         end
       end
+
+      def add_admin_to_repo(full_name, user)
+        if octo.add_collaborator(full_name, user, permission: 'admin')
+          return t('repo_admin_add.pass', repo: full_name, user: user)
+        else
+          return t('repo_admin_add.fail', repo: full_name, user: user)
+        end
+      end
     end
 
     Lita.register_handler(GithubRepo)

data/lita-github.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4', '>= 0.4.0'
   s.add_development_dependency 'yard', '~> 0.8.7'
 
-  s.add_runtime_dependency 'lita', '~> 4.0'
+  s.add_runtime_dependency 'lita', '>= 4.0'
   s.add_runtime_dependency 'octokit', '~> 3.3'
   s.add_runtime_dependency 'rotp', '~> 2.0'
   s.add_runtime_dependency 'lita-confirmation'

data/lita_config.example.rb

@@ -0,0 +1,23 @@
+Lita.configure do |config|
+  config.robot.log_level = :debug
+  config.robot.alias     = '!'
+  config.redis[:host]    = 'redis'
+
+  # For Github/octokit use
+  config.handlers.github.access_token                    = '<GITHUB ACCESS TOKEN>'
+  config.handlers.github.default_org                     = '<ORGANIZATION NAME>'
+  config.handlers.github.default_team_slugs              = %w(<TEAM1> <TEAM2> <ETC>) 
+  config.handlers.github.repo_create_enabled             = true
+  config.handlers.github.repo_delete_enabled             = true
+  config.handlers.github.repo_private_default            = true
+  config.handlers.github.org_team_add_allowed_perms      = %w(pull push)
+  config.handlers.github.repo_create_enabled             = true
+  config.handlers.github.repo_delete_enabled             = true
+  config.handlers.github.pr_merge_enabled                = true
+  config.handlers.github.repo_team_add_enabled           = true
+  config.handlers.github.repo_team_rm_enabled            = true
+  config.handlers.github.repo_update_description_enabled = true
+  config.handlers.github.repo_update_homepage_enabled    = true
+  config.handlers.github.org_team_add_enabled            = true
+  config.handlers.github.org_team_rm_enabled             = true
+end

data/locales/en.yml

@@ -53,6 +53,9 @@ en:
           updated: "The homepage for %{repo} has been updated to: '%{url}'"
           invalid_url: "The URL provided is not valid: '%{url}'"
           boom: "An uncaught exception was hit while trying to update the homepage of %{repo}. Is GitHub having issues?"
+        repo_admin_add:
+          pass: "Added user '%{user}' as admin to %{repo}"
+          fail: "Something went wrong trying to add user '%{user}' as admin to %{repo}. Is that user in your organization?"
       github_pr:
         method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         exception: "An unexpected exception was hit during the GitHub API operation. Please make sure all arguments are proper and try again, or try checking the GitHub status (gh status)"

data/spec/spec_helper.rb

@@ -18,6 +18,16 @@ require 'rspec'
 require 'lita/rspec'
 require 'codeclimate-test-reporter'
 
+RSpec.configure do |config|
+  config.before do
+    if ENV['RSPEC_REDIS_HOST']
+      Lita.configure do |c|
+        c.redis[:host] = ENV['RSPEC_REDIS_HOST']
+      end
+    end
+  end
+end
+
 Lita.version_3_compatibility_mode = false
 
 CodeClimate::TestReporter.start

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

@@ -27,7 +27,7 @@ describe Lita::Handlers::GithubIssues, lita_handler: true do
 
   let(:gh_org) { 'GapeDuty' }
   let(:gh_repo) { 'lita-test' }
-  let(:github_issues) { Lita::Handlers::GithubIssues.new('robot') }
+  let(:github_issues) { Lita::Handlers::GithubIssues.new(robot) }
 
   describe '.validate_list_opts' do
     let(:good_opts) { { state: 'open', sort: 'updated', direction: 'asc' } }

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

@@ -51,7 +51,7 @@ describe Lita::Handlers::GithubOrg, lita_handler: true do
   it { is_expected.to route_command('gh org eject GrapeDuty theckman').to(:org_eject_user) }
   it { is_expected.to route_command('gh org eject theckman').to(:org_eject_user) }
 
-  let(:github_org) { Lita::Handlers::GithubOrg.new('robot') }
+  let(:github_org) { Lita::Handlers::GithubOrg.new(robot) }
   let(:disabled_err) { 'Sorry, this function has either been disabled or not enabled in the config' }
 
   ####

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

@@ -33,7 +33,7 @@ describe Lita::Handlers::GithubPR, lita_handler: true do
   it { is_expected.to route_command('gh pr list GrapeDuty/lita-test').to(:pr_list) }
   it { is_expected.to route_command('gh pr list lita-test').to(:pr_list) }
 
-  let(:github_pr) { Lita::Handlers::GithubPR.new('robot') }
+  let(:github_pr) { Lita::Handlers::GithubPR.new(robot) }
   let(:github_org) { 'GrapeDuty' }
   let(:github_repo) { 'lita-test' }
   let(:full_name) { "#{github_org}/#{github_repo}" }

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

@@ -22,6 +22,7 @@ describe Lita::Handlers::GithubRepo, lita_handler: true do
   it { is_expected.to route_command('gh repo new GrapeDuty/lita-test').to(:repo_create) }
   it { is_expected.to route_command('gh repo new lita-test').to(:repo_create) }
   it { is_expected.to route_command('gh repo new GrapeDuty/lita-test private:true team:heckman').to(:repo_create) }
+  it { is_expected.to route_command('gh repo new GrapeDuty/lita-test private:true team:heckman admin:anon').to(:repo_create) }
   it { is_expected.to route_command('gh repo new GrapeDuty/lita-test private:true randomunparseabletext ').to(:repo_create) }
 
   # repo_rename command routing
@@ -76,7 +77,7 @@ describe Lita::Handlers::GithubRepo, lita_handler: true do
   it { is_expected.to route_command('gh repo update description GrapeDuty/lita-test Some description here').to(:repo_update_router) }
   it { is_expected.to route_command('gh repo update description lita-test Some description here').to(:repo_update_router) }
 
-  let(:github_repo) { Lita::Handlers::GithubRepo.new('robot') }
+  let(:github_repo) { Lita::Handlers::GithubRepo.new(robot) }
   let(:github_org) { 'GrapeDuty' }
   let(:disabled_reply) { 'Sorry, this function has either been disabled or not enabled in the config' }
 
@@ -361,6 +362,15 @@ describe Lita::Handlers::GithubRepo, lita_handler: true do
             .to eql 'Created GrapeDuty/lita-test: https://github.com/GrapeDuty/lita-test'
         end
       end
+
+      context 'when an admin user is given' do
+        it 'should add an admin to the repo after creating it' do
+          expect(github_repo).to receive(:add_admin_to_repo).with('GrapeDuty/lita-test', 'anon')
+          opts = { private: true, team_id: 1, organization: github_org, admin: 'anon'}
+          expect(github_repo.send(:create_repo, github_org, 'lita-test', opts))
+            .to eql 'Created GrapeDuty/lita-test: https://github.com/GrapeDuty/lita-test'
+        end
+      end
     end
 
     context 'when repo not created' do

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

@@ -17,7 +17,7 @@
 require 'spec_helper'
 
 describe Lita::Handlers::Github, lita_handler: true do
-  let(:github) { Lita::Handlers::Github.new('robot') }
+  let(:github) { Lita::Handlers::Github.new(robot) }
 
   # status routing
   it { is_expected.to route_command('gh status').to(:status) }
@@ -33,9 +33,9 @@ describe Lita::Handlers::Github, lita_handler: true do
   it { is_expected.to route_command('gh whois theckman').to(:whois) }
   it { is_expected.to route_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
+  describe '#config' do
+    it 'should set default teams to nil' do
+      expect(Lita.config.handlers.github.default_team_slugs).to be_nil
     end
 
     it 'should set repos to private by default' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-github
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tim Heckman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,14 +138,14 @@ dependencies:
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -205,6 +205,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - lib/lita-github.rb
 - lib/lita-github/config.rb
 - lib/lita-github/filters.rb
@@ -220,6 +221,7 @@ files:
 - lib/lita/handlers/github_pr.rb
 - lib/lita/handlers/github_repo.rb
 - lita-github.gemspec
+- lita_config.example.rb
 - locales/en.yml
 - spec/spec_helper.rb
 - spec/unit/lita-github/config_spec.rb
@@ -257,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: GitHub repo/org management in Lita; handler not ready for production