firespring_dev_commands 2.1.11.pre.alpha.1 → 2.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56bf08e32560ceaa334b8d40fca0488b851527a472b36e5338b49084d3da295b
-  data.tar.gz: a54b0aaa2fd492e7a8ac2564fddec64458a0b2c742759b67ea8fc3758d7704ae
+  metadata.gz: 29a90961c458e9095d240b89cf65bfd7cbe3541abd792f59c378a6f758636d67
+  data.tar.gz: 385f95613b2a66502c4e7a0b55d16315138c9e6cc02637e037865df7d1f3099e
 SHA512:
-  metadata.gz: c319501a7c3dbad17908f5d1af9c7b63835a676eefc182cf11a054912dcda5b2b2b3430df4dcfeabed834c5146572d63bd5aaca99158c8cf2a64632112e13874
-  data.tar.gz: bc6544562f620053912cc68772892c24d20dbcea9d171132518ec8f1a81adc9344ae8fc4d2bdfaf4712bbe7d57fe02d26e97828f5ba0ab0752fa5bb4a6f1f0c3
+  metadata.gz: dcd3f6a6d8f4fea275bf93500fa17b1c3fcda7a81b16dcd9c7c0072de8e5fe2b4298c1dc9bfdcaa5d1a8a46ecde4bcb4c624da03291638237a58a7a8b99cd12d
+  data.tar.gz: 3cb1434dd6f7edb66f79abfa7520e91bccf50bdc35588f78487d0eb20771e24f74e5105f4ed10a72c2b0d97d9f762b12ccfd43209f5853dadbd18641fa09a304

data/lib/firespring_dev_commands/target_process/query.rb

@@ -53,6 +53,7 @@ module Dev
         self << "(Id in ('#{user_story_ids.join("', '")}'))"
       end
 
+      # Add a filter that looks for stories whose team id is contained in the list of ids given
       def filter_by_team_ids(team_ids)
         self << "(Team.Id in ('#{team_ids.join("', '")}'))" unless team_ids.nil? || team_ids.empty?
       end
@@ -72,6 +73,7 @@ module Dev
         self << "(EntityState.IsFinal eq 'true')"
       end
 
+      # Add a filter that looks for start dates between the given dates`
       def filter_start_date_between(start_date, end_date)
         self << "(StartDate gte '#{start_date}')" if start_date
         self << "(StartDate lt '#{end_date}')" if end_date
@@ -83,24 +85,34 @@ module Dev
         self << "(EndDate lt '#{end_date}')" if end_date
       end
 
+      # Add a filter that looks for entities whose date is between the given dates
+      def filter_date_between(start_date, end_date)
+        self << "(Date gte '#{start_date}')" if start_date
+        self << "(Date 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
 
+      # Add a filter that looks for items with a set start date and null end date
       def filter_by_started_not_finished
         self << '(StartDate is not nil)'
         self << '(EndDate is nil)'
       end
 
+      # Add a filter that looks for assignable entity types that match the name
       def filter_by_entity_type(entity_type)
         self << "(Assignable.EntityType.Name eq '#{entity_type}')" unless entity_type.nil?
       end
 
+      # Add a filter that looks for assignable ids which are included in the given array
       def filter_by_entity_ids(entity_ids)
         self << "(Assignable.Id in ('#{entity_ids.join("', '")}'))" unless entity_ids.nil? || entity_ids.empty?
       end
 
+      # Add a filter that looks for a custom deploy date between the given dates`
       def filter_by_deploy_date(start_date, end_date = nil)
         self << "('CustomFields.Deploy Date' gt '#{start_date}')" if start_date
         self << "('CustomFields.Deploy Date' lt '#{end_date}')" if end_date

data/lib/firespring_dev_commands/target_process/user_story_history.rb

@@ -0,0 +1,45 @@
+module Dev
+  class TargetProcess
+    # Class containing user story information
+    class UserStoryHistory
+      # The resource type for the api endpoint
+      RESOURCE_TYPE = 'UserStoryHistory'.freeze
+
+      # The api path for user story requests
+      PATH = '/UserStoryHistories'.freeze
+
+      attr_accessor :type, :id, :source_entity_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']
+        @source_entity_id = data['SourceEntityId']
+        @type = data['ResourceType']
+        @name = data['Name']
+        @description = data['Description']
+        @state = data['EntityState']['Name'] if data['EntityState']
+        @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
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process.rb

@@ -45,6 +45,10 @@ module Dev
 
     # 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)
+      raise 'username is required' if username.to_s.strip.empty?
+      raise 'password is required' if password.to_s.strip.empty?
+      raise 'url is required' if url.to_s.strip.empty?
+
       @username = username
       @password = password
       @auth = Base64.strict_encode64("#{@username}:#{@password}")
@@ -85,6 +89,18 @@ module Dev
       end
     end
 
+    # Perform a query to the user story history api path
+    # Call the given block (if present) with each user story history
+    # Return all user stories
+    def user_story_histories(query, &)
+      [].tap do |ary|
+        get(UserStoryHistory::PATH, query) do |result|
+          ary << UserStoryHistory.new(result)
+        end
+        ary.each(&)
+      end
+    end
+
     # Perform a query to the team assignments api path
     # Call the given block (if present) with each team assignment
     # Return all team assignments

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.11.pre.alpha.1'.freeze
+    VERSION = '2.1.11'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.11.pre.alpha.1
+  version: 2.1.11
 platform: ruby
 authors:
 - Firespring
@@ -313,6 +313,7 @@ files:
 - lib/firespring_dev_commands/target_process/team_assignment.rb
 - lib/firespring_dev_commands/target_process/user.rb
 - lib/firespring_dev_commands/target_process/user_story.rb
+- lib/firespring_dev_commands/target_process/user_story_history.rb
 - lib/firespring_dev_commands/templates/aws.rb
 - lib/firespring_dev_commands/templates/base_interface.rb
 - lib/firespring_dev_commands/templates/ci.rb
@@ -341,9 +342,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: