solicit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115b96f84a7bc69ebfabf45139d2261663e73f2b0895d0ce8456a055c124f7af
-  data.tar.gz: 736dca15502cdfad1c6218d083a0567938e11cf4bdc29d02c79c413b790f5625
+  metadata.gz: 239ba565f4a101f8d7e705663bba9e001c614854c40c24c4ed7ff9bf9da05896
+  data.tar.gz: 58a72e1639c8a440dedc7eed64d3bdf247017389505bf22992a26ddf1aefbe45
 SHA512:
-  metadata.gz: 0ddb5c194e2a18cb5f05b7f26817decfe1bb9f47d6d88683df6166c866e9beab6ed1919761324c41f0b63de50224bcd27c3c722d81a2346e3890484e3c208a63
-  data.tar.gz: 9f07848217775d9de5713802b436e3f310a3f32348f2469645a4438c6d415bc1e20539868105b70ac8ad748f063e87b8aae81570736a3452ee8aba8bcbb7bd04
+  metadata.gz: 9f87726122bfcf127d144098f10bf5a3e617dd03ce242eefa375bc9ca6ec19b2c40c995e90ff654db5a26f4ff52b18c60ad9bf78a547fe1f7fec367c3e4140a2
+  data.tar.gz: bc47411a5692d44c2c0f1f0eeb8549c548258383773664dac274488d4547532700f3594c0d57543b9175b4962ab7752463ab89d2c635add48538986daa833ddd

data/README.md

@@ -1,35 +1,118 @@
 # Solicit
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/solicit`. To experiment with that code, run `bin/console` for an interactive prompt.
+Solicit requests reviewers from your slack channel automatically!
 
-TODO: Delete this and the text above, and describe your gem
+It works by listening for labels on your repo(s) from the github api,
+and posting a message into a specified slack channel which allows people
+to assign themselves to the pull request.
+
+This was developed at the third annual Optimal Workshop hackathon.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Add an outgoing webhook to your github repository, with the 'pull requests' event type enabled
+
+![](/images/step1.png)
+_NB: the 'Secret' value here will become your github_secret value_
 
+2. [Create a slack app] for your team
+![](/images/step2.png)
+_NB: note your 'Webhook URL' and 'Verification token' here to use as 'slack_webhook_url and slack_secret later_
+
+3. Configure the gem on your app
 ```ruby
+# Gemfile
 gem 'solicit'
 ```
+```ruby
+# routes.rb
+mount Solicit::Engine, at: '/solicit'
+```
+```ruby
+# app/initializers/solicit.rb
+
+# required
+Solicit.slack_webhook_url = "<your webhook url>"
+Solicit.github_api_token = "<your api token>"
+Solicit.contributors_map = {
+  timmy: { handle: "TimmyTeaco", name: "Timmy", emoji: "dolphin" }
+  jimmy: { handle: "JimmyBoy", name: "Jimmy", emoji: "whale" }
+}
+
+# optional
+Solicit.labels_map = { "review me": "#reviewers" } # default is { "go" => "#general" }
+Solicit.slack_username = "ReviewBot"
+Solicit.slack_secret = "<your slack secret>"
+Solicit.github_secret = "<your github secret>"
+Solicit.needs_more_assignees = proc do |github_response, label|
+  label == "swarm"
+end
+```
+
+More info on each option is below:
+
+##### slack_webhook_url (required)
+
+The url of the webhook provided by your slack app
+
+https://api.slack.com/incoming-webhooks
+
+##### github_api_token (required)
+
+A personal API token with access to your github repo.
 
-And then execute:
+https://github.blog/2013-05-16-personal-api-tokens/
 
-    $ bundle
+##### contributors_map (required)
 
-Or install it yourself as:
+A hash which maps slack usernames to github usernames.
+You can optionally provide a custom emoji which will appear when this
+person claims a PR.
 
-    $ gem install solicit
+##### labels_map (optional)
 
-## Usage
+A hash which maps github label names to the slack channel in which they should appear. By default, any PR that has the 'go' label placed on it will notify the #general channel.
 
-TODO: Write usage instructions here
+##### slack_username (optional)
+
+The username which should appear as the message sender. By default, the bot is named 'Solicit'
+
+##### slack_secret (optional)
+
+A signing token from slack to secure requests to your app.
+You can read more about setting up secure slack webhooks here:
+
+https://api.slack.com/docs/verifying-requests-from-slack
+
+##### github_secret (optional)
+
+A signing token from github to secure requests to your app.
+You can read more about setting up secure github webhooks here:
+
+https://developer.github.com/webhooks/securing/
+
+##### needs_more_assignees (optional)
+
+Some organizations may have rules around how many assignees should be
+put on a given PR. If so, you can define a method which returns whether
+a PR should continue to accept reviewers.
+(TODO explain this better)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Installation
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+#### Running tests
+
+To run the test suite, run
+```bash
+rake test
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/solicit.
+Bug reports and pull requests are welcome on GitHub at https://github.com/optimalworkshop/solicit.
+Please note that this project is released with a [Contributor Code of Conduct](CONTRIBUTORS.md). By participating in this project you agree to abide by its terms.

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'rake/testtask'
+
+desc "Run tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/app/controllers/solicit/pull_requests_controller.rb

