pivotal-tracker-api 0.2.3 → 1.0.0

data/test/test_story_transition.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+class TestStoryTransition < Test::Unit::TestCase
+  should "parse a valid json object into an instance of StoryTransition" do
+    transition = PivotalAPI::StoryTransition.from_json({
+          state: "started",
+          story_id: 1,
+          project_id: 2,
+          project_version: 3,
+          occurred_at: "2016-08-09T18:55:58Z",
+          performed_by_id: 4,
+          kind: "some-kind"
+        })
+        
+    assert_equal(1, transition.story_id)
+    assert_equal(2, transition.project_id)
+    assert_equal(3, transition.project_version)
+    assert_equal(4, transition.performed_by_id)
+    assert_equal("started", transition.state)
+    assert_equal(DateTime.parse("2016-08-09T18:55:58Z"), transition.occurred_at)
+    assert_equal("some-kind", transition.kind)
+  end
+  
+  should "parse a valid json array into an arrary of StoryTransition instances" do
+    transitions = PivotalAPI::StoryTransition.from_json([{
+        state: "started",
+        story_id: 1,
+        project_id: 2,
+        project_version: 3,
+        occurred_at: "2016-08-09T18:55:58Z",
+        performed_by_id: 4,
+        kind: "some-kind"
+      },
+      {
+        state: "finished",
+        story_id: 5,
+        project_id: 6,
+        project_version: 7,
+        occurred_at: "2016-08-09T18:55:58Z",
+        performed_by_id: 8,
+        kind: "some-kind"
+      },
+      {
+        state: "accepted",
+        story_id: 9,
+        project_id: 10,
+        project_version: 11,
+        occurred_at: "2016-08-09T18:55:58Z",
+        performed_by_id: 12,
+        kind: "some-kind"
+      }
+    ])
+    
+    assert_equal(3, transitions.count)
+    
+    assert_equal(1, transitions[0].story_id)
+    assert_equal(2, transitions[0].project_id)
+    assert_equal(3, transitions[0].project_version)
+    assert_equal(4, transitions[0].performed_by_id)
+    assert_equal("started", transitions[0].state)
+    assert_equal(DateTime.parse("2016-08-09T18:55:58Z"), transitions[0].occurred_at)
+    assert_equal("some-kind", transitions[0].kind)
+    
+    assert_equal(5, transitions[1].story_id)
+    assert_equal(6, transitions[1].project_id)
+    assert_equal(7, transitions[1].project_version)
+    assert_equal(8, transitions[1].performed_by_id)
+    assert_equal("finished", transitions[1].state)
+    assert_equal(DateTime.parse("2016-08-09T18:55:58Z"), transitions[1].occurred_at)
+    assert_equal("some-kind", transitions[1].kind)
+    
+    assert_equal(9, transitions[2].story_id)
+    assert_equal(10, transitions[2].project_id)
+    assert_equal(11, transitions[2].project_version)
+    assert_equal(12, transitions[2].performed_by_id)
+    assert_equal("accepted", transitions[2].state)
+    assert_equal(DateTime.parse("2016-08-09T18:55:58Z"), transitions[2].occurred_at)
+    assert_equal("some-kind", transitions[2].kind)
+  end
+end

data/test/test_string_extensions.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestActivity < Test::Unit::TestCase
+  
+  context "Appending query params" do 
+
+    should "should append limit, offset, and fields as expected" do
+      url = "/projects/12345/stories"
+      query_params = {
+        limit: 1,
+        offset: 2,
+        fields: PivotalAPI::Comment.fields
+      }
+      url.append_pivotal_params(query_params)
+      expected_url = "/projects/12345/stories?limit=1&offset=2"
+      expected_url += "&fields=person(name,id,initials,email,username,kind),text,updated_at,id," \
+                      "created_at,story_id,file_attachments,google_attachment_ids,commit_identifier,commit_type,kind"
+      assert_equal(expected_url, url)
+    end
+    
+    should "should append filters" do
+      url = "/projects/12345/stories"
+      query_params = {
+        limit: 1,
+        offset: 2,
+        filter: {
+          includedone: true,
+          id: [1,2,3,4,5]
+        }
+      }
+      url.append_pivotal_params(query_params)
+      expected_url = "/projects/12345/stories?limit=1&offset=2&filter=includedone%3Atrue%20id%3A1,2,3,4,5"
+      assert_equal(expected_url, url)
+    end
+    
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-tracker-api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - jfox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: business_time
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.7.6
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.6
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: A ruby gem to communicate with the Picotal Tracker API v5
 email: atljeremy@me.com
 executables: []
@@ -119,19 +105,35 @@ files:
 - 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
 homepage: http://github.com/atljeremy/pivotal-tracker-api
 licenses:
 - MIT

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

@@ -1,28 +0,0 @@
-module Scorer
-  class Attachment < Base
-
-    attr_accessor :filename, :id, :created_at, :uploaded_by, :big_url,
-                  :width, :height, :download_url, :thumbnail_url, :size, :content_type
-
-    def self.parse_attachments(attachments)
-      parsed_attachments = []
-      attachments.each do |file|
-        parsed_attachments << new({
-          id: file[:id].to_i,
-          filename: file[:filename],
-          created_at: file[:created_at],
-          uploaded_by: file[:uploaded_by],
-          big_url: file[:big_url],
-          width: file[:width],
-          height: file[:height],
-          download_url: file[:download_url],
-          thumbnail_url: file[:thumbnail_url],
-          size: file[:size],
-          content_type: file[:content_type]
-        })
-      end if attachments
-      parsed_attachments
-    end
-
-  end
-end

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

