pivotal-tracker-api 0.2.3 → 1.0.0

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

@@ -0,0 +1,81 @@
+# state enumerated string
+#  —  State the story transitioned to. This field is read only.
+# Valid enumeration values: accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled
+#
+# story_id int
+#  —  ID of the story. This field is read only.
+#
+# project_id int
+#  —  ID of the project. This field is read only.
+#
+# project_version int
+#  —  The activity version of the story transition. This field is read only.
+#
+# occurred_at datetime
+#  —  Time of the transition. This field is read only.
+#
+# performed_by_id int
+#  —  ID of the person who performed the story transition. This field is read only.
+#
+# kind string
+#  —  The type of this object: story_transition. This field is read only.
+
+module PivotalAPI
+  class StoryTransition < Base
+
+    attr_accessor :state, :story_id, :project_id, :project_version, :occurred_at, :performed_by_id, :kind
+
+    class << self
+      
+      def from_json(json)
+        return nil unless json
+        if json.is_a?(Array)
+          parse_json_story_transitions(json)
+        else
+          parse_json_story_transition(json)
+        end
+      end
+
+      def parse_json_story_transitions(json_story_transitions)
+        transitions = []
+        json_story_transitions.each do |transition|
+          transitions << parse_json_story_transition(transition)
+        end
+        transitions
+      end
+
+      def parse_json_story_transition(json_story_transition)
+        new({
+          state: json_story_transition[:state],
+          story_id: json_story_transition[:story_id].to_i,
+          project_id: json_story_transition[:project_id].to_i,
+          project_version: json_story_transition[:project_version].to_i,
+          occurred_at: (DateTime.parse(json_story_transition[:occurred_at]) if json_story_transition[:occurred_at]),
+          performed_by_id: json_story_transition[:performed_by_id].to_i,
+          kind: json_story_transition[:kind]
+        })
+      end
+      
+    end
+
+  end
+  
+  class StoryTransitions < StoryTransition
+    
+    class << self
+      
+      def from_json(json)
+        return nil unless json
+        parse_json_story_transitions(json)
+      end
+
+      def parse_json_story_transitions(story_transitions)
+        transitions = []
+        story_transitions.each { |transition| transitions << parse_json_story_transition(transition) }
+        transitions
+      end
+      
+    end
+    
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'cgi'
+
+module PivotalAPI
+  module Extensions
+    module String
+      module QueryParams
+
+        def append_pivotal_params(params, replace=true)
+          return self if params.nil?
+          
+          resulting_url = if replace then self else "" end
+          
+          if self.rindex("?").nil?
+            resulting_url += "?"
+            replace(resulting_url)
+          end
+          
+          case params
+          when Array
+            resulting_url += params_from_array(params)
+          when Hash
+            resulting_url += params_from_hash(params)
+          else
+            resulting_url += "#{params}"
+          end
+          
+          if replace then replace(resulting_url) else resulting_url end
+        end
+        
+        protected
+        
+        def params_from_hash(hash)
+          q_params = ""
+          hash.each do |k,v|
+            case v
+            when Array
+              q_params += if q_params.length == 0 then "#{k}=" else "&#{k}=" end
+              q_params += params_from_array(v)
+            when Hash
+              q_params += if q_params.length == 0 then "#{k}=" else "&#{k}=" end
+              v.each { |kk,vv|
+                q_params += if v.keys.first == kk then "#{kk}%3A" else "%20#{kk}%3A" end
+                q_params += append_pivotal_params(vv, false)
+              }
+            else
+              q_params += if q_params.length == 0 then "#{k}=#{v}" else "&#{k}=#{v}" end
+            end
+          end
+          q_params
+        end
+        
+        def params_from_array(array)
+          q_params = ""
+          array.each { |vv| q_params += if array.index(vv) == 0 then "#{vv}" else ",#{vv}" end }
+          q_params
+        end
+        
+      end
+    end
+  end
+end

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

@@ -1,21 +1,65 @@
-module Scorer
+# PROPERTIES
+# id int
+#  —  Database id of the task. This field is read only. This field is always returned.
+#
+# story_id int
+#  —  The id of the story to which the task is connected. This field is read only.
+#
+# description string[1000]
+# Required On Create  —  Content of the task. This field is required on create.
+#
+# complete boolean
+#  —  Flag showing the completion of the task.
+#
+# position int
+#  —  Offset from the top of the task list. Positions start counting from 1 for the first task on a story.
+#
+# created_at datetime
+#  —  Creation time. This field is read only.
+#
+# updated_at datetime
+#  —  Time of last update. This field is read only.
+#
+# kind string
+#  —  The type of this object: task. This field is read only.
+
+module PivotalAPI
   class Task < Base
 
     attr_accessor :project_id, :story_id, :id, :description, :position, :complete, :created_at
 
