pivotal-tracker-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbfb334bb577e14833146540ec08e68f8dc26cca
-  data.tar.gz: dc59ed6076a4899c0b09458865c99aee9982d381
+  metadata.gz: 0b104677712cae09b437565df220315ae88480d0
+  data.tar.gz: 92f8ff95cc3783d225490b0b53a0a42bcb6420f1
 SHA512:
-  metadata.gz: 4b689d03586d7eed80ffb25444b47192adb4a5371c65b79710971805331f178d10bb092207f3800ecacf93b1fc006ae9ce67034636f2941bb78c7282b826b672
-  data.tar.gz: 9f959cc0af6ce48c3acde9785a10ad268bad1b82c3ee1376cf428b0f91636152bc6f99d14e8ce2c22f951b117004b06d38a8e93397063a113988c02e306aac60
+  metadata.gz: 7e0fd85f353763e431780593df56b051e5c021b59474f45aedb0fbfc7c3babb2245efff89501fbbfc395d997798807a5456aca5aaf12d1220c9d04185fe97fe2
+  data.tar.gz: 602e9a5acacb5429c59adf434d050266ff3428027dedb8b1a0c2be8e45ff718e318ab8a4ed9493fc3fadd5612cfae38b97d382301ed6fc462ee2520a9515ecf1

data/README.md

@@ -3,62 +3,100 @@ pivotal-tracker-api
 
 A Pivotal Tracker API gem that can be used to interface with the Pivotal Tracker API v5.
 
+[![Gem](https://img.shields.io/gem/v/pivotal-tracker-api.svg?maxAge=2592000)]() [![Gem](https://img.shields.io/gem/dtv/pivotal-tracker-api.svg?maxAge=2592000)]()
+
 ### Basic Example
 
 ```ruby
-# Use your personal Pivotal token
-def set_token
-  # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
-  # config.cache_classes = true
-  PivotalAPI::Service.set_token(your_token_here)
-end
+# Use your personal pivotal token
+PivotalAPI::Service.set_token A_PIVOTAL_TOKEN
 ```
 
 ```ruby
 # Authenticate a user using email / pass
-def get_user_token
-  email = params[:email]
-  pass = params[:pass]
-  # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
-  # config.cache_classes = true
-  token = PivotalAPI::Client.token(email, pass)
-  # do something with the token
-end
+@me = PivotalAPI::Me.retrieve('USERNAME', 'PASSWORD')
+# Note: PivotalAPI::Me.retrieve will automatically set the api token so there is no need to use PivotalAPI::Service.set_token if you use PivotalAPI::Me.retrieve to login
+```
+
+```ruby
+# If you login using PivotalAPI::Me.retrieve, you can simply ask your Me object for your projects.
+@projects = @me.projects
+
+# If you set your personal pivotal token manually using PivotalAPI::Service.set_token, you can get your projects using the following.
+@projects = PivotalAPI::Projects.retrieve()
+```
+
+```ruby
+# To get a specific project, use the following.
+@project = PivotalAPI::Project.retrieve(PROJECT_ID)
+```
+
+```ruby
+# Get a project's stories, this will return an array of PivotalAPI::Story instance's
+@stories = @project.stories
+```
+
+```ruby
+# Get a specific story for a project, this will return a PivotalAPI::Story instance
+@story = @project.story(STORY_ID)
+```
+
+```ruby
+# Get a story's comments, this will return an array of PivotalAPI::Comment instance's
+@comments = @story.comments
+```
+
+```ruby
+# Get a story's owners, this will return an array of PivotalAPI::Person instance's
+@owners = @story.owners
+```
+
+```ruby
+# Get a story's followers, this will return an array of PivotalAPI::Person instance's
+@followers = @story.followers
+```
+
+```ruby
+# Get a story's tasks, this will return an array of PivotalAPI::Task instance's
+@tasks = @story.tasks
+```
+
+```ruby
+# Get a story's transitions, this will return an array of PivotalAPI::StoryTransition instance's
+@transitions = @story.transitions
+```
+
+```ruby
+# Get a story's cycle time details, this will return ana array of PivotalAPI::CycleTimeDetails instance's
+@cycle_time_details = @story.cycle_time_details
+```
+
+```ruby
+# Get a project's activity, this will return an array of PivotalAPI::Activity instance's
+@stories = @project.activity
 ```
 
 ```ruby
-# Get all of the users Projects
-def projects
-  @projects = PivotalAPI::Service.all_projects(PivotalAPI::Project.fields)
-end
+# Get a project's iterations, this will return an array of PivotalAPI::Iteration instance's
+@iterations = @project.iterations
 ```
 
 ```ruby
-# Get only 1 of the users Projects
-def project
-  @project = PivotalAPI::Service.one_project(params[:project_id], PivotalAPI::Project.fields)
-end
+# Get a project's current iteration
+@iteration = @project.current_iteration
 ```
 
 ```ruby
-# Get a Projects Stories by a specific Label
-def stories_by_label
-  project_label   = params[:project_label]
-  @project_label  = CGI.escape(project_label) if project_label
-  @stories = PivotalAPI::Service.all_stories(@project_label, @project, PivotalAPI::Story.fields) if @project_label
-end
+# Get a project's next iteration
+@iteration = @project.next_iteration
 ```
 
 ```ruby
-# Get an Iteration and it's Stories
-def get_iteration
-  @project_id = params[:project_id]
-  @iteration  = PivotalAPI::Service.iterations(@project_id, 'current')
-  @stories    = @iteration.stories
-end
+# Get a project's previous iteration
+@iteration = @project.previous_iteration
 ```
 
-For additional infomation on how to interface with this gem and use it to communicate with the Pivotal Tracker API v5 see the [PivotalAPI::Service](https://github.com/atljeremy/pivotal-tracker-api/blob/master/lib/pivotal-tracker-api/pivotal_service.rb) class.
+For additional infomation on how to interface with this gem and use it to communicate with the Pivotal Tracker API v5 see the [PivotalAPI::Service](https://github.com/atljeremy/pivotal-tracker-api/blob/master/lib/pivotal-tracker-api/service.rb) class and the [Service Tests](https://github.com/atljeremy/pivotal-tracker-api/blob/master/test/test_service.rb).
 
 ### Contributing to pivotal-tracker-api
  

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

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

@@ -106,22 +106,46 @@ module PivotalAPI
     def hours
       return 0 if transitions.nil?
       duration_hrs = 0
-      started = nil
-      transitions.each do |transition|
+      prev_transition = nil
+      transitions.reverse.each do |transition|
         case transition.state
         when 'started'
-          started = Time.parse(transition.occurred_at.to_s)
+          prev_transition = transition
         when 'finished'
-          duration_hrs += hours_between(started, Time.parse(transition.occurred_at.to_s)) if started
+          if prev_transition
+            start_time = Time.parse(prev_transition.occurred_at.to_s)
+            end_time = Time.parse(transition.occurred_at.to_s)
+            puts "finished: start_time: #{start_time} - end_time: #{end_time}"
+            duration_hrs += hours_between(start_time, end_time)
+          end
+          prev_transition = transition
+        when 'delivered'
+          if prev_transition
+            start_time = Time.parse(prev_transition.occurred_at.to_s)
+            end_time = Time.parse(transition.occurred_at.to_s)
+            puts "delivered: start_time: #{start_time} - end_time: #{end_time}"
+            duration_hrs += hours_between(start_time, end_time)
+          end
+          prev_transition = transition
+        when 'rejected'
+          if prev_transition
+            start_time = Time.parse(prev_transition.occurred_at.to_s)
+            end_time = Time.parse(transition.occurred_at.to_s)
+            puts "rejected: start_time: #{start_time} - end_time: #{end_time}"
+            duration_hrs += hours_between(start_time, end_time)
+          end
+          prev_transition = transition
+        when 'accepted'
+          if prev_transition
+            start_time = Time.parse(prev_transition.occurred_at.to_s)
+            end_time = Time.parse(transition.occurred_at.to_s)
+            puts "accepted: start_time: #{start_time} - end_time: #{end_time}"
+            duration_hrs += hours_between(start_time, end_time)
+          end
+          prev_transition = transition
         end
       end
       
-      if current_state == 'accepted'
-        duration_hrs += hours_between(started, Time.parse(accepted_at.to_s))
-      elsif current_state != 'accepted' && started
-        duration_hrs += hours_between(started, Time.now)
-      end
-      
       duration_hrs
     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 1.0.0 ruby lib
+# stub: pivotal-tracker-api 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pivotal-tracker-api"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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-08-23"
+  s.date = "2016-08-24"
   s.description = "A ruby gem to communicate with the Picotal Tracker API v5"
   s.email = "atljeremy@me.com"
   s.extra_rdoc_files = [

data/test/test_service.rb

@@ -19,7 +19,10 @@ class TestService < Test::Unit::TestCase
     #   iteration = project.iterations.first
     #   iteration.stories.each do |story|
     #     puts "------------------"
-    #     puts "Story: #{story.name} - status: #{story.current_state} - overdue: #{story.overdue?}"
+    #     puts "Story: #{story.name}\n
+    #           status: #{story.current_state}\n
+    #           overdue: #{story.overdue?}\n
+    #           hours: #{story.hours}"
     #     puts "------------------"
     #   end
     #

data/test/test_story.rb

@@ -136,15 +136,14 @@ class TestActivity < Test::Unit::TestCase
             kind: "label"
           }],
         transitions: [{
-            state: "started",
+            state: "accepted",
             story_id: 1,
             project_id: 2,
             project_version: 3,
-            occurred_at: "2016-08-17T11:03:53-04:00",
+            occurred_at: "2016-08-19T11:04:53-04:00",
             performed_by_id: 4,
             kind: "some-kind"
-          },
-          {
+          },{
             state: "finished",
             story_id: 1,
             project_id: 2,
@@ -152,13 +151,12 @@ class TestActivity < Test::Unit::TestCase
             occurred_at: "2016-08-19T11:03:53-04:00",
             performed_by_id: 4,
             kind: "some-kind"
-          },
-          {
-            state: "accepted",
+          },{
+            state: "started",
             story_id: 1,
             project_id: 2,
             project_version: 3,
-            occurred_at: "2016-08-19T11:03:53-04:00",
+            occurred_at: "2016-08-17T11:03:53-04:00",
             performed_by_id: 4,
             kind: "some-kind"
           }]
@@ -276,7 +274,7 @@ class TestActivity < Test::Unit::TestCase
     end
     
     should "have valid transitions" do
-      assert_equal("started", @story.transitions[0].state)
+      assert_equal("accepted", @story.transitions[0].state)
     end
     
     should "have a valid task_ids" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-tracker-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - jfox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client