shipit-engine 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5426e5013d5212ede90d2822ff120284f476a065
-  data.tar.gz: 7aadb634611342fb72106ed6a7b0ec3f10dbfa6a
+  metadata.gz: eec3ad56957753526c730d8e7aaa24eceb08aafb
+  data.tar.gz: f02335b4c8b8d8dea3ddadc8de5c4351339a289f
 SHA512:
-  metadata.gz: 1181813ddadc3e0bf49276542a4f44506d500f5c6cbd3214c3e4bd20f3774ba75eb4bd65fa32318af80769341b135b9edde114f21edac1024af31cf631852e01
-  data.tar.gz: 3cd714bc2387ece2d228d2d4ed27ce721dd24690e862c8f5412d2b76f5107b58effbcdde8388f79f3c4a49209fb1fd1e729ce278333843aa76212d978081c908
+  metadata.gz: 34f44b9cc7315992879ae69fe283fe76a8f250f5244376fd7cd5ef49688fba8ba3234b91aa0304349ace86fbdd15d8bc0bbce3cc1fcdf7d608459ce958c48d86
+  data.tar.gz: 7f4116a87a98201a0be003d3baeaa38dba7fb3d3a0cc131bb7ccf974daec70c16da76b3959f1ee238255d4b2dc057cfff610bb6cc51a24e345a12c78426169e2

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

@@ -0,0 +1,13 @@
+module Shipit
+  module Api
+    module Cacheable
+      def render_resources(resources, *)
+        super if stale?(etag: resources, last_modified: resources.map(&:updated_at).max, template: false)
+      end
+
+      def render_resource(resource, *)
+        super if stale?(etag: resource, last_modified: resource.updated_at, template: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Shipit
+  module Api
+    module Paginable
+      extend ActiveSupport::Concern
+
+      LINK = 'Link'.freeze
+
+      included do
+        class_attribute :max_page_size
+        class_attribute :default_page_size
+        class_attribute :default_order
+
+        self.max_page_size = 100
+        self.default_page_size = 30
+        self.default_order = {id: :desc}.freeze
+      end
+
+      private
+
+      def render_resources(resource, *)
+        paginator = Shipit::Paginator.new(
+          resource,
+          self,
+          order: default_order,
+          max_page_size: max_page_size,
+          default_page_size: default_page_size,
+        )
+        headers[LINK] = render_links(paginator.links)
+        super(paginator.to_a)
+      end
+
+      def render_links(links)
+        links.map { |rel, url| %(<#{url}>; rel="#{rel}") }.join(', ')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Shipit
+  module Api
+    module Rendering
+      private
+
+      def render_resources(resources, options = {})
+        options[:json] = resources
+        render options
+      end
+
+      def render_resource(resource, options = {})
+        if resource.destroyed?
+          options[:status] = :no_content
+          options[:text] = nil
+        elsif resource.errors.any?
+          options[:json] = {errors: resource.errors}
+          options[:status] = :unprocessable_entity
+        else
+          options[:json] = resource
+        end
+        render options
+      end
+    end
+  end
+end

data/app/controllers/concerns/{api/paginable.rb → shipit/pagination.rb}

@@ -1,9 +1,7 @@
-module Api
-  module Paginable
+module Shipit
+  module Pagination
     extend ActiveSupport::Concern
 
-    LINK = 'Link'.freeze
-
     included do
       class_attribute :max_page_size
       class_attribute :default_page_size
@@ -16,20 +14,14 @@ module Api
 
     private
 
-    def render_resources(resource, *)
-      paginator = Shipit::Paginator.new(
-        resource,
+    def paginate(relation)
+      Shipit::Paginator.new(
+        relation,
         self,
         order: default_order,
         max_page_size: max_page_size,
         default_page_size: default_page_size,
       )
-      headers[LINK] = render_links(paginator.links)
-      super(paginator.to_a)
-    end
-
-    def render_links(links)
-      links.map { |rel, url| %(<#{url}>; rel="#{rel}") }.join(', ')
     end
   end
 end

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

@@ -0,0 +1,68 @@
+module Shipit
+  module Api
+    class BaseController < ActionController::Base
+      include Shipit::Engine.routes.url_helpers
+      include Rendering
+      include Cacheable
+      include Paginable
+
+      rescue_from ApiClient::InsufficientPermission, with: :insufficient_permission
+      rescue_from TaskDefinition::NotFound, with: :not_found
+
+      class << self
+        def require_permission(operation, scope, options = {})
+          before_action(options) { require_permission!(operation, scope) }
+        end
+      end
+
+      before_action :authenticate_api_client
+
+      def index
+        render json: {stacks_url: api_stacks_url}
+      end
+
+      private
+
+      def authenticate_api_client
+        @current_api_client = authenticate_with_http_basic do |*parts|
+          token = parts.select(&:present?).join('--')
+          ApiClient.authenticate(token)
+        end
+        return if @current_api_client
+        headers['WWW-Authenticate'] = 'Basic realm="Authentication token"'
+        render status: :unauthorized, json: {message: 'Bad credentials'}
+      end
+
+      attr_reader :current_api_client
+
+      def current_user
+        @current_user ||= identify_user || AnonymousUser.new
+      end
+
+      def identify_user
+        user_login = request.headers['X-Shipit-User'].presence
+        User.find_by(login: user_login) if user_login
+      end
+
+      def stacks
+        @stacks ||= current_api_client.stack_id? ? Stack.where(id: current_api_client.stack_id) : Stack.all
+      end
+
+      def stack
+        @stack ||= stacks.from_param!(params[:stack_id])
+      end
+
+      def require_permission!(operation, scope)
+        current_api_client.check_permissions!(operation, scope)
+      end
+
+      def insufficient_permission(error)
+        render status: :forbidden, json: {message: error.message}
+      end
+
+      def not_found(_error)
+        render status: :not_found, json: {status: '404', error: 'Not Found'}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Shipit
+  module Api
+    class DeploysController < BaseController
+      require_permission :deploy, :stack
+
+      params do
+        requires :sha, String, length: {in: 6..40}
+        accepts :force, Boolean, default: false
+      end
+      def create
+        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?
+        render_resource stack.trigger_deploy(commit, current_user), status: :accepted
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Shipit
+  module Api
+    class HooksController < BaseController
+      require_permission :read, :hook, only: %i(index show)
+      require_permission :write, :hook, only: %i(create update destroy)
+
+      def index
+        render_resources hooks
+      end
+
+      def show
+        render json: hook
+      end
+
+      params do
+        requires :url, String
+        requires :events, Array[String]
+        accepts :content_type, String
+      end
+      def create
+        render_resource hooks.create(params)
+      end
+
+      params do
+        accepts :url, String
+        accepts :events, Array[String]
+        accepts :content_type, String
+      end
+      def update
+        hook.update(params)
+        render_resource hook
+      end
+
+      def destroy
+        render_resource hook.destroy
+      end
+
+      private
+
+      def hook
+        hooks.find(params[:id])
+      end
+
+      def hooks
+        Hook.where(stack_id: stack_id)
+      end
+
+      def stack_id
+        stack.id if params[:stack_id].present?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Shipit
+  module Api
+    class LocksController < BaseController
+      require_permission :lock, :stack
+
+      params do
+        requires :reason, String, presence: true
+      end
+      def create
+        if stack.locked?
+          render json: {message: 'Already locked'}, status: :conflict
+        else
+          stack.update(lock_reason: params.reason, lock_author: current_user)
+          render_resource stack
+        end
+      end
+
+      params do
+        requires :reason, String, presence: true
+      end
+      def update
+        stack.update(lock_reason: params.reason, lock_author: current_user)
+        render_resource stack
+      end
+
+      def destroy
+        stack.update(lock_reason: nil, lock_author: nil)
+        render_resource stack
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Shipit
+  module Api
+    class OutputsController < BaseController
+      require_permission :read, :stack
+
+      def show
+        render plain: task.chunk_output
+      end
+
+      private
+
+      def task
+        @task ||= stack.tasks.find(params[:task_id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Shipit
+  module Api
+    class StacksController < BaseController
+      require_permission :read, :stack
+
+      def index
+        render_resources stacks
+      end
+
+      def show
+        render_resource stack
+      end
+
+      private
+
+      def stack
+        @stack ||= stacks.from_param!(params[:id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Shipit
+  module Api
+    class TasksController < BaseController
+      require_permission :read, :stack
+      require_permission :deploy, :stack, only: :trigger
+
+      def index
+        render_resources stack.tasks
+      end
+
+      def show
+        render_resource stack.tasks.find(params[:id])
+      end
+
+      def trigger
+        render_resource stack.trigger_task(params[:task_name], current_user), status: :accepted
+      end
+    end
+  end
+end

data/app/controllers/shipit/commit_checks_controller.rb

@@ -0,0 +1,26 @@
+module Shipit
+  class CommitChecksController < ShipitController
+    params do
+      accepts :since, Integer, default: 0
+    end
+    def tail
+      output = checks.output(since: params.since)
+      next_offset = params.since + output.bytesize
+      url = stack_tail_commit_checks_path(stack, sha: commit.sha, since: next_offset) unless checks.finished?
+
+      render json: {url: url, output: output, status: checks.status}
+    end
+
+    private
+
+    delegate :checks, to: :commit
+
+    def commit
+      @commit ||= stack.commits.find_by_sha!(params[:sha])
+    end
+
+    def stack
+      @stack ||= Stack.from_param!(params[:stack_id])
+    end
+  end
+end

data/app/controllers/shipit/deploys_controller.rb

@@ -0,0 +1,47 @@
+module Shipit
+  class DeploysController < ShipitController
+    include ChunksHelper
+
+    before_action :load_stack
+    before_action :load_deploy, only: %i(show rollback)
+    before_action :load_until_commit, only: :create
+
+    def new
+      @commit = @stack.commits.by_sha!(params[:sha])
+      @commit.checks.schedule if @stack.checks?
+      @deploy = @stack.deploys.new(until_commit: @commit, since_commit: @stack.last_deployed_commit)
+    end
+
+    def show
+    end
+
+    def create
+      return redirect_to new_stack_deploy_path(@stack, sha: @until_commit.sha) if !params[:force] && @stack.deploying?
+
+      @deploy = @stack.trigger_deploy(@until_commit, current_user, env: deploy_params[:env])
+      respond_with(@deploy.stack, @deploy)
+    end
+
+    def rollback
+      @rollback = @deploy.build_rollback
+    end
+
+    private
+
+    def load_deploy
+      @deploy = @stack.deploys.find(params[:id])
+    end
+
+    def load_stack
+      @stack ||= Stack.from_param!(params[:stack_id])
+    end
+
+    def load_until_commit
+      @until_commit = @stack.commits.find(deploy_params[:until_commit_id])
+    end
+
+    def deploy_params
+      @deploy_params ||= params.require(:deploy).permit(:until_commit_id, env: @stack.deploy_variables.map(&:name))
+    end
+  end
+end