@@ -5,8 +5,8 @@ module Solicit
 
     def claim
       render json: ClaimPullRequest.perform(
-        url:      payload[:callback_id],
-        label:    payload.dig(:actions, 0, :value),
+        url: payload[:callback_id],
+        label: payload.dig(:actions, 0, :value),
         assignee: Solicit.contributors_map[payload.dig(:user, :name)],
         original: payload[:original_message]
       )
@@ -14,10 +14,10 @@ module Solicit
 
     def notify
       PostToSlack.perform(
-        url:      Solicit.slack_webhook_url,
-        channel:  Solicit.labels_map[payload.dig(:label, :name).to_sym],
+        url: Solicit.slack_webhook_url,
+        channel: Solicit.labels_map[payload.dig(:label, :name).to_sym],
         username: Solicit.slack_username,
-        payload:  payload
+        payload: payload
       )
       head :ok
     end
@@ -43,6 +43,7 @@ module Solicit
 
     def request_is_from_slack?
       return true unless Solicit.slack_secret
+
       signature = 'v0=' + OpenSSL::HMAC.hexdigest(
         OpenSSL::Digest::SHA256.new,
         Solicit.slack_secret,
@@ -53,6 +54,7 @@ module Solicit
 
     def request_is_from_github?
       return true unless Solicit.github_secret
+
       signature = 'sha1=' + OpenSSL::HMAC.hexdigest(
         OpenSSL::Digest.new('sha1'),
         Solicit.github_secret,

data/app/use_cases/solicit/claim_pull_request.rb

@@ -1,6 +1,5 @@
 module Solicit
   class ClaimPullRequest
-
     def initialize(url:, label:, assignee:, original:)
       @url      = url
       @label    = label
@@ -13,7 +12,7 @@ module Solicit
     end
 
     def perform
-      return unless claim_pull_request.success?
+      return unless claim_pull_request&.success?
 
       @original[:attachments].reject! { |a| a[:callback_id] == @url } unless needs_more_assignees?
       @original[:attachments] << { color: :good, text: claim_message }
@@ -22,20 +21,31 @@ module Solicit
 
     private
 
+    def needs_more_assignees?
+      Solicit.needs_more_assignees.call(current_assignees, @label)
+    end
+
     def claim_pull_request
       return unless @assignee['handle'].presence
-      HTTParty.post @url, default_github_params.merge(body: { assignees: Array(@assignee['handle']) }.to_json)
+
+      @claim_pull_request ||= HTTParty.post @url, default_github_params.merge(
+        body: { assignees: Array(@assignee['handle']) }.to_json
+      )
     end
 
-    def needs_more_assignees?
-      response = HTTParty.get @url.gsub('/assignees', ''), default_github_params
-      Solicit.needs_more_assignees.call(response, @label)
+    def current_assignees
+      @current_assignees ||= HTTParty.get @url.gsub('/assignees', ''), default_github_params
     end
 
     def claim_message
-      I18n.t :"engines.solicit.volunteer",
+      I18n.t :"engines.solicit.volunteer", claim_message_options
+    end
+
+    def claim_message_options
+      {
         name: @assignee.fetch('name', 'Someone'),
-        emoji: @assignee.fetch('emoji', 'star2')
+        emoji: @assignee.fetch('emoji', 'star2'),
+      }
     end
 
     def default_github_params

data/app/use_cases/solicit/post_to_slack.rb

@@ -1,41 +1,64 @@
 module Solicit
   class PostToSlack
+    attr_reader :text
 
     def initialize(url:, channel:, username:, payload:)
       @url      = url
       @channel  = channel
       @username = username
       @payload  = payload
+      @text     = I18n.t(:"engines.solicit.title", title_options)
     end
 
     def self.perform(*args)
-      new(*args).perform
+      new(*args).tap(&:perform)
     end
 
     def perform
       Slack::Notifier.new(@url, channel: @channel, username: @username).ping(
-        text: I18n.t(:"engines.solicit.title",
-          link:  @payload.dig(:pull_request, :html_url),
-          title: @payload.dig(:pull_request, :title),
-          label: @payload.dig(:label, :name)
-        ),
+        text: text,
         attachments: [{
           title: I18n.t(:"engines.solicit.review"),
-          callback_id: [
-            @payload.dig(:repository, :url),
-            'issues',
-            @payload.dig(:pull_request, :number),
-            'assignees',
-          ].join('/'),
+          callback_id: callback_id,
           color: :warning,
-          actions: [{
-            name: :claim,
-            text: I18n.t(:"engines.solicit.claim"),
-            type: :button,
-            value: @payload.dig(:label, :name),
-          }],
+          actions: Array(claim_action),
         }]
       )
     end
+
+    private
+
+    def title_options
+      {
+        author: author_name,
+        link:   @payload.dig(:pull_request, :html_url),
+        title:  @payload.dig(:pull_request, :title),
+        label:  @payload.dig(:label, :name),
+      }
+    end
+
+    def callback_id
+      [
+        @payload.dig(:repository, :url),
+        'issues',
+        @payload.dig(:pull_request, :number),
+        'assignees',
+      ].join('/')
+    end
+
+    def claim_action
+      {
+        name: :claim,
+        text: I18n.t(:"engines.solicit.claim"),
+        type: :button,
+        value: @payload.dig(:label, :name),
+      }
+    end
+
+    def author_name
+      Solicit.contributors_map.detect do |_, value|
+        value[:handle] == @payload.dig(:sender, :login)
+      end&.dig(1, 'name') || I18n.t(:"engines.solicit.someone")
+    end
   end
 end

data/config/locales/en.yml

@@ -4,4 +4,5 @@ en:
       volunteer: "%{name} has volunteered! :%{emoji}:"
       claim:     "I'll do it!"
       review:    "Review this PR"
-      title:     "PR <%{link}|%{title}> now has a %{label} label!"
+      someone:   "Someone"
+      title:     "%{author} has added a %{label} label to a PR: <%{link}|%{title}>"

data/lib/solicit/version.rb

@@ -1,3 +1,3 @@
 module Solicit
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

data/lib/solicit.rb

@@ -13,7 +13,9 @@ module Solicit
 
     # by default, always remove the "I'll do it" button;
     # the main app can define more complicated behaviour here if necessary
-    self.needs_more_assignees = Proc.new { false }
+    self.needs_more_assignees = proc { false }
+    self.labels_map           = { go: "#general" }
+    self.slack_username       = "Solicit"
   end
 
   class Engine < ::Rails::Engine

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: solicit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Optimal Workshop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -31,61 +59,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.1.6.1
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: slack-notifier
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
+        version: '0.12'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: ''
 email: 
 executables: []
@@ -101,7 +143,7 @@ files:
 - config/routes.rb
 - lib/solicit.rb
 - lib/solicit/version.rb
-homepage: 
+homepage: https://github.com/optimalworkshop/solicit
 licenses:
 - MIT
 metadata: {}
@@ -120,8 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Solicit reviewers for your github pull requests on Slack