shipit-engine 0.28.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdb3736fb9999c0409f7b81081a52467f33a39ee419f2a40e14e6aca73866263
-  data.tar.gz: f58bfcbbc8084bb18cf2234ed0a75658a5c6bc9e2b593bc8a2b90e5f89d030b5
+  metadata.gz: b1e854d10e7f525e0a9af5a02bfb432ae6cd091079a8adae14894fc2e42415f2
+  data.tar.gz: 250798a87f4662d2a13e01090a31f4fc3bf82df6b206468002ca5098c792d951
 SHA512:
-  metadata.gz: 19ffafe44e93c6f02f277c5208160a605286557f5080cf3569355fcfa85b2a8583eace47a89c1ac223490ad157de451f0837343d5b818e891c9794b27ca20554
-  data.tar.gz: 57be6895de1d5757a48b603cfb4796316f477b791feef7cfc876dc57b5226d869e65b2332e920e695e3edbba3bd99b39dc75e0e3ceeab2b6aee851eaeea15c2e
+  metadata.gz: 8872ae9ba8ed5dcbf9de6dca1d46d40f87d9b870a5927e4b31ab62f794713b9ec030f4b8e13cf344ab2fc588d501e6d35532f13019f70815247a11fdfac0e8c8
+  data.tar.gz: 146fc5d4fec1d577d5b49bbee57b3dc9d9f391522be6e6f8877dcf80b62438eafa908454439124843ba5034e96afaaae93632b3e61f8ef1211542d297d7a4666

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/jobs/shipit/fetch_deployed_revision_job.rb

@@ -1,6 +1,6 @@
 module Shipit
   class FetchDeployedRevisionJob < BackgroundJob
-    queue_as :default
+    queue_as :deploys
 
     def perform(stack)
       return if stack.active_task?

data/app/jobs/shipit/github_sync_job.rb

@@ -2,7 +2,7 @@ module Shipit
   class GithubSyncJob < BackgroundJob
     include BackgroundJob::Unique
 
-    MAX_FETCHED_COMMITS = 10
+    MAX_FETCHED_COMMITS = 25
     queue_as :default
 
     self.timeout = 60

data/app/jobs/shipit/update_github_last_deployed_ref_job.rb

@@ -2,6 +2,8 @@ module Shipit
   class UpdateGithubLastDeployedRefJob < BackgroundJob
     queue_as :default
 
+    # We do not prefix 'refs/' because Octokit methods will do this automatically.
+    BRANCH_REF_PREFIX = 'heads'.freeze
     DEPLOY_PREFIX = 'shipit-deploy'.freeze
 
     def perform(stack)
@@ -20,7 +22,7 @@ module Shipit
     private
 
     def create_full_ref(stack_environment)
-      [DEPLOY_PREFIX, stack_environment].join("/")
+      [BRANCH_REF_PREFIX, DEPLOY_PREFIX, stack_environment].join("/")
     end
 
     def create_ref(client:, repo_name:, ref:, sha:)

data/app/models/shipit/github_status.rb

@@ -8,7 +8,7 @@ module Shipit
       end
 
       def refresh_status
-        Rails.cache.write(CACHE_KEY, Shipit.github.api.github_status)
+        Rails.cache.write(CACHE_KEY, Shipit.github.api_status)
       rescue Faraday::Error, Octokit::ServerError
       end
     end

data/app/models/shipit/user.rb

