firespring_dev_commands 2.1.8 → 2.1.10.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b724b0a6f7c0ab20b780894cc5c312fe545efb7a0460801bdde3fd25ea5d0c
-  data.tar.gz: 940ff9bff43521dbc47be595adb02cc369ec7e0e1f70c0ea1361ecf0f32a796f
+  metadata.gz: c75f83066598edad92a8d34dd12d898d9f5229cf80bd8eeba166cd7e5451296e
+  data.tar.gz: 832006c6ec28b9b8a288e3a0d510f628f3c468b3c0cb8614d1eae5927f25184a
 SHA512:
-  metadata.gz: 3faa331db0c214a38e4d17c352f86c4978e2813985111b59b1e43fc7a775907e7bf1fe178ccfbd2df275933345a16fe4882c99ac6a9779e8dee877a66143b0e5
-  data.tar.gz: 0e5da5e49aa2664c7fb678cd4cd11c37d85a4787c3aa91210022f1d20f1084109815cb3e875729c81932eb074a1f81b3372eb9e5f21c41a3ddeb2caae921669e
+  metadata.gz: f3ea07c7f9be119c8ec47914c213560069ee1c17b6a0e8dcbe43b41cb246febd258079b12843d2819cdd4b1cc7aa180e3515fd8edeaca8fea9a5866758614a33
+  data.tar.gz: b395757808d58b999546d5df762ef46caf59ebf670599ec77d0b1c91098381c9f6da96e102141050f1a638ea83972c2757d795016e90cff1bb0474d0865b5db0

data/lib/firespring_dev_commands/git.rb

@@ -203,6 +203,7 @@ module Dev
 
     # Checks out the given branch in the given repo
     # Defaults to the current directory
+    # optionally raise errors
     def checkout(branch, dir: default_project_dir, raise_errors: false)
       raise 'branch is required' if branch.to_s.strip.empty?
       return unless File.exist?(dir)
@@ -231,6 +232,8 @@ module Dev
     end
 
     # Create the given branch in the given repo
+    # Defaults to the current directory
+    # optionally raise errors
     def create_branch(branch, dir: default_project_dir, raise_errors: false)
       raise 'branch is required' if branch.to_s.strip.empty?
       raise "refusing to create protected branch '#{branch}'" if %w(master develop).any?(branch.to_s.strip)
@@ -259,6 +262,9 @@ module Dev
       false
     end
 
+    # Add the given paths to git
+    # Defaults to the current directory
+    # optionally raise errors
     def add(*paths, dir: default_project_dir, raise_errors: false)
       g = ::Git.open(dir)
       indent g.add(paths)
@@ -292,6 +298,8 @@ module Dev
     end
 
     # Merge the given branch into the given repo
+    # Defaults to the current directory
+    # optionally raise errors
     def merge(branch, dir: default_project_dir, raise_errors: false)
       raise 'branch is required' if branch.to_s.strip.empty?
       return unless File.exist?(dir)
@@ -337,6 +345,8 @@ module Dev
     end
 
     # Pull the given repo
+    # Defaults to the current directory
+    # optionally raise errors
     def pull(dir: default_project_dir, raise_errors: false)
       return unless File.exist?(dir)
 
@@ -374,6 +384,8 @@ module Dev
     end
 
     # Push the given repo
+    # Defaults to the current directory
+    # optionally raise errors
     def push(dir: default_project_dir, raise_errors: false)
       return unless File.exist?(dir)
 

data/lib/firespring_dev_commands/jira/histories.rb

@@ -1,6 +1,8 @@
 module Dev
   class Jira
+    # Class which provides a helper method for converting the changelog data to history objects
     class Histories
+      # If changelog is present in the given data, return an array of history objects for each changelog entry
       def self.populate(data)
         return nil unless data.attrs.key?('changelog')
 

data/lib/firespring_dev_commands/jira/history.rb

@@ -2,6 +2,7 @@ require 'date'
 
 module Dev
   class Jira
+    # Class contains history data for jira objects
     class History
       attr_accessor :date, :id, :author, :created, :items
 

data/lib/firespring_dev_commands/jira/issue.rb

@@ -21,21 +21,25 @@ module Dev
         @last_closed_history = nil
       end
 
