buildkit 1.2.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a85af6bb40a281c219a2837700833cbb6f32d99
-  data.tar.gz: dc2cd54f37470feb90fda6c37a3ae3d8855b43bf
+SHA256:
+  metadata.gz: e0d8ad5ef2805dc0580084a0bb934c5e013740b7b02dfd6747941014293958b6
+  data.tar.gz: edf69422089f0ddca1c75969a575e546617be02db8989703b9804624d91553b1
 SHA512:
-  metadata.gz: 4df322a711ba16b8a5abe274195af31a2caff1891b57593fcb6f077a584c35d7ed28e618dbba2638672c860309990664b30f072c4e309b6d0a20053e49b6c1f1
-  data.tar.gz: 27c8787d3ce593c0cc038ec527d73ed7ff0dba2810b1d674f78d80ec8cd741a8f5e042f28a85eba6b97e8b4f07339851627709c7a1ff83d0a654bdbd8e1a6846
+  metadata.gz: 0d7efe3865fbbbeffa1280491a0babafd410aeabd4552824f68ed86ff3bd841c274612f71133a5ba512b2473f2680472458638b1517a0eb05a2262522b83570a
+  data.tar.gz: 3967182cd91e643ac31237bc27496bb67b8f125a3b5f18ad457f900b5a63a2b3622376f17c3b5196ac9cd5507f4c0e76c4f44269ccafbe48e21b207dbe616f71

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+on: push
+name: Test Buildkit Gem
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run rspec
+        run: 'bundle exec rspec spec'

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
 
 Metrics/LineLength:
   Max: 120
@@ -9,6 +9,9 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 25
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false # RSpec ... :facepalm:
 
@@ -36,10 +39,13 @@ Lint/AssignmentInCondition:
 Style/PerlBackrefs:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInArguments:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'byebug'

data/README.md

@@ -2,7 +2,6 @@
 
 Ruby toolkit for the Buildkite API.
 
-[![Build Status](https://secure.travis-ci.org/Shopify/buildkit.png)](http://travis-ci.org/Shopify/buildkit)
 [![Gem Version](https://badge.fury.io/rb/buildkit.png)](http://badge.fury.io/rb/buildkit)
 
 ## Installation

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
@@ -7,13 +9,13 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task test: :spec
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
 
 namespace :doc do
   require 'yard'
   YARD::Rake::YardocTask.new do |task|
-    task.files = %w(LICENSE.md lib/**/*.rb)
-    task.options = %w(--output-dir doc/yard --markup markdown)
+    task.files = %w[LICENSE.md lib/**/*.rb]
+    task.options = %w[--output-dir doc/yard --markup markdown]
   end
   task default: :yard
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'buildkit'

data/buildkit.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'buildkit/version'
 
@@ -18,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'sawyer', '~> 0.6'
+  spec.add_dependency 'sawyer', '>= 0.6'
   spec.add_development_dependency 'bundler'
 end

data/dev.yml

@@ -0,0 +1,11 @@
+name: buildkit
+
+type: ruby
+
+up:
+  - ruby: 2.5.5
+  - bundler
+
+commands:
+  test:
+    run: bundle exec rake

data/lib/buildkit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'buildkit/version'
 require 'buildkit/client'
 

data/lib/buildkit/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sawyer'
 require 'buildkit/client/agents'
 require 'buildkit/client/builds'
@@ -6,6 +8,7 @@ require 'buildkit/client/pipelines'
 require 'buildkit/client/jobs'
 require 'buildkit/client/artifacts'
 require 'buildkit/response/raise_error'
+require 'buildkit/header_link_parser'
 
 module Buildkit
   class Client
@@ -15,15 +18,18 @@ module Buildkit
     include Pipelines
     include Jobs
     include Artifacts
+    include HeaderLinkParser
 
-    DEFAULT_ENDPOINT = 'https://api.buildkite.com/v2/'.freeze
+    DEFAULT_ENDPOINT = 'https://api.buildkite.com/v2/'
 
     # Header keys that can be passed in options hash to {#get},{#head}
-    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
 
     # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
     RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
 
+    attr_accessor :auto_paginate
+
     class << self
       def build_middleware
         RACK_BUILDER_CLASS.new do |builder|
@@ -36,10 +42,11 @@ module Buildkit
 
     def initialize(endpoint: ENV.fetch('BUILDKITE_API_ENDPOINT', DEFAULT_ENDPOINT),
                    token: ENV.fetch('BUILDKITE_API_TOKEN'),
-                   middleware: self.class.build_middleware)
+                   middleware: self.class.build_middleware, auto_paginate: false)
       @middleware = middleware
       @endpoint = endpoint
       @token = token
+      @auto_paginate = auto_paginate
     end
 
     # Make a HTTP GET request
@@ -48,7 +55,11 @@ module Buildkit
     # @param options [Hash] Query and header params for request
     # @return [Sawyer::Resource]
     def get(url, options = {})
-      request :get, url, parse_query_and_convenience_headers(options)
+      if @auto_paginate
+        paginate :get, url, parse_query_and_convenience_headers(options)
+      else
+        request :get, url, parse_query_and_convenience_headers(options)
+      end
     end
 
     # Make a HTTP POST request
@@ -109,19 +120,51 @@ module Buildkit
 
     def request(method, path, data, options = {})
       if data.is_a?(Hash)
-        options[:query]   = data.delete(:query) || {}
-        options[:headers] = data.delete(:headers) || {}
+        options = extract_query_and_headers_from data
         if accept = data.delete(:accept)
           options[:headers][:accept] = accept
         end
       end
 
-      @last_response = response = sawyer_agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      @last_response = response = sawyer_agent.call(method, URI::DEFAULT_PARSER.escape(path.to_s), data, options)
       response.data
     end
 
+    def extract_query_and_headers_from(data)
+      {
+        query: data.delete(:query) || {},
+        headers: data.delete(:headers) || {},
+      }
+    end
+
+    def paginate(method, path, data, options = {})
+      response = []
+      loop do
+        request method, path, data, options
+
+        # Paginated API calls always return Arrays.
+        return last_response.data unless @last_response.data.is_a?(Array)
+
+        response.concat @last_response.data
+
+        link_header = parse_link_header(@last_response.headers[:link])
+        break if link_header[:next].nil?
+
+        path = next_page(link_header[:next])
+      end
+      response
+    end
+
+    def next_page(next_page)
+      build_path URI(next_page)
+    end
+
+    def build_path(uri)
+      "#{uri.path}?#{uri.query}"
+    end
+
     def sawyer_agent
-      @agent ||= Sawyer::Agent.new(@endpoint, sawyer_options) do |http|
+      @sawyer_agent ||= Sawyer::Agent.new(@endpoint, sawyer_options) do |http|
         http.headers[:accept] = 'application/json'
         http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = "Buildkit v#{Buildkit::VERSION}"
@@ -145,7 +188,7 @@ module Buildkit
       end
       query = options.delete(:query)
       opts = {query: options}
-      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:query].merge!(query) if query&.is_a?(Hash)
       opts[:headers] = headers unless headers.empty?
 
       opts

data/lib/buildkit/client/agents.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the Agents API

data/lib/buildkit/client/artifacts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the Artifacts API
@@ -13,6 +15,16 @@ module Buildkit
       def artifacts(org, pipeline, build, options = {})
         get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/artifacts", options)
       end
+
+      # List all artifacts for a job
+      #
+      # @return [Array<Sawyer::Resource>] Array of hashes representing Buildkite artifacts.
+      # @see https://buildkite.com/docs/rest-api/artifacts#list-artifacts-for-a-job
+      # @example
+      #   Buildkit.job_artifacts('my-great-org', 'great-pipeline', 42, '76365070-34d5-4104-8b91-952780f8029f')
+      def job_artifacts(org, pipeline, build, job, options = {})
+        get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/artifacts", options)
+      end
     end
   end
 end

data/lib/buildkit/client/builds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the Builds API

data/lib/buildkit/client/jobs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the Jobs API
@@ -31,6 +33,20 @@ module Buildkit
       def job_env(org, pipeline, build, job, options = {})
         get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/env", options)
       end
+
+      # Get a job's log output
+      #
+      # @param org [String] Organization slug.
+      # @param pipeline [String] Pipeline slug.
+      # @param build [Integer] Build number.
+      # @param job [String] Job id.
+      # @return [Sawyer::Resource] Hash representing the Buildkit job log output.
+      # @see https://buildkite.com/docs/rest-api/jobs#get-a-jobs-log-output
+      # @example
+      #   Buildkit.job_log('my-great-org', 'great-pipeline', 123, 'my-job-id')
+      def job_log(org, pipeline, build, job, options = {})
+        get("/v2/organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/log", options)
+      end
     end
   end
 end

data/lib/buildkit/client/organizations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the Organizations API

data/lib/buildkit/client/pipelines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   class Client
     # Methods for the pipelines API
@@ -31,7 +33,7 @@ module Buildkit
       # @param org [String] Organization slug.
       # @see https://buildkite.com/docs/api/pipelines#create-a-pipeline
       # @example
-      #   Buildkit.create_build('my-great-org', {
+      #   Buildkit.create_pipeline('my-great-org', {
       #     name: 'My pipeline',
       #     repository: 'git@github.com:acme/pipeline.git',
       #     steps: [

data/lib/buildkit/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
   # Custom error class for rescuing from all Buildkite errors
   class Error < StandardError
@@ -44,7 +46,7 @@ module Buildkit
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
-      if data && data.is_a?(Hash)
+      if data&.is_a?(Hash)
         data[:errors] || []
       else
         []
@@ -87,26 +89,34 @@ module Buildkit
     def response_error_summary
       return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
 
-      summary = "\nError summary:\n"
-      summary << data[:errors].map do |hash|
+      errors = data[:errors].map do |hash|
         hash.map { |k, v| "  #{k}: #{v}" }
-      end.join("\n")
+      end
 
-      summary
+      <<~MSG.chomp
+        Error summary:
+        #{errors.join("\n")}
+      MSG
     end
 
     def build_error_message
       return nil if @response.nil?
 
-      message = "#{@response[:method].to_s.upcase} #{redact_url(@response[:url].to_s)}: #{@response[:status]} - "
-      message << "#{response_message}#{response_error}#{response_error_summary}"
-      message << " // See: #{documentation_url}" unless documentation_url.nil?
-      message
+      documentation_text = if documentation_url
+        "// See: #{documentation_url}"
+      else
+        ""
+      end
+
+      <<~MSG.strip
+        #{@response[:method].to_s.upcase} #{redact_url(@response[:url].to_s)}: #{@response[:status]} - #{response_message}#{response_error}#{response_error_summary}
+        #{documentation_text}
+      MSG
     end
 
     def redact_url(url_string)
-      %w(client_secret access_token).each do |token|
-        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      %w[client_secret access_token].each do |token|
+        url_string = url_string.gsub(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
       end
       url_string
     end

data/lib/buildkit/header_link_parser.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Buildkit
+  module HeaderLinkParser
+    module_function
+
+    def parse_link_header(link_header)
+      {}.tap do |hash_link|
+        link_header.split(',').each do |link|
+          link_obj = LinkParser.new(link)
+          hash_link[link_obj.name] = link_obj.link
+        end
+      end
+    end
+
+    class LinkParser
+      def initialize(value)
+        @value = value
+      end
+
+      def name
+        @name ||= @value[/rel="(.*)"/, 1].to_sym
+      end
+
+      def link
+        @link ||= @value[/<(.+)>/, 1]
+      end
+    end
+  end
+end

data/lib/buildkit/response/raise_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'buildkit/error'
 
@@ -7,8 +9,6 @@ module Buildkit
     # This class raises an Buildkit-flavored exception based
     # HTTP status codes returned by the API
     class RaiseError < Faraday::Response::Middleware
-      private
-
       def on_complete(response)
         if error = Buildkit::Error.from_response(response)
           raise error

data/lib/buildkit/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Buildkit
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.4.3'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: buildkit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
@@ -45,11 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,6 +57,7 @@ files:
 - bin/console
 - bin/setup
 - buildkit.gemspec
+- dev.yml
 - lib/buildkit.rb
 - lib/buildkit/client.rb
 - lib/buildkit/client/agents.rb
@@ -66,12 +67,14 @@ files:
 - lib/buildkit/client/organizations.rb
 - lib/buildkit/client/pipelines.rb
 - lib/buildkit/error.rb
+- lib/buildkit/header_link_parser.rb
 - lib/buildkit/response/raise_error.rb
 - lib/buildkit/version.rb
 homepage: https://github.com/shopify/buildkit
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -80,15 +83,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the Buildkite API

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-before_install: gem install bundler
-rvm:
-  - '2.1'
-  - '2.2'
-