buildkiterb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d17326f3ed42ef0a798a0716d1fa179f78ed88d9ba50e71577cd5178c3dd01ed
-  data.tar.gz: 389c4e4a122256db5c50c319ed842102f2590b85feb8ad46bef3074145ca77a1
+  metadata.gz: f6ecaa3ffea095a7da23de6dac919c1eef744c42d645d75288ae2a3411f4e10c
+  data.tar.gz: 2a03c413f50559febd8d3f4432640153af6e380028a1ba39a42757ec1cb528ea
 SHA512:
-  metadata.gz: b9acd806d5629f3ecb086dc388eb3be47eead385a6e74f2b2af3cf7150192c655c559b79a938171aff07af389428d59554ebe9af8e60c2121f14ba3cc7bcaf74
-  data.tar.gz: 9936c96c5bc35e1d59e4b4d50c53c3d7b440e17762b833d6f477a8f00a18195c6a9a5ad940cb01ffe957e3ac1a79e3d22c815ca808688d7f3d787283f556f84c
+  metadata.gz: 8e4d2348ff0f7ab4418e78c5a273b63dce1d441cf50a39cdd6d5dcf5632413aa25d54d55b61cb627f3d56d41b54ec941ecaa526fee633313541e022b17808e2e
+  data.tar.gz: f8e8a39511244f94c497b6443d0acc9b7d37c8ef2a375be3ba1ed2df485584c4025153f9577dd38f0d2d7c9b1202c6b67f97a3872e7f96c0d6b7beac44682b82

data/.env.example

@@ -1 +1,2 @@
-API_TOKEN=
+BUILDKITE_TOKEN=
+BUILDKITE_ORG=

data/.github/workflows/ci.yml

@@ -7,12 +7,12 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - 2.6
           - 2.7
           - 3.0
           - 3.1
+          - 3.2
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}

data/Gemfile

@@ -5,4 +5,6 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
-gem "dotenv"
+gem "dotenv"
+
+gem "vcr"

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    buildkiterb (0.2.0)
+    buildkiterb (1.0.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     dotenv (2.7.6)
-    faraday (2.7.4)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     minitest (5.15.0)
     rake (12.3.3)
     ruby2_keywords (0.0.5)
+    vcr (6.2.0)
 
 PLATFORMS
   ruby
@@ -24,6 +25,7 @@ DEPENDENCIES
   dotenv
   minitest (~> 5.0)
   rake (~> 12.0)
+  vcr
 
 BUNDLED WITH
    2.3.21

data/README.md

@@ -15,164 +15,235 @@ gem "buildkiterb"
 ### Set Client Details
 
 Firstly you'll need to create an API Token on [Buildkite](https://buildkite.com/user/api-access-tokens)
-and then set it like so: 
+and then configure it like below.
+
+Buildkite tokens are created for a single organization now, so I recommend setting the `org` the same way,
+to tidy up your code.
+
+You can optionally set a pipeline too.
 
 ```ruby
-@client = Buildkite::Client.new(token: "abc123")
+Buildkite.configure do |config|
+  config.token    = ENV["BUILDKITE_TOKEN"]
+  config.org      = ENV["BUILDKITE_ORG"]
+  config.pipeline = ENV["BUILDKITE_PIPELINE"]
+end
+
 ```
 
 ### Access Token
 
 ```ruby
 # Get details of the current token
-@client.access_token.get
+Buildkite::AccessToken.retrieve
 
 # Revoke the current token
-@client.access_token.revoke
+Buildkite::AccessToken.revoke
 ```
 
 ### Organizations
 
 ```ruby
-# List all of your organizations
-@client.organizations.list
-
 # Retrieves an organization
-@client.organizations.get slug: "my-org-slug"
+Buildkite::Organization.get slug: "my-org-slug"
 ```
 
 ### Pipelines
 
 ```ruby
 # List all pipelines for an org
-@client.pipelines.list org: "org-slug"
+Buildkite::Pipeline.list
 #=> #<Buildkite::Collection...
 
 # Get a pipeline
-@client.pipelines.get org: "org-slug", slug: "pipeline-slug"
+Buildkite::Pipeline.retrieve pipeline: "my pipeline"
 
 # Create a Pipeline. View the 2 docs links for the correct params
 # Docs: https://buildkite.com/docs/apis/rest-api/pipelines#create-a-yaml-pipeline
 # Docs: https://buildkite.com/docs/apis/rest-api/pipelines#create-a-visual-step-pipeline
-@client.pipelines.create org: "org-slug", name: "my pipeline", repository: "git@github.com:user/repo.git", configuration: {}
+Buildkite::Pipeline.create name: "my pipeline", repository: "git@github.com:user/repo.git", configuration: {}
 
 # Update a pipeline
 # Docs: https://buildkite.com/docs/apis/rest-api/pipelines#update-a-pipeline
-@client.pipelines.update org: "org-slug", slug: "my-pipeline", {}
+Buildkite::Pipeline.update pipeline: "my-pipeline", {}
 
 # Archive a pipeline
-@client.pipelines.archive org: "org-slug", slug: "my-pipeline"
+Buildkite::Pipeline.archive pipeline: "my-pipeline"
 
 # Unarchive a pipeline
-@client.pipelines.unarchive org: "org-slug", slug: "my-pipeline"
+Buildkite::Pipeline.unarchive pipeline: "my-pipeline"
 
 # Delete a pipeline
-@client.pipelines.delete org: "org-slug", slug: "my-pipeline"
+Buildkite::Pipeline.delete pipeline: "my-pipeline"
 
 # Setup automatic webhooks
 # Returns 422 if not supported or cannot be done
-@client.pipelines.webhook org: "org-slug", slug: "my-pipeline"
+Buildkite::Pipeline.webhook pipeline: "my-pipeline"
 ```
 
 ### Builds
 
 ```ruby
 # List all builds
-@client.builds.list
+Buildkite::Build.list
 
 # List all builds for an org
-@client.builds.list org: "org-slug"
+Buildkite::Build.list org: "org-slug"
 
 # List all builds for a pipeline
-@client.builds.list org: "org-slug", pipeline: "pipeline-slug"
+Buildkite::Build.list org: "org-slug", pipeline: "pipeline-slug"
 
 # Get a build
 # The Build Number is used, not the ID
-@client.builds.get org: "org-slug", pipeline: "pipeline-slug", number: 123
+Buildkite::Build.retrieve pipeline: "pipeline-slug", number: 123
 
 # Create a Build
 # Docs: https://buildkite.com/docs/apis/rest-api/builds#create-a-build
-@client.builds.create org: "org-slug", pipeline: "pipeline-slug", commit: "abc123", branch: "master"
+Buildkite::Build.create pipeline: "pipeline-slug", commit: "abc123", branch: "master"
 
 # Cancel a build
-@client.builds.cancel org: "org-slug", pipeline: "pipeline-slug", number: 123
+Buildkite::Build.cancel pipeline: "pipeline-slug", number: 123
 
 # Rebuild a build
-@client.builds.rebuild org: "org-slug", pipeline: "pipeline-slug", number: 123
+Buildkite::Build.rebuild pipeline: "pipeline-slug", number: 123
 ```
 
 ### Agents
 
 ```ruby
 # List all agents for an org
-@client.agents.list org: "org-slug"
+Buildkite::Agent.list
 
 # Get an agent
-@client.agents.get org: "org-slug", id: "abc123"
+Buildkite::Agent.retrieve id: "abc123"
 
 # Stop an agent
 # To force an agent to stop, add `force: true`
-@client.agents.get org: "org-slug", id: "abc123"
+Buildkite::Agent.stop id: "abc123"
+```
+
+### Clusters
+
+```ruby
+# List all clusters for an org
+Buildkite::Cluster.list
+
+# Get a cluster
+Buildkite::Cluster.retrieve id: "abc123"
+
+# Create a cluster
+Buildkite::Cluster.create name: "Open Source"
+
+# Update a cluster
+Buildkite::Cluster.update id: "abc123", description: "A cluster for our Open Source projects"
+
+# Delete a cluster
+Buildkite::Cluster.delete id: "abc123"
 ```
 
+### Cluster Queues
+
+```ruby
+# List all queues for a cluster
+Buildkite::ClusterQueue.list cluster: "abc123",
+
+# Get a cluster queue
+Buildkite::ClusterQueue.retrieve cluster: "abc123", id: "abc123"
+
+# Create a cluster queue
+Buildkite::ClusterQueue.create cluster: "abc123", key: "arm64"
+
+# Update a cluster queue
+Buildkite::ClusterQueue.update cluster: "abc123", id: "abc123", description: "For ARM64 builds"
+
+# Pause a cluster queue
+Buildkite::ClusterQueue.pause cluster: "abc123", id: "abc123", note: "For maintenance"
+
+# Unpause a cluster queue
+Buildkite::ClusterQueue.unpause cluster: "abc123", id: "abc123"
+
+# Delete a cluster queue
+Buildkite::ClusterQueue.delete cluster: "abc123", id: "abc123"
+```
+
+### Cluster Tokens
+
+```ruby
+# List all tokens for a cluster
+Buildkite::ClusterToken.list cluster: "abc123",
+
+# Get a cluster token
+Buildkite::ClusterToken.retrieve cluster: "abc123", id: "abc123"
+
+# Create a cluster token
+Buildkite::ClusterToken.create cluster: "abc123", description: "Windows Agents"
+
+# Update a cluster token
+Buildkite::ClusterToken.update cluster: "abc123", id: "abc123", allowed_ip_addresses: "1.1.1.1"
+
+# Delete a cluster token
+Buildkite::ClusterToken.delete cluster: "abc123", id: "abc123"
+```
+
+
 ### Jobs
 
 ```ruby
 # Retry a job
-@client.jobs.retry org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123"
+Buildkite::Job.retry pipeline: "pipeline-slug", number: 123, job: "abc123"
 
 # Unblock a job
 # Docs: https://buildkite.com/docs/apis/rest-api/jobs#unblock-a-job
-@client.jobs.unblock org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123", {}
+Buildkite::Job.unblock pipeline: "pipeline-slug", number: 123, job: "abc123", {}
 
 # Get a job's logs
-@client.jobs.log org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123"
+Buildkite::Job.log pipeline: "pipeline-slug", number: 123, job: "abc123"
 
 # Delete a job's log
-@client.jobs.delete_log org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123"
+Buildkite::Job.delete_log pipeline: "pipeline-slug", number: 123, job: "abc123"
 
 # Get a job's environment variables
-@client.jobs.env org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123"
+Buildkite::Job.env pipeline: "pipeline-slug", number: 123, job: "abc123"
 ```
 
 ### Annotations
 
 ```ruby
 # List annotations for a build
-@client.annotations.list org: "org-slug", pipeline: "pipeline-slug", number: 123
+Buildkite::Annotation.list pipeline: "pipeline-slug", number: 123
 ```
 
 ### Artifacts
 
 ```ruby
 # List artifacts for a build
-@client.artifacts.list org: "org-slug", pipeline: "pipeline-slug", number: 123
+Buildkite::Artifact.list pipeline: "pipeline-slug", number: 123
 
 # List artifacts for a build job
-@client.artifacts.list org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123"
+Buildkite::Artifact.list pipeline: "pipeline-slug", number: 123, job: "abc123"
 
 # Get an artifact
-@client.artifacts.get org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
+Buildkite::Artifact.retrieve pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
 
 # Download an artifact
-@client.artifacts.download org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
+Buildkite::Artifact.download pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
 
 # Delete an artifact
-@client.artifacts.delete org: "org-slug", pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
+Buildkite::Artifact.delete pipeline: "pipeline-slug", number: 123, job: "abc123", id: "123abc"
 ```
 
 ### Emojis
 
 ```ruby
 # List emojis for an organization
-@client.emojis.list org: "org-slug"
+Buildkite::Emoji.list
 ```
 
 ### User
 
 ```ruby
 # Get the current user
-@client.user.get
+Buildkite::User.retrieve
 ```
 
 ## Contributing

data/bin/console

@@ -13,7 +13,10 @@ require 'dotenv/load'
 # require "pry"
 # Pry.start
 
-@client = Buildkite::Client.new(token: ENV["API_TOKEN"])
+Buildkite.configure do |config|
+  config.token = ENV["BUILDKITE_TOKEN"]
+  config.org   = ENV["BUILDKITE_ORG"]
+end
 
 require "irb"
 IRB.start(__FILE__)

data/lib/buildkite/client.rb

@@ -1,70 +1,69 @@
 module Buildkite
   class Client
-    BASE_URL = "https://api.buildkite.com/v2"
-
-    attr_reader :token, :adapter
-
-    def initialize(token:, adapter: Faraday.default_adapter, stubs: nil)
-      @token = token
-      @adapter = adapter
 
-      # Test stubs for requests
-      @stubs = stubs
-    end
-
-    def access_token
-      AccessTokenResource.new(self)
-    end
+    BASE_URL = "https://api.buildkite.com/v2"
 
-    def organizations
-      OrganizationsResource.new(self)
-    end
+    class << self
 
-    def pipelines
-      PipelinesResource.new(self)
-    end
+      def connection
+        @connection ||= Faraday.new(BASE_URL) do |conn|
+          conn.request :authorization, :Bearer, Buildkite.config.token
 
-    def builds
-      BuildsResource.new(self)
-    end
+          conn.headers = {
+            "User-Agent" => "buildkiterb/v#{VERSION} (github.com/deanpcmad/buildkiterb)"
+          }
 
-    def jobs
-      JobsResource.new(self)
-    end
+          conn.request :json
 
-    def agents
-      AgentsResource.new(self)
-    end
-
-    def artifacts
-      ArtifactsResource.new(self)
-    end
+          conn.response :json, content_type: "application/json"
+        end
+      end
 
-    def annotations
-      AnnotationsResource.new(self)
-    end
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
 
-    def emojis
-      EmojisResource.new(self)
-    end
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(url, body, headers)
+      end
 
-    def user
-      UserResource.new(self)
-    end
+      def put_request(url, body:, headers: {})
+        handle_response connection.put(url, body, headers)
+      end
 
-    def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
-        conn.request :authorization, :Bearer, token
-        
-        conn.headers = {
-          "User-Agent" => "buildkiterb/v#{VERSION} (github.com/deanpcmad/buildkiterb)"
-        }
-        
-        conn.request :json
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
 
-        conn.response :json, content_type: "application/json"
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
 
-        conn.adapter adapter, @stubs
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["message"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request. '#{response.body["message"]}'"
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["message"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["message"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["message"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["message"]}'"
+        when 204
+          return true
+        end
+
+        response
       end
     end
 

data/lib/buildkite/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Buildkite
+  class Configuration
+
+    attr_accessor :token
+    attr_accessor :org
+    attr_accessor :pipeline
+
+  end
+end

data/lib/buildkite/models/access_token.rb

@@ -0,0 +1,18 @@
+module Buildkite
+  class AccessToken < Object
+
+    class << self
+
+      def retrieve
+        response = Client.get_request("access-token")
+        AccessToken.new response.body
+      end
+
+      def revoke
+        Client.delete_request("access-token")
+      end
+
+    end
+
+  end
+end

data/lib/buildkite/models/agent.rb

@@ -0,0 +1,23 @@
+module Buildkite
+  class Agent < Object
+
+    class << self
+
+      def list(org: Buildkite.config.org)
+        response = Client.get_request("organizations/#{org}/agents")
+        Collection.from_response(response, type: Agent)
+      end
+
+      def retrieve(org: Buildkite.config.org, id:)
+        response = Client.get_request("organizations/#{org}/agents/#{id}")
+        Agent.new response.body
+      end
+
+      def stop(org: Buildkite.config.org, id:, **args)
+        Client.put_request("organizations/#{org}/agents/#{id}/stop", body: args)
+      end
+
+    end
+
+  end
+end

data/lib/buildkite/models/annotation.rb

@@ -0,0 +1,14 @@
+module Buildkite
+  class Annotation < Object
+
+    class << self
+
+      def list(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, build:)
+        response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/annotations")
+        Collection.from_response(response, type: Annotation)
+      end
+
+    end
+
+  end
+end

data/lib/buildkite/models/artifact.rb

@@ -0,0 +1,33 @@
+module Buildkite
+  class Artifact < Object
+
+    class << self
+
+      def list(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, build:, job: nil)
+        if job
+          response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/artifacts")
+        else
+          response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/artifacts")
+        end
+
+        Collection.from_response(response, type: Artifact)
+      end
+
+      def retrieve(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, build:, job:, id:)
+        response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/artifacts/#{id}")
+        Artifact.new response.body
+      end
+
+      def download(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, build:, job:, id:)
+        response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/artifacts/#{id}/download")
+        ArtifactDownload.new response.body
+      end
+
+      def delete(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, build:, job:, id:)
+        Client.delete_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{build}/jobs/#{job}/artifacts/#{id}")
+      end
+
+    end
+
+  end
+end

data/lib/buildkite/models/build.rb

@@ -0,0 +1,44 @@
+module Buildkite
+  class Build < Object
+
+    class << self
+
+      def list(org: nil, pipeline: nil)
+        if org && pipeline
+          response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds")
+        elsif org
+          response = Client.get_request("organizations/#{org}/builds")
+        else
+          response = Client.get_request("builds")
+        end
+
+        if response
+          Collection.from_response(response, type: Build)
+        end
+      end
+
+      def retrieve(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, number:)
+        response = Client.get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}")
+        Build.new response.body
+      end
+
+      def create(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, commit:, branch:, **args)
+        data = {commit: commit, branch: branch}
+        response = Client.post_request("organizations/#{org}/pipelines/#{pipeline}/builds", body: data.merge(args))
+        Build.new response.body
+      end
+
+      def cancel(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, number:)
+        response = Client.put_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/cancel", body: {})
+        Build.new response.body
+      end
+
+      def rebuild(org: Buildkite.config.org, pipeline: Buildkite.config.pipeline, number:)
+        response = Client.put_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/rebuild", body: {})
+        Build.new response.body
+      end
+
+    end
+
+  end
+end

data/lib/buildkite/models/cluster.rb

@@ -0,0 +1,34 @@
+module Buildkite
+  class Cluster < Object
+
+    class << self
+
+      def list(org: Buildkite.config.org)
+        response = Client.get_request("organizations/#{org}/clusters")
+        Collection.from_response(response, type: Cluster)
+      end
+
+      def retrieve(org: Buildkite.config.org, id:)
+        response = Client.get_request("organizations/#{org}/clusters/#{id}")
+        Cluster.new response.body
+      end
+
+      def create(org: Buildkite.config.org, name:, **args)
+        data = {name: name}
+        response = Client.post_request("organizations/#{org}/clusters", body: data.merge(args))
+        Cluster.new response.body
+      end
+
+      def update(org: Buildkite.config.org, id:, **args)
+        response = Client.patch_request("organizations/#{org}/clusters/#{id}", body: args)
+        Cluster.new response.body
+      end
+
+      def delete(org: Buildkite.config.org, id:)
+        Client.delete_request("organizations/#{org}/clusters/#{id}")
+      end
+
+    end
+
+  end
+end