+      # Returns the cycle time of the issue (time between in progress and closed states)
       def cycle_time
         # Calculate the difference and convert to days
         ((last_closed_history.created - last_in_progress_history.created) / 60 / 60 / 24).round(2)
       end
 
+      # Returns the time the issue was in progress (time between in progress and in review states)
       def in_progress_cycle_time
         # Calculate the difference and convert to days
         ((first_in_review_history.created - last_in_progress_history.created) / 60 / 60 / 24).round(2)
       end
 
+      # Returns the time the issue was in review (time between in review and closed states)
       def in_review_cycle_time
         # Calculate the difference and convert to days
         ((last_closed_history.created - first_in_review_history.created) / 60 / 60 / 24).round(2)
       end
 
+      # Loop through the issue history and find the most recent state change from Open to In Progress
       private def last_in_progress_history
         raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
 
@@ -50,6 +54,7 @@ module Dev
         @last_in_progress_history
       end
 
+      # Loop through the issue history and find the oldest state change to In Review
       private def first_in_review_history
         raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
 
@@ -64,6 +69,7 @@ module Dev
         @first_in_review_history
       end
 
+      # Loop through the issue history and find the most recent state change to closed
       private def last_closed_history
         raise 'you must expand the changelog field to calculate cycle time' if histories.nil?
 

data/lib/firespring_dev_commands/platform.rb

@@ -1,8 +1,11 @@
 module Dev
   class Common
+    # Class which returns information about the current platform
     class Platform
+      # Constant containing all supported architectures
       ALLOWED_ARCHITECTURES = %w(arm64 amd64).freeze
 
+      # Normalize the ruby platform to return a docker platform architecture format
       def determine_compute_architecture
         case RUBY_PLATFORM
         when /x86_64|amd64/
@@ -14,6 +17,9 @@ module Dev
         end
       end
 
+      # Determine the platform architecture
+      # If one was specified in the DOCKER_ARCHITECTURE variable, use it
+      # Otherwise, use the RUBY_PLATFORM built-in to auto-detect and architecture
       def architecture
         docker_architecture = ENV['DOCKER_ARCHITECTURE'].to_s.strip.downcase
         if docker_architecture.empty?
@@ -22,13 +28,11 @@ module Dev
           raise "Missing 'linux/' prefix in DOCKER_ARCHITECTURE: #{docker_architecture}" unless docker_architecture.start_with?('linux/')
 
           architecture_name = docker_architecture.split('/')[1]
-
           unless ALLOWED_ARCHITECTURES.include?(architecture_name)
             raise "Invalid DOCKER_ARCHITECTURE: #{architecture_name}. Allowed architectures are #{ALLOWED_ARCHITECTURES.join(', ')}"
           end
 
           docker_architecture
-
         end
       end
     end

data/lib/firespring_dev_commands/target_process/project.rb

@@ -0,0 +1,14 @@
+module Dev
+  class TargetProcess
+    # Class containing project information
+    class Project
+      attr_accessor :id, :type, :name
+
+      def initialize(data)
+        @id = data['Id']
+        @type = data['ResourceType']
+        @name = data['Name']
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/query.rb

