pivotal-tracker-api 0.2.3 → 1.0.0

data/lib/pivotal-tracker-api/comment.rb

@@ -1,37 +1,86 @@
-module Scorer
+# PROPERTIES
+# id int
+#  —  Database id of the comment. This field is read only. This field is always returned.
+#
+# story_id int
+#  —  The id of the story to which the comment is attached (will be absent if comment attached to an epic. This field is read only.
+#
+# epic_id int
+#  —  The id of the epic to which the comment is attached (will be absent if comment attached to a story. This field is read only.
+#
+# text string[20000]
+#  —  Content of the comment. This field is writable only on create.
+#
+# person_id int
+#  —  The id of the comment creator. This field is writable only on create. In API responses, this attribute may be person_id or person.
+#
+# created_at datetime
+#  —  Creation time. This field is read only.
+#
+# updated_at datetime
+#  —  Updated time. (Comments are updated by removing one of their attachments.) This field is read only.
+#
+# file_attachment_ids List[int]
+#  —  IDs of any file attachments associated with the comment. This field is writable only on create. This field is excluded by default. In API responses, this attribute may be file_attachment_ids or file_attachments.
+#
+# google_attachment_ids List[int]
+#  —  IDs of any google attachments associated with the comment. This field is writable only on create. This field is excluded by default. In API responses, this attribute may be google_attachment_ids or google_attachments.
+#
+# commit_identifier string[255]
+#  —  Commit Id on the remote source control system for the comment. Present only on comments that were created by a POST to the source commits API endpoint. This field is writable only on create. (Note that this attribute does not indicate an association to another resource.)
+#
+# commit_type string[255]
+#  —  String identifying the type of remote source control system if Pivotal Tracker can determine it. Present only on comments that were created by a POST to the source commits API endpoint. This field is writable only on create.
+#
+# kind string
+#  —  The type of this object: comment. This field is read only.
+
+module PivotalAPI
   class Comment < Base
 
-    attr_accessor :project_id, :story_id, :id, :text, :author, :created_at, :updated_at, :file_attachments
+    attr_accessor :project_id, :story_id, :epic_id, :id, :text, :person, 
+                  :created_at, :updated_at, :file_attachments, 
+                  :google_attachment_ids, :commit_identifier, :commit_type, 
+                  :kind
 
     def self.fields
-      ["person(#{Scorer::Person.fields.join(',')})", 'text', 'updated_at', 'id',
-       'created_at', 'story_id', 'file_attachments']
+      ["person(#{Person.fields.join(',')})", 'text', 'updated_at', 'id',
+       'created_at', 'story_id', 'file_attachments', 'google_attachment_ids',
+       'commit_identifier', 'commit_type', 'kind']
+    end
+    
+    def self.from_json(json)
+      parse_json_comment(json)
+    end
+    
+    def self.parse_json_comment(comment)
+      person = Person.from_json(comment[:person]) if comment[:person]
+      person = Person.unkown if person.nil?
+      new({
+        id: comment[:id].to_i,
+        text: comment[:text],
+        person: person,
+        created_at: DateTime.parse(comment[:created_at].to_s),
+        updated_at: DateTime.parse(comment[:updated_at].to_s),
+        file_attachments: FileAttachments.from_json(comment[:file_attachments]),
+        commit_identifier: comment[:commit_identifier],
+        google_attachment_ids: comment[:google_attachment_ids],
+        commit_type: comment[:commit_type],
+        kind: comment[:kind]
+      })
     end
 
-    def self.parse_json_comments(json_comments, story)
-      comments = Array.new
-      json_comments.each do |comment|
-        person = Scorer::Person.parse_json_person(comment[:person]) if comment[:person]
-        person = Scorer::Person.parse_json_person({
-          id: '0',
-          name: 'Unkown',
-          initials: 'Unkown',
-          username: 'Unkown',
-          email: 'Unkown'
-        }) if person.nil?
-        file_attachments = []
-        file_attachments = Scorer::Attachment.parse_attachments(comment[:file_attachments]) if comment[:file_attachments]
-        comments << new({
-          id: comment[:id].to_i,
-          text: comment[:text],
-          author: person,
-          created_at: DateTime.parse(comment[:created_at].to_s).to_s,
-          updated_at: DateTime.parse(comment[:updated_at].to_s).to_s,
-          file_attachments: file_attachments
-        })
-      end
+  end
+  
+  class Comments < Comment
+    def self.from_json(json)
+      parse_json_comments(json) if json.is_a?(Array)
+    end
+    
+    def self.parse_json_comments(json_comments)
+      comments = []
+      json_comments.each { |comment| comments << parse_json_comment(comment) }
       comments
     end