@@ -100,7 +100,7 @@ module Shipit
       assign_attributes(
         github_id: github_user.id,
         name: github_user.name || github_user.login, # Name is not mandatory on GitHub
-        email: github_user.email,
+        email: appropriate_email_for(github_user),
         login: github_user.login,
         avatar_url: github_user.avatar_url,
         api_url: github_user.url,
@@ -123,5 +123,27 @@ module Shipit
     rescue Octokit::NotFound
       false
     end
+
+    def email_valid_and_preferred?(email_address)
+      org_domains = Shipit.preferred_org_emails
+      return true if org_domains.blank?
+      return false if email_address.blank?
+
+      org_domains.any? { |domain| email_address.end_with?("@#{domain}") }
+    end
+
+    def appropriate_email_for(github_user)
+      return github_user.email if email_valid_and_preferred?(github_user.email)
+
+      begin
+        github_api.emails
+                  .sort_by { |e| e.primary ? 0 : 1 }
+                  .map(&:email)
+                  .find { |e| email_valid_and_preferred?(e) }
+      rescue Octokit::NotFound, Octokit::Forbidden
+        # If the user hasn't agreed to the necessary permission, we can't access their private emails.
+        nil
+      end
+    end
   end
 end

data/app/views/layouts/shipit.html.erb

@@ -33,7 +33,7 @@
 
   <div id="layout-content">
     <% github_status = Shipit::GithubStatus.status
-       unless github_status.nil? || github_status[:status] == 'good' %>
+       unless github_status.nil? || github_status[:status] == 'operational' %>
       <div class="banner github-status banner--orange hidden">
         <div class="banner__inner wrapper">
           <div class="banner__content">

data/app/views/shipit/deploys/new.html.erb

@@ -9,18 +9,6 @@
     <%= render 'shipit/deploys/summary', commits: @deploy.commits %>
   </section>
 
-  <% unless @deploy.commits_since.empty?  %>
-    <section class="less-important">
-
-      <p>The following commits are <strong>not</strong> included in this deploy.
-      Please ensure that none of these commits are needed for what
-      <strong>is</strong> being deployed (for example, if they contain the revert
-      of a broken change).</p>
-
-      <%= render 'shipit/deploys/summary', commits: @deploy.commits_since %>
-    </section>
-  <% end %>
-
   <%= render_monitoring @stack %>
 
   <%= render_checks @commit %>
@@ -37,4 +25,21 @@
       <%= f.submit class: 'btn btn--primary btn--large trigger-deploy' %>
     </section>
   <% end %>
+
+  <% unless @deploy.commits_since.empty?  %>
+    <section class="less-important">
+      <header class="section-header">
+        <h2>Commits not included in this deploy</h2>
+      </header>
+
+      <div>
+        <p>The following commits are <strong>not</strong> included in this deploy.
+        Please ensure that none of these commits are needed for what
+        <strong>is</strong> being deployed (for example, if they contain the revert
+        of a broken change).</p>
+
+        <%= render 'shipit/deploys/summary', commits: @deploy.commits_since %>
+      </div>
+    </section>
+  <% end %>
 </div>

data/lib/shipit.rb

@@ -47,7 +47,7 @@ require 'shipit/deploy_commands'
 require 'shipit/rollback_commands'
 require 'shipit/environment_variables'
 require 'shipit/stat'
-require 'shipit/strip_cache_control'
+require 'shipit/github_http_cache_middleware'
 require 'shipit/cast_value'
 require 'shipit/line_buffer'
 
@@ -60,7 +60,7 @@ module Shipit
   delegate :table_name_prefix, to: :secrets
 
   attr_accessor :disable_api_authentication, :timeout_exit_codes
-  attr_writer :internal_hook_receivers, :task_logger
+  attr_writer :internal_hook_receivers, :task_logger, :preferred_org_emails
 
   self.timeout_exit_codes = [].freeze
 
@@ -106,22 +106,6 @@ module Shipit
     end
   end
 
-  def new_faraday_stack
-    Faraday::RackBuilder.new do |builder|
-      builder.use(
-        Faraday::HttpCache,
-        shared_cache: false,
-        store: Rails.cache,
-        logger: Rails.logger,
-        serializer: NullSerializer,
-      )
-      builder.use StripCacheControl
-      builder.use Octokit::Response::RaiseError
-      builder.adapter Faraday.default_adapter
-      yield builder if block_given?
-    end
-  end
-
   def api_clients_secret
     secrets.api_clients_secret.presence || secrets.secret_key_base
   end
@@ -196,6 +180,10 @@ module Shipit
     @internal_hook_receivers ||= []
   end
 
+  def preferred_org_emails
+    @preferred_org_emails ||= []
+  end
+
   def task_logger
     @task_logger ||= Logger.new(nil)
   end

data/lib/shipit/github_app.rb

@@ -25,6 +25,7 @@ module Shipit
 
     DOMAIN = 'github.com'.freeze
     AuthenticationFailed = Class.new(StandardError)
+    API_STATUS_ID = 'brv1bkgrwx7q'.freeze
 
     attr_reader :oauth_teams, :domain, :bot_login
 
@@ -53,6 +54,13 @@ module Shipit
       client
     end
 
+    def api_status
+      conn = Faraday.new(url: 'https://www.githubstatus.com')
+      response = conn.get('/api/v2/components.json')
+      parsed = JSON.parse(response.body, symbolize_names: true)
+      parsed[:components].find { |c| c[:id] == API_STATUS_ID }
+    end
+
     def verify_webhook_signature(signature, message)
       return true unless webhook_secret
 
@@ -118,7 +126,7 @@ module Shipit
 
     def new_client(options = {})
       client = Octokit::Client.new(options.reverse_merge(api_endpoint: api_endpoint))
-      client.middleware = Shipit.new_faraday_stack
+      client.middleware = faraday_stack
       client
     end
 
@@ -126,6 +134,21 @@ module Shipit
 
     attr_reader :webhook_secret, :oauth_id, :oauth_secret
 
+    def faraday_stack
+      @faraday_stack ||= Faraday::RackBuilder.new do |builder|
+        builder.use(
+          Faraday::HttpCache,
+          shared_cache: false,
+          store: Rails.cache,
+          logger: Rails.logger,
+          serializer: NullSerializer,
+        )
+        builder.use GitHubHTTPCacheMiddleware
+        builder.use Octokit::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
     def app_id
       @app_id ||= @config.fetch(:app_id)
     end

data/lib/shipit/github_http_cache_middleware.rb

@@ -0,0 +1,56 @@
+module Shipit
+  class GitHubHTTPCacheMiddleware < Faraday::Middleware
+    def call(request_env)
+      @app.call(request_env).on_complete do |response_env|
+        if headers = response_env[:response_headers]
+
+          # We're removing max-age and s-maxage because some endpoints,
+          # especially /<repo>/commits, returns a max-age=0. This means that
+          # if two commits are pushed within 1 minute of each others, we won't
+          # see the second one. So instead we still issue the request, but we
+          # revalidate it.
+          cache_control = parse(headers['cache-control'].to_s)
+          cache_control.delete('max-age')
+          cache_control.delete('s-maxage')
+          cache_control['no-cache'] = true
+          cache_control['must-revalidate'] = true
+          headers['cache-control'] = dump(cache_control)
+
+          # We're removing `Authorization` from the `Vary` header because
+          # Faraday::HttpCache has a very limited garbage collection support
+          # and this cause cache entries to grow indefinitely.
+          # See https://github.com/Shopify/shipit-engine/issues/935 for
+          # more details.
+          vary = parse(headers['vary'].to_s)
+          vary.delete('authorization')
+          headers['vary'] = dump(vary)
+        end
+      end
+    end
+
+    private
+
+    def dump(directives)
+      directives.map do |k, v|
+        if v == true
+          k
+        else
+          "#{k}=#{v}"
+        end
+      end.join(', ')
+    end
+
+    def parse(header)
+      directives = {}
+
+      header.delete(' ').split(',').each do |part|
+        next if part.empty?
+
+        name, value = part.split('=', 2)
+        directives[name.downcase] = (value || true) unless name.empty?
+      end
+
+      directives
+    end
+  end
+end

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.28.0'.freeze
+  VERSION = '0.28.1'.freeze
 end

data/test/dummy/db/seeds.rb

@@ -1,8 +1,11 @@
 require 'faker'
-require 'fakeweb'
+require 'webmock'
+include WebMock::API
+WebMock.enable!
+WebMock.allow_net_connect!
 
 # Sometimes on Travis the background job runs immediately so provide a response to fake hooks
-FakeWeb.register_uri(:post, %r{https://example\.com/}, status: %w(200 OK))
+stub_request(:post, %r{https://example\.com/}).to_return(status: %w(200 OK))
 
 # Cheap hack to allow rake db:seed to work
 module Shipit

data/test/jobs/deliver_hook_job_test.rb

@@ -8,7 +8,7 @@ module Shipit
     end
 
     test "#perform delivers a delivery" do
-      FakeWeb.register_uri(:post, @delivery.url, body: 'OK')
+      stub_request(:post, @delivery.url).to_return(body: 'OK')
       @job.perform(@delivery)
       assert_equal 'sent', @delivery.reload.status
     end

data/test/jobs/merge_pull_requests_job_test.rb

@@ -17,15 +17,15 @@ module Shipit
 
     test "#perform rejects unmergeable PRs and merge the others" do
       PullRequest.any_instance.stubs(:refresh!)
-      FakeWeb.register_uri(:put, "#{@pending_pr.api_url}/merge", status: %w(200 OK), body: {
+      stub_request(:put, "#{@pending_pr.api_url}/merge").to_return(status: %w(200 OK), body: {
         sha: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
         merged: true,
         message: "Pull Request successfully merged",
       }.to_json)
       branch_url = "https://api.github.com/repos/shopify/shipit-engine/git/refs/heads/feature-62"
-      FakeWeb.register_uri(:delete, branch_url, status: %w(204 No content))
+      stub_request(:delete, branch_url).to_return(status: %w(204 No content))
       pulls_url = "https://api.github.com/repos/shopify/shipit-engine/pulls?base=feature-62"
-      FakeWeb.register_uri(:get, pulls_url, status: %w(200 OK), body: '[]')
+      stub_request(:get, pulls_url).to_return(status: %w(200 OK), body: '[]')
 
       @job.perform(@stack)
 
@@ -35,7 +35,7 @@ module Shipit
 
     test "#perform rejects PRs if the merge attempt fails" do
       PullRequest.any_instance.stubs(:refresh!)
-      FakeWeb.register_uri(:put, "#{@pending_pr.api_url}/merge", status: %w(405 Method not allowed), body: {
+      stub_request(:put, "#{@pending_pr.api_url}/merge").to_return(status: %w(405 Method not allowed), body: {
         message: "Pull Request is not mergeable",
         documentation_url: "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button",
       }.to_json)

data/test/jobs/update_github_last_deployed_ref_job_test.rb

@@ -8,22 +8,23 @@ module Shipit
       @deploy = @stack.deploys.last
       @commit = @deploy.until_commit
       @api_client = Shipit.github.api
-      @expected_ref_prefix = "shipit-deploy/#{@stack.environment}"
       @expected_name = @stack.github_repo_name
       @expected_sha = @commit.sha
 
-      expected_ref = ["refs", @expected_ref_prefix].join('/')
-      ref_url = "http://api.github.test.com/shopify/shipit-engine/git/#{expected_ref}"
+      expected_ref_suffix = "shipit-deploy/#{@stack.environment}"
+      @expected_ref = ["heads", expected_ref_suffix].join('/')
+
+      ref_url = "http://api.github.test.com/shopify/shipit-engine/git/#{@expected_ref}"
       commit_url = "https://api.github.test.com/repos/shopify/shipit-engine/git/commits/#{@commit.sha}"
       response_inner_obj = OpenStruct.new(sha: @commit.sha, type: "commit", url: commit_url)
-      @response = OpenStruct.new(ref: expected_ref, node_id: "blah", url: ref_url, object: response_inner_obj)
+      @response = OpenStruct.new(ref: @expected_ref, node_id: "blah", url: ref_url, object: response_inner_obj)
     end
 
     test "#perform will create a ref when one is not present" do
       Octokit::UnprocessableEntity.any_instance.stubs(:build_error_message).returns("Reference does not exist")
 
-      @api_client.expects(:update_ref).with(@expected_name, @expected_ref_prefix, @expected_sha).raises(Octokit::UnprocessableEntity)
-      @api_client.expects(:create_ref).with(@expected_name, @expected_ref_prefix, @expected_sha).returns(@response)
+      @api_client.expects(:update_ref).with(@expected_name, @expected_ref, @expected_sha).raises(Octokit::UnprocessableEntity)
+      @api_client.expects(:create_ref).with(@expected_name, @expected_ref, @expected_sha).returns(@response)
 
       result = @job.perform(@stack)
 
@@ -38,7 +39,7 @@ module Shipit
       @commit.sha = new_sha
       @commit.save
 
-      @api_client.expects(:update_ref).with(@expected_name, @expected_ref_prefix, new_sha).returns(@response)
+      @api_client.expects(:update_ref).with(@expected_name, @expected_ref, new_sha).returns(@response)
 
       result = @job.perform(@stack)
 
@@ -48,8 +49,8 @@ module Shipit
     test '#perform will raise an exception for non ref existence errors' do
       Octokit::UnprocessableEntity.any_instance.stubs(:build_error_message).returns("Some other error.")
 
-      @api_client.expects(:update_ref).with(@expected_name, @expected_ref_prefix, @expected_sha).raises(Octokit::UnprocessableEntity)
-      @api_client.expects(:create_ref).with(@expected_name, @expected_ref_prefix, @expected_sha).never
+      @api_client.expects(:update_ref).with(@expected_name, @expected_ref, @expected_sha).raises(Octokit::UnprocessableEntity)
+      @api_client.expects(:create_ref).with(@expected_name, @expected_ref, @expected_sha).never
 
       assert_raises Octokit::UnprocessableEntity do
         @job.perform(@stack)
@@ -72,7 +73,7 @@ module Shipit
       new_deploy.status = "faulty"
       new_deploy.save
 
-      @api_client.expects(:update_ref).with(@expected_name, @expected_ref_prefix, new_sha).returns(@response)
+      @api_client.expects(:update_ref).with(@expected_name, @expected_ref, new_sha).returns(@response)
       result = @job.perform(@stack)
 
       assert_equal @response, result
@@ -81,7 +82,7 @@ module Shipit
       new_deploy.status = "success"
       new_deploy.save
 
-      @api_client.expects(:update_ref).with(@expected_name, @expected_ref_prefix, new_commit.sha).returns(@response)
+      @api_client.expects(:update_ref).with(@expected_name, @expected_ref, new_commit.sha).returns(@response)
       @job.perform(@stack)
     end
   end

data/test/models/commits_test.rb

@@ -8,6 +8,12 @@ module Shipit
       @pr.message = "Merge pull request #31 from Shopify/improve-polling\n\nSeveral improvements to polling"
       @stack.reload
       @commit = shipit_commits(:first)
+
+      stub_request(:get, "https://api.github.com/user/emails").to_return(
+        status: %w(200 OK),
+        body: {}.to_json,
+        headers: {"Content-Type" => "application/json"},
+      )
     end
 
     test '.create_from_github handle unknown users' do

data/test/models/delivery_test.rb

@@ -24,7 +24,7 @@ module Shipit
 
     test "#send! post the payload and update the status to `sent`" do
       headers = {'content-type' => 'text/plain', 'content-length' => '2'}
-      FakeWeb.register_uri(:post, @delivery.url, headers.merge(body: 'OK'))
+      stub_request(:post, @delivery.url).to_return(headers: headers, body: 'OK')
 
       assert_equal 'scheduled', @delivery.status
       @delivery.send!

data/test/models/users_test.rb

@@ -3,6 +3,7 @@ require 'test_helper'
 module Shipit
   class UsersTest < ActiveSupport::TestCase
     setup do
+      @previous_preferred_org_emails = Shipit.preferred_org_emails
       @user = shipit_users(:walrus)
       @github_user = stub(
         id: 42,
@@ -12,6 +13,8 @@ module Shipit
         avatar_url: 'https://avatars.githubusercontent.com/u/42?v=3',
         url: 'https://api.github.com/user/george',
       )
+      @org_domain = "shopify.com"
+      @emails_url = "https://api.github.com/user/emails"
       @minimal_github_user = stub(
         id: 43,
         name: nil,
@@ -23,6 +26,10 @@ module Shipit
       )
     end
 
+    teardown do
+      Shipit.preferred_org_emails = @previous_preferred_org_emails
+    end
+
     test "find_or_create_from_github persist a new user if he is unknown" do
       assert_difference 'User.count', 1 do
         fetch_user
@@ -58,10 +65,103 @@ module Shipit
     end
 
     test "find_or_create_from_github accepts minimal users without name nor email" do
+      Shipit.preferred_org_emails = [].freeze
       user = User.find_or_create_from_github(@minimal_github_user)
       assert_equal @minimal_github_user.login, user.login
     end
 
+    test "find_or_create_from_github selects any email when org email is unspecified" do
+      github_org_user = stub(
+        id: 42,
+        name: 'Jim Jones',
+        login: 'jim',
+        email: "jim@#{@org_domain}",
+        avatar_url: 'https://avatars.githubusercontent.com/u/42?v=3',
+        url: 'https://api.github.com/user/jim',
+      )
+
+      Shipit.preferred_org_emails = [].freeze
+      user = User.find_or_create_from_github(github_org_user)
+      assert_equal github_org_user.email, user.email
+    end
+
+    test "find_or_create_from_github selects org email for user" do
+      Shipit.preferred_org_emails = [@org_domain]
+      expected_email = "myuser@#{@org_domain}"
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: [{email: expected_email}].to_json,
+        headers: {"Content-Type" => "application/json"},
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_equal expected_email, user.email
+    end
+
+    test "find_or_create_from_github selects private and primary org email for user when necessary" do
+      Shipit.preferred_org_emails = [@org_domain]
+      expected_email = "myuser@#{@org_domain}"
+      result_email_records = [
+        {
+          email: "notmyuser1@#{@org_domain}",
+          primary: false,
+        },
+        {
+          email: "notmyuser2@#{@org_domain}",
+        },
+        {
+          email: expected_email,
+          primary: true,
+        },
+      ]
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: result_email_records.to_json,
+        headers: {"Content-Type" => "application/json"},
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_equal expected_email, user.email
+    end
+
+    test "find_or_create_from_github selects no email when org emails are provided but not found" do
+      Shipit.preferred_org_emails = [@org_domain]
+      result_email_records = [
+        {
+          email: "notmyuser1@not#{@org_domain}",
+          primary: false,
+        },
+        {
+          email: "notmyuser2@not#{@org_domain}",
+        },
+      ]
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: result_email_records.to_json,
+        headers: {"Content-Type" => "application/json"},
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_nil user.email
+    end
+
+    test "find_or_create_from_github handles user 404" do
+      Shipit.preferred_org_emails = [@org_domain]
+      Octokit::Client.any_instance.expects(:emails).raises(Octokit::NotFound)
+      user = User.find_or_create_from_github(@minimal_github_user)
+      assert_nil user.email
+    end
+
+    test "find_or_create_from_github handles user 403" do
+      Shipit.preferred_org_emails = [@org_domain]
+      Octokit::Client.any_instance.expects(:emails).raises(Octokit::Forbidden)
+      user = User.find_or_create_from_github(@minimal_github_user)
+      assert_nil user.email
+    end
+
     test "#identifiers_for_ping returns a hash with the user's github_id, name, email and github_login" do
       user = shipit_users(:bob)
       expected_ouput = {github_id: user.github_id, name: user.name, email: user.email, github_login: user.login}

data/test/test_helper.rb

@@ -3,8 +3,7 @@ ENV["RAILS_ENV"] ||= "test"
 require 'simplecov'
 SimpleCov.start 'rails'
 
-require 'fakeweb'
-FakeWeb.allow_net_connect = false
+require 'webmock/minitest'
 
 require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
 ActiveRecord::Migrator.migrations_paths = [

data/test/unit/github_app_test.rb

@@ -13,6 +13,34 @@ module Shipit
       end
     end
 
+    test "#api_status" do
+      stub_request(:get, "https://www.githubstatus.com/api/v2/components.json").to_return(
+        status: 200,
+        body: %(
+          {
+            "page":{},
+            "components":[
+              {
+                "id":"brv1bkgrwx7q",
+                "name":"API Requests",
+                "status":"operational",
+                "created_at":"2017-01-31T20:01:46.621Z",
+                "updated_at":"2019-07-23T18:41:18.197Z",
+                "position":2,
+                "description":"Requests for GitHub APIs",
+                "showcase":false,
+                "group_id":null,
+                "page_id":"kctbh9vrtdwd",
+                "group":false,
+                "only_show_if_degraded":false
+              }
+            ]
+          }
+        ),
+      )
+      assert_equal "operational", app.api_status[:status]
+    end
+
     test "#domain defaults to github.com" do
       assert_equal 'github.com', @github.domain
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -706,6 +706,7 @@ files:
 - lib/shipit/first_parent_commits_iterator.rb
 - lib/shipit/flock.rb
 - lib/shipit/github_app.rb
+- lib/shipit/github_http_cache_middleware.rb
 - lib/shipit/line_buffer.rb
 - lib/shipit/null_serializer.rb
 - lib/shipit/octokit_check_runs.rb
@@ -715,7 +716,6 @@ files:
 - lib/shipit/simple_message_verifier.rb
 - lib/shipit/stack_commands.rb
 - lib/shipit/stat.rb
-- lib/shipit/strip_cache_control.rb
 - lib/shipit/task_commands.rb
 - lib/shipit/version.rb
 - lib/snippets/assert-egg-version-tag
@@ -908,155 +908,154 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Application deployment software
 test_files:
-- test/helpers/hooks_helper.rb
-- test/helpers/links_helper.rb
-- test/helpers/fixture_aliases_helper.rb
-- test/helpers/json_helper.rb
-- test/helpers/payloads_helper.rb
-- test/helpers/api_helper.rb
-- test/helpers/queries_helper.rb
-- test/models/membership_test.rb
-- test/models/rollbacks_test.rb
-- test/models/output_chunk_test.rb
-- test/models/pull_request_test.rb
-- test/models/team_test.rb
-- test/models/commit_deployment_status_test.rb
-- test/models/deploy_spec_test.rb
-- test/models/task_definitions_test.rb
-- test/models/stacks_test.rb
-- test/models/undeployed_commits_test.rb
-- test/models/shipit/check_run_test.rb
-- test/models/github_hook_test.rb
-- test/models/status/group_test.rb
-- test/models/status/missing_test.rb
-- test/models/api_client_test.rb
-- test/models/deploys_test.rb
-- test/models/hook_test.rb
-- test/models/commit_checks_test.rb
-- test/models/status_test.rb
-- test/models/users_test.rb
-- test/models/commit_deployment_test.rb
-- test/models/release_statuses_test.rb
-- test/models/duration_test.rb
-- test/models/tasks_test.rb
-- test/models/delivery_test.rb
-- test/models/commits_test.rb
-- test/fixtures/payloads/check_suite_master.json
-- test/fixtures/payloads/push_not_master.json
-- test/fixtures/payloads/status_master.json
-- test/fixtures/payloads/push_master.json
-- test/fixtures/timeout
-- test/fixtures/shipit/users.yml
-- test/fixtures/shipit/output_chunks.yml
-- test/fixtures/shipit/teams.yml
-- test/fixtures/shipit/github_hooks.yml
-- test/fixtures/shipit/hooks.yml
-- test/fixtures/shipit/commits.yml
-- test/fixtures/shipit/commit_deployments.yml
-- test/fixtures/shipit/statuses.yml
-- test/fixtures/shipit/stacks.yml
-- test/fixtures/shipit/pull_requests.yml
-- test/fixtures/shipit/api_clients.yml
-- test/fixtures/shipit/tasks.yml
-- test/fixtures/shipit/release_statuses.yml
-- test/fixtures/shipit/memberships.yml
-- test/fixtures/shipit/commit_deployment_statuses.yml
-- test/fixtures/shipit/deliveries.yml
-- test/fixtures/shipit/check_runs.yml
-- test/dummy/config/secrets.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/database.postgresql.yml
-- test/dummy/config/database.mysql.yml
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/application.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/initializers/0_load_development_secrets.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
-- test/dummy/Rakefile
+- test/dummy/public/favicon.ico
+- test/dummy/public/500.html
+- test/dummy/public/422.html
+- test/dummy/public/404.html
+- test/dummy/db/seeds.rb
+- test/dummy/db/schema.rb
+- test/dummy/bin/rake
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
-- test/dummy/bin/rake
 - test/dummy/bin/setup
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/public/500.html
-- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/controllers/application_controller.rb
-- test/dummy/db/seeds.rb
-- test/dummy/db/schema.rb
+- test/dummy/app/helpers/application_helper.rb
 - test/dummy/config.ru
-- test/controllers/deploys_controller_test.rb
+- test/dummy/Rakefile
+- test/dummy/config/application.rb
+- test/dummy/config/database.yml
+- test/dummy/config/locales/en.yml
+- test/dummy/config/secrets.yml
+- test/dummy/config/boot.rb
+- test/dummy/config/database.mysql.yml
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/0_load_development_secrets.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/database.postgresql.yml
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/controllers/webhooks_controller_test.rb
+- test/controllers/rollbacks_controller_test.rb
+- test/controllers/github_authentication_controller_test.rb
+- test/controllers/merge_status_controller_test.rb
+- test/controllers/commit_checks_controller_test.rb
+- test/controllers/ccmenu_controller_test.rb
 - test/controllers/stacks_controller_test.rb
-- test/controllers/status_controller_test.rb
-- test/controllers/api/deploys_controller_test.rb
-- test/controllers/api/locks_controller_test.rb
-- test/controllers/api/stacks_controller_test.rb
-- test/controllers/api/release_statuses_controller_test.rb
+- test/controllers/deploys_controller_test.rb
+- test/controllers/api/hooks_controller_test.rb
 - test/controllers/api/ccmenu_controller_test.rb
+- test/controllers/api/stacks_controller_test.rb
+- test/controllers/api/base_controller_test.rb
+- test/controllers/api/locks_controller_test.rb
+- test/controllers/api/deploys_controller_test.rb
 - test/controllers/api/commits_controller_test.rb
-- test/controllers/api/outputs_controller_test.rb
-- test/controllers/api/hooks_controller_test.rb
+- test/controllers/api/release_statuses_controller_test.rb
 - test/controllers/api/pull_requests_controller_test.rb
 - test/controllers/api/tasks_controller_test.rb
-- test/controllers/api/base_controller_test.rb
-- test/controllers/commit_checks_controller_test.rb
-- test/controllers/release_statuses_controller_test.rb
-- test/controllers/webhooks_controller_test.rb
-- test/controllers/ccmenu_controller_test.rb
-- test/controllers/rollbacks_controller_test.rb
+- test/controllers/api/outputs_controller_test.rb
+- test/controllers/status_controller_test.rb
 - test/controllers/commits_controller_test.rb
-- test/controllers/github_authentication_controller_test.rb
+- test/controllers/release_statuses_controller_test.rb
 - test/controllers/pull_requests_controller_test.rb
 - test/controllers/tasks_controller_test.rb
-- test/controllers/merge_status_controller_test.rb
+- test/unit/command_test.rb
+- test/unit/commands_test.rb
+- test/unit/line_buffer_test.rb
+- test/unit/deploy_commands_test.rb
+- test/unit/shipit_test.rb
+- test/unit/rollback_commands_test.rb
+- test/unit/csv_serializer_test.rb
+- test/unit/variable_definition_test.rb
+- test/unit/github_url_helper_test.rb
+- test/unit/environment_variables_test.rb
+- test/unit/github_app_test.rb
+- test/models/release_statuses_test.rb
+- test/models/deploys_test.rb
+- test/models/undeployed_commits_test.rb
+- test/models/team_test.rb
+- test/models/rollbacks_test.rb
+- test/models/commit_checks_test.rb
+- test/models/github_hook_test.rb
+- test/models/task_definitions_test.rb
+- test/models/tasks_test.rb
+- test/models/output_chunk_test.rb
+- test/models/commit_deployment_status_test.rb
+- test/models/delivery_test.rb
+- test/models/users_test.rb
+- test/models/commit_deployment_test.rb
+- test/models/duration_test.rb
+- test/models/api_client_test.rb
+- test/models/shipit/check_run_test.rb
+- test/models/commits_test.rb
+- test/models/status/group_test.rb
+- test/models/status/missing_test.rb
+- test/models/deploy_spec_test.rb
+- test/models/stacks_test.rb
+- test/models/hook_test.rb
+- test/models/membership_test.rb
+- test/models/status_test.rb
+- test/models/pull_request_test.rb
 - test/test_command_integration.rb
-- test/test_helper.rb
-- test/jobs/destroy_stack_job_test.rb
-- test/jobs/fetch_deployed_revision_job_test.rb
-- test/jobs/fetch_commit_stats_job_test.rb
+- test/helpers/hooks_helper.rb
+- test/helpers/queries_helper.rb
+- test/helpers/json_helper.rb
+- test/helpers/fixture_aliases_helper.rb
+- test/helpers/payloads_helper.rb
+- test/helpers/links_helper.rb
+- test/helpers/api_helper.rb
+- test/jobs/emit_event_job_test.rb
+- test/jobs/unique_job_test.rb
 - test/jobs/merge_pull_requests_job_test.rb
+- test/jobs/deliver_hook_job_test.rb
 - test/jobs/update_github_last_deployed_ref_job_test.rb
-- test/jobs/cache_deploy_spec_job_test.rb
-- test/jobs/emit_event_job_test.rb
+- test/jobs/refresh_status_job_test.rb
+- test/jobs/fetch_deployed_revision_job_test.rb
+- test/jobs/purge_old_deliveries_job_test.rb
 - test/jobs/refresh_github_user_job_test.rb
 - test/jobs/chunk_rollup_job_test.rb
 - test/jobs/mark_deploy_healthy_job_test.rb
-- test/jobs/refresh_status_job_test.rb
-- test/jobs/purge_old_deliveries_job_test.rb
-- test/jobs/deliver_hook_job_test.rb
-- test/jobs/github_sync_job_test.rb
+- test/jobs/fetch_commit_stats_job_test.rb
+- test/jobs/cache_deploy_spec_job_test.rb
 - test/jobs/perform_task_job_test.rb
-- test/jobs/unique_job_test.rb
-- test/unit/environment_variables_test.rb
-- test/unit/commands_test.rb
-- test/unit/github_app_test.rb
-- test/unit/rollback_commands_test.rb
-- test/unit/command_test.rb
-- test/unit/shipit_test.rb
-- test/unit/line_buffer_test.rb
-- test/unit/csv_serializer_test.rb
-- test/unit/deploy_commands_test.rb
-- test/unit/variable_definition_test.rb
-- test/unit/github_url_helper_test.rb
+- test/jobs/github_sync_job_test.rb
+- test/jobs/destroy_stack_job_test.rb
+- test/fixtures/timeout
+- test/fixtures/shipit/check_runs.yml
+- test/fixtures/shipit/release_statuses.yml
+- test/fixtures/shipit/users.yml
+- test/fixtures/shipit/output_chunks.yml
+- test/fixtures/shipit/deliveries.yml
+- test/fixtures/shipit/hooks.yml
+- test/fixtures/shipit/github_hooks.yml
+- test/fixtures/shipit/statuses.yml
+- test/fixtures/shipit/memberships.yml
+- test/fixtures/shipit/teams.yml
+- test/fixtures/shipit/tasks.yml
+- test/fixtures/shipit/api_clients.yml
+- test/fixtures/shipit/stacks.yml
+- test/fixtures/shipit/commits.yml
+- test/fixtures/shipit/pull_requests.yml
+- test/fixtures/shipit/commit_deployments.yml
+- test/fixtures/shipit/commit_deployment_statuses.yml
+- test/fixtures/payloads/status_master.json
+- test/fixtures/payloads/push_master.json
+- test/fixtures/payloads/push_not_master.json
+- test/fixtures/payloads/check_suite_master.json
+- test/test_helper.rb

data/lib/shipit/strip_cache_control.rb

@@ -1,40 +0,0 @@
-module Shipit
-  class StripCacheControl < Faraday::Middleware
-    def call(request_env)
-      @app.call(request_env).on_complete do |response_env|
-        if headers = response_env[:response_headers]
-          headers.delete('last-modified')
-          directives = parse(headers['cache-control'].to_s)
-          directives.delete('max-age')
-          directives.delete('s-maxage')
-          headers['cache-control'] = dump(directives)
-        end
-      end
-    end
-
-    private
-
-    def dump(directives)
-      directives.map do |k, v|
-        if v == true
-          k
-        else
-          "#{k}=#{v}"
-        end
-      end.join(', ')
-    end
-
-    def parse(header)
-      directives = {}
-
-      header.delete(' ').split(',').each do |part|
-        next if part.empty?
-
-        name, value = part.split('=', 2)
-        directives[name.downcase] = (value || true) unless name.empty?
-      end
-
-      directives
-    end
-  end
-end