trixie 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9fb9e4a817416d5df9d692a6da48f03afc54c429b1956e6b74724739253776e
-  data.tar.gz: f0cbfc84bccc590573c633fe8a36ee00762fd4d6a94748c928ebb55668730d64
+  metadata.gz: 4601cd84921ad3fca11a80ffb627ef4b5d44d9a404dc25ac1905d75ab12a0b96
+  data.tar.gz: fcd3bb97d53845a6cd7752c90305bd9641c7809d57e86fc2d9fd4a6bcab41e96
 SHA512:
-  metadata.gz: d897d133563fc5ce764cb7dda155f58b9822191ae74d24113736626cab6a172acbc15cd316d18d9c43cc2b473a7d1dbf93c0b655acfb7373bf09ec6d67120eda
-  data.tar.gz: 41c803e3e23ba1a91d2c523b98e95e053ef8a5a00c72f4cbfee3427aa73f7e8a577c57ac5abc72fcc4ca3e9836069c8479a3da016305fe98276a6520f559dd9f
+  metadata.gz: 558dbef73b15724f9559e64d9f20cfa736fddea2445d8a9edd7c7a8bd9ee514a4c8a244356095c470787e509df6af58c29a99525bd96f5ef94d718a287e75852
+  data.tar.gz: 8327f5fa9e8392e563e888fd981760ac6ec78438de8a28cf8b0c83691c8748dcdb6fd6156457977132421e6780b157c1eae17d5ab59ffd9921486e3f6345d732

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# This owner will be the default owner of everything in the repo.
+* @toptal/devx

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    trixie (0.1.1)
+    trixie (0.1.4)
       dry-cli (~> 0.7.0)
+      dry-schema (~> 1.10.0)
+      dry-validation (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,8 +12,43 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     dry-cli (0.7.0)
+    dry-configurable (0.16.1)
+      dry-core (~> 0.6)
+      zeitwerk (~> 2.6)
+    dry-container (0.11.0)
+      concurrent-ruby (~> 1.0)
+    dry-core (0.9.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (0.3.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.9, >= 0.9)
+      zeitwerk (~> 2.6)
+    dry-schema (1.10.6)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.2)
+      dry-types (~> 1.5)
+    dry-types (1.6.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.9, >= 0.9)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.3, >= 1.3)
+      zeitwerk (~> 2.6)
+    dry-validation (1.8.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.8, >= 1.8.0)
     json (2.6.2)
     method_source (1.0.0)
     parallel (1.22.1)
@@ -54,6 +91,7 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.2.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -18,7 +18,20 @@ secrets:
      value: "{{ op://Developers/NPM_TOKEN/SETUP_SECRET/value }}"
 ```
 
-Then you can run `trixie load > .env.secrets` to update your env file with the `NPM_TOKEN`
+Then you can run `trixie load > .env.secrets` to update your env file with the `NPM_TOKEN`.
+
+Alternatively, you can also leverage the following environment variables:
+- TRIXIE_OP_ADDRESS - sets the authentication address for 1Password
+- TRIXIE_OP_EMAIL - sets the user email address for 1Password
+
+Example:
+```ssh
+  TRIXIE_OP_ADDRESS=https://{account}.1password.com \
+  TRIXIE_OP_EMAIL=john.doe@email.com \
+  trixie load > .env.secrets
+```
+this will populate your env file with:
+`export NPM_TOKEN={toptals-read-only-npm-token}`
 
 ### Groups
 
@@ -70,9 +83,7 @@ Or install it yourself as:
 ## TODO IDEAS
 
 1. Support Multiple Backends/Password Managers, Trixie::Loader can be refactored to be an adapter for the op CLI
-2. Allow specific Backend options, eg: trixie load --backend op --backend-options '{ "email": "bar@foo.com",   "address": "foo.1password.com"}'
-3. Validate the `.trixie.yml`, check if we have the required values for trixie to run
-4. Add a load --cache option, so fetched secrets could be retained for a while without using the Password Manager Backend
+2. Add a load --cache option, so fetched secrets could be retained for a while without using the Password Manager Backend
 
 ## Development
 

data/lib/trixie/contracts/trixie_yml.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trixie
+  module Contracts
+    # class to validate .trixie.yml files
+    # Usage:
+    #   config_contract = Trixie::Contracts::TrixieYml.new
+    #   result = config_contract.call(config_options)
+    #   result.sucess?
+    #   result.errors.to_h
+    class TrixieYml < Dry::Validation::Contract
+      params do
+        required(:secrets).array(:hash) do
+          required(:env).filled(:string)
+          required(:value).filled(Types::Strict::String | Types::Strict::Bool | Types::Strict::Integer)
+          required(:groups).array(:string)
+        end
+      end
+    end
+  end
+end

data/lib/trixie/contracts/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trixie
+  module Contracts
+    module Types
+      include Dry.Types
+    end
+  end
+end

data/lib/trixie/load.rb

@@ -4,6 +4,8 @@ module Trixie
   # Fetches the specified secrets with op cli and returns them formatted
   class Load
     OP_NOT_INSTALLED = "op cli is not installed please download and install at https://developer.1password.com/docs/cli/get-started#install"
+    OP_ADDRESS_ENV = "TRIXIE_OP_ADDRESS"
+    OP_EMAIL_ENV = "TRIXIE_OP_EMAIL"
 
     def initialize(file:, groups: [], format: "env")
       @file = file
@@ -13,6 +15,7 @@ module Trixie
 
     def call
       verify_op_installed!
+      verify_secrets_config!
 
       create_account unless account_is_configured?
 
@@ -20,7 +23,13 @@ module Trixie
     end
 
     def verify_op_installed!
-      raise Trixie::OpCLINotInstalled, OP_NOT_INSTALLED unless system("which op > /dev/null")
+      raise Trixie::OpCLINotInstalledError, OP_NOT_INSTALLED unless system("which op > /dev/null")
+    end
+
+    def verify_secrets_config!
+      result = Trixie::Contracts::TrixieYml.new.call(secrets_config)
+
+      raise Trixie::InvalidConfigError, "Invalid .trixie.yml: #{result.errors.to_h}" if result.errors.any?
     end
 
     def account_is_configured?
@@ -31,7 +40,7 @@ module Trixie
       warn "* Configuring 1password Account"
       warn "To get the Secret Key take a look at https://support.1password.com/secret-key/"
 
-      `op account add`
+      add_op_account
     end
 
     def fetch_secrets
@@ -51,5 +60,14 @@ module Trixie
     def formatted_secrets
       @formatter.call(filtered_secrets)
     end
+
+    def add_op_account
+      cmd = "op account add"
+
+      cmd += " --address #{ENV[OP_ADDRESS_ENV]}" if ENV[OP_ADDRESS_ENV]
+      cmd += " --email #{ENV[OP_EMAIL_ENV]}" if ENV[OP_EMAIL_ENV]
+
+      `#{cmd}`
+    end
   end
 end

data/lib/trixie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trixie
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/trixie.rb

@@ -5,16 +5,20 @@ require "yaml"
 require "json"
 require "pathname"
 require "dry/cli"
+require "dry/validation"
 
 require_relative "trixie/version"
 require_relative "trixie/template"
 require_relative "trixie/formatter"
+require_relative "trixie/contracts/types"
+require_relative "trixie/contracts/trixie_yml"
 require_relative "trixie/load"
 require_relative "trixie/cli"
 
 module Trixie # rubocop:disable Style/Documentation
   class Error < StandardError; end
-  class OpCLINotInstalled < Error; end
+  class OpCLINotInstalledError < Error; end
+  class InvalidConfigError < Error; end
 
   class << self
     def root_path

data/trixie.gemspec

@@ -32,4 +32,6 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
   spec.add_dependency "dry-cli", "~> 0.7.0"
+  spec.add_dependency "dry-schema", "~> 1.10.0"
+  spec.add_dependency "dry-validation", "~> 1.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trixie
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Toptal, LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: 
 email:
 - open-source@toptal.com
@@ -35,6 +63,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -50,6 +79,8 @@ files:
 - exe/trixie
 - lib/trixie.rb
 - lib/trixie/cli.rb
+- lib/trixie/contracts/trixie_yml.rb
+- lib/trixie/contracts/types.rb
 - lib/trixie/formatter.rb
 - lib/trixie/load.rb
 - lib/trixie/template.rb