buildkit 1.4.0 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bfeb459ca2ab1b4f33f68b3af71c8e5000a3c1d
-  data.tar.gz: 627be0e606c9781b8a1378630abceb8954ec49ae
+SHA256:
+  metadata.gz: b4bebd6dca7811f360f2b8bdc9c5a7ee3d8a99de357efd238696f63bf920d9be
+  data.tar.gz: 660b771a177a11b55b0e7b5c11b77adacbecd989db9a518fc5e9889141f759ba
 SHA512:
-  metadata.gz: 7ef6f8e563bccf36437c2def7676473a124a5f7a4a3cb9ef6f8cfaea8bf424d4a72c933c52714756928bbd14aed289cd17afc45aaed6fea1f7ff75502b2d445a
-  data.tar.gz: 733f57b132f8788603b8e618448769967c5f78daa5524ed8abc5b5e425d2b1199609b5fd62bdd222a313a3874d007da022802edd3026c7548d7402bc8a0399fe
+  metadata.gz: 8952141087e4b69e54ef1c2899d3198c178c6f2cf7ae62ffb80392f5761ac433e91e3890724725b19db557177ebc61f33798d34f67d5323e7139cd338516e088
+  data.tar.gz: '09917482121cc325df1765f50b7f83f7591936b2f9cc2548da46f8d83e8186c30a81b0cab52d201aa0a8233d9781fe6b18676c71be2870213b0369576ab0ad0d'

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', '3.0' ]
+    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.2
+  TargetRubyVersion: 2.3
 
 Metrics/LineLength:
   Max: 120
@@ -39,7 +39,7 @@ Lint/AssignmentInCondition:
 Style/PerlBackrefs:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 Style/TrailingCommaInArrayLiteral:

data/Gemfile

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'byebug'
 gem 'rake'
-gem 'rubocop'
 gem 'yard'
 
 group :test do
   gem 'rspec', '~> 3.2'
-  gem 'vcr', '~> 2.9', github: 'vcr/vcr', branch: 'master', ref: '480304be6d73803e6c4a0eb21a4ab4091da558d8'
+  gem 'rubocop', '~> 0.81.0'
+  gem 'vcr', '~> 3.0'
 end
 
 gemspec

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'

data/bin/console

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

data/buildkit.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'buildkit/version'
@@ -17,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.2'
+  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,8 +1,13 @@
+# frozen_string_literal: true
+
 require 'buildkit/version'
 require 'buildkit/client'
 
 module Buildkit
-  def self.new(*args)
-    Client.new(*args)
+  class << self
+    def new(*args)
+      Client.new(*args)
+    end
+    ruby2_keywords :new if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/buildkit/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sawyer'
 require 'buildkit/client/agents'
 require 'buildkit/client/builds'
@@ -18,7 +20,7 @@ module Buildkit
     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(%i[accept content_type])
@@ -139,11 +141,17 @@ module Buildkit
       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])
+
+        unescaped_next = CGI.unescape(link_header[:next])
+        path = next_page(unescaped_next)
       end
       response
     end
@@ -181,7 +189,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

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

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,31 @@ 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 = ''
+      documentation_text = "// See: #{documentation_url}" if documentation_url
+
+      <<~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
+        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

@@ -1,26 +1,30 @@
-module HeaderLinkParser
-  module_function
+# frozen_string_literal: true
 
-  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
+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
-  end
 
-  class LinkParser
-    def initialize(value)
-      @value = value
-    end
+    class LinkParser
+      def initialize(value)
+        @value = value
+      end
 
-    def name
-      @name ||= @value[/rel="(.*)"/, 1].to_sym
-    end
+      def name
+        @name ||= @value[/rel="(.*)"/, 1].to_sym
+      end
 
-    def link
-      @link ||= @value[/<(.+)>/, 1]
+      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.4.0'.freeze
+  VERSION = '1.4.5'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: buildkit
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.5
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2021-04-30 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
@@ -72,7 +73,8 @@ files:
 homepage: https://github.com/shopify/buildkit
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -81,15 +83,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+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.2'
-  - '2.3'
-