tracker_api 1.7.1 → 1.11.0

data/lib/tracker_api/error.rb

@@ -5,14 +5,24 @@ module TrackerApi
     def initialize(wrapped_exception)
       @wrapped_exception = wrapped_exception
       @response          = wrapped_exception.response
-      message            = if wrapped_exception.is_a?(Faraday::Error::ParsingError)
+      message            = if wrapped_exception.is_a?(Faraday::ParsingError)
                              wrapped_exception.message
-                           elsif wrapped_exception.is_a?(Faraday::Error::ClientError)
+                           elsif faraday_response_error?(wrapped_exception)
                              wrapped_exception.response.inspect
                            else
                              wrapped_exception.instance_variable_get(:@wrapped_exception).inspect
                            end
       super(message)
     end
+
+    private
+
+    # faraday 16.0 re-organized their errors. The errors we're interested in,
+    # Faraday::ClientError before 16.0 and Faraday::ServerError introduced in
+    # 16.0, are represented by this conditional.
+    def faraday_response_error?(wrapped_exception)
+      wrapped_exception.is_a?(Faraday::Error) &&
+        wrapped_exception.respond_to?(:response)
+    end
   end
 end

data/lib/tracker_api/file_utility.rb

@@ -0,0 +1,16 @@
+module TrackerApi
+  class FileUtility
+    class << self
+      def get_file_upload(file)
+        mime_type = MimeMagic.by_path(file)
+        { :file => Faraday::UploadIO.new(file, mime_type) }
+      end
+
+      def check_files_exist(files)
+        files.each do | file |
+          raise ArgumentError, 'Attachment file not found.' unless Pathname.new(file).exist?
+        end    
+      end
+    end
+  end
+end

data/lib/tracker_api/resources/activity.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Activity
-      include Virtus.model
+      include Shared::Base
       include Equalizer.new(:guid)
 
       attribute :client

data/lib/tracker_api/resources/blocker.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Resources
+    class Blocker
+      include Shared::Base
+
+      attribute :client
+      attribute :project_id, Integer
+
+      attribute :story_id, Integer
+      attribute :person_id, Integer
+      attribute :description, String
+      attribute :resolved, Boolean
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/comment.rb

@@ -14,7 +14,10 @@ module TrackerApi
       attribute :created_at, DateTime
       attribute :updated_at, DateTime
       attribute :file_attachment_ids, [Integer]
+      attribute :file_attachments, [FileAttachment]
       attribute :google_attachment_ids, [Integer]
+      attribute :file_attachment_ids_to_add, [Integer]
+      attribute :file_attachment_ids_to_remove, [Integer]
       attribute :commit_identifier, String
       attribute :commit_type, String
       attribute :kind, String
@@ -24,6 +27,8 @@ module TrackerApi
 
         property :id
         property :text
+        collection :file_attachment_ids_to_add
+        collection :file_attachment_ids_to_remove
       end
 
       def save
@@ -31,6 +36,36 @@ module TrackerApi
 
         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?
+
+        Endpoints::Comment.new(client).delete(self)
+      end
+
+      # @param [Hash] params attributes to create the comment with
+      # @return [Comment] newly created Comment
+      def create_attachments(params)
+        self.file_attachment_ids_to_add = Endpoints::Attachments.new(client).create(self, params[:files]).collect(&:id)
+        save
+      end
+
+      def delete_attachments(attachment_ids = nil)
+        self.file_attachment_ids_to_remove = attachment_ids || attachments.collect(&:id)
+        save
+      end
+
+      # Provides a list of all the attachments on the comment.
+      #
+      # @reload Boolean to reload the attachments
+      # @return [Array[FileAttachments]]
+      def attachments(reload: false)
+        if !reload && @file_attachments.present?
+          @file_attachments
+        else
+          @file_attachments = Endpoints::Attachment.new(client).get(self)
+        end
+      end
     end
   end
 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

@@ -34,6 +34,15 @@ module TrackerApi
 
         Endpoints::Epic.new(client).update(self, UpdateRepresenter.new(self))
       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.create_attachments(files: files) if files.present?
+        comment
+      end
     end
   end
 end

data/lib/tracker_api/resources/file_attachment.rb

@@ -0,0 +1,37 @@
+module TrackerApi
+  module Resources
+    class FileAttachment
+      include Shared::Base
+
+      attribute :comment, Comment
+
+      attribute :id, Integer
+      attribute :big_url, String
+      attribute :content_type, String
+      attribute :created_at, DateTime
+      attribute :download_url, String
+      attribute :filename, String
+      attribute :height, Integer
+      attribute :kind, String
+      attribute :size, Integer
+      attribute :thumbnail_url, String
+      attribute :thumbnailable, Boolean
+      attribute :uploaded, Boolean
+      attribute :uploader_id, Integer
+      attribute :width, Integer
+
+      def delete
+        comment.delete_attachments([id])
+      end
+
+      # TODO : Implement download properly. 
+      # Look at Attchment#download for more details
+      # The big_url actually has the AWS S3 link for the file
+      # def download
+      #   file_data = Endpoints::Attachment.new(comment.client).download(download_url)
+      #   File.open(filename, 'wb') { |fp| fp.write(file_data) }
+      # end
+    end
+  end
+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,19 @@
+module TrackerApi
+  module Resources
+    class Review
+      include Shared::Base
+
+      attribute :client
+
+      attribute :id, Integer
+      attribute :story_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
+    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
@@ -21,7 +22,7 @@ module TrackerApi
       attribute :integration_id, Integer
       attribute :kind, String
       attribute :label_ids, [Integer]
-      attribute :labels, [Label], default: nil
+      attribute :labels, [Label]
       attribute :name, String
       attribute :owned_by_id, Integer # deprecated!
       attribute :owned_by, Person
@@ -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,7 +56,21 @@ module TrackerApi
         property :deadline
         property :requested_by_id
         property :owner_ids, if: ->(_) { !owner_ids.blank? }
-        collection :labels, class: Label, decorator: Label::UpdateRepresenter, render_empty: true
+        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.
+        # - If the value of labels is not change (i.e. not dirty) then when a new Story
+        #   is created from the dirty attributes in the save method the labels attributes becomes
+        #   an empty array again. render_empty: false keeps this from rendering in the json passed
+        #   in the API PUT request. It is is empty then the labels will be cleared.
+        # - The next issue is that there is no way to delete all the labels from a Story with
+        #   the current implementation.
+        #
+        # NOTE: There are two solutions: 1) remove dirty tracking 2) rewrite without virtus
+        # SEE: https://github.com/dashofcode/tracker_api/pull/98
+        collection :labels, class: Label, decorator: Label::UpdateRepresenter, render_empty: false
+
         property :integration_id
         property :external_id
       end
@@ -104,15 +120,19 @@ 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
       # @return [Array[Comment]]
-      def comments(params = {})
-        if params.blank? && @comments.present?
+      def comments(reload: false)
+        if !reload && @comments.present?
           @comments
         else
-          @comments = Endpoints::Comments.new(client).get(project_id, id, params)
+          @comments = Endpoints::Comments.new(client).get(project_id, id)
         end
       end
 
@@ -152,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)
@@ -161,15 +192,27 @@ module TrackerApi
       # @param [Hash] params attributes to create the comment with
       # @return [Comment] newly created Comment
       def create_comment(params)
-        Endpoints::Comment.new(client).create(project_id, id, params)
+        files = params.delete(:files)
+        comment = Endpoints::Comment.new(client).create(project_id, id, params)
+        comment.create_attachments(files: files) if files.present?
+        comment
       end
 
       # Save changes to an existing Story.
       def save
         raise ArgumentError, 'Can not update a story with an unknown project_id.' if project_id.nil?
+        return self unless dirty?
 
         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