stenographer-rails 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 933b3f63287df841e839e52f4ccd8ed8463d836efdcb3b428b1b876ebc593a0c
+  data.tar.gz: 1ab7e76dd5d1a1c7495c4f67bd5b339fc4a6b4cbf68b8823d7ccfe528554a4ef
+SHA512:
+  metadata.gz: a2cf90ff792bb8ee209da237ed8e00cf249d782a934cb12f37823e5f489ebbac0d9734550d350e827c0e2701e33e70cf8df7eca5a302f9fead0a084f06c7af1a
+  data.tar.gz: 0c3c3964c9f5a46386e182d63036c62061b7d17f96b1a6688ac67833b5c2599899e4ef6fa12454f5384045d261f77fbb6d924b80cb943b3b768a9e05b0d344d6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Michael Carey
+
+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,83 @@
+# Stenographer
+Stenographer is a simplistic way to manage your changes and show them to the users. When using an input like Github that
+has a unique id shared across branches, it will also manage grouping changes by environment.
+
+## Usage
+To create a new item:
+```ruby
+Stenography::Change.create(message: 'My Change', change_type: 'new/improved/fixed', visible: true, environments: 'production', tracker_ids: '#12345', source: '{}')
+```
+It's advised to store the source so you can parse it again later if needed.
+
+To View:
+```
+Open a browser to http://host:port/stenographer or whatever you've set your mount point to.
+```
+
+## Automatic Changelogs
+1. First, setup your input type in your config/stenographer.rb. As of right now, Stenographer only supports ``Stenographer::Inputs::GithubInput`` which users github webhooks.
+1. Then, setup your GitHub webhook setup to use "just the push event" to point at `https://#{YOUR_DOMAIN}/#{STENOGRAPHER_MOUNT_POINT}/changes`
+1. Finally, add `[changelog My change message]` to your commits.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stenographer-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install stenographer-rails
+```
+
+Add the configuration and migrations:
+```bash
+$ rails g stenographer:install
+```
+
+## Configuration
+All configuration is available in the config/initializers/stenographer.rb
+
+## Developing
+#### Running the App
+Set up the database
+
+```ruby
+$ rake app:db:setup
+```
+
+Start the Rails server
+```ruby
+$ rails s
+```
+
+View the site
+[http://locahost:3000/stenographer](http://locahost:3000/stenographer)
+
+#### Testing
+Set up the database
+
+```ruby
+$ RAILS_ENV=test rake app:db:setup
+```
+
+Run the tests
+```ruby
+$ rake spec
+```
+
+## Contributing
+1. Fork the repo and create your branch.
+2. If you've added code that should be tested, add tests.
+4. Ensure the test suite passes using `$ rake spec`.
+5. Make sure your code lints using `$ rubocop`.
+6. Issue that pull request!
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/config/stenographer_manifest.js

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

data/app/assets/javascripts/stenographer/admin/changes.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/stenographer/admin.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/stenographer/admins.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/stenographer/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/javascripts/stenographer/changes.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/stenographer/admin/changes.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/stenographer/application.sass

@@ -0,0 +1,18 @@
+$family-primary: 'Work Sans'
+
+@import 'bulma'
+@import 'changes'
+
+.flash
+  padding: 14px
+  text-align: center
+  position: absolute
+  left: 0
+  right: 0
+  color: #FEFEFE
+
+.flash-notice
+  background: #0074D9
+
+.flash-alert
+  background: #FF4136

data/app/assets/stylesheets/stenographer/changes.css

@@ -0,0 +1,23 @@
+ul.changes {
+    list-style: circle;
+    padding-left: 30px;
+}
+
+li.change {
+    margin: 5px 0;
+    font-weight: 300;
+}
+
+.change p {
+    display: inline-block;
+    margin: 2px;
+}
+
+.changes-pagination {
+    margin: 40px 0;
+}
+
+.changes-none {
+    text-align: center;
+    margin-top: 40px;
+}

data/app/controllers/stenographer/admin/authentications_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class Admin::AuthenticationsController < ApplicationController
+    before_action :assign_authentication, only: %i[show destroy]
+
+    def index
+      @slack_authentication = Authentication.find_by(provider: 'slack')
+
+      page = params[:page] || 1
+      @authentications = Authentication.order(id: :desc).paginate(page: page, per_page: Stenographer.per_page)
+    end
+
+    def show; end
+
+    def destroy
+      if @authentication.destroy
+        redirect_to admin_authentications_path, notice: 'Authentication Destroyed'
+      else
+        redirect_to admin_authentication_path(@authentication), alert: @authentication.errors.full_messages.to_sentence
+      end
+    end
+
+    private
+
+    def assign_authentication
+      @authentication = Authentication.find(params[:id])
+    end
+  end
+end

data/app/controllers/stenographer/admin/changes_controller.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class Admin::ChangesController < ApplicationController
+    before_action :assign_change, only: %i[show edit update destroy]
+
+    def new
+      @change = Change.new
+    end
+
+    def create
+      @change = Change.new(change_params)
+      @change.environments = Rails.env.to_s.downcase
+
+      if @change.save
+        redirect_to admin_change_path(@change), notice: 'Change Created'
+      else
+        flash.now[:alert] = @change.errors.full_messages.to_sentence
+        render :new
+      end
+    end
+
+    def index
+      page = params[:page] || 1
+      @changes = Change.order(created_at: :desc).paginate(page: page, per_page: Stenographer.per_page)
+    end
+
+    def show; end
+
+    def edit; end
+
+    def update
+      message = {}
+
+      if @change.update(change_params)
+        message[:notice] = 'Change Updated'
+
+        redirect_to admin_change_path(@change), message
+      else
+        flash.now[:alert] = @change.errors.full_messages.to_sentence
+        render :edit
+      end
+    end
+
+    def destroy
+      if @change.destroy
+        redirect_to admin_changes_path, notice: 'Change Destroyed'
+      else
+        redirect_to admin_change_path(@change), alert: @change.errors.full_messages.to_sentence
+      end
+    end
+
+    private
+
+    def change_params
+      params.require(:change).permit(:created_at, :message, :visible, :change_type, :environments, :tracker_ids)
+    end
+
+    def assign_change
+      @change = Change.find(params[:id])
+    end
+  end
+end

data/app/controllers/stenographer/admin/outputs_controller.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class Admin::OutputsController < ApplicationController
+    include Stenographer::OutputsHelper
+
+    before_action :assign_output, only: %i[show edit update destroy]
+
+    def index
+      @authentication_count = Authentication.count
+      @providers = Authentication.providers
+
+      page = params[:page] || 1
+      @outputs = Output.order(id: :desc).paginate(page: page, per_page: Stenographer.per_page)
+    end
+
+    def show; end
+
+    def new
+      authentication_id = params[:output][:authentication_id]
+      @authentication = Authentication.find_by(id: authentication_id)
+
+      if @authentication.present?
+        @output = Output.new(authentication_id: authentication_id)
+      else
+        redirect_to admin_outputs_path, alert: 'Cannot create an Output without a Provider'
+      end
+    end
+
+    def create
+      @output = Output.new(output_params)
+      @output.configuration = params[:configuration].to_json
+      @output.filters = params[:filters].to_json
+
+      if @output.save
+        redirect_to admin_output_path(@output), notice: 'Output Created'
+      else
+        redirect_to admin_outputs_path, alert: @output.errors.full_messages.to_sentence
+      end
+    end
+
+    def edit
+      @authentication = @output.authentication
+    end
+
+    def update
+      @output.configuration = params[:configuration].to_json
+      @output.filters = params[:filters].to_json
+
+      if @output.save
+        redirect_to admin_output_path(@output), notice: 'Output Created'
+      else
+        redirect_to admin_outputs_path, alert: @output.errors.full_messages.to_sentence
+      end
+    end
+
+    def destroy
+      if @output.destroy
+        redirect_to admin_outputs_path, notice: 'Output Destroyed'
+      else
+        redirect_to admin_output_path(@output), alert: @output.errors.full_messages.to_sentence
+      end
+    end
+
+    private
+
+    def assign_output
+      @output = Output.find(params[:id])
+    end
+
+    def output_params
+      params.require(:output).permit(:authentication_id)
+    end
+  end
+end

data/app/controllers/stenographer/admin_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class AdminController < ApplicationController
+    def index
+      @change_count = Change.count
+      @authentication_count = Authentication.count
+      @output_count = Output.count
+    end
+  end
+end

data/app/controllers/stenographer/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/stenographer/authentications_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class AuthenticationsController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    def create
+      auth_hash = request.env['omniauth.auth']
+      @hash = auth_hash
+
+      if auth_hash.try(:provider).present?
+        Authentication.find_or_create_by(provider: auth_hash.provider) do |authentication|
+          authentication.uid = auth_hash.uid
+          authentication.credentials = auth_hash.credentials.present? ? auth_hash.credentials.to_json : nil
+          authentication.source = auth_hash.to_json
+        end
+
+        flash[:notice] = 'Successfully created the Authentication'
+        redirect_to admin_authentications_path
+      else
+        flash[:alert] = 'Did not receive oAuth provider info'
+        redirect_back(fallback_location: root_path)
+      end
+    end
+
+    def failure; end
+  end
+end

data/app/controllers/stenographer/changes_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class ChangesController < ApplicationController
+    skip_before_action :verify_authenticity_token, only: %i[create]
+
+    def create
+      parser = Stenographer.parser.constantize.new
+
+      parms = params.permit!
+      changes = parser.parse(parms)
+      changes.each do |change|
+        Change.create_or_update_by_source_id(change)
+      end
+
+      head :ok
+    end
+
+    def index
+      page = params[:page] || 1
+
+      @change_count = Change.where(visible: true).count
+      @changes = Change.where(visible: true)
+                       .order(created_at: :desc)
+                       .paginate(page: page, per_page: Stenographer.per_page)
+    end
+
+    def show
+      @change = Change.find(params[:id])
+    end
+  end
+end

data/app/helpers/stenographer/admins_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Stenographer
+  module AdminsHelper
+  end
+end

data/app/helpers/stenographer/application_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Stenographer
+  module ApplicationHelper
+    def app_name
+      Stenographer.app_name
+    end
+
+    def app_icon?
+      Stenographer.app_icon.present?
+    end
+
+    def app_icon
+      Stenographer.app_icon
+    end
+
+    def manager?
+      Stenographer.manager.respond_to?(:call) ? Stenographer.manager.call(session) : Stenographer.manager
+    end
+  end
+end

data/app/helpers/stenographer/changes_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Stenographer
+  module ChangesHelper
+  end
+end

data/app/helpers/stenographer/outputs_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Stenographer
+  module OutputsHelper
+    def slack_channels(output)
+      slack_output = Stenographer::Outputs::SlackOutput.new(output: output)
+      slack_output.channels
+    end
+  end
+end

data/app/jobs/stenographer/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/stenographer/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/stenographer/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/stenographer/authentication.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class Authentication < ApplicationRecord
+    validates :provider, presence: true
+    validates :uid, presence: true
+
+    has_many :outputs, class_name: 'Stenographer::Output', dependent: :destroy
+
+    def self.providers
+      distinct(:provider).pluck(:provider)
+    end
+
+    def credentials_hash
+      credentials.present? ? JSON.parse(credentials, symbolize_names: true) : {}
+    end
+  end
+end

data/app/models/stenographer/change.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class Change < ApplicationRecord
+    VALID_CHANGE_TYPES = Stenographer.change_types
+
+    before_save :sanitize_environment
+    after_commit :send_to_outputs, on: [:create]
+    after_update :send_to_outputs, if: proc { |change| change.saved_change_to_environments? }
+
+    validates :message, presence: true
+    validates :change_type, inclusion: { in: VALID_CHANGE_TYPES }, allow_nil: true
+
+    def sanitize_environment
+      if environments.present?
+        environments_array = environments.split(',').map do |environment|
+          environment.downcase.strip
+        end
+        environments_array.uniq!
+        environments_array.join(', ')
+      else
+        nil
+      end
+    end
+
+    def to_markdown
+      Stenographer.markdown_renderer.render(message).html_safe
+    end
+
+    def matches_filters(output = nil)
+      return false if output.blank?
+
+      filters = output.filters_hash
+      return true if filters.empty?
+
+      filters.none? do |key, value|
+        if value.present? && key == :environments
+          environments_array = environments.split(',').map(&:strip)
+          environments_array.last != value.strip
+        else
+          value.present? && send(key) != value
+        end
+      end
+    end
+
+    def environments_to_tags
+      tags = []
+
+      environment_array = environments.split(',').map(&:strip)
+      environment_array.each do |environment|
+        tags << {
+          name: environment.capitalize,
+          color: environment == 'production' ? 'is-primary' : 'is-light'
+        }
+      end
+
+      tags
+    end
+
+    def self.create_or_update_by_source_id(change_params)
+      source_id = change_params[:source_id]
+
+      if source_id.present? && (change = Change.find_by(source_id: source_id)).present?
+        change.environments += ", #{change_params[:environments]}"
+        change.save
+      else
+        Change.create(change_params)
+      end
+    end
+
+    private
+
+    def send_to_outputs
+      unless Rails.env.test?
+        Output.all.find_each do |output|
+          if matches_filters(output)
+            output_class = "Stenographer::Outputs::#{output.authentication.provider.classify}Output".constantize
+            sender = output_class.new(output: output, change: self)
+            sender.send
+          end
+        end
+      end
+    end
+  end
+end