shipit-engine 0.28.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdb3736fb9999c0409f7b81081a52467f33a39ee419f2a40e14e6aca73866263
-  data.tar.gz: f58bfcbbc8084bb18cf2234ed0a75658a5c6bc9e2b593bc8a2b90e5f89d030b5
+  metadata.gz: 98113cef0ad013fa29cb11fea22f09547c191310a601eb788a53fdc5fb3c7e40
+  data.tar.gz: 39c68de0e6356e1daab40942a817af86258ea8219726c1e4276a42bba5d79315
 SHA512:
-  metadata.gz: 19ffafe44e93c6f02f277c5208160a605286557f5080cf3569355fcfa85b2a8583eace47a89c1ac223490ad157de451f0837343d5b818e891c9794b27ca20554
-  data.tar.gz: 57be6895de1d5757a48b603cfb4796316f477b791feef7cfc876dc57b5226d869e65b2332e920e695e3edbba3bd99b39dc75e0e3ceeab2b6aee851eaeea15c2e
+  metadata.gz: 29504e17c71d378485e8610edea95e25e215f5c391478244e609a95a847e3022b508bda95713db97e1f1de22f67c8eed310a562f82cf737e1425803e958341ce
+  data.tar.gz: a7ea41b8ddcf21803a1279cd74d53231c9e030165c06b2ff835f31db55b0cf2240ca802626fba50abaec6b0e5c09e1439900de22c9d3b7719f53b6e2fe524da8

data/README.md

@@ -35,7 +35,11 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
 
-**IV. CONTRIBUTING**
+**IV. INTEGRATING**
+
+* [Registering webhooks](#integrating-webhooks)
+
+**V. CONTRIBUTING**
 
 * [Instructions](#contributing-instructions)
 * [Local development](#contributing-local-dev)
@@ -126,6 +130,8 @@ Also, if your repository is deployed different ways depending on the environment
 
 For example for a stack like: `my-org/my-repo/staging`, `shipit.staging.yml` will have priority over `shipit.yml`.
 
+Lastly, if you override the `app_name` configuration in your Shipit deployment, `yourapp.yml` and `yourapp.staging.yml` will work.
+
 * * *
 
 <h3 id="installing-dependencies">Installing dependencies</h3>
@@ -607,6 +613,8 @@ Your deploy scripts have access to the following environment variables:
 * `SHIPIT`: Set to `1` to allow your script to know it's executed by Shipit
 * `SHIPIT_LINK`: URL to the task output, useful to broadcast it in an IRC channel
 * `SHIPIT_USER`: Full name of the user that triggered the deploy/task
+* `GITHUB_REPO_NAME`: Name of the GitHub repository being used for the current deploy/task.
+* `GITHUB_REPO_OWNER`: The GitHub username of the repository owner for the current deploy/task.
 * `EMAIL`: Email of the user that triggered the deploy/task (if available)
 * `ENVIRONMENT`: The stack environment (e.g `production` / `staging`)
 * `BRANCH`: The stack branch (e.g `master`)
@@ -634,7 +642,36 @@ For Kubernetes, you have to provision Shipit environment with the following tool
 * `kubectl`
 * `kubernetes-deploy` [gem](https://github.com/Shopify/kubernetes-deploy)
 
-<h2 id="contributing">IV. CONTRIBUTING</h2>
+<h2 id="integrating">IV. INTEGRATING</h2>
+
+<h3 id="integrating-webhooks">Registering webhooks</h3>
+
+Shipit handles several webhook types by default, listed in `Shipit::Wehbooks::DEFAULT_HANDLERS`, in order to implement default behaviours. Extra handler blocks can be registered via `Shipit::Webhooks.register_handler`. Valid handlers need only implement the `call` method - meaning any object which implements `call` - blocks, procs, or lambdas are valid. The webhooks controller will pass a `params` argument to the handler. Some examples:
+
+
+<h4>Registering a Plain old Ruby Object as a handler</h4>
+
+```ruby
+class PullRequestHandler
+  def call(params)
+    # do something with pull request webhook events
+  end
+end
+
+Shipit::Webhooks.register_handler('pull_request', PullRequestHandler)
+```
+
+<h4>Registering a Block as a handler</h4>
+
+```ruby
+Shipit::Webhooks.register_handler('pull_request') do |params|
+  # do something with pull request webhook events
+end
+```
+
+Multiple handler blocks can be registered. If any raise errors, execution will be halted and the request will be reported failed to github.
+
+<h2 id="contributing">V. CONTRIBUTING</h2>
 
 <h3 id="contributing-instructions">Instructions</h3>
 
@@ -657,3 +694,5 @@ Run `./bin/bootstrap` in order to bootstrap the dummy application. The bootstrap
 Run `./test/dummy/bin/rails server` to run the rails dummy application.
 
 Set the environment variable `SHIPIT_DISABLE_AUTH=1` in order to disable authentication.
+
+If you need to test caching behaviour in the dummy application, use `bin/rails dev:cache`.

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
@@ -8,7 +9,7 @@ rescue LoadError
 end
 
 APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
+load('rails/tasks/engine.rake')
 
 Bundler::GemHelper.install_tasks
 
@@ -19,6 +20,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.test_files = FileList.new('test/**/*_test.rb').exclude('test/dummy/**/*')
   t.verbose = false
+  t.warning = false
 end
 
-task default: :test
+task(default: :test)

data/app/assets/images/archive-solid.svg

@@ -0,0 +1 @@
+<svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="archive" class="svg-inline--fa fa-archive fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M32 448c0 17.7 14.3 32 32 32h384c17.7 0 32-14.3 32-32V160H32v288zm160-212c0-6.6 5.4-12 12-12h104c6.6 0 12 5.4 12 12v8c0 6.6-5.4 12-12 12H204c-6.6 0-12-5.4-12-12v-8zM480 32H32C14.3 32 0 46.3 0 64v48c0 8.8 7.2 16 16 16h480c8.8 0 16-7.2 16-16V64c0-17.7-14.3-32-32-32z"></path></svg>

data/app/assets/stylesheets/_pages/_stacks.scss

@@ -49,6 +49,15 @@
       padding-left: 30px;
       margin-left: -30px;
     }
+    .archived {
+      // From FontAwesome, license @ https://fontawesome.com/license/free
+      background-image: asset-data-url('archive-solid.svg');
+      background-repeat: no-repeat;
+      background-size: 22px 22px;
+      background-position: 0px center;
+      padding-left: 30px;
+      margin-left: -30px;
+    }
 }
 
 .stack-lst:empty:before {
@@ -84,9 +93,6 @@
 
 .commits-path {
   font-size: 18px;
-  span {
-    text-transform: capitalize;
-  }
   small {
     font-size: 18px;
     color: #8D9EB0;
@@ -161,3 +167,70 @@
 .pagination {
   text-align: center;
 }
+
+.box {
+  border-radius: 5px;
+  width: 32%;
+  float: left;
+  padding: 5px;
+}
+
+.box__header {
+  padding: 15px 25px;
+  position: relative;
+}
+
+.box__header-title {
+  color: #333;
+  font-size: 18px;
+}
+
+.box__body {
+  padding: 0 25px;
+}
+
+.row {
+  @include clearfix;
+}
+
+/* STATS */
+
+.stats {
+  color: #333;
+  position: relative;
+  padding-bottom: 25px;
+}
+
+.stats__amount {
+  font-size: 54px;
+  line-height: 1.2;
+}
+
+.stats__caption {
+  font-size: 18px;
+
+}
+
+.stats__change {
+  position: absolute;
+  top: 10px;
+  right: 0;
+  text-align: right;
+  color: #B1B7C8;
+}
+
+.stats__value {
+  font-size: 18px;
+}
+
+.stats__period {
+  font-size: 14px;
+}
+
+.stats__value--positive {
+  color: #AEDC6F;
+}
+
+.stats__value--negative {
+  color: #FB5055;
+}

data/app/assets/stylesheets/_structure/_main.scss

@@ -142,8 +142,9 @@ pre {
 .less-important {
     color: $grey;
     margin-bottom: 0em;
-    margin-top: 1em;
+    margin-top: 5em;
     p {
+        margin-top: 1.5rem;
         margin-bottom: 0.5em;
     }
 }

data/app/assets/stylesheets/merge_status.scss

@@ -1,3 +0,0 @@
-.merge-status-container {
-  max-width: 700px;
-}

data/app/controllers/concerns/shipit/active_model_serializers_patch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Shipit
+  module ActiveModelSerializersPatch
+    private
+
+    def namespace_for_serializer
+      # TODO: This is a monkey patch for active_model_serializers 0.9.7.
+      # It's really outdated and newer versions aren't really a suitable replacement.
+      # We should look into simply getting rid of it.
+      @namespace_for_serializer ||= self.class.module_parent unless self.class.module_parent == Object
+    end
+  end
+end

data/app/controllers/concerns/shipit/api/cacheable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Cacheable

data/app/controllers/concerns/shipit/api/paginable.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Paginable
       extend ActiveSupport::Concern
 
-      LINK = 'Link'.freeze
+      LINK = 'Link'
 
       included do
         class_attribute :max_page_size
@@ -12,7 +13,7 @@ module Shipit
 
         self.max_page_size = 100
         self.default_page_size = 30
-        self.default_order = {id: :desc}.freeze
+        self.default_order = { id: :desc }.freeze
       end
 
       private

data/app/controllers/concerns/shipit/api/rendering.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     module Rendering
@@ -5,16 +6,16 @@ module Shipit
 
       def render_resources(resources, options = {})
         options[:json] = resources
-        render options
+        render(options)
       end
 
       def render_resource(resource, options = {})
         if resource.destroyed?
-          head :no_content, options.reverse_merge(content_type: 'application/json')
+          head(:no_content, options.reverse_merge(content_type: 'application/json'))
         elsif resource.errors.any?
-          render options.reverse_merge(status: :unprocessable_entity, json: {errors: resource.errors})
+          render(options.reverse_merge(status: :unprocessable_entity, json: { errors: resource.errors }))
         else
-          render options.reverse_merge(json: resource)
+          render(options.reverse_merge(json: resource))
         end
       end
     end

data/app/controllers/concerns/shipit/authentication.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Authentication
     extend ActiveSupport::Concern
@@ -20,10 +21,10 @@ module Shipit
         unless current_user.authorized?
           team_handles = Shipit.github_teams.map(&:handle)
           team_list = team_handles.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')
-          render plain: "You must be a member of #{team_list} to access this application.", status: :forbidden
+          render(plain: "You must be a member of #{team_list} to access this application.", status: :forbidden)
         end
       else
-        redirect_to Shipit::Engine.routes.url_helpers.github_authentication_path(origin: request.original_url)
+        redirect_to(Shipit::Engine.routes.url_helpers.github_authentication_path(origin: request.original_url))
       end
     end
 

data/app/controllers/concerns/shipit/pagination.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Pagination
     extend ActiveSupport::Concern
@@ -9,7 +10,7 @@ module Shipit
 
       self.max_page_size = 100
       self.default_page_size = 30
-      self.default_order = {id: :desc}.freeze
+      self.default_order = { id: :desc }.freeze
     end
 
     private

data/app/controllers/shipit/api/base_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     class BaseController < ActionController::Base
@@ -22,11 +23,15 @@ module Shipit
       before_action :authenticate_api_client
 
       def index
-        render json: {stacks_url: api_stacks_url}
+        render(json: { stacks_url: api_stacks_url })
       end
 
       private
 
+      def namespace_for_serializer
+        nil
+      end
+
       def authenticate_api_client
         @current_api_client = if Shipit.disable_api_authentication
           UnlimitedApiClient.new
@@ -38,7 +43,7 @@ module Shipit
         end
         return if @current_api_client
         headers['WWW-Authenticate'] = 'Basic realm="Authentication token"'
-        render status: :unauthorized, json: {message: 'Bad credentials'}
+        render(status: :unauthorized, json: { message: 'Bad credentials' })
       end
 
       attr_reader :current_api_client
@@ -65,19 +70,19 @@ module Shipit
       end
 
       def insufficient_permission(error)
-        render status: :forbidden, json: {message: error.message}
+        render(status: :forbidden, json: { message: error.message })
       end
 
       def validation_error(error)
-        render status: :unprocessable_entity, json: {message: error.message}
+        render(status: :unprocessable_entity, json: { message: error.message })
       end
 
       def not_found(_error)
-        render status: :not_found, json: {status: '404', error: 'Not Found'}
+        render(status: :not_found, json: { status: '404', error: 'Not Found' })
       end
 
       def conflict(_error)
-        render status: :conflict, json: {status: '409', error: 'Conflict'}
+        render(status: :conflict, json: { status: '409', error: 'Conflict' })
       end
     end
   end

data/app/controllers/shipit/api/ccmenu_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     class CCMenuController < BaseController
@@ -19,7 +20,7 @@ module Shipit
 
       def show
         latest_deploy = stack.deploys_and_rollbacks.last || NoDeploy.new
-        render 'shipit/ccmenu/project.xml.builder', formats: [:xml], locals: {stack: stack, deploy: latest_deploy}
+        render('shipit/ccmenu/project.xml.builder', formats: [:xml], locals: { stack: stack, deploy: latest_deploy })
       end
 
       private

data/app/controllers/shipit/api/commits_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     class CommitsController < BaseController
@@ -9,7 +10,7 @@ module Shipit
           commits = commits.newer_than(stack.last_deployed_commit)
         end
 
-        render_resources commits
+        render_resources(commits)
       end
     end
   end

data/app/controllers/shipit/api/deploys_controller.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     class DeploysController < BaseController
       require_permission :deploy, :stack
 
       def index
-        render_resources stack.deploys_and_rollbacks
+        render_resources(stack.deploys_and_rollbacks)
       end
 
       params do
-        requires :sha, String, length: {in: 6..40}
+        requires :sha, String, length: { in: 6..40 }
         accepts :force, Boolean, default: false
         accepts :env, Hash, default: {}
       end
@@ -16,7 +17,7 @@ module Shipit
         commit = stack.commits.by_sha(params.sha) || param_error!(:sha, 'Unknown revision')
         param_error!(:force, "Can't deploy a locked stack") if !params.force && stack.locked?
         deploy = stack.trigger_deploy(commit, current_user, env: params.env, force: params.force)
-        render_resource deploy, status: :accepted
+        render_resource(deploy, status: :accepted)
       end
     end
   end

data/app/controllers/shipit/api/hooks_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   module Api
     class HooksController < BaseController
@@ -5,11 +6,11 @@ module Shipit
       require_permission :write, :hook, only: %i(create update destroy)
 
       def index
-        render_resources hooks
+        render_resources(hooks)
       end
 
       def show
-        render json: hook
+        render(json: hook)
       end
 
       params do
@@ -18,7 +19,7 @@ module Shipit
         accepts :content_type, String
       end
       def create
-        render_resource hooks.create(params)
+        render_resource(hooks.create(params))
       end
 
       params do
@@ -28,11 +29,11 @@ module Shipit
       end
       def update
         hook.update(params)
-        render_resource hook
+        render_resource(hook)
       end
 
       def destroy
-        render_resource hook.destroy
+        render_resource(hook.destroy)
       end
 
       private