-
   end
 end

data/lib/pivotal-tracker-api/core_ext/string.rb

@@ -0,0 +1,3 @@
+class String
+  include PivotalAPI::Extensions::String::QueryParams
+end

data/lib/pivotal-tracker-api/cycle_time_details.rb

@@ -0,0 +1,43 @@
+# PROPERTIES
+# total_cycle_time int
+#  —  The total amount of time, in milliseconds, between when the story was first started to when it was last accepted. In the case where a story has not been accepted, it is the time between when the story was first started to the current time. If the story has not been started, this property is not returned. This field is read only.
+#
+# started_time int
+#  —  The total amount of time, in milliseconds, that the story was in the started state. This field is read only.
+#
+# started_count int
+#  —  The number of times that the story has been in the started state. This field is read only.
+#
+# finished_time int
+#  —  The total amount of time, in milliseconds, that the story was in the finished state. This field is read only.
+#
+# finished_count int
+#  —  The number of times that the story has been in the finished state. This field is read only.
+#
+# delivered_time int
+#  —  The total amount of time, in milliseconds, that the story was in the delivered state. This field is read only.
+#
+# delivered_count int
+#  —  The number of times that the story has been in the delivered state. This field is read only.
+#
+# rejected_time int
+#  —  The total amount of time, in milliseconds, that the story was in the rejected state. This field is read only.
+#
+# rejected_count int
+#  —  The number of times that the story has been in the rejected state. This field is read only.
+#
+# story_id int
+#  —  The id of the associated story. This field is read only.
+#
+# kind string
+#  —  The type of this object: cycle_time_details. This field is read only.
+
+module PivotalAPI
+  class CycleTimeDetails < Base
+
+    attr_accessor :total_cycle_time, :started_time, :started_count, :finished_time, 
+                  :finished_count, :delivered_time, :delivered_count, :rejected_time, 
+                  :rejected_count, :story_id, :kind
+
+  end
+end

data/lib/pivotal-tracker-api/file_attachment.rb

@@ -0,0 +1,56 @@
+# PROPERTIES
+# id int
+#  —  Database id of the file_attachment. This field is read only. This field is always returned.
+#
+# filename string[255]
+#  —  The file's name. This field is read only.
+#
+# created_at datetime
+#  —  Creation time. This field is read only.
+#
+# uploader_id int
+#  —  The id of the person who uploaded the file. This field is read only. In API responses, this attribute may be uploader_id or uploader.
+#
+# thumbnailable boolean
+#  —  Flag indicating whether Tracker knows how to make a thumbnail image from the attachment. This field is read only.
+#
+# height int
+#  —  If the attachment is thumbnailable the height of it in pixels. This field is read only.
+#
+# width int
+#  —  If the attachment is thumbnailable the width of it in pixels. This field is read only.
+#
+# size int
+#  —  The size of the attachment in bytes. This field is read only.
+#
+# download_url string
+#  —  The URL for the original attachment on S3. This field is read only.
+#
+# content_type string[255]
+#  —  The MIME type of the attachment. This field is read only.
+#
+# uploaded boolean
+#  —  Flag indicating whether the attachment has been moved to S3. This field is read only.
+#
+# big_url string
+#  —  URL to larger-size thumbnail version if attachment is an image. This field is read only.
+#
+# thumbnail_url string
+#  —  URL to small-size thumbnail version if attachment is an image. This field is read only.
+#
+# kind string
+#  —  The type of this object: file_attachment. This field is read only.
+
+module PivotalAPI
+  class FileAttachment < Base
+
+    attr_accessor :filename, :id, :created_at, :uploaded_by, :big_url,
+                  :width, :height, :download_url, :thumbnail_url, :size, 
+                  :content_type, :kind, :uploader_id, :thumbnailable,
+                  :uploaded
+                  
+  end
+  
+  class FileAttachments < FileAttachment
+  end
+end

data/lib/pivotal-tracker-api/iteration.rb

