hiera-eyaml-gkms 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13c56b1159993698e5b10a0a59a9e175a6850c11298bf1c502820b1c8ca1e4b
-  data.tar.gz: 2b4b18a3bb722036b46c250c6873db8ed23c667c4b33aa045a9fa53b816e64e5
+  metadata.gz: 9bc9e778863a8ef92229ce51fd5a941ae5cddc7535f1603e76257c333782ed5d
+  data.tar.gz: baf3e6149681d0b3cd981b170389205d68915d6212b19cf5cabd93c436230d9c
 SHA512:
-  metadata.gz: 11a422d8547d1497dfa62d167a89c9b87a07623bd34e7c2feb433c556f31200dbf61ad4d9e4907ee16955bbbac1cf30ccb86a44d0d734c37a6871e07c9fb9774
-  data.tar.gz: d14d7833b34bc5cfb2a9a4b2d68e2e7eb2fe59820fe63f4dd7537e169f2fb0faeaf0f909e52bd62cf181e7ccb3eb4979821a672755f0b04d5c01bc59afff775e
+  metadata.gz: 705157438320d69e2bdc6cdb9be1f449a86746567877bfe0794021d4d8f34a0f572c1bb17e93e62f3098670b9138253414b7a042392ac2d9a474cc22803c79b9
+  data.tar.gz: 9c414947801011758db08925b3f6cbedb832000aeccc421fafb5634f5552c5c9d6f203990ba9849040397ee14c93082b1cf593ee7a8fb95b0ffbf6a8fd993a3f

data/.gitignore

@@ -7,3 +7,4 @@ tmp/
 .DS_Store
 .ruby-version
 hiera-eyaml-google-kms-*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,83 @@
+---
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: '2.2'
+Metrics/LineLength:
+  Description: People have wide screens, use them.
+  Max: 200
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
+    be consistent then.
+  EnforcedStyle: braces_for_chaining
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template
+    tokens over annotated ones.
+  EnforcedStyle: template
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+Style/TernaryParentheses:
+  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses
+    on complex expressions for better readability, but seriously consider breaking
+    it up.
+  EnforcedStyle: require_parentheses_when_complex
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes
+    diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs,
+    and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  EnforcedStyle: brackets
+Style/Documentation:
+  Exclude:
+  - lib/puppet/parser/functions/**/*
+  - spec/**/*
+Style/WordArray:
+  EnforcedStyle: brackets
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/CollectionMethods:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Layout/EndOfLine:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SymbolProc:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+---
+dist: trusty
+language: ruby
+cache: bundler
+sudo: false
+before_install:
+  - bundle -v
+  - rm Gemfile.lock || true
+  - gem update --system $RUBYGEMS_VERSION
+  - gem update bundler
+  - gem --version
+  - bundle -v
+script:
+  bundle exec rake rubocop
+matrix:
+  include:
+    - rvm: 2.1.9
+      env: RUBYGEMS_VERSION=2.7.8
+    - rvm: 2.4.2

data/CHANGELOG.md

@@ -4,6 +4,9 @@ Release notes for the Google Cloud KMS hiera-eyaml plugin.
 
 ---------------------------------------------------------
 
+## 2019-03-11 - 0.0.3
+  * Under the hood testing and style improvements 
+
 ## 2019-03-11 - 0.0.2
   * Version now reports properly to hiera-eyaml core
 

data/Gemfile

@@ -1,9 +1,2 @@
 source 'https://rubygems.org/'
-
 gemspec
-
-group :dev do
-  gem 'hiera-eyaml'
-  gem 'rake'
-  gem 'google-cloud-kms'
-end

data/README.md

@@ -1,5 +1,6 @@
-# hiera-eyaml-google-kms
+# hiera-eyaml-gkms
 
+[![Build Status](https://secure.travis-ci.org/craigwatson/hiera-eyaml-gkms.svg?branch=master)](http://travis-ci.org/craigwatson/hiera-eyaml-gkms)
 [![Gem Version](https://img.shields.io/gem/v/hiera-eyaml-gkms.svg)](https://rubygems.org/gems/hiera-eyaml-gkms)
 [![Gem Downloads](https://img.shields.io/gem/dt/hiera-eyaml-gkms.svg)](https://rubygems.org/gems/hiera-eyaml-gkms)
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end

data/hiera-eyaml-gkms.gemspec

@@ -1,21 +1,25 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hiera/backend/eyaml/encryptors/gkms'
+
+require 'hiera/backend/eyaml/encryptors/gkms/version'
+require 'English'
 
 Gem::Specification.new do |gem|
-  gem.name          = "hiera-eyaml-gkms"
-  gem.version       = Hiera::Backend::Eyaml::Encryptors::Gkms::VERSION
-  gem.description   = "Google Cloud KMS plugin for Hiera-EYAML"
-  gem.summary       = "Encryption plugin for hiera-eyaml backend for Hiera, using Google Cloud KMS"
-  gem.author        = "Craig Watson"
-  gem.license       = "Apache-2.0"
+  gem.name          = 'hiera-eyaml-gkms'
+  gem.version       = Hiera::Backend::Eyaml::Encryptors::GkmsVersion::VERSION
+  gem.description   = 'Google Cloud KMS plugin for Hiera-EYAML'
+  gem.summary       = 'Encryption plugin for hiera-eyaml backend for Hiera, using Google Cloud KMS'
+  gem.author        = 'Craig Watson'
+  gem.license       = 'Apache-2.0'
 
-  gem.homepage      = "https://github.com/craigwatson/hiera-eyaml-gkms"
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.homepage      = 'https://github.com/craigwatson/hiera-eyaml-gkms'
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency('hiera-eyaml', '>=1.3.8')
 
-  gem.add_dependency('hiera-eyaml', '>=1.3.8')
-  gem.add_runtime_dependency('google-cloud-kms')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rubocop')
 end

data/lib/hiera/backend/eyaml/encryptors/gkms.rb

@@ -1,88 +1,90 @@
 begin
   require 'google/cloud/kms'
 rescue LoadError
-  fail "hiera-eyaml-gkms requires the 'google-cloud-kms' gem"
+  raise StandardError, 'hiera-eyaml-gkms requires the google-cloud-kms gem'
 end
 
 require 'hiera/backend/eyaml/encryptor'
 require 'hiera/backend/eyaml/utils'
 require 'hiera/backend/eyaml/options'
+require 'hiera/backend/eyaml/encryptors/gkms/version'
 
 class Hiera
   module Backend
     module Eyaml
       module Encryptors
+        # Google KMS plugin for hiera-eyaml
         class Gkms < Encryptor
-
-          VERSION      = "0.0.2"
-          self.tag     = "GKMS"
+          VERSION      = Hiera::Backend::Eyaml::Encryptors::GkmsVersion::VERSION
+          self.tag     = 'GKMS'
           self.options = {
-            :project => {
-              :desc    => "GCP Project",
-              :type    => :string,
-              :default => ""
-            },
-            :location => {
-              :desc    => "GCP Region of the KMS Keyring",
-              :type    => :string,
-              :default => "europe-west1"
+            'project' => {
+              'desc' => 'GCP Project',
+              'type' => 'string',
+              'default' => ''
             },
-            :keyring => {
-              :desc    => "GCP KMS Keyring name",
-              :type    => :string,
-              :default => ""
+            'location' => {
+              'desc' => 'GCP Region of the KMS Keyring',
+              'type' => 'string',
+              'default' => 'europe-west1'
             },
-            :crypto_key => {
-              :desc    => "GCP KMS Crypto Key name",
-              :type    => :string,
-              :default => ""
+            'keyring' => {
+              'desc' => 'GCP KMS Keyring name',
+              'type' => 'string',
+              'default' => ''
             },
-            :auth_type => {
-              :desc    => "Authentication type for GCP SDK",
-              :type    => :string,
-              :default => "serviceaccount"
+            'crypto_key' => {
+              'desc' => 'GCP KMS Crypto Key name',
+              'type' => 'string',
+              'default' => ''
             },
-            :credentials => {
-              :desc    => "GCP Service Account credentials",
-              :type    => :string,
-              :default => ""
+            'auth_type' => {
+              'desc' => 'Authentication type for GCP SDK',
+              'type' => 'string',
+              'default' => 'serviceaccount'
             },
+            'credentials' => {
+              'desc' => 'GCP Service Account credentials',
+              'type' => 'string',
+              'default' => ''
+            }
           }
 
           def self.kms_client
-            auth_type = self.option :auth_type
+            auth_type = option('auth_type')
+
+            if auth_type == 'serviceaccount'
+              credentials = option('credentials')
+              raise StandardError, 'gkms_credentials is not defined' unless credentials
 
-            if auth_type == "serviceaccount"
-              credentials = self.option :credentials
-              raise StandardError, "gkms_credentials is not defined" unless credentials
               client_opts = { version: 'v1', credentials: credentials }
             else
               client_opts = { version: 'v1' }
             end
 
-            return Google::Cloud::Kms.new(client_opts)
+            Google::Cloud::Kms.new(client_opts)
           end
 
           def self.key_path
-            project     = self.option :project
-            location    = self.option :location
-            keyring     = self.option :keyring
-            crypto_key  = self.option :crypto_key
+            project     = option('project')
+            location    = option('location')
+            keyring     = option('keyring')
+            crypto_key  = option('crypto_key')
 
-            raise StandardError, "gkms_project is not defined" unless project
-            raise StandardError, "gkms_keyring is not defined" unless keyring
-            raise StandardError, "gkms_crypto_key is not defined" unless crypto_key
+            raise StandardError, 'gkms_project is not defined' unless project
+            raise StandardError, 'gkms_keyring is not defined' unless keyring
+            raise StandardError, 'gkms_crypto_key is not defined' unless crypto_key
 
-            return Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path(project, location, keyring, crypto_key)
+            Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path(project, location, keyring, crypto_key)
           end
 
-          def self.encrypt plaintext
+          def self.encrypt(plaintext)
             kms_client = self.kms_client
             key_path = self.key_path
             kms_client.encrypt(key_path, plaintext).ciphertext
           end
 
-          def self.decrypt ciphertext
+          def self.decrypt(ciphertext)
             kms_client = self.kms_client
             key_path = self.key_path
             kms_client.decrypt(key_path, ciphertext).plaintext

data/lib/hiera/backend/eyaml/encryptors/gkms/version.rb

@@ -0,0 +1,11 @@
+class Hiera
+  module Backend
+    module Eyaml
+      module Encryptors
+        module GkmsVersion
+          VERSION = '0.0.3'.freeze
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiera-eyaml-gkms
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Craig Watson
@@ -25,13 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.8
 - !ruby/object:Gem::Dependency
-  name: google-cloud-kms
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,6 +59,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -53,6 +69,7 @@ files:
 - hiera-eyaml-gkms.gemspec
 - lib/hiera/backend/eyaml/encryptors/gkms.rb
 - lib/hiera/backend/eyaml/encryptors/gkms/eyaml_init.rb
+- lib/hiera/backend/eyaml/encryptors/gkms/version.rb
 - tools/regem.sh
 homepage: https://github.com/craigwatson/hiera-eyaml-gkms
 licenses: