open_github_issue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df9cf04a1ed325115b8e2e66a7ff4549e154dccd4aed589ee13d71850bea7a54
+  data.tar.gz: 6916b20e5bb1419c3de06e4d8ea48c27b42d3d5610b6a926c35221fa265af6bc
+SHA512:
+  metadata.gz: 11bd35a4e18d0a985cf02a9834938705eaf198e84c7300eba93b26c0a775c84f5f1d22e228d71f4d52e8908c4c25fdf7ad480303d72ab100b74cdf2f20d34800
+  data.tar.gz: 9d96bbff0174b0cceddb3ba9841155760b3535d47982822b53e9e84a119c1835dbe0abb727460d6ece6c74fbdd210a795b0b1b149a6c82a2e0c337eec08d4930

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Paweł J. Wal
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# OpenGithubIssue
+
+A simple mountable Rails engine to provide a secure way for users to report issues they see with the application. Useful
+in QA and UAT environments. Minimal gem with no dependencies outside of Rails and Octokit.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_github_issue'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install open_github_issue
+```
+
+This engine requires mounting, e.g.:
+
+```ruby
+# config/routes.rb
+
+mount OpenGithubIssue::Engine, on: '/ogi'
+```
+
+Include JavaScript in `app/assets/javascripts/application.js`:
+
+```javascript
+// = require 'open_github_issue'
+```
+
+Include default CSS in `app/assets/stylesheets/application.css` (or equivalent):
+
+``` css
+/*
+* = require 'open_github_issue'
+*/
+```
+
+Or, if you're using SCSS:
+
+``` scss
+@import('open_github_issue');
+```
+
+
+## Configuration
+
+Build an initializer like this one (defaults presented where available):
+
+```ruby
+OpenGithubIssue.configure do |config|
+  config.github_access_token = 'insert-token-here' # default: nil
+  config.github_repo = 'paweljw/open_github_issue' # default: nil
+  config.user_method = :current_user # default
+  config.user_name_method = :email # default
+  config.constraint = proc { |user| user } # default
+end
+```
+
+### `github_access_token`
+
+A personal access token (get one in the GitHub settings) with `repo` permissions.
+
+### `github_repo`
+
+Path to your GitHub repository (see above example).
+
+### `user_method`
+
+This is expected to exist on controllers where OpenGithubIssue is used. Passed to `constraint`. `user_name_method` is also
+called on the result of this method. It can be `nil`; nothing will be passed to constraint and user names will not be attached
+to reports. `current_user` used by default - if you're using Devise, you're all set.
+
+### `user_name_method`
+
+Attached to issue reports, transparently to the user reporting the issues. Useful for reporter identification purposes. Not
+attached to reports if set to nil. `email` by default - if your current user responds to this, you're all set.
+
+### `constraint`
+
+Called to determine whether the user should be shown the option to report issues. For example, if you want to show the form
+to all logged in users, `proc { |user| user }` will suffice, or `proc { |_| true }` if everyone should have the possibility.
+You can screen this out by role with e.g. `proc { |user| user.qa? }`. If everyone should have access, but only in e.g. staging
+environment, `proc { |_| Rails.env.staging? }` will come in handy.
+
+## Customizing
+
+This gem's behavior can be customized in several ways.
+
+### The report form
+
+The report form can be customized to fit in better with the design of your application. If you place a partial in
+`app/views/application/_open_github_issue_form.html.erb`, it will take precedence over the built-in view.
+
+### I18n
+
+Localize this gem for your application using `config/locales/open_github_issue.en.yml` as reference. This gem is currently
+localized in `:en` and `:pl` locales.
+
+### Controller behavior
+
+Define your own `OpenGithubIssue::ReportsController` using the one in `app/controllers/open_github_issue/reports_controller.rb`
+as reference to customize behavior, e.g. redirects and flashes.
+
+## TODO
+
+[ ] Proper specs
+[ ] Hook up CI (e.g. Travis CI)
+[ ] Hook up a linting service (e.g. CodeClimate)
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OpenGithubIssue'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/open_github_issue_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/ .js
+//= link_directory ../stylesheets/ .css

data/app/assets/javascripts/open_github_issue.js

@@ -0,0 +1,3 @@
+function openGithubIssueFormToggle() {
+  document.getElementById('open-github-issue-form').classList.toggle('active');
+}

data/app/assets/stylesheets/open_github_issue.css

@@ -0,0 +1,73 @@
+/*
+ *= require_self
+ */
+
+.open-github-issue-form {
+  display: none;
+  width: 30%;
+  background: #fff;
+  position: fixed;
+  bottom: 80px;
+  right: 20px;
+  padding: 10px;
+  border-radius: 5px;
+  border: 1px solid #ccc;
+  box-shadow: 0px 0px 15px #666;
+}
+
+.open-github-issue-form.active {
+  display: block;
+}
+
+.open-github-issue-header {
+  font-size: 20px;
+}
+
+.open-github-issue-form.active {
+  display: block;
+}
+
+.open-github-issue-form-group .open-github-issue-form-text-area textarea {
+  width: 100%;
+}
+
+.open-github-issue-form-group .open-github-issue-form-text-input input {
+  width: 100%;
+}
+
+.open-github-issue-form-group, .open-github-issue-form-submit {
+  padding-top: 10px;
+}
+
+.open-github-issue-show {
+  width: 50px;
+  height: 50px;
+  background: #d9534f;
+  display: block;
+  position: fixed;
+  bottom: 20px;
+  right: 20px;
+  border-radius: 25px;
+  border: 0px none;
+  box-shadow: 3px 3px 5px #666;
+  text-align: center;
+  cursor: pointer;
+}
+
+.open-github-issue-show span {
+  color: #fff;
+  font-weight: bold;
+  font-size: 25px;
+  display: block;
+  margin: 15px auto;
+}
+
+.open-github-issue-show:hover span { 
+  -webkit-animation:open-github-issue-spin 1s ease;
+  -moz-animation:open-github-issue-spin 1s ease;
+  animation:open-github-issue-spin 1s ease;
+}
+
+@-moz-keyframes open-github-issue-spin { 100% { -moz-transform: rotate(360deg); } }
+@-webkit-keyframes open-github-issue-spin { 100% { -webkit-transform: rotate(360deg); } }
+@keyframes open-github-issue-spin { 100% { -webkit-transform: rotate(360deg); transform:rotate(360deg); } }

data/app/controllers/open_github_issue/application_controller.rb

@@ -0,0 +1,5 @@
+module OpenGithubIssue
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/open_github_issue/reports_controller.rb

@@ -0,0 +1,19 @@
+module OpenGithubIssue
+  class ReportsController < ApplicationController
+    def report
+      if Constraint.call(self) && Reporter.call(permitted_params, self)
+        flash[:notice] = t('open_github_issue.thanks')
+      else
+        flash[:alert] = t('open_github_issue.error')
+      end
+
+      redirect_to permitted_params[:path]
+    end
+
+    private
+
+    def permitted_params
+      params.require(:open_github_report).permit(:title, :body, :path)
+    end
+  end
+end

data/app/helpers/open_github_issue/open_github_issue_helper.rb

@@ -0,0 +1,8 @@
+module OpenGithubIssue
+  module OpenGithubIssueHelper
+    def open_github_issue_form
+      return unless Constraint.call(self)
+      render partial: 'open_github_issue_form'
+    end
+  end
+end

data/app/views/application/_open_github_issue_form.html.erb

@@ -0,0 +1,32 @@
+<div class="open-github-issue-show" onclick="openGithubIssueFormToggle()">
+  <span>&#9888;<span>
+</div>
+
+<div class="open-github-issue-form" id="open-github-issue-form">
+  <strong class="open-github-issue-header"><%= t('open_github_issue.header') %></strong>
+  <%= form_for :open_github_report, url: OpenGithubIssue::Engine.routes.url_helpers.report_path do |f| %>
+    <div class="open-github-issue-form-group">
+      <div class="open-github-issue-form-description">
+        <%= label :title, t('open_github_issue.title') %>
+      </div>
+      <div class="open-github-issue-form-text-input">
+        <%= f.text_field :title %>
+      </div>
+    </div>
+
+    <div class="open-github-issue-form-group">
+      <div class="open-github-issue-form-description">
+        <%= label :body, t('open_github_issue.body') %>
+      </div>
+      <div class="open-github-issue-form-text-area">
+        <%= f.text_area :body %>
+      </div>
+    </div>
+
+    <%= f.hidden_field :path, value: request.path %>
+
+    <div class="open-github-issue-form-submit">
+      <%= f.submit t('open_github_issue.submit') %>
+    </div>
+  <% end %>
+</div>

data/config/locales/open_github_issue.en.yml

@@ -0,0 +1,8 @@
+en:
+  open_github_issue:
+    header: Report an issue
+    title: Title
+    body: Description
+    submit: Submit
+    thanks: Thank you for submitting the issue!
+    error: Your issue could not be submitted at this time.

data/config/locales/open_github_issue.pl.yml

@@ -0,0 +1,8 @@
+pl:
+  open_github_issue:
+    header: Zgłoś błąd
+    title: Tytuł
+    body: Treść
+    submit: Wyślij
+    thanks: Dziękujemy za zgłoszenie problemu!
+    error: W tej chwili nie można było wysłać zgłoszenia.

data/config/routes.rb

@@ -0,0 +1,3 @@
+OpenGithubIssue::Engine.routes.draw do
+  post :report, to: 'reports#report', as: :report
+end

data/lib/open_github_issue/base_service.rb

@@ -0,0 +1,7 @@
+module OpenGithubIssue
+  class BaseService
+    def self.call(*args)
+      new(*args).call
+    end
+  end
+end

data/lib/open_github_issue/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenGithubIssue
+  class Configuration
+    attr_accessor :github_access_token, :github_repo, :user_method, :user_name_method, :constraint
+
+    def initialize
+      self.user_method = :current_user
+      self.user_name_method = :email
+      self.constraint = proc { |user| user }
+    end
+  end
+end

data/lib/open_github_issue/constraint.rb

@@ -0,0 +1,23 @@
+module OpenGithubIssue
+  class Constraint < BaseService
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def call
+      constraint_proc.call(user)
+    end
+
+    private
+
+    def constraint_proc
+      @constraint_proc ||= OpenGithubIssue.configuration.constraint
+    end
+
+    def user
+      user_method = OpenGithubIssue.configuration.user_method
+      return unless user_method
+      @controller.public_send(user_method)
+    end
+  end
+end

data/lib/open_github_issue/engine.rb

@@ -0,0 +1,10 @@
+module OpenGithubIssue
+  class Engine < ::Rails::Engine
+    isolate_namespace OpenGithubIssue
+    engine_name 'open_github_issue'
+  
+    config.before_initialize do
+      ActiveSupport.on_load(:action_controller_base) { helper(OpenGithubIssue::OpenGithubIssueHelper) }
+    end
+  end
+end

data/lib/open_github_issue/github_issue.rb

@@ -0,0 +1,20 @@
+module OpenGithubIssue
+  class GithubIssue < BaseService
+    def initialize(title, message)
+      @title = title
+      @message = message
+    end
+
+    def call
+      client.create_issue(repo, @title, @message)
+    end
+
+    def client
+      @client ||= Octokit::Client.new(access_token: OpenGithubIssue.configuration.github_access_token)
+    end
+
+    def repo
+      @repo ||= OpenGithubIssue.configuration.github_repo
+    end
+  end
+end

data/lib/open_github_issue/reporter.rb

@@ -0,0 +1,55 @@
+module OpenGithubIssue
+  class Reporter < BaseService
+    def initialize(params, controller)
+      @params = params
+      @controller = controller
+    end
+
+    def call
+      GithubIssue.call(title, message)
+      true
+    rescue Octokit::Error
+      false
+    end
+
+    private
+
+    attr_reader :controller, :params
+
+    def message
+      message = <<-MESSAGE
+        **User**: #{name}
+        **Path**: #{path}
+
+        ---
+
+        #{body}
+      MESSAGE
+      message.strip_heredoc
+    end
+
+    def title
+      params[:title]
+    end
+
+    def body
+      params[:body]
+    end
+
+    def path
+      params[:path]
+    end
+
+    def user
+      user_method = OpenGithubIssue.configuration.user_method
+      return unless user_method
+      controller.public_send(user_method)
+    end
+
+    def name
+      user_name_method = OpenGithubIssue.configuration.user_name_method
+      return '' unless user_name_method
+      user.public_send(user_name_method)
+    end
+  end
+end

data/lib/open_github_issue/version.rb

@@ -0,0 +1,3 @@
+module OpenGithubIssue
+  VERSION = '0.1.0'
+end

data/lib/open_github_issue.rb

@@ -0,0 +1,19 @@
+require 'octokit'
+
+require 'open_github_issue/engine'
+
+require 'open_github_issue/configuration'
+require 'open_github_issue/base_service'
+require 'open_github_issue/reporter'
+require 'open_github_issue/github_issue'
+require 'open_github_issue/constraint'
+
+module OpenGithubIssue
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/tasks/open_github_issue_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :open_github_issue do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: open_github_issue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paweł J. Wal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  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
+  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:
+- p@steamshard.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/open_github_issue_manifest.js
+- app/assets/javascripts/open_github_issue.js
+- app/assets/stylesheets/open_github_issue.css
+- app/controllers/open_github_issue/application_controller.rb
+- app/controllers/open_github_issue/reports_controller.rb
+- app/helpers/open_github_issue/open_github_issue_helper.rb
+- app/views/application/_open_github_issue_form.html.erb
+- config/locales/open_github_issue.en.yml
+- config/locales/open_github_issue.pl.yml
+- config/routes.rb
+- lib/open_github_issue.rb
+- lib/open_github_issue/base_service.rb
+- lib/open_github_issue/configuration.rb
+- lib/open_github_issue/constraint.rb
+- lib/open_github_issue/engine.rb
+- lib/open_github_issue/github_issue.rb
+- lib/open_github_issue/reporter.rb
+- lib/open_github_issue/version.rb
+- lib/tasks/open_github_issue_tasks.rake
+homepage: https://github.com/paweljw/open_github_issue
+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.3
+signing_key: 
+specification_version: 4
+summary: Allow users to open issues on GitHub from your UI securely.
+test_files: []