@@ -1,12 +1,67 @@
-module Scorer
+# PROPERTIES
+# number int
+#  —  Iteration number starting from 1 for the first iteration in the project. This field is read only. This field is always returned.
+#
+# project_id int
+#  —  id of the project. This field is read only.
+#
+# length int
+#  —  Iteration length in weeks.
+#
+# team_strength float
+#  —  Iteration team strength, 1.0 is full-strength.
+#
+# story_ids List[int]
+#  —  Array of stories contained in the iteration. This field is read only. By default this will be included in responses as an array of nested structures, using the key stories. In API responses, this attribute may be story_ids or stories.
+#
+# start datetime
+#  —  Iteration start time. This field is read only.
+#
+# finish datetime
+#  —  Iteration finish time. This field is read only.
+#
+# velocity float
+#  —  The averaged number of points completed over a number of previous iterations, as determined by the project's velocity_averaged_over attribute. This field is read only. This field is excluded by default.
+#
+# points int
+#  —  The number of points in the iteration. This field is read only. This field is excluded by default.
+#
+# effective_points float
+#  —  The number of points in the iteration normalized by iteration length and team strength. This field is read only. This field is excluded by default.
+#
+# accepted daily_history_container
+#  —  The daily summary of stories accepted in this iteration. This field is read only. This field is excluded by default.
+#
+# created daily_history_container
+#  —  The number of stories created in this iteration by type. This field is read only. This field is excluded by default.
+#
+# analytics analytics
+#  —  Analytics data for this iteration. This field is read only. This field is excluded by default.
+#
+# kind string
+#  —  The type of this object: iteration. This field is read only.
+
+module PivotalAPI
   class Iteration < Base
 
-    attr_accessor :project_id, :length, :planned, :stories, :story_ids, :number, :team_strength, :finish, :kind, :start
+    attr_accessor :project_id, :length, :stories, :story_ids, :number, :team_strength, 
+                  :finish, :kind, :start, :velocity, :points, :effective_points, :analytics
+
+    def self.fields
+      ['velocity', 'points', 'effective_points', 'analytics', "stories(#{Story.fields.join(',')})", 'team_strength', 
+       'project_id', 'length', 'start', 'finish']
+    end
+
+    def self.from_json(json)
+      parse_json_iteration(json)
+    end
+    
+    protected
 
-    def self.parse_json_iteration(json_iteration, include_done)
+    def self.parse_json_iteration(json_iteration)
       new({
         project_id: json_iteration[:project_id].to_i,
-        stories: parse_stories(json_iteration[:stories], json_iteration[:project_id].to_i, include_done),
+        stories: Stories.from_json(json_iteration[:stories]),
         story_ids: json_iteration[:story_ids],
         number: json_iteration[:number],
         team_strength: json_iteration[:team_strength],
@@ -16,14 +71,21 @@ module Scorer
       })
     end
 
+  end
+  
+  class Iterations < Iteration
+    
+    def self.from_json(json)
+      parse_json_iterations(json)
+    end
+    
     protected
-
-    def self.parse_stories(stories, project_id, include_done)
-      story_ids = Array.new
-      stories.each { |story| story_ids << story[:id].to_i if !story[:id].nil? }
-      project = PivotalService.one_project(project_id)
-      PivotalService.stories(project, true, story_ids, Scorer::Story.fields, include_done)
+    
+    def self.parse_json_iterations(json_iterations)
+      iterations = []
+      json_iterations.each { |iteration| iterations << parse_json_iteration(iteration) }
+      iterations
     end
-
+    
   end
 end

data/lib/pivotal-tracker-api/label.rb

@@ -0,0 +1,32 @@
+# PROPERTIES
+# id int
+#  —  Database id of the label. This field is read only. This field is always returned.
+#
+# project_id int
+#  —  id of the project. This field is read only.
+#
+# name string[255]
+# Required  —  The label's name.
+#
+# created_at datetime
+#  —  Creation time. This field is read only.
+#
+# updated_at datetime
+#  —  Time of last update. This field is read only.
+#
+# counts story_counts
+#  —  Summary of numbers of stories and points contained. This field is read only. This field is excluded by default.
+#
+# kind string
+#  —  The type of this object: label. This field is read only.
+
+module PivotalAPI
+  class Label < Base
+
+    attr_accessor :id, :project_id, :name, :created_at, :updated_at, :counts, :kind
+
+  end
+  
+  class Labels < Label
+  end
+end

data/lib/pivotal-tracker-api/me.rb

