tracker_api 1.9.0 → 1.13.0

data/lib/tracker_api/resources/comment.rb

@@ -32,13 +32,13 @@ module TrackerApi
       end
 
       def save
-        raise ArgumentError, 'Cannot update a comment with an unknown story_id.' if story_id.nil?
+        raise ArgumentError, 'Cannot update a comment with an unknown story_id or epic_id.' if story_id.nil? && epic_id.nil?
 
         Endpoints::Comment.new(client).update(self, UpdateRepresenter.new(Comment.new(self.dirty_attributes)))
       end
 
       def delete
-        raise ArgumentError, 'Cannot delete a comment with an unknown story_id.' if story_id.nil?
+        raise ArgumentError, 'Cannot delete a comment with an unknown story_id or epic_id.' if story_id.nil? && epic_id.nil?
 
         Endpoints::Comment.new(client).delete(self)
       end

data/lib/tracker_api/resources/cycle_time_details.rb

@@ -0,0 +1,21 @@
+module TrackerApi
+  module Resources
+    class CycleTimeDetails
+      include Shared::Base
+
+      attribute :project_id, Integer
+      attribute :iteration_number, Integer
+      attribute :total_cycle_time, Integer
+      attribute :started_time, Integer
+      attribute :started_count, Integer
+      attribute :finished_time, Integer
+      attribute :finished_count, Integer
+      attribute :delivered_time, Integer
+      attribute :delivered_count, Integer
+      attribute :rejected_time, Integer
+      attribute :rejected_count, Integer
+      attribute :story_id, Integer
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/daily_history_container.rb

@@ -0,0 +1,13 @@
+module TrackerApi
+  module Resources
+    class DailyHistoryContainer
+      include Shared::Base
+
+      attribute :project_id, Integer
+      attribute :iteration_number, Integer
+      attribute :header, [String]
+      attribute :data, [Enumerable]
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/epic.rb

@@ -35,11 +35,20 @@ module TrackerApi
         Endpoints::Epic.new(client).update(self, UpdateRepresenter.new(self))
       end
 
+      # Provides a list of all the comments on the epic.
+      def comments(reload: false)
+        if !reload && @comments.present?
+          @comments
+        else
+          @comments = Endpoints::Comments.new(client).get(project_id, epic_id: id)
+        end
+      end
+
       # @param [Hash] params attributes to create the comment with
       # @return [Comment] newly created Comment
       def create_comment(params)
         files = params.delete(:files)
-        comment = Endpoints::Comment.new(client).create(project_id, id, params)
+        comment = Endpoints::Comment.new(client).create(project_id, epic_id: id, params: params)
         comment.create_attachments(files: files) if files.present?
         comment
       end

data/lib/tracker_api/resources/iteration.rb

@@ -24,6 +24,20 @@ module TrackerApi
       def stories=(data)
         super.each { |s| s.client = client }
       end
+
+      # Provides a list of all the cycle_time_details of each story in the iteration.
+      #
+      # @return [Array[CycleTimeDetails]] array of cycle_time_details of iterations in this project
+      def cycle_time_details
+        Endpoints::Iteration.new(client).get_analytics_cycle_time_details(project_id, number)
+      end
+
+      # Returns per day information of story points and counts by state for the given iteration.
+      #
+      # @return [DailyHistoryContainer]
+      def get_history
+        Endpoints::Iteration.new(client).get_history(project_id, number)
+      end
     end
   end
 end

data/lib/tracker_api/resources/project.rb

@@ -131,6 +131,19 @@ module TrackerApi
         Endpoints::Stories.new(client).get(id, params)
       end
 
+      # Provides a list of all the releases in the project.
+      #
+      # @param [Hash] params
+      # @option params [String] :with_state A release's current_state which all returned releases must match.
+      #   Valid enumeration values: accepted, delivered, finished, started, rejected, unstarted, unscheduled
+      # @option params [Integer] :offset With the first release in your priority list as 0,
+      #   the index of the first release you want returned.
+      # @option params [Integer] :limit The number of releases you want returned.
+      # @return [Array[Release]] releases associated with this project
+      def releases(params={})
+        Endpoints::Releases.new(client).get(id, params)
+      end
+
       # Provides a list of all the memberships in the project.
       #
       # @param [Hash] params

data/lib/tracker_api/resources/release.rb

@@ -0,0 +1,29 @@
+module TrackerApi
+  module Resources
+    class Release
+      include Shared::Base
+
+      attribute :client
+
+      attribute :project_id, Integer
+      attribute :name, String
+      attribute :description, String
+      attribute :current_state, String # (accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled)
+      attribute :accepted_at, DateTime
+      attribute :deadline, DateTime
+      attribute :labels, [Label]
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :url, String
+      attribute :kind, String
+
+      # Provides a list of all the stories in the release.
+      #
+      # @param [Hash] params
+      # @return [Array[Story]] stories of this release
+      def stories(params={})
+        Endpoints::Stories.new(client).get_release(project_id, id, params)
+      end
+    end
+  end
+end

data/lib/tracker_api/resources/review.rb

@@ -0,0 +1,35 @@
+module TrackerApi
+  module Resources
+    class Review
+      include Shared::Base
+
+      attribute :client
+
+      attribute :id, Integer
+      attribute :story_id, Integer
+      attribute :project_id, Integer
+      attribute :review_type_id, Integer
+      attribute :reviewer_id, Integer
+      attribute :status, String # (unstarted, in_review, pass, revise)
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+      attribute :review_type, ReviewType
+
+      class UpdateRepresenter < Representable::Decorator
+        include Representable::JSON
+
+        property :id
+        property :review_type_id
+        property :reviewer_id
+        property :status
+      end
+
+      def save
+        raise ArgumentError, 'Cannot update a review with an unknown story_id.' if story_id.nil?
+
+        Endpoints::Review.new(client).update(self, UpdateRepresenter.new(Review.new(dirty_attributes)))
+      end
+    end
+  end
+end

data/lib/tracker_api/resources/review_type.rb

@@ -0,0 +1,15 @@
+module TrackerApi
+  module Resources
+    class ReviewType
+      include Shared::Base
+
+      attribute :id, Integer
+      attribute :project_id, Integer
+      attribute :name, String
+      attribute :hidden, Boolean
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/story.rb

@@ -8,6 +8,7 @@ module TrackerApi
       attribute :accepted_at, DateTime
       attribute :after_id, Integer
       attribute :before_id, Integer
+      attribute :blockers, [Blocker]
       attribute :comment_ids, [Integer]
       attribute :comments, [Comment]
       attribute :created_at, DateTime
@@ -31,6 +32,7 @@ module TrackerApi
       attribute :project_id, Integer
       attribute :requested_by, Person
       attribute :requested_by_id, Integer
+      attribute :reviews, [Review]
       attribute :story_type, String # (feature, bug, chore, release)
       attribute :task_ids, [Integer]
       attribute :tasks, [Task]
@@ -54,6 +56,7 @@ module TrackerApi
         property :deadline
         property :requested_by_id
         property :owner_ids, if: ->(_) { !owner_ids.blank? }
+        property :project_id
 
         # Use render_empty: false to address: https://github.com/dashofcode/tracker_api/issues/110
         # - The default value of the labels attribute in Resources::Story is an empty array.
@@ -98,7 +101,7 @@ module TrackerApi
       #
       # @param [Person|Fixnum] owner
       def add_owner(owner)
-        owner_id = if owner.kind_of?(Fixnum)
+        owner_id = if owner.kind_of?(Integer)
           owner_id = owner
         else
           raise ArgumentError, 'Valid Person expected.' unless owner.instance_of?(Resources::Person)
@@ -117,6 +120,10 @@ module TrackerApi
         Endpoints::Activity.new(client).get_story(project_id, id, params)
       end
 
+      def blockers(params = {})
+        Endpoints::Blockers.new(client).get(project_id, id, params)
+      end
+
       # Provides a list of all the comments on the story.
       #
       # @param [Hash] params
@@ -125,7 +132,7 @@ module TrackerApi
         if !reload && @comments.present?
           @comments
         else
-          @comments = Endpoints::Comments.new(client).get(project_id, id)
+          @comments = Endpoints::Comments.new(client).get(project_id, story_id: id)
         end
       end
 
@@ -165,6 +172,17 @@ module TrackerApi
         end
       end
 
+      # Returns the story's original ("undirtied") project_id
+      #
+      # @return Integer
+      def project_id
+        if dirty_attributes.key?(:project_id)
+          original_attributes[:project_id]
+        else
+          @project_id
+        end
+      end
+
       # @param [Hash] params attributes to create the task with
       # @return [Task] newly created Task
       def create_task(params)
@@ -175,7 +193,7 @@ module TrackerApi
       # @return [Comment] newly created Comment
       def create_comment(params)
         files = params.delete(:files)
-        comment = Endpoints::Comment.new(client).create(project_id, id, params)
+        comment = Endpoints::Comment.new(client).create(project_id, story_id: id, params: params)
         comment.create_attachments(files: files) if files.present?
         comment
       end
@@ -187,6 +205,14 @@ module TrackerApi
 
         Endpoints::Story.new(client).update(self, UpdateRepresenter.new(Story.new(self.dirty_attributes)))
       end
+
+      def reviews(params = {})
+          if params.blank? && @reviews.present?
+            @reviews
+          else
+            @reviews = Endpoints::Reviews.new(client).get(project_id, id, params)
+          end
+      end
     end
   end
 end

data/lib/tracker_api/version.rb

@@ -1,3 +1,3 @@
 module TrackerApi
-  VERSION = '1.9.0'
+  VERSION = '1.13.0'
 end

data/test/client_test.rb

@@ -2,7 +2,7 @@ require_relative 'minitest_helper'
 
 describe TrackerApi do
   it 'has a version' do
-    ::TrackerApi::VERSION.wont_be_nil
+    _(::TrackerApi::VERSION).wont_be_nil
   end
 end
 
@@ -13,10 +13,10 @@ describe TrackerApi::Client do
                                     token:       '12345',
                                     logger:      LOGGER)
 
-    client.url.must_equal 'http://test.com'
-    client.api_version.must_equal '/foo-bar/1'
-    client.token.must_equal '12345'
-    client.logger.must_equal LOGGER
+    _(client.url).must_equal 'http://test.com'
+    _(client.api_version).must_equal '/foo-bar/1'
+    _(client.token).must_equal '12345'
+    _(client.logger).must_equal LOGGER
   end
 
   describe '.projects' do
@@ -27,18 +27,18 @@ describe TrackerApi::Client do
       VCR.use_cassette('get all projects', record: :new_episodes) do
         projects = client.projects(fields: ':default,account,current_velocity,labels(name),epics(:default,label(name))')
 
-        projects.wont_be_empty
+        _(projects).wont_be_empty
         project = projects.first
-        project.must_be_instance_of TrackerApi::Resources::Project
-        project.id.must_equal pt_user[:project_id]
+        _(project).must_be_instance_of TrackerApi::Resources::Project
+        _(project.id).must_equal pt_user[:project_id]
 
-        project.account.must_be_instance_of TrackerApi::Resources::Account
+        _(project.account).must_be_instance_of TrackerApi::Resources::Account
 
-        project.labels.wont_be_empty
-        project.labels.first.must_be_instance_of TrackerApi::Resources::Label
+        _(project.labels).wont_be_empty
+        _(project.labels.first).must_be_instance_of TrackerApi::Resources::Label
 
-        project.epics.wont_be_empty
-        project.epics.first.must_be_instance_of TrackerApi::Resources::Epic
+        _(project.epics).wont_be_empty
+        _(project.epics.first).must_be_instance_of TrackerApi::Resources::Epic
       end
     end
   end
@@ -52,11 +52,11 @@ describe TrackerApi::Client do
       VCR.use_cassette('get project', record: :new_episodes) do
         project = client.project(project_id)
 
-        project.must_be_instance_of TrackerApi::Resources::Project
-        project.id.must_equal project_id
+        _(project).must_be_instance_of TrackerApi::Resources::Project
+        _(project.id).must_equal project_id
 
-        project.account.must_be_nil
-        project.account_id.wont_be_nil
+        _(project.account).must_be_nil
+        _(project.account_id).wont_be_nil
       end
     end
   end
@@ -69,9 +69,9 @@ describe TrackerApi::Client do
       VCR.use_cassette('get workspace', record: :new_episodes) do
         workspace = client.workspace(pt_user[:workspace_id])
 
-        workspace.must_be_instance_of TrackerApi::Resources::Workspace
-        workspace.id.must_equal pt_user[:workspace_id]
-        workspace.name.wont_be_empty
+        _(workspace).must_be_instance_of TrackerApi::Resources::Workspace
+        _(workspace.id).must_equal pt_user[:workspace_id]
+        _(workspace.name).wont_be_empty
       end
     end
   end
@@ -85,10 +85,10 @@ describe TrackerApi::Client do
       VCR.use_cassette('get all workspaces', record: :new_episodes) do
         workspaces = client.workspaces(fields: ':default,projects(id,name)')
 
-        workspaces.wont_be_empty
+        _(workspaces).wont_be_empty
         workspace = workspaces.first
-        workspace.must_be_instance_of TrackerApi::Resources::Workspace
-        workspace.id.must_equal pt_user[:workspace_id]
+        _(workspace).must_be_instance_of TrackerApi::Resources::Workspace
+        _(workspace.id).must_equal pt_user[:workspace_id]
       end
     end
   end
@@ -105,10 +105,10 @@ describe TrackerApi::Client do
       VCR.use_cassette('get me', record: :new_episodes) do
         me = client.me
 
-        me.must_be_instance_of TrackerApi::Resources::Me
-        me.username.must_equal username
+        _(me).must_be_instance_of TrackerApi::Resources::Me
+        _(me.username).must_equal username
 
-        me.projects.map(&:project_id).must_include project_id
+        _(me.projects.map(&:project_id)).must_include project_id
       end
     end
   end
@@ -124,14 +124,14 @@ describe TrackerApi::Client do
 
         # skip pagination with a hugh limit
         unpaged_stories = project.stories(limit: 300)
-        unpaged_stories.wont_be_empty
-        unpaged_stories.length.must_be :>, 7
+        _(unpaged_stories).wont_be_empty
+        _(unpaged_stories.length).must_be :>, 7
 
         # force pagination with a small limit
         paged_stories = project.stories(limit: 7)
-        paged_stories.wont_be_empty
-        paged_stories.length.must_equal unpaged_stories.length
-        paged_stories.map(&:id).sort.uniq.must_equal unpaged_stories.map(&:id).sort.uniq
+        _(paged_stories).wont_be_empty
+        _(paged_stories.length).must_equal unpaged_stories.length
+        _(paged_stories.map(&:id).sort.uniq).must_equal unpaged_stories.map(&:id).sort.uniq
       end
     end
 
@@ -141,8 +141,8 @@ describe TrackerApi::Client do
 
         # force no pagination
         stories = project.stories(limit: 7, auto_paginate: false)
-        stories.wont_be_empty
-        stories.length.must_equal 7
+        _(stories).wont_be_empty
+        _(stories.length).must_equal 7
       end
     end
 
@@ -152,8 +152,8 @@ describe TrackerApi::Client do
 
         done_iterations = project.iterations(scope: :done, offset: -12, limit: 5)
 
-        done_iterations.wont_be_empty
-        done_iterations.length.must_be :<=, 12
+        _(done_iterations).wont_be_empty
+        _(done_iterations.length).must_be :<=, 12
       end
     end
   end
@@ -166,8 +166,8 @@ describe TrackerApi::Client do
       VCR.use_cassette('client: get single story by story id', record: :new_episodes) do
         story = client.story('66728004', fields: ':default,owned_by')
 
-        story.must_be_instance_of TrackerApi::Resources::Story
-        story.owned_by.wont_be_nil
+        _(story).must_be_instance_of TrackerApi::Resources::Story
+        _(story.owned_by).wont_be_nil
       end
     end
   end
@@ -180,8 +180,8 @@ describe TrackerApi::Client do
       VCR.use_cassette('client: get single epic by epic id', record: :new_episodes) do
         epic = client.epic('1087314', fields: ':default,label_id')
 
-        epic.must_be_instance_of TrackerApi::Resources::Epic
-        epic.label_id.wont_be_nil
+        _(epic).must_be_instance_of TrackerApi::Resources::Epic
+        _(epic.label_id).wont_be_nil
       end
     end
   end
@@ -194,13 +194,13 @@ describe TrackerApi::Client do
       VCR.use_cassette('get all notifications', record: :new_episodes) do
         notifications = client.notifications
 
-        notifications.wont_be_empty
+        _(notifications).wont_be_empty
         notification = notifications.first
-        notification.must_be_instance_of TrackerApi::Resources::Notification
+        _(notification).must_be_instance_of TrackerApi::Resources::Notification
 
-        notification.project.id.must_equal pt_user[:project_id]
-        notification.story.must_be_instance_of TrackerApi::Resources::Story
-        notification.performer.must_be_instance_of TrackerApi::Resources::Person
+        _(notification.project.id).must_equal pt_user[:project_id]
+        _(notification.story).must_be_instance_of TrackerApi::Resources::Story
+        _(notification.performer).must_be_instance_of TrackerApi::Resources::Person
       end
     end
   end
@@ -213,19 +213,19 @@ describe TrackerApi::Client do
       VCR.use_cassette('get my activities', record: :new_episodes) do
         activities = client.activity(fields: ':default')
 
-        activities.wont_be_empty
+        _(activities).wont_be_empty
         activity = activities.first
-        activity.must_be_instance_of TrackerApi::Resources::Activity
+        _(activity).must_be_instance_of TrackerApi::Resources::Activity
 
-        activity.changes.wont_be_empty
-        activity.changes.first.must_be_instance_of TrackerApi::Resources::Change
+        _(activity.changes).wont_be_empty
+        _(activity.changes.first).must_be_instance_of TrackerApi::Resources::Change
 
-        activity.primary_resources.wont_be_empty
-        activity.primary_resources.first.must_be_instance_of TrackerApi::Resources::PrimaryResource
+        _(activity.primary_resources).wont_be_empty
+        _(activity.primary_resources.first).must_be_instance_of TrackerApi::Resources::PrimaryResource
 
-        activity.project.must_be_instance_of TrackerApi::Resources::Project
+        _(activity.project).must_be_instance_of TrackerApi::Resources::Project
 
-        activity.performed_by.must_be_instance_of TrackerApi::Resources::Person
+        _(activity.performed_by).must_be_instance_of TrackerApi::Resources::Person
       end
     end
   end