solicit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 115b96f84a7bc69ebfabf45139d2261663e73f2b0895d0ce8456a055c124f7af
+  data.tar.gz: 736dca15502cdfad1c6218d083a0567938e11cf4bdc29d02c79c413b790f5625
+SHA512:
+  metadata.gz: 0ddb5c194e2a18cb5f05b7f26817decfe1bb9f47d6d88683df6166c866e9beab6ed1919761324c41f0b63de50224bcd27c3c722d81a2346e3890484e3c208a63
+  data.tar.gz: 9f07848217775d9de5713802b436e3f310a3f32348f2469645a4438c6d415bc1e20539868105b70ac8ad748f063e87b8aae81570736a3452ee8aba8bcbb7bd04

data/README.md

@@ -0,0 +1,35 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solicit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solicit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/solicit.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/controllers/solicit/pull_requests_controller.rb

@@ -0,0 +1,68 @@
+module Solicit
+  class PullRequestsController < ActionController::Base
+    before_action :ensure_can_claim,  only: :claim
+    before_action :ensure_can_notify, only: :notify
+
+    def claim
+      render json: ClaimPullRequest.perform(
+        url:      payload[:callback_id],
+        label:    payload.dig(:actions, 0, :value),
+        assignee: Solicit.contributors_map[payload.dig(:user, :name)],
+        original: payload[:original_message]
+      )
+    end
+
+    def notify
+      PostToSlack.perform(
+        url:      Solicit.slack_webhook_url,
+        channel:  Solicit.labels_map[payload.dig(:label, :name).to_sym],
+        username: Solicit.slack_username,
+        payload:  payload
+      )
+      head :ok
+    end
+
+    private
+
+    def ensure_can_claim
+      head :ok unless request_is_from_slack? &&
+                      payload.dig(:user, :name) &&
+                      Solicit.contributors_map.key?(payload.dig(:user, :name)) &&
+                      payload[:callback_id] &&
+                      payload[:original_message] &&
+                      payload.dig(:actions, 0, :value)
+    end
+
+    def ensure_can_notify
+      head :ok unless request_is_from_github? &&
+                      payload[:action] == 'labeled' &&
+                      Solicit.labels_map.key?(payload.dig(:label, :name).to_sym) &&
+                      payload.dig(:pull_request, :number) &&
+                      payload.dig(:repository, :url)
+    end
+
+    def request_is_from_slack?
+      return true unless Solicit.slack_secret
+      signature = 'v0=' + OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest::SHA256.new,
+        Solicit.slack_secret,
+        ['v0', request.headers['X-Slack-Request-Timestamp'], request.body.read].join(':')
+      )
+      Rack::Utils.secure_compare(signature, request.headers['X-Slack-Signature'])
+    end
+
+    def request_is_from_github?
+      return true unless Solicit.github_secret
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha1'),
+        Solicit.github_secret,
+        request.body.read
+      )
+      Rack::Utils.secure_compare(signature, request.headers['HTTP_X_HUB_SIGNATURE'])
+    end
+
+    def payload
+      @payload ||= JSON.parse(params.require(:payload)).with_indifferent_access
+    end
+  end
+end

data/app/use_cases/solicit/claim_pull_request.rb

@@ -0,0 +1,45 @@
+module Solicit
+  class ClaimPullRequest
+
+    def initialize(url:, label:, assignee:, original:)
+      @url      = url
+      @label    = label
+      @assignee = assignee
+      @original = original
+    end
+
+    def self.perform(*args)
+      new(*args).perform
+    end
+
+    def perform
+      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 }
+      @original
+    end
+
+    private
+
+    def claim_pull_request
+      return unless @assignee['handle'].presence
+      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)
+    end
+
+    def claim_message
+      I18n.t :"engines.solicit.volunteer",
+        name: @assignee.fetch('name', 'Someone'),
+        emoji: @assignee.fetch('emoji', 'star2')
+    end
+
+    def default_github_params
+      { query: { access_token: Solicit.github_api_token } }
+    end
+  end
+end

data/app/use_cases/solicit/post_to_slack.rb

@@ -0,0 +1,41 @@
+module Solicit
+  class PostToSlack
+
+    def initialize(url:, channel:, username:, payload:)
+      @url      = url
+      @channel  = channel
+      @username = username
+      @payload  = payload
+    end
+
+    def self.perform(*args)
+      new(*args).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)
+        ),
+        attachments: [{
+          title: I18n.t(:"engines.solicit.review"),
+          callback_id: [
+            @payload.dig(:repository, :url),
+            'issues',
+            @payload.dig(:pull_request, :number),
+            'assignees',
+          ].join('/'),
+          color: :warning,
+          actions: [{
+            name: :claim,
+            text: I18n.t(:"engines.solicit.claim"),
+            type: :button,
+            value: @payload.dig(:label, :name),
+          }],
+        }]
+      )
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  engines:
+    solicit:
+      volunteer: "%{name} has volunteered! :%{emoji}:"
+      claim:     "I'll do it!"
+      review:    "Review this PR"
+      title:     "PR <%{link}|%{title}> now has a %{label} label!"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Solicit::Engine.routes.draw do
+  resources :pull_requests, only: [] do
+    post :claim,  on: :collection
+    post :notify, on: :collection
+  end
+end

data/lib/solicit/version.rb

@@ -0,0 +1,3 @@
+module Solicit
+  VERSION = "0.1.0"
+end

data/lib/solicit.rb

@@ -0,0 +1,26 @@
+require "solicit/version"
+
+module Solicit
+  class << self
+    mattr_accessor :labels_map,
+                   :contributors_map,
+                   :slack_webhook_url,
+                   :slack_username,
+                   :slack_secret,
+                   :github_api_token,
+                   :github_secret,
+                   :needs_more_assignees
+
+    # 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 }
+  end
+
+  class Engine < ::Rails::Engine
+    isolate_namespace Solicit
+
+    config.before_initialize do
+      config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: solicit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Optimal Workshop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.1
+- !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: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/solicit/pull_requests_controller.rb
+- app/use_cases/solicit/claim_pull_request.rb
+- app/use_cases/solicit/post_to_slack.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/solicit.rb
+- lib/solicit/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Solicit reviewers for your github pull requests on Slack
+test_files: []