@@ -0,0 +1,16 @@
+module PivotalAPI
+  class Me < Person
+    
+    attr_accessor :api_token, :updated_at, :created_at, :has_google_identity, 
+                  :projects, :receives_in_app_notifications, :time_zone
+                  
+    def self.retrieve(username, password)
+      Service.me(username, password)
+    end
+    
+    def projects
+      Projects.retrieve()
+    end
+    
+  end
+end

data/lib/pivotal-tracker-api/person.rb

@@ -1,21 +1,25 @@
-module Scorer
+module PivotalAPI
   class Person < Base
 
-    attr_accessor :name, :id, :initials, :email, :username
+    attr_accessor :name, :id, :initials, :email, :username, :kind
 
     def self.fields
-      ['name', 'id', 'initials', 'email', 'username']
+      ['name', 'id', 'initials', 'email', 'username', 'kind']
     end
 
-    def self.parse_json_person(json_person)
+    def self.unknown
       new({
-        id: json_person[:id].to_i,
-        name: json_person[:name],
-        initials: json_person[:initals],
-        email: json_person[:email],
-        username: json_person[:username]
+        id: '0',
+        name: 'Unkown',
+        initials: 'Unkown',
+        username: 'Unkown',
+        email: 'Unkown',
+        kind: 'person'
       })
     end
 
   end
+  
+  class People < Person
+  end
 end

data/lib/pivotal-tracker-api/project.rb

@@ -1,4 +1,4 @@
-module Scorer
+module PivotalAPI
   class Project < Base
 
     attr_accessor :updated_at, :bugs_and_chores_are_estimatable, :enable_planned_mode, :public, :story_ids, :name,
@@ -11,16 +11,18 @@ module Scorer
     class << self
 
       def fields
-        ['description', 'labels', 'name']
+        ['description', 'labels', 'name', 'current_velocity', 'velocity_averaged_over']
       end
 
-      def parse_json_projects(json_projects)
-        projects = Array.new
-        json_projects.each do |project|
-          projects << parse_json_project(project)
-        end
-        projects
+      def from_json(json)
+        parse_json_project(json)
       end
+      
+      def retrieve(project_id)
+        Service.project(project_id: project_id, fields: Project.fields)
+      end
+      
+      protected
 
       def parse_json_project(project)
         new({
@@ -28,28 +30,79 @@ module Scorer
           name: project[:name],
           week_start_day: project[:week_start_day],
           point_scale: project[:point_scale],
-          labels: parse_labels(project[:labels]),
+          labels: PivotalAPI::Label.from_json(project[:labels]),
           iteration_length: project[:iteration_length],
           current_velocity: project[:current_velocity]
         })
       end
-
-      def parse_labels(labels)
-        parsed_labels = ''
-        labels.each do |label|
-          parsed_labels = parsed_labels + "#{label[:name]},"
-        end
-        parsed_labels
-      end
+      
     end
-
-    def initialize(attributes={})
-      update_attributes(attributes)
+    
+    def activity(opts={})
+      opts[:project_id] = id
+      
+      Service.activity(opts)
     end
-
-    def get_labels
-      self.labels.split(',')
+    
+    def story(opts={})
+      opts[:project_id] = id
+      opts[:parameters] = {} unless opts[:parameters]
+      opts[:parameters][:fields] = Story.fields
+      
+      Service.story(opts)
+    end
+    
+    def stories(opts={})
+      opts[:project_id] = id
+      opts[:parameters] = {} unless opts[:parameters]
+      opts[:parameters][:fields] = Story.fields
+      
+      Service.stories(opts)
+    end
+    
+    def iterations(opts={})
+      opts[:project_id] = id
+      opts[:parameters] = {} unless opts[:parameters]
+      opts[:fields] = Iteration.fields if opts[:fields].nil?
+      
+      Service.iterations(opts)
+    end
+    
+    def current_iteration
+      iterations.first
+    end
+    
+    def previous_iteration
+      iterations(scope: 'done').first
+    end
+    
+    def next_iteration
+      iterations(scope: 'backlog').first
     end
 
   end
+  
+  class Projects < Project
+    
+    class << self
+      
+      def retrieve()
+        Service.projects(fields: Project.fields)
+      end
+    
+      def from_json(json)
+        parse_json_projects(json)
+      end
+    
+      protected
+    
+      def parse_json_projects(json_projects)
+        projects = Array.new
+        json_projects.each { |project| projects << parse_json_project(project) }
+        projects
+      end
+    
+    end
+    
+  end
 end