-    def self.parse_tasks(tasks, story)
-      parsed_tasks = []
-      tasks.each do |task|
-        parsed_tasks << new({
-            id: task[:id].to_i,
-            description: task[:description],
-            complete: task[:complete],
-            created_at: DateTime.parse(task[:created_at].to_s).to_s,
-            story_id: story[:id]
-        })
-      end if tasks
+    def self.from_json(json)
+      return nil unless json
+      parse_task(json)
+    end
+
+    protected
+    
+    def self.parse_task(task)
+      new({
+        id: task[:id].to_i,
+        description: task[:description],
+        complete: task[:complete],
+        created_at: DateTime.parse(task[:created_at].to_s),
+        story_id: task[:id]
+      })
+    end
+  end
+  
+  class Tasks < Task
+    
+    def self.from_json(json)
+      return nil unless json
+      parse_tasks(json)
+    end
 
+    protected
+    
+    def self.parse_tasks(tasks)
+      parsed_tasks = []
+      tasks.each { |task| parsed_tasks << parse_task(task) }
       parsed_tasks
     end
+    
   end
 end

data/pivotal-tracker-api.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: pivotal-tracker-api 0.2.3 ruby lib
+# stub: pivotal-tracker-api 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pivotal-tracker-api"
-  s.version = "0.2.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["jfox"]
-  s.date = "2016-01-22"
+  s.date = "2016-08-23"
   s.description = "A ruby gem to communicate with the Picotal Tracker API v5"
   s.email = "atljeremy@me.com"
   s.extra_rdoc_files = [
@@ -36,19 +36,35 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/pivotal-tracker-api.rb",
     "lib/pivotal-tracker-api/activity.rb",
-    "lib/pivotal-tracker-api/attachment.rb",
+    "lib/pivotal-tracker-api/analytics.rb",
     "lib/pivotal-tracker-api/base.rb",
     "lib/pivotal-tracker-api/client.rb",
     "lib/pivotal-tracker-api/comment.rb",
+    "lib/pivotal-tracker-api/core_ext/string.rb",
+    "lib/pivotal-tracker-api/cycle_time_details.rb",
+    "lib/pivotal-tracker-api/file_attachment.rb",
     "lib/pivotal-tracker-api/iteration.rb",
+    "lib/pivotal-tracker-api/label.rb",
+    "lib/pivotal-tracker-api/me.rb",
     "lib/pivotal-tracker-api/person.rb",
-    "lib/pivotal-tracker-api/pivotal_service.rb",
     "lib/pivotal-tracker-api/project.rb",
+    "lib/pivotal-tracker-api/service.rb",
     "lib/pivotal-tracker-api/story.rb",
+    "lib/pivotal-tracker-api/story_transition.rb",
+    "lib/pivotal-tracker-api/string_extensions.rb",
     "lib/pivotal-tracker-api/task.rb",
     "pivotal-tracker-api.gemspec",
     "test/helper.rb",
-    "test/test_pivotal-tracker-api.rb"
+    "test/test_activity.rb",
+    "test/test_analytics.rb",
+    "test/test_cycle_time_details.rb",
+    "test/test_iteration.rb",
+    "test/test_label.rb",
+    "test/test_me.rb",
+    "test/test_service.rb",
+    "test/test_story.rb",
+    "test/test_story_transition.rb",
+    "test/test_string_extensions.rb"
   ]
   s.homepage = "http://github.com/atljeremy/pivotal-tracker-api"
   s.licenses = ["MIT"]
@@ -60,26 +76,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rest-client>, ["~> 1.7"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<business_time>, ["~> 0.7.6"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.1"])
     else
       s.add_dependency(%q<rest-client>, ["~> 1.7"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<business_time>, ["~> 0.7.6"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.1"])
     end
   else
     s.add_dependency(%q<rest-client>, ["~> 1.7"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<business_time>, ["~> 0.7.6"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.1"])
   end
 end
 

data/test/helper.rb

@@ -8,6 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'test/unit'
+require 'mocha/test_unit'
 require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/test/test_activity.rb

@@ -0,0 +1,79 @@
+require 'helper'
+
+class TestActivity < Test::Unit::TestCase
+  
+  context "A PivotalAPI::Activity" do 
+  
+    setup do
+      @activity = PivotalAPI::Activity.from_json([{
+            project_id: 1,
+            occurred_at: "2016-08-17T11:03:53-04:00",
+            highlight: "some-string",
+            primary_resources: [{foo: "bar"}],
+            changes: [{abc: "123"}],
+            guid: "123abc",
+            kind: "some-kind",
+            performed_by_id: 2,
+            performed_by: {
+              id: 2,
+              name: "John Appleseed",
+              initials: "JA",
+              email: "john@email.com",
+              username: "johnapple"
+            },
+            message: "some message",
+            project_version: 3
+          }])
+    end
+
+    should "have a valid project_id" do
+      assert_equal(1, @activity[0].project_id)
+    end
+    
+    should "have a valid occurred_at date" do
+      assert_equal(DateTime.parse("2016-08-17T11:03:53-04:00"), @activity[0].occurred_at)
+    end
+    
+    should "have a valid highlight" do
+      assert_equal("some-string", @activity[0].highlight)
+    end
+    
+    should "have valid primary_resources" do
+      assert_equal("bar", @activity[0].primary_resources[0][:foo])
+    end
+    
+    should "have valid changes" do
+      assert_equal("123", @activity[0].changes[0][:abc])
+    end
+    
+    should "have a valid guid" do
+      assert_equal("123abc", @activity[0].guid)
+    end
+    
+    should "have a valid kind" do
+      assert_equal("some-kind", @activity[0].kind)
+    end
+    
+    should "have a valid performed_by_id" do
+      assert_equal(2, @activity[0].performed_by_id)
+    end
+    
+    should "have a valid performed_by person" do
+      person = @activity[0].performed_by
+      assert_equal(2, person.id)
+      assert_equal("John Appleseed", person.name)
+      assert_equal("JA", person.initials)
+      assert_equal("john@email.com", person.email)
+      assert_equal("johnapple", person.username)
+    end
+    
+    should "have a valid message" do
+      assert_equal("some message", @activity[0].message)
+    end
+    
+    should "have a valid project_version" do
+      assert_equal(3, @activity[0].project_version)
+    end
+    
+  end
+end

data/test/test_analytics.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestAnalytics < Test::Unit::TestCase
+  
+  context "A PivotalAPI::Analytics" do
+  
+    setup do
+      @analytics = PivotalAPI::Analytics.from_json({
+            stories_accepted: 5,
+            bugs_created: 2,
+            cycle_time: 343434,
+            rejection_rate: 33.8,
+            kind: "some-kind"
+          })
+    end
+  
+    should "have a valid stories_accepted count" do
+      assert_equal(5, @analytics.stories_accepted)
+    end
+    
+    should "have a valid bugs_created count" do
+      assert_equal(2, @analytics.bugs_created)
+    end
+    
+    should "have a valid cycle_time" do
+      assert_equal(343434, @analytics.cycle_time)
+    end
+    
+    should "have a valid rejection_rate" do
+      assert_equal(33.8, @analytics.rejection_rate)
+    end
+    
+    should "have a valid kind" do
+      assert_equal("some-kind", @analytics.kind)
+    end
+    
+  end
+end

data/test/test_cycle_time_details.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class TestAnalytics < Test::Unit::TestCase
+  
+  
+  context "A PivotalAPI::CycleTimeDetails" do
+    
+    setup do
+      @cycle_time_details = PivotalAPI::CycleTimeDetails.from_json({
+          total_cycle_time: 12345, 
+          started_time: 1111111111, 
+          started_count: 2, 
+          finished_time: 2222222222, 
+          finished_count: 3, 
+          delivered_time: 3333333333, 
+          delivered_count: 4, 
+          rejected_time: 4444444444, 
+          rejected_count: 5, 
+          story_id: 33, 
+          kind: "some-kind"
+          })
+    end
+    
+    should "have a valid total_cycle_time" do
+      assert_equal(12345, @cycle_time_details.total_cycle_time)
+    end
+    
+    should "have a valid started_time" do
+      assert_equal(1111111111, @cycle_time_details.started_time)
+    end
+    
+    should "have a valid started_count" do
+      assert_equal(2, @cycle_time_details.started_count)
+    end
+    
+    should "have a valid finished_time" do
+      assert_equal(2222222222, @cycle_time_details.finished_time)
+    end
+    
+    should "have a valid finished_count" do
+      assert_equal(3, @cycle_time_details.finished_count)
+    end
+    
+    should "have a valid delivered_time" do
+      assert_equal(3333333333, @cycle_time_details.delivered_time)
+    end
+    
+    should "have a valid delivered_count" do
+      assert_equal(4, @cycle_time_details.delivered_count)
+    end
+    
+    should "have a valid rejected_time" do
+      assert_equal(4444444444, @cycle_time_details.rejected_time)
+    end
+    
+    should "have a valid rejected_count" do
+      assert_equal(5, @cycle_time_details.rejected_count)
+    end
+    
+    should "have a valid story_id" do
+      assert_equal(33, @cycle_time_details.story_id)
+    end
+    
+    should "have a valid kind" do
+      assert_equal("some-kind", @cycle_time_details.kind)
+    end
+  
+  end
+end