circleci-build-report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b42b006e51a99ed37842af86ab86ee41e79a302d
+  data.tar.gz: 7bfdd9a8fb5467de98134bfbe331c6bebbfcbc1d
+SHA512:
+  metadata.gz: 3edc4a21b7cf13aed10202c7759f9bfe3c04e5af911fdb205c4e8ce2886e06279fbb9b2cf4d5a3daeb2e88772e5a4ec3b9aa8d42fd1e46a436a91629a7e4e796
+  data.tar.gz: dbb346e5b979f6c61d7a972b9ccab6ab0c65804fe4045a85e37de806e11ad05398f3f254d045ab6400f60dfe65c9072e3d2e397e450769d50c7ae5b593d54e24

data/LICENSE

@@ -0,0 +1,25 @@
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2018 View The Space (viewthespace) 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+## CircleCI Build Report
+This gem is CLI tool for exporting build data for a given CircleCI project and branch in a CSV format. The returned CSV contains only three columns: `build_num`, `start_date`, `status`.
+
+### Install
+Install from ruby gems
+
+```
+gem install circleci_build_report
+```
+
+## Usage
+circleci_build_report --org=<ORG_NAME> --project=<PROJECT_NAME> --branch=<BRANCH_NAME> --token=<CIRCLE_CI_TOKEN> --out=<FILE_TO_WRITE_TO>

data/bin/circleci_build_report

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# encoding: UTF-8
+
+require 'circleci_build_report'
+
+CircleCIBuildReport.start

data/lib/circleci_build_report.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'net/http'
+require 'uri'
+require 'optparse'
+require 'json'
+require_relative 'version'
+
+class CircleCIBuildReport
+  PAGINATION_LIMIT = 100;
+
+  def self.start
+    parse_opts
+    check_opts
+
+    earliest_seen = Date.today
+    since = Date.today - 30
+    offset = 0
+    builds = [['build_num', 'start_date', 'status']]
+    end_of_builds_reached = false
+
+    while((since < earliest_seen) || end_of_builds_reached)
+      request = CircleAPIRequest.new(
+        config[:org],
+        config[:project],
+        config[:branch],
+        config[:token],
+        offset
+      )
+      response = request.perform
+      response_json = JSON.parse(response.body)
+      end_of_builds_reached = true if response_json == []
+      response_json.each do |build_json|
+        available_date = build_json['start_date'] || build_json['author_date'] || build_json['usage_queued_at']
+        build_date = Date.parse(available_date)
+        earliest_seen = build_date if build_date < earliest_seen
+        builds << [build_json['build_num'], available_date, build_json['status']]
+      end
+      offset += PAGINATION_LIMIT
+    end
+    File.open(config[:out], 'w') { |file| file.write(builds.map { |build| build.join(', ') }.join("\n")) }
+  end
+
+  def self.parse_opts
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: fir [options]'
+      opts.on('-v', '--version', 'Show version') do |v|
+        config[:version] = v
+      end
+      opts.on('-g', '--org ARG', 'The name of the organization on Github/CircleCI') do |org|
+        config[:org] = org
+      end
+      opts.on('-p', '--project ARG', 'The name of the project') do |project|
+        config[:project] = project
+      end
+      opts.on('-b', '--branch ARG', 'The name of the branch. By default runs master') do |branch|
+        config[:branch] = branch
+      end
+      opts.on('-o', '--out ARG', 'The name of the file to save the results to. Default is out.csv') do |out|
+        config[:out] = out
+      end
+      opts.on('-t', '--token ARG', 'The CircleCI token') do |token|
+        config[:token] = token
+      end
+    end.parse!
+    process_immediate_opts(config)
+  end
+
+  def self.check_opts
+    if !config[:org]
+      raise ArgumentError.new("Please specify organization name with --org")
+    end
+    if !config[:project]
+      raise ArgumentError.new("Please specify project name with --project")
+    end
+    if !config[:branch]
+      raise ArgumentError.new("Please specify branch name with --branch")
+    end
+    if !config[:token]
+      raise ArgumentError.new("Please specify CircleCI token with --token")
+    end
+  end
+
+  def self.config
+    @config ||= {
+      branch: 'master',
+      out: 'out.csv'
+    }
+  end
+
+  def self.process_immediate_opts(opts)
+    return unless opts[:version]
+    puts(VERSION)
+    exit(0)
+  end
+
+  class CircleAPIRequest
+    attr_reader :org, :project, :branch, :token, :offset
+
+    def initialize(org, project, branch, token, offset)
+      @org = org
+      @project = project
+      @branch = branch
+      @token = token
+      @offset = offset
+    end
+
+    def perform
+      http.use_ssl = true
+      response = http.get(query_params)
+    end
+
+    def query_params
+      "/api/v1.1/project/github/#{org}/#{project}/tree/#{branch}?circle-token=#{token}&limit=100&offset=#{offset}"
+    end
+
+    def uri
+      @uri ||= URI.parse('https://circleci.com')
+    end
+
+    def http
+      @http ||= Net::HTTP.new(uri.host, uri.port)
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class CircleCIBuildReport
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: circleci-build-report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nassredean Nasseri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies: []
+description: Export build data for a given project and branch on CircleCI in CSV format
+email: dean@vts.com
+executables:
+- circleci_build_report
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/circleci_build_report
+- lib/circleci_build_report.rb
+- lib/version.rb
+homepage: https://github.com/viewthespace/circleci_build_report
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Export build data for a given project and branch on CircleCI in CSV format
+test_files: []