@@ -0,0 +1,82 @@
+module Dev
+  class TargetProcess
+    # Class for writing target process query statements
+    class Query
+      attr_accessor :where, :incl, :take
+
+      def initialize
+        @where = []
+        @incl = []
+        @take = 250
+      end
+
+      # Add a new query clause
+      def <<(item)
+        where << item
+      end
+
+      # Add the item to the where clause
+      def where=(item)
+        if item.is_a?(Array)
+          where.concat(item)
+        else
+          where << item
+        end
+      end
+
+      # Add the item to the include clause
+      def include=(item)
+        if item.is_a?(Array)
+          incl.concat(item)
+        else
+          incl << item
+        end
+      end
+
+      # Generate the string representation for this query
+      def generate
+        {}.tap do |clause|
+          clause[:where] = where.join(' and ') unless where.nil? || where.empty?
+          clause[:include] = "[#{incl.join(',')}]" unless incl.nil? || incl.empty?
+          clause[:take] = take if take.to_i.positive?
+        end
+      end
+
+      # Generate the string representation for this query
+      def to_s
+        generate
+      end
+
+      # Add a filter that looks for stories whose id is contained in the list of ids given
+      def filter_by_user_story_ids(user_story_ids)
+        self << "(Id in ('#{user_story_ids.join("', '")}'))"
+      end
+
+      # Add a filter that looks for stories whose project id is contained in the list of ids given
+      def filter_by_project(projects)
+        self << "(Project.Name in ('#{projects.join("', '")}'))"
+      end
+
+      # Add a filter that looks for stories whose state is contained in the list of states given
+      def filter_by_states(states)
+        self << "(EntityState.Name in ('#{states.join("', '")}'))" unless states.nil? || states.empty?
+      end
+
+      # Add a filter that looks for stories whose state is set to final
+      def filter_by_final
+        self << "(EntityState.IsFinal eq 'true')"
+      end
+
+      # Add a filter that looks for stories whose end date is between the given dates
+      def filter_by_end_dates(start_date, end_date)
+        self << "(EndDate gt '#{start_date}')" if start_date
+        self << "(EndDate lt '#{end_date}')" if end_date
+      end
+
+      # Add a filter that looks for stories which do not have a linked test plan
+      def filter_by_missing_tests
+        self << '(LinkedTestPlan is nil)'
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/release.rb

@@ -0,0 +1,14 @@
+module Dev
+  class TargetProcess
+    # Class containing release information
+    class Release
+      attr_accessor :id, :type, :name
+
+      def initialize(data)
+        @id = data['Id']
+        @type = data['ResourceType']
+        @name = data['Name']
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/team.rb

@@ -0,0 +1,14 @@
+module Dev
+  class TargetProcess
+    # Class containing team information
+    class Team
+      attr_accessor :id, :type, :name
+
+      def initialize(data)
+        @id = data['Id']
+        @type = data['ResourceType']
+        @name = data['Name']
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/user.rb

@@ -0,0 +1,15 @@
+module Dev
+  class TargetProcess
+    # Class containing user information
+    class User
+      attr_accessor :id, :type, :name, :login
+
+      def initialize(data)
+        @id = data['Id']
+        @type = data['ResourceType']
+        @name = data['FullName']
+        @login = data['Login']
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/user_story.rb

@@ -0,0 +1,48 @@
+module Dev
+  class TargetProcess
+    # Class containing user story information
+    class UserStory
+      # The api path for user story requests
+      PATH = '/UserStories'.freeze
+
+      attr_accessor :type, :id, :name, :description, :start_date, :end_date, :create_date, :modify_date, :tags, :effort, :time_spent, :last_state_change_date, :project,
+                    :owner, :creator, :release, :team, :priority, :state, :original_data
+
+      def initialize(data)
+        @id = data['Id']
+        @type = data['ResourceType']
+        @name = data['Name']
+        @description = data['Description']
+        @state = data['EntityState']['Name']
+        @project = Project.new(data['Project']) if data['Project']
+        @owner = User.new(data['Owner']) if data['Owner']
+        @creator = User.new(data['Creator']) if data['Creator']
+        @release = Release.new(data['Release']) if data['Release']
+        @team = Team.new(data['Team']) if data['Team']
+        @start_date = parse_time(data['StartDate'])
+        @end_date = parse_time(data['EndDate'])
+        @create_date = parse_time(data['CreateDate'])
+        @modify_date = parse_time(data['ModifyDate'])
+        @tags = data['Tags']
+        @effort = data['Effort']
+        @time_spent = data['TimeSpent']
+        @last_state_change_date = parse_time(data['LastStateChangeDate'])
+        @original_data = original_data
+      end
+
+      # Parse the dot net time representation into something that ruby can use
+      def parse_time(string)
+        return nil unless string && !string.empty?
+
+        Time.at(string.slice(6, 10).to_i)
+      end
+
+      # Calculate the cycle time as the amount of time the story was open
+      def cycle_time
+        return 1.0 unless start_date && end_date
+
+        (end_date - start_date).to_f
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process.rb

@@ -0,0 +1,105 @@
+require 'net/http'
+
+module Dev
+  # Class for querying target process data from their api
+  class TargetProcess
+    # The config file to try to load credentials from
+    CONFIG_FILE = "#{Dir.home}/.env.tp".freeze
+
+    # The text of the username variable key
+    TP_USERNAME = 'TP_USERNAME'.freeze
+
+    # The text of the password variable key
+    TP_PASSWORD = 'TP_PASSWORD'.freeze
+
+    # The text of the url variable key
+    TP_URL = 'TP_URL'.freeze
+
+    # Config object for setting top level jira config options
+    Config = Struct.new(:username, :password, :url, :http_debug) do
+      def initialize
+        Dotenv.load(CONFIG_FILE) if File.exist?(CONFIG_FILE)
+
+        self.username = ENV.fetch(TP_USERNAME, nil)
+        self.password = ENV.fetch(TP_PASSWORD, nil)
+        self.url = ENV.fetch(TP_URL, nil)
+        self.http_debug = false
+      end
+    end
+
+    class << self
+      # Instantiates a new top level config object if one hasn't already been created
+      # Yields that config object to any given block
+      # Returns the resulting config object
+      def config
+        @config ||= Config.new
+        yield(@config) if block_given?
+        @config
+      end
+
+      # Alias the config method to configure for a slightly clearer access syntax
+      alias_method :configure, :config
+    end
+
+    attr_accessor :username, :password, :url, :auth, :client, :headers
+
+    # Initialize a new target process client using the given inputs
+    def initialize(username: self.class.config.username, password: self.class.config.password, url: self.class.config.url)
+      @username = username
+      @password = password
+      @auth = Base64.strict_encode64("#{@username}:#{@password}")
+      @url = url
+      uri = URI.parse(@url)
+      @client = Net::HTTP.new(uri.host, uri.port)
+      @client.use_ssl = true
+      @client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      @client.set_debug_output(LOG) if self.class.config.http_debug
+      @headers = {
+        'authorization' => "Basic #{auth}",
+        'content-type' => 'application/json',
+        'accept' => 'application/json'
+      }
+    end
+
+    # Perform a query to the user story api path
+    # Call the given block (if present) with each user story
+    # Return all user stories
+    def user_stories(query, &)
+      [].tap do |ary|
+        get(UserStory::PATH, query) do |result|
+          ary << UserStory.new(result)
+        end
+        ary.each(&)
+      end
+    end
+
+    # Perform a get request to the given path using the given query
+    # Call the given block (if present) with each piece of data
+    # Return all pieces of data
+    def get(path, query, &)
+      query_string = query.generate
+      url = "/api/v1/#{path}"
+      url << "?#{URI.encode_www_form(query_string)}" unless query_string.empty?
+
+      response = client.request_get(url, headers)
+      raise "Error querying #{url} [#{query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+
+      parsed_response = JSON.parse(response.body)
+      return parsed_response unless parsed_response.key?('Items')
+
+      parsed_response['Items'].each(&)
+
+      while parsed_response['Next']
+        response = client.request_get(parsed_response['Next'], headers)
+        raise "Error querying #{parsed_response['Next']} [#{query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+
+        parsed_response = JSON.parse(response.body)
+        return parsed_response unless parsed_response.key?('Items')
+
+        parsed_response['Items'].each(&)
+      end
+
+      nil
+    end
+  end
+end

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.8'.freeze
+    VERSION = '2.1.10.pre.alpha.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.1.10.pre.alpha.2
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.6
+        version: 7.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.6
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
   requirement: !ruby/object:Gem::Requirement
@@ -305,6 +305,13 @@ files:
 - lib/firespring_dev_commands/tar.rb
 - lib/firespring_dev_commands/tar/pax_header.rb
 - lib/firespring_dev_commands/tar/type_flag.rb
+- lib/firespring_dev_commands/target_process.rb
+- lib/firespring_dev_commands/target_process/project.rb
+- lib/firespring_dev_commands/target_process/query.rb
+- lib/firespring_dev_commands/target_process/release.rb
+- lib/firespring_dev_commands/target_process/team.rb
+- lib/firespring_dev_commands/target_process/user.rb
+- lib/firespring_dev_commands/target_process/user_story.rb
 - lib/firespring_dev_commands/templates/aws.rb
 - lib/firespring_dev_commands/templates/base_interface.rb
 - lib/firespring_dev_commands/templates/ci.rb
@@ -333,9 +340,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: