buildkiterb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c74759ca24a01e1c3014a40e390bf0e6856f6f822afbe9b3ec04ce4eedf47a3
-  data.tar.gz: 15155f0dd6b2925cd986ca1fe4f800070b14f532b26bdf75dd368c40996afdc0
+  metadata.gz: d17326f3ed42ef0a798a0716d1fa179f78ed88d9ba50e71577cd5178c3dd01ed
+  data.tar.gz: 389c4e4a122256db5c50c319ed842102f2590b85feb8ad46bef3074145ca77a1
 SHA512:
-  metadata.gz: 6471e3269bedfda857df898a96435d6b71759720880d4707e95ee1e9dd1d1eb54539446c9a05ada092413c7bc67327414781153ffec061dad8136c39d753ae04
-  data.tar.gz: 1424178e0527a785d2ac7b63d6632ee02fa7b8e19bae68e2a4a02dc15df3e0b04066395ba7de968a9db24df2c4be6f06dbaeb68a73b444e1fff65aa3cffe41be
+  metadata.gz: b9acd806d5629f3ecb086dc388eb3be47eead385a6e74f2b2af3cf7150192c655c559b79a938171aff07af389428d59554ebe9af8e60c2121f14ba3cc7bcaf74
+  data.tar.gz: 9936c96c5bc35e1d59e4b4d50c53c3d7b440e17762b833d6f477a8f00a18195c6a9a5ad940cb01ffe957e3ac1a79e3d22c815ca808688d7f3d787283f556f84c

data/.env.example

@@ -1 +1 @@
-ACCESS_TOKEN=
+API_TOKEN=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkiterb (0.1.0)
+    buildkiterb (0.2.0)
       faraday (~> 2.0)
 
 GEM

data/README.md

@@ -18,7 +18,17 @@ Firstly you'll need to create an API Token on [Buildkite](https://buildkite.com/
 and then set it like so: 
 
 ```ruby
-@client = Buildkite::Client.new(access_token: "")
+@client = Buildkite::Client.new(token: "abc123")
+```
+
+### Access Token
+
+```ruby
+# Get details of the current token
+@client.access_token.get
+
+# Revoke the current token
+@client.access_token.revoke
 ```
 
 ### Organizations
@@ -31,6 +41,140 @@ and then set it like so:
 @client.organizations.get slug: "my-org-slug"
 ```
 
+### Pipelines
+
+```ruby
+# List all pipelines for an org
+@client.pipelines.list org: "org-slug"
+#=> #<Buildkite::Collection...
+
+# Get a pipeline
+@client.pipelines.get org: "org-slug", slug: "pipeline-slug"
+
+# 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: {}
+
+# Update a pipeline
+# Docs: https://buildkite.com/docs/apis/rest-api/pipelines#update-a-pipeline
+@client.pipelines.update org: "org-slug", slug: "my-pipeline", {}
+
+# Archive a pipeline
+@client.pipelines.archive org: "org-slug", slug: "my-pipeline"
+
+# Unarchive a pipeline
+@client.pipelines.unarchive org: "org-slug", slug: "my-pipeline"
+
+# Delete a pipeline
+@client.pipelines.delete org: "org-slug", slug: "my-pipeline"
+
+# Setup automatic webhooks
+# Returns 422 if not supported or cannot be done
+@client.pipelines.webhook org: "org-slug", slug: "my-pipeline"
+```
+
+### Builds
+
+```ruby
+# List all builds
+@client.builds.list
+
+# List all builds for an org
+@client.builds.list org: "org-slug"
+
+# List all builds for a pipeline
+@client.builds.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
+
+# 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"
+
+# Cancel a build
+@client.builds.cancel org: "org-slug", pipeline: "pipeline-slug", number: 123
+
+# Rebuild a build
+@client.builds.rebuild org: "org-slug", pipeline: "pipeline-slug", number: 123
+```
+
+### Agents
+
+```ruby
+# List all agents for an org
+@client.agents.list org: "org-slug"
+
+# Get an agent
+@client.agents.get org: "org-slug", id: "abc123"
+
+# Stop an agent
+# To force an agent to stop, add `force: true`
+@client.agents.get org: "org-slug", id: "abc123"
+```
+
+### Jobs
+
+```ruby
+# Retry a job
+@client.jobs.retry org: "org-slug", 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", {}
+
+# Get a job's logs
+@client.jobs.log org: "org-slug", 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"
+
+# Get a job's environment variables
+@client.jobs.env org: "org-slug", 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
+```
+
+### Artifacts
+
+```ruby
+# List artifacts for a build
+@client.artifacts.list org: "org-slug", pipeline: "pipeline-slug", number: 123
+
+# List artifacts for a build job
+@client.artifacts.list org: "org-slug", 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"
+
+# Download an artifact
+@client.artifacts.download org: "org-slug", 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"
+```
+
+### Emojis
+
+```ruby
+# List emojis for an organization
+@client.emojis.list org: "org-slug"
+```
+
+### User
+
+```ruby
+# Get the current user
+@client.user.get
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/buildkiterb.

data/bin/console

@@ -13,7 +13,7 @@ require 'dotenv/load'
 # require "pry"
 # Pry.start
 
-@client = Buildkite::Client.new(access_token: ENV["ACCESS_TOKEN"])
+@client = Buildkite::Client.new(token: ENV["API_TOKEN"])
 
 require "irb"
 IRB.start(__FILE__)

data/lib/buildkite/client.rb

@@ -2,23 +2,59 @@ module Buildkite
   class Client
     BASE_URL = "https://api.buildkite.com/v2"
 
-    attr_reader :access_token, :adapter
+    attr_reader :token, :adapter
 
-    def initialize(access_token:, adapter: Faraday.default_adapter, stubs: nil)
-      @access_token = access_token
+    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
+
     def organizations
       OrganizationsResource.new(self)
     end
 
+    def pipelines
+      PipelinesResource.new(self)
+    end
+
+    def builds
+      BuildsResource.new(self)
+    end
+
+    def jobs
+      JobsResource.new(self)
+    end
+
+    def agents
+      AgentsResource.new(self)
+    end
+
+    def artifacts
+      ArtifactsResource.new(self)
+    end
+
+    def annotations
+      AnnotationsResource.new(self)
+    end
+
+    def emojis
+      EmojisResource.new(self)
+    end
+
+    def user
+      UserResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
-        conn.request :authorization, :Bearer, access_token
+        conn.request :authorization, :Bearer, token
         
         conn.headers = {
           "User-Agent" => "buildkiterb/v#{VERSION} (github.com/deanpcmad/buildkiterb)"

data/lib/buildkite/objects/access_token.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class AccessToken < Object
+  end
+end

data/lib/buildkite/objects/agent.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Agent < Object
+  end
+end

data/lib/buildkite/objects/annotation.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Annotation < Object
+  end
+end

data/lib/buildkite/objects/artifact.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Artifact < Object
+  end
+end

data/lib/buildkite/objects/artifact_download.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class ArtifactDownload < Object
+  end
+end

data/lib/buildkite/objects/build.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Build < Object
+  end
+end

data/lib/buildkite/objects/emoji.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Emoji < Object
+  end
+end

data/lib/buildkite/objects/job.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Job < Object
+  end
+end

data/lib/buildkite/objects/job_env.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class JobEnv < Object
+  end
+end

data/lib/buildkite/objects/job_log.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class JobLog < Object
+  end
+end

data/lib/buildkite/objects/pipeline.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class Pipeline < Object
+  end
+end

data/lib/buildkite/objects/user.rb

@@ -0,0 +1,4 @@
+module Buildkite
+  class User < Object
+  end
+end

data/lib/buildkite/resource.rb

@@ -33,23 +33,23 @@ module Buildkite
       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["error"]}'"
+        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["error"]}'"
+        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["error"]}'"
+        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 422
         raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}"
       when 429
-        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
+        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["error"]}'"
+        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["error"]}'"
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["message"]}'"
       when 204
-        # 204 is a response for success on Twitch's API
+        # 204 is a response for success
         return true
       end
 

data/lib/buildkite/resources/access_token.rb

@@ -0,0 +1,13 @@
+module Buildkite
+  class AccessTokenResource < Resource
+    
+    def get
+      AccessToken.new get_request("access-token").body
+    end
+
+    def revoke
+      delete_request("access-token")
+    end
+
+  end
+end

data/lib/buildkite/resources/agents.rb

@@ -0,0 +1,18 @@
+module Buildkite
+  class AgentsResource < Resource
+    
+    def list(org:)
+      response = get_request("organizations/#{org}/agents")
+      Collection.from_response(response, type: Agent)
+    end
+
+    def get(org:, id:)
+      Agent.new get_request("organizations/#{org}/agents/#{id}").body
+    end
+
+    def stop(org:, id:, **args)
+      put_request("organizations/#{org}/agents/#{id}/stop", body: args)
+    end
+
+  end
+end

data/lib/buildkite/resources/annotations.rb

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

data/lib/buildkite/resources/artifacts.rb

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

data/lib/buildkite/resources/builds.rb

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

data/lib/buildkite/resources/emojis.rb

@@ -0,0 +1,10 @@
+module Buildkite
+  class EmojisResource < Resource
+    
+    def list(org:)
+      response = get_request("organizations/#{org}/emojis")
+      Collection.from_response(response, type: Emoji)
+    end
+
+  end
+end

data/lib/buildkite/resources/jobs.rb

@@ -0,0 +1,25 @@
+module Buildkite
+  class JobsResource < Resource
+
+    def retry(org:, pipeline:, number:, job:)
+      Job.new put_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/jobs/#{job}/retry", body: {}).body
+    end
+
+    def unblock(org:, pipeline:, number:, job:, **args)
+      Job.new put_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/jobs/#{job}/unblock", body: args).body
+    end
+
+    def log(org:, pipeline:, number:, job:)
+      JobLog.new get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/jobs/#{job}/log").body
+    end
+
+    def delete_log(org:, pipeline:, number:, job:)
+      delete_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/jobs/#{job}/log")
+    end
+
+    def env(org:, pipeline:, number:, job:)
+      JobEnv.new get_request("organizations/#{org}/pipelines/#{pipeline}/builds/#{number}/jobs/#{job}/env").body["env"]
+    end
+
+  end
+end

data/lib/buildkite/resources/pipelines.rb

@@ -0,0 +1,39 @@
+module Buildkite
+  class PipelinesResource < Resource
+    
+    def list(org:)
+      response = get_request("organizations/#{org}/pipelines")
+      Collection.from_response(response, type: Pipeline)
+    end
+
+    def get(org:, slug:)
+      Pipeline.new get_request("organizations/#{org}/pipelines/#{slug}").body
+    end
+
+    def create(org:, name:, repository:, configuration:, **args)
+      data = {name: name, repository: repository, configuration: configuration}
+      Pipeline.new post_request("organizations/#{org}/pipelines", body: data.merge(args)).body
+    end
+
+    def update(org:, slug:, **args)
+      Pipeline.new patch_request("organizations/#{org}/pipelines/#{slug}", body: args).body
+    end
+
+    def archive(org:, slug:)
+      Pipeline.new post_request("organizations/#{org}/pipelines/#{slug}/archive", body: {}).body
+    end
+
+    def unarchive(org:, slug:)
+      Pipeline.new post_request("organizations/#{org}/pipelines/#{slug}/unarchive", body: {}).body
+    end
+
+    def delete(org:, slug:)
+      delete_request("organizations/#{org}/pipelines/#{slug}")
+    end
+
+    def webhook(org:, slug:)
+      post_request("organizations/#{org}/pipelines/#{slug}/webhook", body: {})
+    end
+
+  end
+end

data/lib/buildkite/resources/user.rb

@@ -0,0 +1,9 @@
+module Buildkite
+  class UserResource < Resource
+    
+    def get
+      User.new get_request("user").body
+    end
+
+  end
+end

data/lib/buildkite/version.rb

@@ -1,3 +1,3 @@
 module Buildkite
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/buildkite.rb

@@ -10,9 +10,29 @@ module Buildkite
   autoload :Resource, "buildkite/resource"
   autoload :Object, "buildkite/object"
   
-
+  autoload :AccessTokenResource, "buildkite/resources/access_token"
   autoload :OrganizationsResource, "buildkite/resources/organizations"
+  autoload :PipelinesResource, "buildkite/resources/pipelines"
+  autoload :BuildsResource, "buildkite/resources/builds"
+  autoload :JobsResource, "buildkite/resources/jobs"
+  autoload :AgentsResource, "buildkite/resources/agents"
+  autoload :AnnotationsResource, "buildkite/resources/annotations"
+  autoload :ArtifactsResource, "buildkite/resources/artifacts"
+  autoload :EmojisResource, "buildkite/resources/emojis"
+  autoload :UserResource, "buildkite/resources/user"
 
+  autoload :AccessToken, "buildkite/objects/access_token"
   autoload :Organization, "buildkite/objects/organization"
+  autoload :Pipeline, "buildkite/objects/pipeline"
+  autoload :Build, "buildkite/objects/build"
+  autoload :Job, "buildkite/objects/job"
+  autoload :JobLog, "buildkite/objects/job_log"
+  autoload :JobEnv, "buildkite/objects/job_env"
+  autoload :Agent, "buildkite/objects/agent"
+  autoload :Annotation, "buildkite/objects/annotation"
+  autoload :Artifact, "buildkite/objects/artifact"
+  autoload :ArtifactDownload, "buildkite/objects/artifact_download"
+  autoload :Emoji, "buildkite/objects/emoji"
+  autoload :User, "buildkite/objects/user"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkiterb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -48,9 +48,30 @@ files:
 - lib/buildkite/collection.rb
 - lib/buildkite/error.rb
 - lib/buildkite/object.rb
+- lib/buildkite/objects/access_token.rb
+- lib/buildkite/objects/agent.rb
+- lib/buildkite/objects/annotation.rb
+- lib/buildkite/objects/artifact.rb
+- lib/buildkite/objects/artifact_download.rb
+- lib/buildkite/objects/build.rb
+- lib/buildkite/objects/emoji.rb
+- lib/buildkite/objects/job.rb
+- lib/buildkite/objects/job_env.rb
+- lib/buildkite/objects/job_log.rb
 - lib/buildkite/objects/organization.rb
+- lib/buildkite/objects/pipeline.rb
+- lib/buildkite/objects/user.rb
 - lib/buildkite/resource.rb
+- lib/buildkite/resources/access_token.rb
+- lib/buildkite/resources/agents.rb
+- lib/buildkite/resources/annotations.rb
+- lib/buildkite/resources/artifacts.rb
+- lib/buildkite/resources/builds.rb
+- lib/buildkite/resources/emojis.rb
+- lib/buildkite/resources/jobs.rb
 - lib/buildkite/resources/organizations.rb
+- lib/buildkite/resources/pipelines.rb
+- lib/buildkite/resources/user.rb
 - lib/buildkite/version.rb
 - lib/buildkiterb.rb
 homepage: https://deanpcmad.com