buildkit 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c6dff3c82bb149b2cdc144fd406166383677156
-  data.tar.gz: 546b10638c5c057c039938453c91f950c39762a6
+  metadata.gz: 6bfeb459ca2ab1b4f33f68b3af71c8e5000a3c1d
+  data.tar.gz: 627be0e606c9781b8a1378630abceb8954ec49ae
 SHA512:
-  metadata.gz: fc285edc5ef194f29f87ffbe771fcd624d1f629d651c90f119a077d22a3fbf4b6393a1c2bb8d3e16a5ab0876be5ac3f35490fcb856d8d24e78ad6ccbf18ca8d8
-  data.tar.gz: 91d612ddcc59751858f38788fd8e882847ff03863149aaa00534cdeebb85b07635ce0f040a87526cf817d7bc9f6db1812cefff92d6ffb5c83eb1c99798a3694a
+  metadata.gz: 7ef6f8e563bccf36437c2def7676473a124a5f7a4a3cb9ef6f8cfaea8bf424d4a72c933c52714756928bbd14aed289cd17afc45aaed6fea1f7ff75502b2d445a
+  data.tar.gz: 733f57b132f8788603b8e618448769967c5f78daa5524ed8abc5b5e425d2b1199609b5fd62bdd222a313a3874d007da022802edd3026c7548d7402bc8a0399fe

data/.rubocop.yml

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

data/.travis.yml

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

data/buildkit.gemspec

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'buildkit/version'
 
@@ -19,7 +17,7 @@ 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.required_ruby_version = '>= 2.2'
 
   spec.add_dependency 'sawyer', '~> 0.6'
   spec.add_development_dependency 'bundler'

data/lib/buildkit/client.rb

@@ -6,6 +6,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,6 +16,7 @@ module Buildkit
     include Pipelines
     include Jobs
     include Artifacts
+    include HeaderLinkParser
 
     DEFAULT_ENDPOINT = 'https://api.buildkite.com/v2/'.freeze
 
@@ -24,6 +26,8 @@ module Buildkit
     # 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 +40,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 +53,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 +118,46 @@ 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
+        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}"

data/lib/buildkit/client/artifacts.rb

@@ -13,6 +13,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/header_link_parser.rb

@@ -0,0 +1,26 @@
+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

data/lib/buildkit/version.rb

@@ -1,3 +1,3 @@
 module Buildkit
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkit
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
@@ -66,6 +66,7 @@ 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
@@ -80,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="