firespring_dev_commands 2.1.1.pre.alpha.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e54929040a40491ff1d2b36af03da9c718e2770a507cf29f62ab7b24993b8d8
-  data.tar.gz: da2feb3080c1864f22b988b9898a08408c874e29251be018b7f82f7290d5a922
+  metadata.gz: abb45242307cc08509ddc63a507488ce03e1d545ef01abc2f909d2b09382c8a1
+  data.tar.gz: 2f65a0f2845675e4930ff062865d47535c086b88267be51bba1e142f4b678057
 SHA512:
-  metadata.gz: bd65f5fb950c89f42cbb761c39241a0f6fd414f99c22e3b8ae6800bc1361ba46b104dd70e1a890477789db04750d14ab8529db53be96e8917f16d4424b2daa46
-  data.tar.gz: 85dd595b1e98265d75c41d24d3a98e72dbafa4d1fd112a04849d37061441251e5018a8295ab38486ccc78622052af98c0e111c0fc3498bf221d06072703be3b7
+  metadata.gz: 7d699f6345d0cae3650009a92330ee4b46882c849ac85fe6cb99e53861e9a57bd9e53e119e28be8ffbce6066d9e021985a7e93734aec848705b227cdd291522a
+  data.tar.gz: 972fd3a65395c8cff43136fb5cadaf96f1ab554c78feb917c9f7fccb765f3210d680e7e653f46693d9568f42bf04ef7a670e4036cf0eedec33e214b969e62ea0

data/lib/firespring_dev_commands/aws/account.rb

@@ -23,6 +23,7 @@ module Dev
       # The name of the file containing the Aws settings
       CONFIG_FILE = "#{Dev::Aws::CONFIG_DIR}/config".freeze
 
+      # Returns the config ini file associated with this object
       def self.config_ini
         IniFile.new(filename: CONFIG_FILE, default: 'default')
       end

data/lib/firespring_dev_commands/aws/credentials.rb

@@ -11,6 +11,7 @@ module Dev
       # The local file where temporary credentials are stored
       CONFIG_FILE = "#{Dev::Aws::CONFIG_DIR}/credentials".freeze
 
+      # Returns the config ini file associated with this object
       def self.config_ini
         IniFile.new(filename: CONFIG_FILE, default: 'default')
       end

data/lib/firespring_dev_commands/common.rb

@@ -89,8 +89,8 @@ module Dev
       true
     end
 
-    # Remove all leading non '{' characters
-    # Remove all trailing non '}' characters
+    # Remove all leading non left-curly-brace characters
+    # Remove all trailing non right-curly-brace characters
     def strip_non_json(str)
       str.sub(/\A[^{]*{/m, '{').sub(/}[^}]*\z/m, '}')
     end

data/lib/firespring_dev_commands/slack/global.rb

@@ -3,21 +3,26 @@ require 'dotenv'
 
 module Dev
   class Slack
+    # A class to manage slack global configuration settings
     class Global
       # The filename where we store the local auth information
       CONFIG_FILE = "#{Dir.home}/.env.slack".freeze
 
+      # The name of the environmental setting which holds the slack token
       SLACK_API_TOKEN = 'SLACK_API_TOKEN'.freeze
 
+      # Method to load the slack config file and then configure slack
       def configure
         # Always load the env slack auth
         Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
 
         ::Slack.configure do |c|
-          c.token = ENV.fetch('SLACK_API_TOKEN', nil)
+          c.token = ENV.fetch(SLACK_API_TOKEN, nil)
           c.logger = LOG if ENV['ENABLE_SLACK_DEBUG'].to_s.strip == 'true'
         end
       end
+
+      # Run the configure when creating this class to load any existing settings
       new.configure
 
       # Write the new slack auth value to the env file

data/lib/firespring_dev_commands/slack.rb

@@ -1,18 +1,23 @@
 require 'slack'
 
 module Dev
+  # The main slack class for posting/uploading messages
   class Slack
+    # The attribute which contains the underlying slack web client object
     attr_accessor :client
 
+    # Create a new slack web client and make sure it has valid credentials
     def initialize
       @client = ::Slack::Web::Client.new
       @client.auth_test
     end
 
+    # Post the text to the given channel
     def post(channel:, text:)
       client.chat_postMessage(channel:, text:)
     end
 
+    # Upload the text to the give channel as a text file
     def upload_text(channel:, text:, title: 'Text File', filename: 'file.txt')
       raise 'text should be a string' unless text.is_a?(String)
 

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.1.pre.alpha.5'.freeze
+    VERSION = '2.1.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.1.pre.alpha.5
+  version: 2.1.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -330,9 +330,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: