capistrano-redmine-deployment 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c60ab7f09f79a4d3b3e90a9bf6edb0da4dc66129392dd09971a2883de1413515
-  data.tar.gz: a49b08f33c15eb4f9491c65501a85b26a33eb20c89fde872f463a29d70b56a0f
+  metadata.gz: d6bcb935ad7aaa01c101fa9380a958b0dc57a3d6b1b39797fafb3eff6ae03a05
+  data.tar.gz: adaff749719d3b3178b3f6f23e71d9605c8785ff37c773d2422eb2a76f568956
 SHA512:
-  metadata.gz: 2cc8663317d582086c96f39be819bbd203fd118e58e5428ec9dcdfd1dcebaec273c9c4eb4ee21cdb70f370e2acf5715052a43ae6a15eacb72900f768b040a196
-  data.tar.gz: 195c99e17cb7ebfee2d15f6d4db30f2d33003d36b4accafc7d1ddb9c504e17fb7f4abe711ec8fb08dee856a012a17387eba049fdf9699eb5130ec1f86f100a44
+  metadata.gz: c552022bdeac49a92283af11c3e99869efb1509be175ee68179759300c6c3fde2e502b1e096736157f20e4382e77bdd1a934ceb93c6a82a2d736bd544a3ba9c1
+  data.tar.gz: b3d6ae5239ac13d3042f5228ba2a6175a3a0d1b115e186196bf26418d50db3518cb3ea4da397d7c5893f4203db3047ffa3b727ead08e30cddf69f5c25227ac2d

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/Gemfile

@@ -6,3 +6,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake"
+gem "rspec"

data/README.md

@@ -1,10 +1,10 @@
 # Capistrano::Redmine::Deployment
 
-[![GitHub](https://img.shields.io/badge/github-ruby--smart/capistrano-redmine-deployment-blue.svg)](http://github.com/ruby-smart/capistrano-redmine-deployment)
+[![GitHub](https://img.shields.io/badge/github-ruby--smart/capistrano--redmine--deployment-blue.svg)](http://github.com/ruby-smart/capistrano-redmine-deployment)
 [![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.info/gems/capistrano-redmine-deployment)
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-redmine-deployment.svg?kill_cache=1)](https://badge.fury.io/rb/capistrano-redmine-deployment)
-[![License](https://img.shields.io/github/license/ruby-smart/capistrano-redmine-deployment)](docs/LICENSE.txt)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE.txt)
 
 Redmine Deployment Tracking (for redmine_deployment plugin)
 
@@ -29,22 +29,64 @@ Or install it yourself as:
 
     $ gem install capistrano-redmine-deployment
 
-Configure redmine credentials within your `config/deploy.rb`.
+## Setup
+
+Require deployment tasks within your `Capfile`
+
+    require 'capistrano/redmine/deployment/receipts'
+
+-----
+
+## Configuration
+
+### Shared configuration
+Configure shared redmine credentials within your `config/deploy.rb`.
 ```ruby
 # redmine deployment credentials (without api_key)
 set(:redmine_host, "https://your-redmine-host")
 set(:redmine_project, "target-redmine-project-identifier")
 set(:redmine_repository, "target-redmine-repository-identifier")
+
+# in case of `SSL` issues that are caused by *CRL* (i.e. by LetsEncrypt certificates)
+set(:redmine_host_verification, false)
+
+# alternatively, for instances with a custom CA, point to a CA bundle instead of
+# disabling verification entirely (preferred over :redmine_host_verification)
+set(:redmine_ca_file, "/path/to/ca-bundle.pem")
 ```
 
-Setup redmine API-KEY through rake-task:
+### User-specific credentials
 
-    $ rake capistrano:redmine:deploy:setup
+The `api_key` is resolved from the following sources, **later ones win**:
 
+1. capistrano variables: `:redmine_api_key`, or `:redmine_api_key_command` (its stdout is used as the key) as fallback
+2. `.redmine` file in the current directory (`$PWD`) or `$HOME`
+3. the `REDMINE_API_KEY` ENV variable
 
-Require deployment tasks within your `Capfile`
+#### Option A: macOS Keychain (recommended)
+
+Store the key once per developer in the keychain (use a dedicated entry):
+
+    $ security add-generic-password -s ri-redmine-deploy -a "$USER" -w 'YOUR_KEY'
+
+Then point capistrano at a command that reads it, in your `config/deploy.rb`:
+
+```ruby
+set :redmine_api_key_command, 'security find-generic-password -s ri-redmine-deploy -w'
+```
+
+No secret ends up in `deploy.rb` or your SCM — only the command. Once every developer
+has switched over, the `.redmine` file can be removed entirely (it stays supported as a
+fallback).
+
+> Use a **dedicated** keychain entry (e.g. `ri-redmine-deploy`).
+
+#### Option B: `.redmine` file via rake-task
+
+Setup redmine `API-KEY` through rake-task:
+
+    $ rake capistrano:redmine:deployment:setup
 
-    require 'capistrano/redmine/deployment/receipts'
 
 ## Redmine requirements
 
@@ -61,14 +103,14 @@ Install the plugin `redmine_deployment`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on [GitHub](https://github.com/ruby-smart/support).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/ruby-smart/capistrano-redmine-deployment).
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](docs/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-A copy of the [LICENSE](docs/LICENSE.md) can be found @ the docs.
+A copy of the [LICENSE](LICENSE.txt) can be found @ the docs.
 
 ## Code of Conduct
 

data/docs/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Capistrano::Redmine::Deployment - CHANGELOG
 
+## [1.1.0] - 2026-07-10
+* **[add]** ENV layer for config (`REDMINE_API_KEY`, `REDMINE_HOST`, `REDMINE_PROJECT`, `REDMINE_REPOSITORY`, `REDMINE_CA_FILE`)
+* **[add]** `:redmine_api_key` capistrano variable, with `:redmine_api_key_command` (command stdout, e.g. macOS keychain) as fallback
+* **[add]** `:redmine_ca_file` config (and `REDMINE_CA_FILE` ENV) as a safe alternative to disabling host verification
+* **[add]** rspec test suite for `Config.resolve` layer precedence
+* **[ref]** config resolution order: capistrano is the base, then `.redmine` files, then ENV win over it
+* **[fix]** enable SSL by URI scheme (`https`) instead of only port 443, so HTTPS on non-standard ports works
+
+## [1.0.1] - 2025-10-24
+* **[add]** config for `host_verification` to skip issues with OpenSSL / CRL issues
+* **[add]** warning message during deployment while host verification is disabled
+* **[ref]** setup task for better configuration
+* **[ref]** logging messages for successfully / error deployment
+* **[fix]** host verification SSL/CRL issues
+
 ## [1.0.0] - 2024-10-01
 * **[add]** config, client & receipts
 * **[add]** rake task for setup

data/lib/capistrano/redmine/deployment/client.rb

@@ -2,6 +2,7 @@
 
 require 'net/http'
 require 'json'
+require 'openssl'
 
 module Capistrano
   module Redmine
@@ -25,7 +26,7 @@ module Capistrano
         end
 
         def initialize(config, logging: true)
-          @config  = config
+          @config = config
           @logging = logging
         end
 
@@ -56,15 +57,21 @@ module Capistrano
         private
 
         def send_deployment(deployment)
-          uri  = URI("#{config.host}/projects/#{config.project}/deploy/#{config.repository}.json")
+          uri = URI("#{config.host}/projects/#{config.project}/deploy/#{config.repository}.json")
 
           http = Net::HTTP.new(uri.host, uri.port)
-          http.use_ssl = true if uri.port == 443
+          http.use_ssl = true if uri.scheme == 'https'
 
-          request                      = Net::HTTP::Post.new(uri.request_uri)
-          request["Content-Type"]      = "application/json"
+          if config.ca_file
+            http.ca_file = config.ca_file
+          elsif config.host_verification == false
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request["Content-Type"] = "application/json"
           request['X-Redmine-API-Key'] = config.api_key
-          request.body                 = { deployment: deployment }.to_json
+          request.body = { deployment: deployment }.to_json
 
           response = http.request(request)
 
@@ -77,16 +84,20 @@ module Capistrano
 
         def log_deploy(deployment)
           puts "Sending deployment information to #{config.host} (project: '#{config.project}' | repo: '#{config.repository}')"
-
+          puts "\e[33m   Using custom CA file: #{config.ca_file}\e[0m" if config.ca_file
+          puts "\e[33m   WARNING: Host verification disabled!\e[0m" if config.ca_file.nil? && config.host_verification == false
+          puts ""
           puts "   Commits......: #{deployment[:from_revision]} ... #{deployment[:to_revision]}"
           puts "   Environment..: #{deployment[:environment] || '-'}"
           puts "   Branch.......: #{deployment[:branch] || '-'}"
           puts "   Server(s)....: #{deployment[:servers]}"
           puts "   Result.......: #{deployment[:result]}"
+          puts ""
         end
 
         def log_deploy_done(response)
           puts "\e[32mSuccessfully created deployment ##{response['deployment']['id']}\e[0m"
+          puts ""
         end
 
         def log_deploy_errors(response)
@@ -95,7 +106,7 @@ module Capistrano
           else
             puts "\e[31mFailed to created deployment: #{response.inspect}\e[0m"
           end
-
+          puts ""
         end
       end
     end

data/lib/capistrano/redmine/deployment/config.rb

@@ -14,7 +14,7 @@ module Capistrano
             # build new empty config
             config = new
 
-            # try to resolve from capistrano
+            # capistrano is the base - files and ENV win over it
             config.assign!(config_from_capistrano(capistrano)) if capistrano
 
             # try to resolve from current PWD
@@ -22,32 +22,68 @@ module Capistrano
             config.assign!(config_from_file(File.join(ENV['HOME'], '.redmine')))
             config.assign!(config_from_file(file)) if file
 
+            # ENV wins over files and capistrano
+            config.assign!(config_from_env)
+
             config
           end
 
           def config_from_capistrano(capistrano)
             config = {
-              host:       capistrano.fetch(:redmine_host),
-              project:    capistrano.fetch(:redmine_project) || capistrano.fetch(:redmine_project_id),
-              repository: capistrano.fetch(:redmine_repository)
+              api_key: capistrano.fetch(:redmine_api_key) || api_key_from_command(capistrano),
+              host: capistrano.fetch(:redmine_host),
+              project: capistrano.fetch(:redmine_project) || capistrano.fetch(:redmine_project_id),
+              repository: capistrano.fetch(:redmine_repository),
+              host_verification: capistrano.fetch(:redmine_host_verification),
+              ca_file: capistrano.fetch(:redmine_ca_file)
             }
 
             new(config)
           end
 
+          # Resolves config from ENV variables. Values are filtered by `assign!`,
+          # so unset (nil/empty) variables never overwrite an existing value.
+          def config_from_env
+            new({
+              api_key:    ENV['REDMINE_API_KEY'],
+              host:       ENV['REDMINE_HOST'],
+              project:    ENV['REDMINE_PROJECT'],
+              repository: ENV['REDMINE_REPOSITORY'],
+              ca_file:    ENV['REDMINE_CA_FILE']
+            })
+          end
+
           def config_from_file(file)
             new(file: file)
           end
+
+          private
+
+          # Resolves the api_key by running the `:redmine_api_key_command` capistrano
+          # variable (if set) and taking its stdout. This keeps the secret out of
+          # `deploy.rb` - only the command (e.g. a keychain lookup) lives there.
+          #
+          # On any failure (non-zero exit or empty stdout) nil is returned so the
+          # file/ENV fallback still applies.
+          def api_key_from_command(capistrano)
+            cmd = capistrano.fetch(:redmine_api_key_command)
+            return nil unless cmd && cmd != ''
+
+            key = `#{cmd}`.strip
+            return nil unless $?.success? && !key.empty?
+
+            key
+          end
         end
 
         def initialize(config = {}, file: nil)
           @config = config
-          @file   = file
+          @file = file
           load
         end
 
         def set(key, value)
-          if value && value != ''
+          if value != nil && value != ''
             @config[key.to_sym] = value
           else
             @config.delete(key.to_sym)
@@ -66,7 +102,7 @@ module Capistrano
           return unless other
 
           other.to_h.each do |key, value|
-            next if !value || value == ''
+            next if value == nil || value == ''
 
             set(key, value)
           end

data/lib/capistrano/redmine/deployment/gem_version.rb

@@ -10,7 +10,7 @@ module Capistrano
 
       module VERSION
         MAJOR = 1
-        MINOR = 0
+        MINOR = 1
         TINY  = 0
         PRE   = nil
 

data/lib/capistrano/redmine/deployment/tasks/setup.rake

@@ -8,34 +8,77 @@ Configure the redmine credentials for deployment.
       task :setup do
         require 'capistrano/redmine/deployment/config'
 
+        # resolve configs
+        config = Capistrano::Redmine::Deployment::Config.config_from_file(File.join(Dir.pwd, '.redmine'))
+
         puts "******************************************************************************************************"
         puts "== Capistrano::Redmine::Deployment - setup                                                          =="
         puts "******************************************************************************************************"
         puts ""
         puts " This task creates a '.redmine' file in your current application folder (pwd)."
+        puts " Define credentials with this task (e.g. api_key)."
+        puts ""
         puts " This file must NOT be exposed and should be EXCLUDED by your scm."
-        puts " Define application-related settings within your 'config/deploy.rb' (e.g. host, project, repository)."
-        puts " Define authentication-related settings with this task (e.g. api_key)."
+        puts " Define shared settings within your 'config/deploy.rb' (e.g. host, project, repository)."
+        puts " Define credentials with this task (e.g. api_key)."
+        puts ""
+        puts " > HINT: Keep configs empty to prevent to overwrite existing configs."
+        puts ""
+        puts " > ALTERNATIVE (recommended): the api_key can also be provided without this file"
+        puts "   via the ENV variable 'REDMINE_API_KEY' or the capistrano variable"
+        puts "   ':redmine_api_key_command' (e.g. a macOS keychain lookup). Both win over"
+        puts "   the '.redmine' file. See the README for details."
         puts ""
         puts "******************************************************************************************************"
-        print "REDMINE API-KEY (required)    > "
+        puts ""
+        puts ""
+
+        # -- BEGIN over here ...
+
+        if config.get(:api_key)
+          print "API-KEY (already done)..................> "
+        else
+          print "API-KEY (optional)......................> "
+        end
         redmine_api_key = STDIN.gets.strip
-        print "REDMINE HOST (optional)       > "
+
+        if config.get(:host)
+          print "HOST (already done).....................> "
+        else
+          print "HOST (optional).........................> "
+        end
         redmine_host = STDIN.gets.strip
-        print "REDMINE PROJECT (optional)    > "
+
+        if config.get(:project)
+          print "PROJECT (already done)..................> "
+        else
+          print "PROJECT (optional)......................> "
+        end
         redmine_project = STDIN.gets.strip
-        print "REDMINE REPOSITORY (optional) > "
+
+        if config.get(:repository)
+          print "REPOSITORY (already done)...............> "
+        else
+          print "REPOSITORY (optional)...................> "
+        end
         redmine_repository = STDIN.gets.strip
+
+        if config.get(:host_verification) != nil
+          print "DISABLE HOST VERIFICATION (already done)........> "
+        else
+          print "DISABLE HOST VERIFICATION (y / n)...............> "
+        end
+        redmine_host_verification = STDIN.gets.strip
+
         puts ""
 
-        # build config
-        config = Capistrano::Redmine::Deployment::Config.config_from_file(File.join(Dir.pwd, '.redmine'))
 
         # force set to overwrite possible existing keys
-        config.set(:api_key, redmine_api_key)
-        config.set(:host, redmine_host)
-        config.set(:project, redmine_project)
-        config.set(:repository, redmine_repository)
+        config.set(:api_key, redmine_api_key) if redmine_api_key != ''
+        config.set(:host, redmine_host) if redmine_host != ''
+        config.set(:project, redmine_project) if redmine_project != ''
+        config.set(:repository, redmine_repository) if redmine_repository != ''
+        config.set(:host_verification, redmine_host_verification.downcase != 'y') if redmine_host_verification != ''
 
         if config.save
           puts "Successfully stored config @ #{config.file}"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-redmine-deployment
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   'capistrano-redmine-deployment' is a capistrano task to log deployments to any related redmine repository.
@@ -20,7 +19,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -28,7 +29,6 @@ files:
 - capistrano-redmine-deployment.gemspec
 - docs/CHANGELOG.md
 - docs/CODE_OF_CONDUCT.md
-- docs/LICENSE.md
 - lib/capistrano-redmine-deployment.rb
 - lib/capistrano/redmine/deployment/client.rb
 - lib/capistrano/redmine/deployment/config.rb
@@ -46,7 +46,6 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/capistrano-redmine-deployment
   changelog_uri: https://github.com/ruby-smart/capistrano-redmine-deployment/blob/main/docs/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Redmine Deployment Tracking (for redmine_deployment plugin)
 test_files: []