unofficial_buildkite_client 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 46138fea6beff276a6d3a7068364c97ad27e5249805201c24d5594ac97e4f04c
4
+ data.tar.gz: 15bf7b5bee8aa97bd298ea017f99e5ee1323c4c357bbbbc8b2a8e1c72e8a9f66
5
+ SHA512:
6
+ metadata.gz: 1ecb6591cdabffabd41a05b54f2e4d4bd4530c951a18929d3a64911d6ba78808282972d96332021874c7787010087ed7b82e27fb5905867a3bb6b0fd6d3f4139
7
+ data.tar.gz: 18411ee2a1a57a5cbc117f28d57ae02c55b23d0f33000b64d17fd8d36312393d501c56e531cea4dcd679417512f5580c68cf5c3a3b691e7887f09cfb1903d958
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ *.env
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ - Using welcoming and inclusive language
18
+ - Being respectful of differing viewpoints and experiences
19
+ - Gracefully accepting constructive criticism
20
+ - Focusing on what is best for the community
21
+ - Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ - The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ - Trolling, insulting/derogatory comments, and personal or political attacks
28
+ - Public or private harassment
29
+ - Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ - Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at mtsmfm@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in unofficial_buildkite_client.gemspec
6
+ gemspec
7
+
8
+ gem "pry-byebug"
data/Gemfile.lock ADDED
@@ -0,0 +1,30 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ unofficial_buildkite_client (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ byebug (11.0.1)
10
+ coderay (1.1.2)
11
+ method_source (0.9.2)
12
+ pry (0.12.2)
13
+ coderay (~> 1.1.0)
14
+ method_source (~> 0.9.0)
15
+ pry-byebug (3.7.0)
16
+ byebug (~> 11.0)
17
+ pry (~> 0.10)
18
+ rake (10.5.0)
19
+
20
+ PLATFORMS
21
+ ruby
22
+
23
+ DEPENDENCIES
24
+ bundler (~> 1.17)
25
+ pry-byebug
26
+ rake (~> 10.0)
27
+ unofficial_buildkite_client!
28
+
29
+ BUNDLED WITH
30
+ 1.17.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Fumiaki MATSUSHIMA
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # UnofficialBuildkiteClient
2
+
3
+ Unofficial [Buildkite](https://buildkite.com) API client.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'unofficial_buildkite_client'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install unofficial_buildkite_client
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ ENV["BUILDKITE_ACCESS_TOKEN"] = "xxxxxxxxxxxxxxx"
25
+ client = UnofficialBuildkiteClient.new(org_slug: "rails", pipeline_slug: "rails")
26
+ # or
27
+ # client = UnofficialBuildkiteClient.new(access_token: "xxxxxxxxxxxxxx", org_slug: "rails", pipeline_slug: "rails")
28
+ builds = client.fetch_builds(created_at_from: "2019-04-19T07:00", first: 1, state: ["FAILED", "PASSED"])
29
+ build = client.fetch_build(number: builds.first[:number])
30
+ job = build[:jobs].first
31
+ log = client.fetch_log(build_number: job[:build_number], job_id: job[:id])
32
+ ```
33
+
34
+ ## Development
35
+
36
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
37
+
38
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
39
+
40
+ ## Contributing
41
+
42
+ Bug reports and pull requests are welcome on GitHub at https://github.com/mtsmfm/unofficial_buildkite_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
43
+
44
+ ## License
45
+
46
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
47
+
48
+ ## Code of Conduct
49
+
50
+ Everyone interacting in the UnofficialBuildkiteClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/unofficial_buildkite_client/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "unofficial_buildkite_client"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ client = UnofficialBuildkiteClient.new(org_slug: "rails", pipeline_slug: "rails")
10
+ builds = client.fetch_builds(created_at_from: "2019-04-19T07:00", first: 1, state: ["FAILED", "PASSED"])
11
+ build = client.fetch_build(number: builds.first[:number])
12
+ job = build[:jobs].first
13
+ log = client.fetch_log(build_number: job[:build_number], job_id: job[:id])
14
+
15
+ Bundler.require
16
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,77 @@
1
+ require "unofficial_buildkite_client/version"
2
+ require "unofficial_buildkite_client/json_api_client"
3
+
4
+ class UnofficialBuildkiteClient
5
+ class Error < StandardError; end
6
+
7
+ class << self
8
+ def logger=(logger)
9
+ @logger = logger
10
+ end
11
+
12
+ def logger
13
+ @logger
14
+ end
15
+ end
16
+
17
+ self.logger = Logger.new(STDERR)
18
+
19
+ GRAPHQL_ENDPOINT = "https://graphql.buildkite.com/v1"
20
+ INTERNAL_API_HOST = "https://buildkite.com"
21
+
22
+ def initialize(access_token: ENV["BUILDKITE_ACCESS_TOKEN"], org_slug: nil, pipeline_slug: nil)
23
+ @client = JsonApiClient.new(authorization_header: "Bearer #{access_token}")
24
+ @org_slug = org_slug
25
+ @pipeline_slug = pipeline_slug
26
+ end
27
+
28
+ def fetch_builds(org_slug: @org_slug, pipeline_slug: @pipeline_slug, created_at_from:, first:, state:)
29
+ variables = {slug: "#{org_slug}/#{pipeline_slug}", createdAtFrom: created_at_from, first: first, state: state}
30
+
31
+ post_graphql(<<~GRAPHQL, variables: variables).dig(:data, :pipeline, :builds, :edges).map {|b| b[:node] }
32
+ query ($createdAtFrom: DateTime, $slug: ID!, $first: Int, $state: [BuildStates!]) {
33
+ pipeline(slug: $slug) {
34
+ builds(
35
+ first: $first
36
+ state: $state
37
+ createdAtFrom: $createdAtFrom
38
+ ) {
39
+ edges {
40
+ node {
41
+ branch
42
+ canceledAt
43
+ commit
44
+ createdAt
45
+ env
46
+ finishedAt
47
+ id
48
+ message
49
+ number
50
+ scheduledAt
51
+ source {
52
+ name
53
+ }
54
+ startedAt
55
+ state
56
+ url
57
+ uuid
58
+ }
59
+ }
60
+ }
61
+ }
62
+ }
63
+ GRAPHQL
64
+ end
65
+
66
+ def fetch_build(org_slug: @org_slug, pipeline_slug: @pipeline_slug, number:)
67
+ @client.request(:get, "#{INTERNAL_API_HOST}/#{org_slug}/#{pipeline_slug}/builds/#{number}")
68
+ end
69
+
70
+ def fetch_log(org_slug: @org_slug, pipeline_slug: @pipeline_slug, build_number:, job_id:)
71
+ @client.request(:get, "#{INTERNAL_API_HOST}/organizations/#{org_slug}/pipelines/#{pipeline_slug}/builds/#{build_number}/jobs/#{job_id}/log")
72
+ end
73
+
74
+ def post_graphql(query, variables: {})
75
+ @client.request(:post, GRAPHQL_ENDPOINT, params: {query: query, variables: variables})
76
+ end
77
+ end
@@ -0,0 +1,55 @@
1
+ require "net/https"
2
+ require "uri"
3
+ require "json"
4
+ require "logger"
5
+
6
+ class UnofficialBuildkiteClient
7
+ class JsonApiClient
8
+ def initialize(authorization_header: nil)
9
+ @authorization_header = authorization_header
10
+ end
11
+
12
+ def request(method, url, params: nil)
13
+ uri = URI.parse(url)
14
+ http = Net::HTTP.new(uri.host, uri.port)
15
+ http.use_ssl = true
16
+
17
+ logger.info("method: #{method}, url: #{url}, params: #{params.inspect}")
18
+
19
+ request =
20
+ case method
21
+ when :get
22
+ uri.query = URI.encode_www_form(params) if params
23
+ Net::HTTP::Get.new(uri.request_uri)
24
+ when :post
25
+ Net::HTTP::Post.new(uri.request_uri).tap do |req|
26
+ req.body = params.to_json if params
27
+ end
28
+ else
29
+ raise NotImplementedError
30
+ end
31
+
32
+ json_headers.each do |k, v|
33
+ request[k] = v
34
+ end
35
+ response = http.request(request)
36
+ raise Error.new("#{response.inspect}") unless response.code.start_with?("2")
37
+ JSON.parse(response.body, symbolize_names: true)
38
+ end
39
+
40
+ private
41
+
42
+ def json_headers
43
+ h = {
44
+ "Content-Type" => "application/json",
45
+ "Accept" => "application/json",
46
+ }
47
+ h.merge!("Authorization" => @authorization_header)
48
+ h
49
+ end
50
+
51
+ def logger
52
+ UnofficialBuildkiteClient.logger
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,3 @@
1
+ class UnofficialBuildkiteClient
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,28 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "unofficial_buildkite_client/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "unofficial_buildkite_client"
8
+ spec.version = UnofficialBuildkiteClient::VERSION
9
+ spec.authors = ["Fumiaki MATSUSHIMA"]
10
+ spec.email = ["mtsmfm@gmail.com"]
11
+
12
+ spec.summary = %q{Unofficial Buildkite API client}
13
+ spec.description = %q{Unofficial Buildkite API client}
14
+ spec.homepage = "https://github.com/mtsmfm/unofficial_buildkite_client"
15
+ spec.license = "MIT"
16
+
17
+ # Specify which files should be added to the gem when it is released.
18
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.17"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ end
metadata ADDED
@@ -0,0 +1,84 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: unofficial_buildkite_client
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Fumiaki MATSUSHIMA
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-05-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.17'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: Unofficial Buildkite API client
42
+ email:
43
+ - mtsmfm@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - CODE_OF_CONDUCT.md
50
+ - Gemfile
51
+ - Gemfile.lock
52
+ - LICENSE.txt
53
+ - README.md
54
+ - Rakefile
55
+ - bin/console
56
+ - bin/setup
57
+ - lib/unofficial_buildkite_client.rb
58
+ - lib/unofficial_buildkite_client/json_api_client.rb
59
+ - lib/unofficial_buildkite_client/version.rb
60
+ - unofficial_buildkite_client.gemspec
61
+ homepage: https://github.com/mtsmfm/unofficial_buildkite_client
62
+ licenses:
63
+ - MIT
64
+ metadata: {}
65
+ post_install_message:
66
+ rdoc_options: []
67
+ require_paths:
68
+ - lib
69
+ required_ruby_version: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ required_rubygems_version: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: '0'
79
+ requirements: []
80
+ rubygems_version: 3.0.3
81
+ signing_key:
82
+ specification_version: 4
83
+ summary: Unofficial Buildkite API client
84
+ test_files: []