sleet 0.3.10 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ce6d9391262e355854886ea05dd44082be2f51aec4bb300132f9f26d1a1737
-  data.tar.gz: 210ede2430b468b996c60c5f245a21fea5b1590a50d4636aa6da6d884163f056
+  metadata.gz: 022c2a45bc1d863b22fd82ab7af14dbc67ba5aef247b5dae0769ac980ce9a2a2
+  data.tar.gz: c4fe3d8aa029508432ac6fce6215cb7c81782e12bc9a458adfe80540f9aae669
 SHA512:
-  metadata.gz: 27afbb4ae3cf79b183af8a8ec1c398d05f1450f3662fa75abf2343c2d703ba68645cd971262767d790b356e6d93a86cbdfcf3f39675e87c9cea3515a419f8fba
-  data.tar.gz: 383e4b3e98cae18a20e9499fc6622ceec0f09cae6e18ca13f994eb4d91ab2e3dd7d25ce1c7e06a22e722a8d41f4f3668924f5ce24381ba3d3bcaf4a83a9ffa0b
+  metadata.gz: 8bf1267eec2081f51b2afadce3da9e66f42d04ea190a7ac3c7788d39db47f0dc9d524bd1bb0109fbd009540b0392cc2f8430bd7425a4d2b51352fbc17f0bc06d
+  data.tar.gz: 7b735f0733806f08f66fe9357bf4bfd44d46b3dc3f402eb232cabde4dffd7397d691117360913dd00a147270d65f9e7be3459ec83bfb5cc69ff6f375ee815c37

data/.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2
 jobs:
   build:
-    parallelism: 1
+    parallelism: 2
     docker:
       - image: circleci/ruby:latest
 

data/.rubocop_todo.yml

@@ -1,11 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-04 17:57:32 -0500 using RuboCop version 0.52.1.
+# on 2018-03-08 00:46:21 -0500 using RuboCop version 0.53.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
 # Offense count: 1
 # Configuration parameters: Max.
 RSpec/NestedGroups:

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Change Log
 
-## [v0.3.10](https://github.com/coreyja/sleet/tree/v0.3.10) (2018-03-07)
+## [v0.4.0](https://github.com/coreyja/sleet/tree/v0.4.0) (2018-03-08)
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.10...v0.4.0)
+
+**Closed issues:**
+
+- Allow Specifying Token from Config Files [\#9](https://github.com/coreyja/sleet/issues/9)
+
+**Merged pull requests:**
+
+- Get Token From Config File [\#21](https://github.com/coreyja/sleet/pull/21) ([coreyja](https://github.com/coreyja))
+
+## [v0.3.10](https://github.com/coreyja/sleet/tree/v0.3.10) (2018-03-08)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.9...v0.3.10)
 
 **Merged pull requests:**

data/README.md

@@ -52,11 +52,16 @@ To do this we need to create a step which [saves](https://circleci.com/docs/2.0/
 
 ### 3. Save a CircleCI Token locally (to access private builds)
 
-In order to see private builds/repos in CircleCI you will need to get a CircleCI token and save it to the `~/.circleci.token` file.
+In order to see private builds/repos in CircleCI you will need to get a CircleCI token and save it locally to a Sleet Configuration file.
+The recommended approach is to create a yml file in your home directory which contains your the key `circle_ci_token`
+
+```
+circle_ci_token: PLACE_TOKEN_HERE
+```
 
 An API token can be generated here: [https://circleci.com/account/api](https://circleci.com/account/api)
 
-### 4. Run this tool in the root of your project
+### 4. Run this tool from your project
 
 ```
 sleet
@@ -83,6 +88,8 @@ Sleet currently supports two ways to input configurations:
 2. Through the CLI
     - These always take presendece the options provided in the YML files
 
+To view your current configuration use the `sleet config` command which will give you a table of the current configuration. You can also use the `--print-config` flag with the `fetch` command to print out the config, including any other CLI options. This can be useful for bebugging as the output also tells you where each option came from.
+
 ### Options
 
 These are the options that are currently supported

data/lib/sleet/artifact_downloader.rb

@@ -2,20 +2,21 @@
 
 module Sleet
   class ArtifactDownloader
-    def initialize(artifacts:, file_name:)
+    def initialize(circle_ci_token:, artifacts:, file_name:)
+      @circle_ci_token = circle_ci_token
       @artifacts = artifacts
       @file_name = file_name
     end
 
     def files
       @files ||= urls.map do |url|
-        Sleet::CircleCi.get(url)
+        Sleet::CircleCi.get(url, circle_ci_token)
       end.map(&:body)
     end
 
     private
 
-    attr_reader :artifacts, :file_name
+    attr_reader :artifacts, :file_name, :circle_ci_token
 
     def urls
       rspec_artifacts.map { |x| x['url'] }

data/lib/sleet/branch.rb

@@ -2,14 +2,15 @@
 
 module Sleet
   class Branch
-    def initialize(github_user:, github_repo:, branch:)
+    def initialize(circle_ci_token:, github_user:, github_repo:, branch:)
+      @circle_ci_token = circle_ci_token
       @github_user = github_user
       @github_repo = github_repo
       @branch = branch
     end
 
     def builds
-      @builds ||= JSON.parse(Sleet::CircleCi.get(url).body)
+      @builds ||= JSON.parse(Sleet::CircleCi.get(url, circle_ci_token).body)
     end
 
     def builds_with_artificats
@@ -18,7 +19,7 @@ module Sleet
 
     private
 
-    attr_reader :github_user, :github_repo, :branch
+    attr_reader :github_user, :github_repo, :branch, :circle_ci_token
 
     def url
       "https://circleci.com/api/v1.1/project/github/#{github_user}/#{github_repo}/tree/#{branch}?filter=completed"

data/lib/sleet/build.rb

@@ -4,19 +4,20 @@ module Sleet
   class Build
     attr_reader :build_num
 
-    def initialize(github_user:, github_repo:, build_num:)
+    def initialize(circle_ci_token:, github_user:, github_repo:, build_num:)
+      @circle_ci_token = circle_ci_token
       @github_user = github_user
       @github_repo = github_repo
       @build_num = build_num
     end
 
     def artifacts
-      @artifacts ||= JSON.parse(Sleet::CircleCi.get(url).body)
+      @artifacts ||= JSON.parse(Sleet::CircleCi.get(url, circle_ci_token).body)
     end
 
     private
 
-    attr_reader :github_user, :github_repo
+    attr_reader :github_user, :github_repo, :circle_ci_token
 
     def url
       "https://circleci.com/api/v1.1/project/github/#{github_user}/#{github_repo}/#{build_num}/artifacts" # rubocop:disable Metrics/LineLength

data/lib/sleet/circle_ci.rb

@@ -4,22 +4,8 @@ require 'singleton'
 
 module Sleet
   class CircleCi
-    include Singleton
-
-    def token
-      @token ||= File.read("#{Dir.home}/.circleci.token").strip
-    end
-
-    def get(url)
+    def self.get(url, token)
       Faraday.get(url, 'circle-token' => token)
     end
-
-    def reset!
-      @token = nil
-    end
-
-    def self.get(url)
-      instance.get(url)
-    end
   end
 end

data/lib/sleet/cli.rb

@@ -23,13 +23,14 @@ module Sleet
     option :workflows, type: :hash, aliases: [:w], desc: <<~DESC
       To use Sleet with CircleCI Workflows you need to tell Sleet which build(s) to look in, and where each output should be saved. The input is a hash, where the key is the build name and the value is the output_file for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
     DESC
-    option :print_config, type: :boolean, default: false
+    option :print_config, type: :boolean
     def fetch
       sleet_config = Sleet::Config.new(cli_hash: options, dir: Dir.pwd)
       if options[:print_config]
         sleet_config.print!
         exit
       end
+      raise Sleet::Error, 'circle_ci_token required and not provided' unless sleet_config.circle_ci_token
       Sleet::FetchCommand.new(sleet_config).do!
     end
 
@@ -44,6 +45,7 @@ module Sleet
     end
 
     desc 'config', 'Print the config'
+    option :show_sensitive, type: :boolean
     def config
       Sleet::Config.new(cli_hash: options, dir: Dir.pwd).print!
     end

data/lib/sleet/config.rb

@@ -3,6 +3,7 @@
 module Sleet
   class Config
     OPTION_FILENAME = '.sleet.yml'
+    HIDDEN_UNLESS_IN_CLI_OPTIONS = %w[show_sensitive print_config].freeze
     ConfigOption = Struct.new(:value, :source)
 
     def initialize(dir:, cli_hash: {})
@@ -26,6 +27,10 @@ module Sleet
       options_hash[:workflows]
     end
 
+    def circle_ci_token
+      options_hash[:circle_ci_token]
+    end
+
     def print!
       puts Terminal::Table.new headings: %w[Option Value Source], rows: table_rows
     end
@@ -43,15 +48,23 @@ module Sleet
     end
 
     def table_rows
-      options.map do |key, option|
+      table_options.map do |key, option|
         if key.to_sym == :workflows
           [key, Terminal::Table.new(headings: ['Job Name', 'Output File'], rows: option.value.to_a), option.source]
+        elsif key.to_sym == :circle_ci_token && !options['show_sensitive'].value
+          [key, '**REDACTED**', option.source]
         else
           [key, option.value, option.source]
         end
       end
     end
 
+    def table_options
+      options.reject do |key, _option|
+        HIDDEN_UNLESS_IN_CLI_OPTIONS.include?(key) && !cli_hash.key?(key)
+      end
+    end
+
     def cli_options
       build_option_hash('CLI', cli_hash)
     end
@@ -88,7 +101,9 @@ module Sleet
       {
         'source_dir' => File.expand_path(default_dir),
         'input_file' => '.rspec_example_statuses',
-        'output_file' => '.rspec_example_statuses'
+        'output_file' => '.rspec_example_statuses',
+        'show_sensitive' => false,
+        'print_config' => true
       }
     end
 

data/lib/sleet/fetch_command.rb

@@ -26,8 +26,7 @@ module Sleet
     def fetchers
       job_name_to_output_files.map do |job_name, output_filename|
         Sleet::JobFetcher.new(
-          source_dir: config.source_dir,
-          input_filename: config.input_file,
+          config: config,
           output_filename: output_filename,
           repo: repo,
           job_name: job_name
@@ -40,7 +39,7 @@ module Sleet
     end
 
     def repo
-      @repo ||= Sleet::Repo.from_dir(config.source_dir)
+      @repo ||= Sleet::Repo.from_config(config)
     end
   end
 end

data/lib/sleet/job_fetcher.rb

@@ -2,9 +2,10 @@
 
 module Sleet
   class JobFetcher
-    def initialize(source_dir:, input_filename:, output_filename:, job_name:, repo:)
-      @source_dir = source_dir
-      @input_filename = input_filename
+    def initialize(config:, output_filename:, job_name:, repo:)
+      @circle_ci_token = config.circle_ci_token
+      @source_dir = config.source_dir
+      @input_filename = config.input_file
       @output_filename = output_filename
       @job_name = job_name
       @repo = repo
@@ -17,7 +18,7 @@ module Sleet
 
     private
 
-    attr_reader :input_filename, :output_filename, :job_name, :source_dir, :repo
+    attr_reader :input_filename, :output_filename, :job_name, :source_dir, :repo, :circle_ci_token
 
     def validate!
       build_selector.validate!
@@ -35,7 +36,8 @@ module Sleet
     def build_persistance_artifacts
       @build_persistance_artifacts ||= Sleet::ArtifactDownloader.new(
         file_name: input_filename,
-        artifacts: build.artifacts
+        artifacts: build.artifacts,
+        circle_ci_token: circle_ci_token
       ).files
     end
 

data/lib/sleet/repo.rb

@@ -6,12 +6,16 @@ module Sleet
     CURRENT_BRANCH_REGEX = %r{^refs\/heads\/}
     GITHUB_MATCH_REGEX = %r{github.com[:\/](.+)\/(.+)\.git}
 
-    def self.from_dir(dir)
-      new(repo: Rugged::Repository.new(dir))
+    def self.from_config(config)
+      new(
+        repo: Rugged::Repository.new(config.source_dir),
+        circle_ci_token: config.circle_ci_token
+      )
     end
 
-    def initialize(repo:)
+    def initialize(repo:, circle_ci_token:)
       @repo = repo
+      @circle_ci_token = circle_ci_token
     end
 
     def validate!
@@ -22,6 +26,7 @@ module Sleet
 
     def branch
       @branch ||= Sleet::Branch.new(
+        circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
         branch: remote_branch
@@ -30,6 +35,7 @@ module Sleet
 
     def build_for(build_num)
       Sleet::Build.new(
+        circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
         build_num: build_num
@@ -38,7 +44,7 @@ module Sleet
 
     private
 
-    attr_reader :repo
+    attr_reader :repo, :circle_ci_token
 
     def remote_branch
       current_branch.upstream.name.match(REMOTE_BRANCH_REGEX)[2]

data/lib/sleet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sleet
-  VERSION = '0.3.10'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleet
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.0
 platform: ruby
 authors:
 - Corey Alexander