@@ -1,141 +0,0 @@
-require 'json'
-
-class PivotalService
-
-  class << self
-
-    def set_token(token)
-      Scorer::Client.token = token
-    end
-
-    def all_projects(fields=[])
-      api_url = append_fields('/projects', fields)
-      response = Scorer::Client.get(api_url)
-      json_projects = JSON.parse(response, {:symbolize_names => true})
-      Scorer::Project.parse_json_projects(json_projects)
-    end
-
-    def one_project(id, fields=[])
-      return @project if !@project.nil? && @project.id == id
-
-      api_url = append_fields('/projects' + "/#{id}", fields)
-      response = Scorer::Client.get(api_url)
-      json_project = JSON.parse(response, {:symbolize_names => true})
-      @project = Scorer::Project.parse_json_project(json_project)
-    end
-
-    def activity(project_id, story_id=0, limit=20)
-      api_url = "/projects/#{project_id}/"
-      api_url = api_url + "stories/#{story_id}/" if story_id > 0
-      api_url = api_url + "activity?limit=#{limit}"
-      response = Scorer::Client.get(api_url)
-      json_activity = JSON.parse(response, {:symbolize_names => true})
-      Scorer::Activity.parse_json_activity(json_activity, project_id)
-    end
-
-    def iterations(project_id, scope, fields=[], limit=1, offset=1)
-      return @iterations if !@iterations.nil? && @iterations.last.project_id == project_id
-
-      api_url = "/projects/#{project_id}/iterations?"
-
-      if scope == 'current'
-        api_url = append_scope(api_url, scope)
-      elsif scope == 'done' || scope == 'backlog' || scope == 'current_backlog'
-        api_url = append_limit_offset(api_url, limit, offset)
-        api_url = append_scope(api_url, scope)
-      else
-        api_url = append_limit_offset(api_url, limit, offset)
-      end
-
-      api_url = append_fields(api_url, fields)
-      response = Scorer::Client.get_with_caching(api_url)
-      json_iterations = JSON.parse(response, {:symbolize_names => true})
-      @iterations = []
-      json_iterations.each do |iteration|
-        @iterations << Scorer::Iteration.parse_json_iteration(iteration, (scope == 'done'))
-      end
-      @iterations
-    end
-
-    def all_stories(project_label, project, fields=[])
-      api_url = append_fields('/projects' + "/#{project.id}/stories", fields)
-      api_url = api_url + "&with_label=#{project_label}&with_state=unstarted&limit=100"
-      response = Scorer::Client.get(api_url)
-      json_stories = JSON.parse(response, {:symbolize_names => true})
-      Scorer::Story.parse_json_stories(json_stories, project.id)
-    end
-
-    def one_story(project_label, project, fields=[])
-      api_url = append_fields('/projects' + "/#{project.id}/stories", fields)
-      api_url = api_url + "&with_label=#{project_label}&with_state=unstarted&limit=100"
-      response = Scorer::Client.get(api_url)
-      json_story = JSON.parse(response, {:symbolize_names => true})
-      Scorer::Story.parse_json_story(json_story, project.id)
-    end
-
-    def stories(project, should_cache, ids=[], fields=[], include_done=false)
-      @stories = Array.new
-      api_url = append_fields('/projects' + "/#{project.id}/stories", fields)
-      if api_url.rindex('?fields=')
-        api_url = "#{api_url}&filter=includedone%3A#{include_done}%20id%3A"
-      else
-        api_url = "#{api_url}?filter=includedone%3A#{include_done}%20id%3A"
-      end
-      if ids.size == 1
-        api_url = api_url + ids[0].to_s
-        if should_cache
-          response = Scorer::Client.get_with_caching(api_url)
-        else
-          response = Scorer::Client.get(api_url)
-        end
-        json_story = JSON.parse(response, {:symbolize_names => true})
-        @stories << Scorer::Story.parse_json_story(json_story[0], project.id)
-      else
-        story_ids = ''
-        ids.each do |id|
-          story_ids = "#{story_ids}#{id}%2C"
-        end
-        api_url = api_url + story_ids
-        if should_cache
-          response = Scorer::Client.get_with_caching(api_url)
-        else
-          response = Scorer::Client.get(api_url)
-        end
-        json_stories = JSON.parse(response, {:symbolize_names => true})
-        @stories = Scorer::Story.parse_json_stories(json_stories, project.id)
-      end
-    end
-
-    def update_story(story_id, project_id, updates={})
-      project = one_project(project_id, Scorer::Project.fields)
-      api_url = '/projects' + "/#{project.id}/stories/#{story_id}"
-      Scorer::Client.put(api_url, updates)
-    end
-
-    def comments(project_id, story, fields)
-      api_url = append_fields('/projects' + "/#{project_id}/stories/#{story.id}/comments", fields)
-      response = Scorer::Client.get_with_caching(api_url)
-      json_comments = JSON.parse(response, {:symbolize_names => true})
-      Scorer::Comment.parse_json_comments(json_comments, story)
-    end
-
-    private
-
-    def append_fields(api_url, fields)
-      url = api_url
-      fields.each do |field|
-        url = url.rindex('?fields=') ? url + ",#{field}" : url + "?fields=#{field}"
-      end
-      url
-    end
-
-    def append_scope(api_url, scope)
-      api_url + "&scope=#{scope}"
-    end
-
-    def append_limit_offset(api_url, limit, offset)
-      api_url + "&limit=#{limit}&offset=#{offset}"
-    end
-
-  end
-end

data/test/test_pivotal-tracker-api.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestPivotalTrackerApi < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-
-  end
-end