rake_circle_ci 0.10.0.pre.4 → 0.10.0.pre.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa307a2276542c67d73d861a659df253f36618d6c27e5d25be7a3b9b06df3819
-  data.tar.gz: c2f62ff03caf6a244b7648272bfaacaf041bb216fd8baec44418f9453f7caa5c
+  metadata.gz: 799f94557915913f8f49a505d1f36fc022f291bee34ea54982486c4d2ed0c251
+  data.tar.gz: eb1d7ade7b37375721bb70b80e7d148fb99a00886f213da1015d26f7a9e40a2d
 SHA512:
-  metadata.gz: 3d8cbed1081ee0b81499fa3d75acdcc5266c24662cb3df1db80abc3fb6d23f883787eb4acf2acc4b8597e101f59b5e334fd614cfe00c644b9bb36a37bbed5da5
-  data.tar.gz: 2f0ad52a3047c16e5d80c4d256de0b6b8fe9d769295d449f5722fd48d855917a7d28ec36d0cfd7398314cb1fef7bb96336406e6ae71423d8495d6904151c09ab
+  metadata.gz: 92fcd413f5fc3a5bef72f7a985bf3bc7b97b3180e5061e139c839e0a7411e965b975ed08bb8d75b2f05045461a98b3e4ba2847f07003af0064f8c3653097b848
+  data.tar.gz: 0ebd133933c2d83139277317ae9c5810d2f3eb0f0ea98aefb18075543829266b1ca3539ee9b2caf14f2e698dea0c5d4d6b04ec2202e88d943460f76a0cbeaef1

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake_docker.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_circle_ci (0.10.0.pre.4)
+    rake_circle_ci (0.10.0.pre.7)
       colored2 (~> 3.1)
       excon (~> 0.72)
       rake_factory (~> 0.23)
@@ -17,11 +17,12 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concurrent-ruby (1.1.9)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    excon (0.92.0)
+    excon (0.92.2)
     faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -60,7 +61,11 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (13.0.6)
     rake_factory (0.29.0)
       activesupport (>= 4)
@@ -77,6 +82,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -90,6 +97,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_gpg2 (0.8.0)
       lino (>= 1.5)
@@ -105,6 +128,7 @@ GEM
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -120,7 +144,10 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.10

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,20 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[
+  library:fix
+  test:unit
+]
 
 namespace :encryption do
   namespace :passphrase do
+    desc 'Generate encryption passphrase for CI GPG key'
     task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+      FileUtils.mkdir_p('config/secrets/ci/')
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +28,102 @@ end
 namespace :keys do
   namespace :deploy do
     RakeSSH.define_key_tasks(
-        path: 'config/secrets/ci/',
-        comment: 'maintainers@infrablocks.io')
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
   end
 
   namespace :gpg do
     RakeGPG.define_generate_key_task(
-        output_directory: 'config/secrets/ci',
-        name_prefix: 'gpg',
-        owner_name: 'InfraBlocks Maintainers',
-        owner_email: 'maintainers@infrablocks.io',
-        owner_comment: 'rake_circle_ci CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'rake_circle_ci CI Key'
+    )
   end
 end
 
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/rake_circle_ci'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/rake_circle_ci'
 ) do |t|
   circle_ci_config =
-      YAML.load_file('config/secrets/circle_ci/config.yaml')
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
 
-  t.api_token = circle_ci_config["circle_ci_api_token"]
+  t.api_token = circle_ci_config['circle_ci_api_token']
   t.environment_variables = {
-      ENCRYPTION_PASSPHRASE:
-          File.read('config/secrets/ci/encryption.passphrase')
-              .chomp
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
   }
   t.checkout_keys = []
   t.ssh_keys = [
-      {
-          hostname: "github.com",
-          private_key: File.read('config/secrets/ci/ssh.private')
-      }
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
   ]
 end
 
 RakeGithub.define_repository_tasks(
-    namespace: :github,
-    repository: 'infrablocks/rake_circle_ci',
+  namespace: :github,
+  repository: 'infrablocks/rake_circle_ci'
 ) do |t, args|
   github_config =
-      YAML.load_file('config/secrets/github/config.yaml')
+    YAML.load_file('config/secrets/github/config.yaml')
 
-  t.access_token = github_config["github_personal_access_token"]
+  t.access_token = github_config['github_personal_access_token']
   t.deploy_keys = [
-      {
-          title: 'CircleCI',
-          public_key: File.read('config/secrets/ci/ssh.public')
-      }
+    {
+      title: 'CircleCI',
+      ssh_key: File.read('config/secrets/ci/ssh.public')
+    }
   ]
   t.branch_name = args.branch_name
   t.commit_message = args.commit_message
 end
 
 namespace :pipeline do
-  task :prepare => [
-      :'circle_ci:project:follow',
-      :'circle_ci:env_vars:ensure',
-      :'circle_ci:checkout_keys:ensure',
-      :'circle_ci:ssh_keys:ensure',
-      :'github:deploy_keys:ensure'
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:project:follow
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
   ]
 end
 
 namespace :version do
-  desc "Bump version for specified type (pre, major, minor, patch)"
+  desc 'Bump version for specified type (pre, major, minor, patch)'
   task :bump, [:type] do |_, args|
     bump_version_for(args.type)
   end
 end
 
-desc "Release gem"
+desc 'Release gem'
 task :release do
-  sh "gem release --tag --push"
+  sh 'gem release --tag --push'
 end
 
 def bump_version_for(version_type)
-  sh "gem bump --version #{version_type} " +
-      "&& bundle install " +
-      "&& export LAST_MESSAGE=\"$(git log -1 --pretty=%B)\" " +
-      "&& git commit -a --amend -m \"${LAST_MESSAGE} [ci skip]\""
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rake_circle_ci"
+require 'bundler/setup'
+require 'rake_circle_ci'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rake_circle_ci"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rake_circle_ci/client.rb

@@ -1,35 +1,100 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'excon'
 require 'sshkey'
 
 module RakeCircleCI
-  class Client
+  class URLs
     def initialize(opts)
       @base_url = opts[:base_url]
       @api_token = opts[:api_token]
       @project_slug = opts[:project_slug]
     end
 
+    def follow_url
+      "#{@base_url}/v1.1/project/#{@project_slug}/follow?" \
+        "circle-token=#{@api_token}"
+    end
+
+    def env_vars_url
+      "#{@base_url}/v2/project/#{@project_slug}/envvar"
+    end
+
+    def env_var_url(name)
+      "#{@base_url}/v2/project/#{@project_slug}/envvar/#{name}"
+    end
+
+    def settings_url
+      "#{@base_url}/v1.1/project/#{@project_slug}/settings?" \
+        "circle-token=#{@api_token}"
+    end
+
+    def ssh_keys_url
+      "#{@base_url}/v1.1/project/#{@project_slug}/ssh-key?" \
+        "circle-token=#{@api_token}"
+    end
+
+    def checkout_keys_url
+      "#{@base_url}/v1.1/project/#{@project_slug}/checkout-key"
+    end
+
+    def checkout_key_url(fingerprint)
+      "#{@base_url}/v1.1/project/#{@project_slug}/checkout-key/#{fingerprint}"
+    end
+  end
+
+  class HTTPClient
+    def get(url, opts)
+      assert_successful(Excon.get(url, opts))
+    end
+
+    def post(url, opts)
+      assert_successful(Excon.post(url, opts))
+    end
+
+    def delete(url, opts)
+      assert_successful(Excon.delete(url, opts))
+    end
+
+    private
+
+    def assert_successful(response)
+      unless response.status >= 200 && response.status < 300
+        host = response.data[:host]
+        path = response.data[:path]
+        status = response.status
+        reason = response.data[:reason_phrase]
+        raise "Unsuccessful request: #{host}#{path} #{status} #{reason}"
+      end
+      response
+    end
+  end
+
+  class Client
+    def initialize(opts)
+      @urls = URLs.new(opts)
+      @api_token = opts[:api_token]
+      @http = HTTPClient.new
+    end
+
     def follow_project
-      assert_successful(Excon.post(follow_url, headers: headers))
+      @http.post(@urls.follow_url, headers: headers)
     end
 
     def find_env_vars
-      response = assert_successful(Excon.get(env_vars_url, headers: headers))
+      response = @http.get(@urls.env_vars_url, headers: headers)
       body = JSON.parse(response.body)
-      env_vars = body["items"].map { |item| item["name"] }
-
-      env_vars
+      body['items'].map { |item| item['name'] }
     end
 
     def create_env_var(name, value)
       body = JSON.dump(name: name, value: value)
-      assert_successful(
-          Excon.post(env_vars_url, body: body, headers: headers))
+      @http.post(@urls.env_vars_url, body: body, headers: headers)
     end
 
     def delete_env_var(name)
-      assert_successful(Excon.delete(env_var_url(name), headers: headers))
+      @http.delete(@urls.env_var_url(name), headers: headers)
     end
 
     def delete_env_vars
@@ -40,32 +105,28 @@ module RakeCircleCI
     end
 
     def find_ssh_keys
-      response = assert_successful(Excon.get(settings_url, headers: headers))
+      response = @http.get(@urls.settings_url, headers: headers)
       body = JSON.parse(response.body, symbolize_names: true)
-      ssh_keys = body[:ssh_keys]
-
-      ssh_keys
+      body[:ssh_keys]
     end
 
     def create_ssh_key(private_key, opts = {})
       body = {
-          fingerprint: SSHKey.new(private_key).sha1_fingerprint,
-          private_key: private_key,
+        fingerprint: SSHKey.new(private_key).sha1_fingerprint,
+        private_key: private_key
       }
       body = body.merge(hostname: opts[:hostname]) if opts[:hostname]
       body = JSON.dump(body)
-      assert_successful(
-          Excon.post(ssh_keys_url, body: body, headers: headers))
+      @http.post(@urls.ssh_keys_url, body: body, headers: headers)
     end
 
     def delete_ssh_key(fingerprint, opts = {})
       body = {
-          fingerprint: fingerprint
+        fingerprint: fingerprint
       }
       body = body.merge(hostname: opts[:hostname]) if opts[:hostname]
       body = JSON.dump(body)
-      assert_successful(
-          Excon.delete(ssh_keys_url, body: body, headers: headers))
+      @http.delete(@urls.ssh_keys_url, body: body, headers: headers)
     end
 
     def delete_ssh_keys
@@ -73,33 +134,28 @@ module RakeCircleCI
       ssh_keys.each do |ssh_key|
         fingerprint = ssh_key[:fingerprint]
         hostname = ssh_key[:hostname]
-        options = hostname && {hostname: hostname}
+        options = hostname && { hostname: hostname }
         args = [fingerprint, options].compact
         delete_ssh_key(*args)
       end
     end
 
     def find_checkout_keys
-      response = assert_successful(
-          Excon.get(checkout_keys_url, headers: headers))
-      checkout_keys = JSON.parse(response.body, symbolize_names: true)
-
-      checkout_keys
+      response = @http.get(@urls.checkout_keys_url, headers: headers)
+      JSON.parse(response.body, symbolize_names: true)
     end
 
     def create_checkout_key(type)
       type_strings = {
-          deploy_key: 'deploy-key',
-          github_user_key: 'github-user-key'
+        deploy_key: 'deploy-key',
+        github_user_key: 'github-user-key'
       }
       body = JSON.dump(type: type_strings[type.to_sym] || type.to_s)
-      assert_successful(
-          Excon.post(checkout_keys_url, body: body, headers: headers))
+      @http.post(@urls.checkout_keys_url, body: body, headers: headers)
     end
 
     def delete_checkout_key(fingerprint)
-      assert_successful(
-          Excon.delete(checkout_key_url(fingerprint), headers: headers))
+      @http.delete(@urls.checkout_key_url(fingerprint), headers: headers)
     end
 
     def delete_checkout_keys
@@ -113,52 +169,10 @@ module RakeCircleCI
 
     def headers
       {
-          "Circle-Token": @api_token,
-          "Content-Type": "application/json",
-          "Accept": "application/json"
+        'Circle-Token': @api_token,
+        'Content-Type': 'application/json',
+        Accept: 'application/json'
       }
     end
-
-    def assert_successful(response)
-      unless response.status >= 200 && response.status < 300
-        host = response.data[:host]
-        path = response.data[:path]
-        status = response.status
-        reason = response.data[:reason_phrase]
-        raise "Unsuccessful request: #{host}#{path} #{status} #{reason}"
-      end
-      response
-    end
-
-    def follow_url
-      "#{@base_url}/v1.1/project/#{@project_slug}/follow?" +
-          "circle-token=#{@api_token}"
-    end
-
-    def env_vars_url
-      "#{@base_url}/v2/project/#{@project_slug}/envvar"
-    end
-
-    def env_var_url(name)
-      "#{@base_url}/v2/project/#{@project_slug}/envvar/#{name}"
-    end
-
-    def settings_url
-      "#{@base_url}/v1.1/project/#{@project_slug}/settings?" +
-          "circle-token=#{@api_token}"
-    end
-
-    def ssh_keys_url
-      "#{@base_url}/v1.1/project/#{@project_slug}/ssh-key?" +
-          "circle-token=#{@api_token}"
-    end
-
-    def checkout_keys_url
-      "#{@base_url}/v1.1/project/#{@project_slug}/checkout-key"
-    end
-
-    def checkout_key_url(fingerprint)
-      "#{@base_url}/v1.1/project/#{@project_slug}/checkout-key/#{fingerprint}"
-    end
   end
 end

data/lib/rake_circle_ci/task_sets/checkout_keys.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks'
@@ -17,17 +19,17 @@ module RakeCircleCI
       parameter :ensure_task_name, default: :ensure
 
       task Tasks::CheckoutKeys::Provision,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.provision_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.provision_task_name
+           }
       task Tasks::CheckoutKeys::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.destroy_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.destroy_task_name
+           }
       task Tasks::CheckoutKeys::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.ensure_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.ensure_task_name
+           }
     end
   end
 end

data/lib/rake_circle_ci/task_sets/environment_variables.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake_factory'
 
 require_relative '../tasks'
@@ -17,17 +19,17 @@ module RakeCircleCI
       parameter :ensure_task_name, default: :ensure
 
       task Tasks::EnvironmentVariables::Provision,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.provision_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.provision_task_name
+           }
       task Tasks::EnvironmentVariables::Destroy,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.destroy_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.destroy_task_name
+           }
       task Tasks::EnvironmentVariables::Ensure,
-          name: RakeFactory::DynamicValue.new { |ts|
-            ts.ensure_task_name
-          }
+           name: RakeFactory::DynamicValue.new { |ts|
+             ts.ensure_task_name
+           }
     end
   end
 end