tracker_api 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a617d2b19c294a813a8edf94eed605c18daa6969
-  data.tar.gz: 8d05e8a155dcdf15e84c0efaba86dcd6b1914e86
+  metadata.gz: b4cba526663ee9306a7f26b12aa8f9f0c574b935
+  data.tar.gz: d91cb8b54927afb96dfb2ffd266a21fe9e4732fb
 SHA512:
-  metadata.gz: 374ec16671b186d2309513d2419e7839f98b0e71e88fee635660a18f2f5a406e5133cc24252fc8cebb6a5094d2b3cdc725edf879ad94c4bf585aa79ded685fd9
-  data.tar.gz: b8b668d588b2e6ffc4fd8455d0ef0b288e5f25c8ed896385fc707e35f608639e93781aef742aec4ef9483b48ef54a9ae8cf9e01fba4cc38dd43f2563d5f47de4
+  metadata.gz: a7784c955bea7296f2f92903c5722d114d46895935acb4d8f83519b1fd885803cf4be195cfc0835966a57ea745b4b8fbe295dd0d72bb985e66bd8c17f4bc9b72
+  data.tar.gz: 3fc7c32d7be48c0eaec816b99698ffb7f9ca7d12290dc68aca563ae90bc1a2f1b36702a77fb4be687beaf38ffa1a01fbbbde44f6ef6ebe5585861b1d3897d53f

data/README.md

@@ -53,7 +53,7 @@ story.activity                                                            # Get
 
 story.name = 'Save the Ewoks'                                             # Update a single story attribute
 story.attributes = { name: 'Save the Ewoks', description: '...' }         # Update multiple story attributes
-story.labels << Label.new(name: 'Endor')                                  # Add a new label to an existing story
+story.labels << TrackerApi::Resources::Label.new(name: 'Endor')           # Add a new label to an existing story
 story.save                                                                # Save changes made to a story
 
 epics = project.epics                                                     # Get all epics for a project
@@ -71,6 +71,8 @@ client = TrackerApi::Client.new(token: 'my-api-token')                    # Crea
 client.project(project_id, fields: ':default,labels(name)')               # Eagerly get labels with a project
 client.project(project_id, fields: ':default,epics')                      # Eagerly get epics with a project
 client.project(project_id).stories(fields: ':default,tasks')              # Eagerly get stories with tasks
+client.project.stories(fields: ':default,comments(:default,person)')      # Eagerly get stories with comments and the person that made the comment
+story.comments(fields: ':default,person')                                 # Eagerly get comments and the person that made the comment for a story
 ```
 
 ## TODO

data/lib/tracker_api/client.rb

@@ -20,7 +20,7 @@ module TrackerApi
     #
     # @example Creating a Client
     #   Client.new token: 'my-super-special-token'
-    def initialize(options={})
+    def initialize(options={}, &block)
       url                = options.fetch(:url, 'https://www.pivotaltracker.com')
       @url               = Addressable::URI.parse(url).to_s
       @api_version       = options.fetch(:api_version, '/services/v5')
@@ -31,6 +31,8 @@ module TrackerApi
       @token             = options[:token]
       raise 'Missing required options: :token' unless @token
 
+      @faraday_block = block if block_given?
+
       @connection = Faraday.new({ url: @url }.merge(connection_options)) do |builder|
         # response
         builder.use Faraday::Response::RaiseError
@@ -41,6 +43,7 @@ module TrackerApi
         builder.request :json
 
         builder.use TrackerApi::Logger, @logger
+        @faraday_block.call(builder) if @faraday_block
         builder.adapter adapter
       end
     end

data/lib/tracker_api/endpoints/activity.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(params={})
         data = client.paginate("/my/activity", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
 
         data.map do |activity|
           Resources::Activity.new({ client: client }.merge(activity))
@@ -18,7 +18,7 @@ module TrackerApi
 
       def get_project(project_id, params={})
         data = client.paginate("/projects/#{project_id}/activity", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
 
         data.map do |activity|
           Resources::Activity.new({ client: client }.merge(activity))
@@ -27,7 +27,7 @@ module TrackerApi
 
       def get_story(project_id, story_id, params={})
         data = client.paginate("/projects/#{project_id}/stories/#{story_id}/activity", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
 
         data.map do |activity|
           Resources::Activity.new({ client: client }.merge(activity))

data/lib/tracker_api/endpoints/comments.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, story_id, params={})
         data = client.paginate("/projects/#{project_id}/stories/#{story_id}/comments", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
 
         data.map do |comment|
           Resources::Comment.new({ story_id: story_id }.merge(comment))

data/lib/tracker_api/endpoints/epic.rb

@@ -10,7 +10,21 @@ module TrackerApi
       def get(project_id, id, params={})
         data = client.get("/projects/#{project_id}/epics/#{id}", params: params).body
 
-        Resources::Epic.new({ project_id: project_id }.merge(data))
+        Resources::Epic.new({ client: client, project_id: project_id }.merge(data))
+      end
+
+      def create(project_id, params={})
+        data = client.post("/projects/#{project_id}/epics", params: params).body
+
+        Resources::Epic.new({ client: client }.merge(data))
+      end
+
+      def update(epic, params={})
+        raise ArgumentError, 'Valid epic required to update.' unless epic.instance_of?(Resources::Epic)
+
+        data = client.put("/projects/#{epic.project_id}/epics/#{epic.id}", params: params).body
+
+        epic.attributes = data
       end
     end
   end

data/lib/tracker_api/endpoints/epics.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, params={})
         data = client.paginate("/projects/#{project_id}/epics", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of epics expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of epics expected' unless data.is_a? Array
 
         data.map do |epic|
           Resources::Epic.new({ project_id: project_id }.merge(epic))

data/lib/tracker_api/endpoints/iterations.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, params={})
         data = client.paginate("/projects/#{project_id}/iterations", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of iterations expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of iterations expected' unless data.is_a? Array
 
         data.map do |iteration|
           Resources::Iteration.new({ client: client, project_id: project_id }.merge(iteration))

data/lib/tracker_api/endpoints/labels.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, params={})
         data = client.paginate("/projects/#{project_id}/labels", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of labels expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of labels expected' unless data.is_a? Array
 
         data.map do |label|
           Resources::Label.new({ project_id: project_id }.merge(label))

data/lib/tracker_api/endpoints/memberships.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, params={})
         data = client.paginate("/projects/#{project_id}/memberships", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of memberships expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of memberships expected' unless data.is_a? Array
 
         data.map do |membership|
           Resources::ProjectMembership.new({ project_id: project_id }.merge(membership))

data/lib/tracker_api/endpoints/notifications.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(params={})
         data = client.paginate('/my/notifications', params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of notifications expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of notifications expected' unless data.is_a? Array
 
         data.map do |notification|
           Resources::Notification.new({ client: client }.merge(notification))

data/lib/tracker_api/endpoints/projects.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(params={})
         data = client.paginate('/projects', params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of projects expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of projects expected' unless data.is_a? Array
 
         data.map { |project| Resources::Project.new({ client: client }.merge(project)) }
       end

data/lib/tracker_api/endpoints/stories.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, params={})
         data = client.paginate("/projects/#{project_id}/stories", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
 
         data.map do |story|
           Resources::Story.new({ client: client, project_id: project_id }.merge(story))

data/lib/tracker_api/endpoints/story_owners.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class StoryOwners
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, story_id, params={})
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/owners", params: params)
+        raise Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
+
+        data.map do |owner|
+          Resources::Person.new({ story_id: story_id }.merge(owner))
+        end
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/tasks.rb

@@ -9,7 +9,7 @@ module TrackerApi
 
       def get(project_id, story_id, params={})
         data = client.paginate("/projects/#{project_id}/stories/#{story_id}/tasks", params: params)
-        raise TrackerApi::Errors::UnexpectedData, 'Array of tasks expected' unless data.is_a? Array
+        raise Errors::UnexpectedData, 'Array of tasks expected' unless data.is_a? Array
 
         data.map do |task|
           Resources::Task.new({ story_id: story_id }.merge(task))

data/lib/tracker_api/resources/account.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Account
-      include Resources::Base
+      include Shared::HasId
 
       attribute :created_at, DateTime
       attribute :status, String

data/lib/tracker_api/resources/activity.rb

@@ -2,7 +2,6 @@ module TrackerApi
   module Resources
     class Activity
       include Virtus.model
-
       include Equalizer.new(:guid)
 
       attribute :client
@@ -12,10 +11,10 @@ module TrackerApi
       attribute :project_version, Integer
       attribute :message, String
       attribute :highlight, String
-      attribute :changes, Array[Resources::Change]
-      attribute :primary_resources, Array[Resources::PrimaryResource]
-      attribute :project, Resources::Project
-      attribute :performed_by, Resources::Person
+      attribute :changes, Array[Change]
+      attribute :primary_resources, Array[PrimaryResource]
+      attribute :project, Project
+      attribute :performed_by, Person
       attribute :occurred_at, DateTime
 
       def project=(data)

data/lib/tracker_api/resources/change.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Change
-      include Resources::Base
+      include Shared::HasId
 
       attribute :change_type, String
       attribute :kind, String

data/lib/tracker_api/resources/comment.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Comment
-      include Resources::Base
+      include Shared::HasId
 
       attribute :story_id, Integer
       attribute :epic_id, Integer

data/lib/tracker_api/resources/epic.rb

@@ -1,16 +1,38 @@
 module TrackerApi
   module Resources
     class Epic
-      include Resources::Base
+      include Shared::HasId
 
+      attribute :client
+
+      attribute :comment_ids, Array[Integer]
+      attribute :comments, Array[Comment]
       attribute :created_at, DateTime
       attribute :description, String
+      attribute :follower_ids, Array[Integer]
+      attribute :followers, Array[Person]
       attribute :kind, String
-      attribute :label, TrackerApi::Resources::Label
+      attribute :label, Label
+      attribute :label_id, Integer
       attribute :name, String
       attribute :project_id, Integer
       attribute :updated_at, DateTime
       attribute :url, String
+
+      class UpdateRepresenter < Representable::Decorator
+        include Representable::JSON
+
+        property :name
+        property :description
+        property :label, class: Label, decorator: Label::UpdateRepresenter, render_empty: true
+      end
+
+      # Save changes to an existing Epic.
+      def save
+        raise ArgumentError, 'Can not update an epic with an unknown project_id.' if project_id.nil?
+
+        Endpoints::Epic.new(client).update(self, UpdateRepresenter.new(self))
+      end
     end
   end
 end

data/lib/tracker_api/resources/iteration.rb

@@ -2,7 +2,6 @@ module TrackerApi
   module Resources
     class Iteration
       include Virtus.model
-
       include Equalizer.new(:number, :project_id)
 
       attribute :client
@@ -14,7 +13,7 @@ module TrackerApi
       attribute :planned, Boolean
       attribute :project_id, Integer
       attribute :start, DateTime
-      attribute :stories, [TrackerApi::Resources::Story]
+      attribute :stories, [Story]
       attribute :story_ids, [Integer]
       attribute :team_strength, Float
 

data/lib/tracker_api/resources/label.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Label
-      include Resources::Base
+      include Shared::HasId
 
       attribute :created_at, DateTime
       attribute :kind, String

data/lib/tracker_api/resources/me.rb

@@ -1,16 +1,16 @@
 module TrackerApi
   module Resources
     class Me
-      include Resources::Base
+      include Shared::HasId
 
       attribute :name, String
       attribute :initials, String
       attribute :username, String
-      attribute :time_zone, TrackerApi::Resources::TimeZone
+      attribute :time_zone, TimeZone
       attribute :api_token, String
       attribute :has_google_identity, Boolean
       attribute :project_ids, Array[Integer]
-      attribute :projects, [TrackerApi::Resources::MembershipSummary]
+      attribute :projects, [MembershipSummary]
       attribute :workspace_ids, Array[Integer]
       attribute :email, String
       attribute :receives_in_app_notifications, Boolean

data/lib/tracker_api/resources/membership_summary.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class MembershipSummary
-      include Resources::Base
+      include Shared::HasId
 
       attribute :kind, String
       attribute :last_viewed_at, DateTime

data/lib/tracker_api/resources/notification.rb

@@ -1,15 +1,15 @@
 module TrackerApi
   module Resources
     class Notification
-      include Resources::Base
+      include Shared::HasId
 
       attribute :client
 
       attribute :message, String
       attribute :kind, String
-      attribute :project, TrackerApi::Resources::Project
-      attribute :story, TrackerApi::Resources::Story
-      attribute :performer, TrackerApi::Resources::Person
+      attribute :project, Project
+      attribute :story, Story
+      attribute :performer, Person
       attribute :created_at, DateTime
       attribute :updated_at, DateTime
 

data/lib/tracker_api/resources/person.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Person
-      include Resources::Base
+      include Shared::HasId
 
       attribute :kind, String
       attribute :name, String

data/lib/tracker_api/resources/primary_resource.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class PrimaryResource
-      include Resources::Base
+      include Shared::HasId
 
       attribute :kind, String
       attribute :name, String

data/lib/tracker_api/resources/project.rb

@@ -1,11 +1,11 @@
 module TrackerApi
   module Resources
     class Project
-      include Resources::Base
+      include Shared::HasId
 
       attribute :client
 
-      attribute :account, TrackerApi::Resources::Account
+      attribute :account, Account
       attribute :account_id, Integer
       attribute :atom_enabled, Boolean
       attribute :bugs_and_chores_are_estimatable, Boolean
@@ -18,13 +18,13 @@ module TrackerApi
       attribute :enable_planned_mode, Boolean
       attribute :enable_tasks, Boolean
       attribute :epic_ids, Array[Integer]
-      attribute :epics, Array[TrackerApi::Resources::Epic]
+      attribute :epics, Array[Epic]
       attribute :has_google_domain, Boolean
       attribute :initial_velocity, Integer
       attribute :iteration_length, Integer
       attribute :kind, String
       attribute :label_ids, Array[Integer]
-      attribute :labels, Array[TrackerApi::Resources::Label]
+      attribute :labels, Array[Label]
       attribute :name, String
       attribute :number_of_done_iterations_to_show, Integer
       attribute :point_scale, String
@@ -33,7 +33,7 @@ module TrackerApi
       attribute :public, Boolean
       attribute :start_date, DateTime
       attribute :start_time, DateTime
-      attribute :time_zone, TrackerApi::Resources::TimeZone
+      attribute :time_zone, TimeZone
       attribute :updated_at, DateTime
       attribute :velocity_averaged_over, Integer
       attribute :version, Integer
@@ -149,6 +149,22 @@ module TrackerApi
         Endpoints::Story.new(client).create(id, params)
       end
 
+      # Find a epic by id for the project.
+      #
+      # @param [Fixnum] epic_id id of epic to get
+      # @return [Epic] epic with given id
+      def epic(epic_id, params={})
+        Endpoints::Epic.new(client).get(id, epic_id, params)
+      end
+
+      # Create a new epic in the project.
+      #
+      # @param [Hash] params attributes to create the epic with
+      # @return [epic] newly created Epic
+      def create_epic(params)
+        Endpoints::Epic.new(client).create(id, params)
+      end
+
       # Add a new membership for the project.
       #
       # @param [Hash] params attributes to add a member; must have at least email or user_id

data/lib/tracker_api/resources/project_membership.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class ProjectMembership
-      include Resources::Base
+      include Shared::HasId
 
       attribute :person_id, Integer
       attribute :project_id, Integer
@@ -9,7 +9,7 @@ module TrackerApi
       attribute :project_color, String
       attribute :wants_comment_notification_emails, Boolean
       attribute :kind, String
-      attribute :person, TrackerApi::Resources::Person
+      attribute :person, Person
     end
   end
 end

data/lib/tracker_api/resources/shared/has_id.rb

@@ -0,0 +1,18 @@
+require 'virtus'
+
+module TrackerApi
+  module Resources
+    module Shared
+      module HasId
+        def self.included(base)
+          base.class_eval do
+            include Virtus.model
+            include Equalizer.new(:id)
+
+            attribute :id, Integer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tracker_api/resources/story.rb

@@ -1,13 +1,13 @@
 module TrackerApi
   module Resources
     class Story
-      include Resources::Base
+      include Shared::HasId
 
       attribute :client
 
       attribute :accepted_at, DateTime
       attribute :comment_ids, Array[Integer]
-      attribute :comments, Array[Resources::Comment]
+      attribute :comments, Array[Comment], :default => []
       attribute :created_at, DateTime
       attribute :current_state, String # (accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled)
       attribute :deadline, DateTime
@@ -15,21 +15,23 @@ module TrackerApi
       attribute :estimate, Float
       attribute :external_id, String
       attribute :follower_ids, Array[Integer]
+      attribute :followers, Array[Person]
       attribute :integration_id, Integer
       attribute :kind, String
       attribute :label_ids, Array[Integer]
-      attribute :labels, Array[Resources::Label]
+      attribute :labels, Array[Label], :default => []
       attribute :name, String
       attribute :owned_by_id, Integer # deprecated!
+      attribute :owned_by, Person
       attribute :owner_ids, Array[Integer]
-      attribute :owners, Array[Resources::Person]
+      attribute :owners, Array[Person], :default => []
       attribute :planned_iteration_number, Integer
       attribute :project_id, Integer
       attribute :requested_by, Person
       attribute :requested_by_id, Integer
       attribute :story_type, String # (feature, bug, chore, release)
       attribute :task_ids, Array[Integer]
-      attribute :tasks, Array[Resources::Task]
+      attribute :tasks, Array[Task], :default => []
       attribute :updated_at, DateTime
       attribute :url, String
 
@@ -47,7 +49,7 @@ module TrackerApi
         property :deadline
         property :requested_by_id
         property :owner_ids
-        collection :labels, class: Resources::Label, decorator: Resources::Label::UpdateRepresenter, render_empty: true
+        collection :labels, class: Label, decorator: Label::UpdateRepresenter, render_empty: true
         property :integration_id
         property :external_id
       end
@@ -70,7 +72,7 @@ module TrackerApi
       # @param [Hash] params
       # @return [Array[Comment]]
       def comments(params = {})
-        if @comments && @comments.any?
+        if params.blank? && @comments.any?
           @comments
         else
           @comments = Endpoints::Comments.new(client).get(project_id, id, params)
@@ -82,13 +84,25 @@ module TrackerApi
       # @param [Hash] params
       # @return [Array[Task]]
       def tasks(params = {})
-        if @tasks && @tasks.any?
+        if params.blank? && @tasks.any?
           @tasks
         else
           @tasks = Endpoints::Tasks.new(client).get(project_id, id, params)
         end
       end
 
+      # Provides a list of all the owners of the story.
+      #
+      # @param [Hash] params
+      # @return [Array[Person]]
+      def owners(params = {})
+        if params.blank? && @owners.any?
+          @owners
+        else
+          @owners = Endpoints::StoryOwners.new(client).get(project_id, id, params)
+        end
+      end
+
       # @param [Hash] params attributes to create the task with
       # @return [Task] newly created Task
       def create_task(params)

data/lib/tracker_api/resources/task.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Task
-      include Resources::Base
+      include Shared::HasId
 
       attribute :story_id, Integer
       attribute :description, String

data/lib/tracker_api/version.rb

@@ -1,3 +1,3 @@
 module TrackerApi
-  VERSION = '0.2.10'
+  VERSION = '0.2.11'
 end

data/lib/tracker_api.rb

@@ -4,7 +4,11 @@ require 'tracker_api/version'
 require 'virtus'
 require 'faraday'
 require 'faraday_middleware'
-require 'core_ext/object/blank'
+if defined?(ActiveSupport)
+  require 'active_support/core_ext/object/blank'
+else
+  require 'core_ext/object/blank'
+end
 require 'equalizer'
 require 'representable/json'
 require 'oj'
@@ -38,13 +42,16 @@ module TrackerApi
     autoload :Projects, 'tracker_api/endpoints/projects'
     autoload :Stories, 'tracker_api/endpoints/stories'
     autoload :Story, 'tracker_api/endpoints/story'
+    autoload :StoryOwners, 'tracker_api/endpoints/story_owners'
     autoload :Task, 'tracker_api/endpoints/task'
     autoload :Tasks, 'tracker_api/endpoints/tasks'
     autoload :Comments, 'tracker_api/endpoints/comments'
   end
 
   module Resources
-    autoload :Base, 'tracker_api/resources/base'
+    module Shared
+      autoload :HasId, 'tracker_api/resources/shared/has_id'
+    end
     autoload :Activity, 'tracker_api/resources/activity'
     autoload :Account, 'tracker_api/resources/account'
     autoload :Change, 'tracker_api/resources/change'

data/test/minitest_helper.rb

@@ -30,3 +30,4 @@ PT_USER_3 = { username: 'trackerapi3', password: 'trackerapi3', token: '77f9b9a4
 PT_USERS  = [PT_USER_1, PT_USER_2, PT_USER_3]
 
 LOGGER = ::Logger.new(STDOUT)
+# LOGGER.level = ::Logger::DEBUG

data/test/story_test.rb

@@ -67,71 +67,112 @@ describe TrackerApi::Resources::Story do
     story_a.equal?(story_c).must_equal false
   end
 
-  describe '.tasks' do
-    it 'gets all tasks for this story with eager loading' do
-      VCR.use_cassette('get story with tasks', record: :new_episodes) do
-        tasks = project.story(story_id, fields: ':default,tasks').tasks
-
-        tasks.wont_be_empty
-        task = tasks.first
-        task.must_be_instance_of TrackerApi::Resources::Task
+  describe '.owners' do
+    it 'gets all owners for this story with eager loading' do
+      skip('Until this is resolved: https://pivotaltracker.zendesk.com/requests/35823')
+
+      story = VCR.use_cassette('get story with owners', record: :new_episodes) do
+        project.story(story_id, fields: ':default,owners')
       end
+
+      # this should not raise VCR::Errors::UnhandledHTTPRequestError since
+      # it should not be making another HTTP request.
+      owners = story.owners
+
+      owners.wont_be_empty
+      owner = owners.first
+      owner.must_be_instance_of TrackerApi::Resources::Person
     end
 
-    it 'gets all tasks for this story' do
-      VCR.use_cassette('get tasks', record: :new_episodes) do
-        story = project.story(story_id)
-        tasks = VCR.use_cassette('get tasks for story') { story.tasks }
+  it 'gets all owners for this story' do
+    VCR.use_cassette('get story', record: :new_episodes) do
+      story = project.story(story_id)
+      owners = VCR.use_cassette('get owners for story') { story.owners }
 
-        tasks.wont_be_empty
-        task = tasks.first
-        task.must_be_instance_of TrackerApi::Resources::Task
-      end
+      owners.wont_be_empty
+      owner = owners.first
+      owner.must_be_instance_of TrackerApi::Resources::Person
+    end
+  end
+end
+
+describe '.tasks' do
+  it 'gets all tasks for this story with eager loading' do
+    VCR.use_cassette('get story with tasks', record: :new_episodes) do
+      tasks = project.story(story_id, fields: ':default,tasks').tasks
+
+      tasks.wont_be_empty
+      task = tasks.first
+      task.must_be_instance_of TrackerApi::Resources::Task
     end
+  end
+
+  it 'gets all tasks for this story' do
+    VCR.use_cassette('get tasks', record: :new_episodes) do
+      story = project.story(story_id)
+      tasks = VCR.use_cassette('get tasks for story') { story.tasks }
+
+      tasks.wont_be_empty
+      task = tasks.first
+      task.must_be_instance_of TrackerApi::Resources::Task
+    end
+  end
 
-    it 'gets all tasks even when the project_id is excluded from the story fields' do
-      VCR.use_cassette('get tasks when stories filtered', record: :new_episodes) do
-        stories = project.stories(with_state: 'unstarted', fields: 'name,story_type')
-        stories.each do |story|
-          tasks = story.tasks
-          unless tasks.empty?
-            task = tasks.first
-            task.must_be_instance_of TrackerApi::Resources::Task
-          end
+  it 'gets all tasks even when the project_id is excluded from the story fields' do
+    VCR.use_cassette('get tasks when stories filtered', record: :new_episodes) do
+      stories = project.stories(with_state: 'unstarted', fields: 'name,story_type')
+      stories.each do |story|
+        tasks = story.tasks
+        unless tasks.empty?
+          task = tasks.first
+          task.must_be_instance_of TrackerApi::Resources::Task
         end
       end
     end
+  end
 
-    it 'can create task' do
-      VCR.use_cassette('create task') do
-        task = project.story(story_id).create_task(description: 'Test task')
+  it 'can create task' do
+    VCR.use_cassette('create task') do
+      task = project.story(story_id).create_task(description: 'Test task')
 
-        task.must_be_instance_of TrackerApi::Resources::Task
-        task.id.wont_be_nil
-        task.id.must_be :>, 0
-        task.description.must_equal 'Test task'
-      end
+      task.must_be_instance_of TrackerApi::Resources::Task
+      task.id.wont_be_nil
+      task.id.must_be :>, 0
+      task.description.must_equal 'Test task'
     end
   end
+end
 
-  describe '.activity' do
-    before do
-      # create some activity
-      story.name = "#{story.name}+"
+describe '.activity' do
+  before do
+    # create some activity
+    story.name = "#{story.name}+"
 
-      VCR.use_cassette('update story to create activity', record: :new_episodes) do
-        story.save
-      end
+    VCR.use_cassette('update story to create activity', record: :new_episodes) do
+      story.save
     end
+  end
 
-    it 'gets all the activity for this story' do
-      VCR.use_cassette('get story activity', record: :new_episodes) do
-        activity = story.activity
+  it 'gets all the activity for this story' do
+    VCR.use_cassette('get story activity', record: :new_episodes) do
+      activity = story.activity
 
-        activity.wont_be_empty
-        event = activity.first
-        event.must_be_instance_of TrackerApi::Resources::Activity
-      end
+      activity.wont_be_empty
+      event = activity.first
+      event.must_be_instance_of TrackerApi::Resources::Activity
     end
   end
 end
+
+describe '.owners' do
+  it 'gets all owners of this story' do
+    VCR.use_cassette('get story owners', record: :new_episodes) do
+      owners = story.owners
+
+      owners.wont_be_empty
+      owner = owners.first
+      owner.must_be_instance_of TrackerApi::Resources::Person
+    end
+  end
+end
+end

data/test/vcr/cassettes/get_owners_for_story.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/projects/1027488/stories/66728004/owners","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.5 (x86_64-darwin14.0; ruby) TrackerApi/0.2.10 Faraday/0.9.1"],"X-TrackerToken":["d55c3bc1f74346b843ca84ba340b29bf"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"X-Tracker-Project-Version":["78"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"1b3412c670febaa8cc831588a4b38288\""],"Cache-Control":["max-age=0, private, must-revalidate"],"X-Request-Id":["468eec53ea706a1fdf0b69be835c09f4"],"X-Runtime":["0.057243"],"Date":["Mon, 20 Jul 2015 20:16:28 GMT"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger 4.0.41"],"Server":["nginx/1.6.0 + Phusion Passenger 4.0.41"],"Access-Control-Allow-Origin":["*"],"Access-Control-Allow-Credentials":["false"],"Access-Control-Allow-Methods":["GET, POST, PUT, DELETE, OPTIONS"],"Access-Control-Allow-Headers":["X-TrackerToken,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,X-Tracker-Warn-Unless-Project-Version-Is"],"X-Tracker-Client-Pinger-Interval":["12"]},"body":{"encoding":"UTF-8","string":"[{\"kind\":\"person\",\"id\":1266314,\"name\":\"Tracker API User1\",\"email\":\"forestcarlisle+trackerapi1@gmail.com\",\"initials\":\"TU1\",\"username\":\"trackerapi1\"},{\"kind\":\"person\",\"id\":1266316,\"name\":\"Tracker API User2\",\"email\":\"forestcarlisle+trackerapi2@gmail.com\",\"initials\":\"TU2\",\"username\":\"trackerapi2\"}]"},"http_version":null},"recorded_at":"Mon, 20 Jul 2015 20:16:49 GMT"}],"recorded_with":"VCR 2.9.3"}

data/test/vcr/cassettes/get_story_owners.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/projects/1027488/stories/66728004/owners","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.5 (x86_64-darwin14.0; ruby) TrackerApi/0.2.9 Faraday/0.9.1"],"X-TrackerToken":["d55c3bc1f74346b843ca84ba340b29bf"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"X-Tracker-Project-Version":["66"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"2694c3642376e2adeda5f9cea6310da6\""],"Cache-Control":["max-age=0, private, must-revalidate"],"X-Request-Id":["0d0edc87fef723a07ac224c1b7e4ba9f"],"X-Runtime":["0.051762"],"Date":["Wed, 24 Jun 2015 21:06:02 GMT"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger 4.0.41"],"Server":["nginx/1.6.0 + Phusion Passenger 4.0.41"],"Access-Control-Allow-Origin":["*"],"Access-Control-Allow-Credentials":["false"],"Access-Control-Allow-Methods":["GET, POST, PUT, DELETE, OPTIONS"],"Access-Control-Allow-Headers":["X-TrackerToken,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,X-Tracker-Warn-Unless-Project-Version-Is"],"X-Tracker-Client-Pinger-Interval":["12"]},"body":{"encoding":"UTF-8","string":"[{\"kind\":\"person\",\"id\":22778038,\"name\":\"John Smith\",\"email\":\"john.smith@example.org\",\"initials\":\"JS\",\"username\":\"john.smith\"},{\"kind\":\"person\",\"id\":32873326,\"name\":\"Jane Smith\",\"email\":\"jane.smith@example.org\",\"initials\":\"JaS\",\"username\":\"jane.smith\"}]"},"http_version":null},"recorded_at":"Wed, 24 Jun 2015 21:06:11 GMT"}],"recorded_with":"VCR 2.9.3"}

data/test/vcr/cassettes/get_story_with_owners.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/projects/1027488/stories/66728004?fields=%3Adefault%2Cowners","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.5 (x86_64-darwin14.0; ruby) TrackerApi/0.2.10 Faraday/0.9.1"],"X-TrackerToken":["d55c3bc1f74346b843ca84ba340b29bf"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"X-Tracker-Project-Version":["78"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"1f26a282513ccf8b2f5b0e873938e95b\""],"Cache-Control":["max-age=0, private, must-revalidate"],"X-Request-Id":["a4c140d6a71860108446763556b27a88"],"X-Runtime":["0.074538"],"Date":["Mon, 20 Jul 2015 20:12:29 GMT"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger 4.0.41"],"Server":["nginx/1.6.0 + Phusion Passenger 4.0.41"],"Access-Control-Allow-Origin":["*"],"Access-Control-Allow-Credentials":["false"],"Access-Control-Allow-Methods":["GET, POST, PUT, DELETE, OPTIONS"],"Access-Control-Allow-Headers":["X-TrackerToken,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,X-Tracker-Warn-Unless-Project-Version-Is"],"X-Tracker-Client-Pinger-Interval":["12"]},"body":{"encoding":"UTF-8","string":"{\"kind\":\"story\",\"id\":66728004,\"created_at\":\"2014-02-17T00:00:00Z\",\"updated_at\":\"2015-07-02T16:57:53Z\",\"story_type\":\"bug\",\"name\":\"Some product photos not scaled properly when browsing products++\",\"description\":\"+\",\"current_state\":\"started\",\"requested_by_id\":1266314,\"project_id\":1027488,\"url\":\"https://www.pivotaltracker.com/story/show/66728004\",\"owner_ids\":[1266314,1266316],\"owners\":[],\"labels\":[{\"id\":11049868,\"project_id\":1027488,\"kind\":\"label\",\"name\":\"label1\",\"created_at\":\"2015-03-07T12:51:39Z\",\"updated_at\":\"2015-03-07T12:51:39Z\"},{\"id\":11049870,\"project_id\":1027488,\"kind\":\"label\",\"name\":\"label2\",\"created_at\":\"2015-03-07T12:51:39Z\",\"updated_at\":\"2015-03-07T12:51:39Z\"},{\"id\":12049778,\"project_id\":1027488,\"kind\":\"label\",\"name\":\"super-special-label\",\"created_at\":\"2015-06-24T22:46:12Z\",\"updated_at\":\"2015-06-24T22:46:12Z\"}],\"owned_by_id\":1266314}"},"http_version":null},"recorded_at":"Mon, 20 Jul 2015 20:12:49 GMT"}],"recorded_with":"VCR 2.9.3"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracker_api
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Forest Carlisle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -236,13 +236,13 @@ files:
 - lib/tracker_api/endpoints/projects.rb
 - lib/tracker_api/endpoints/stories.rb
 - lib/tracker_api/endpoints/story.rb
+- lib/tracker_api/endpoints/story_owners.rb
 - lib/tracker_api/endpoints/task.rb
 - lib/tracker_api/endpoints/tasks.rb
 - lib/tracker_api/error.rb
 - lib/tracker_api/logger.rb
 - lib/tracker_api/resources/account.rb
 - lib/tracker_api/resources/activity.rb
-- lib/tracker_api/resources/base.rb
 - lib/tracker_api/resources/change.rb
 - lib/tracker_api/resources/comment.rb
 - lib/tracker_api/resources/epic.rb
@@ -255,6 +255,7 @@ files:
 - lib/tracker_api/resources/primary_resource.rb
 - lib/tracker_api/resources/project.rb
 - lib/tracker_api/resources/project_membership.rb
+- lib/tracker_api/resources/shared/has_id.rb
 - lib/tracker_api/resources/story.rb
 - lib/tracker_api/resources/task.rb
 - lib/tracker_api/resources/time_zone.rb
@@ -280,12 +281,15 @@ files:
 - test/vcr/cassettes/get_labels.json
 - test/vcr/cassettes/get_me.json
 - test/vcr/cassettes/get_my_activities.json
+- test/vcr/cassettes/get_owners_for_story.json
 - test/vcr/cassettes/get_project.json
 - test/vcr/cassettes/get_project_activity.json
 - test/vcr/cassettes/get_project_with_epics.json
 - test/vcr/cassettes/get_project_with_labels.json
 - test/vcr/cassettes/get_story.json
 - test/vcr/cassettes/get_story_activity.json
+- test/vcr/cassettes/get_story_owners.json
+- test/vcr/cassettes/get_story_with_owners.json
 - test/vcr/cassettes/get_story_with_tasks.json
 - test/vcr/cassettes/get_tasks.json
 - test/vcr/cassettes/get_tasks_for_story.json
@@ -343,12 +347,15 @@ test_files:
 - test/vcr/cassettes/get_labels.json
 - test/vcr/cassettes/get_me.json
 - test/vcr/cassettes/get_my_activities.json
+- test/vcr/cassettes/get_owners_for_story.json
 - test/vcr/cassettes/get_project.json
 - test/vcr/cassettes/get_project_activity.json
 - test/vcr/cassettes/get_project_with_epics.json
 - test/vcr/cassettes/get_project_with_labels.json
 - test/vcr/cassettes/get_story.json
 - test/vcr/cassettes/get_story_activity.json
+- test/vcr/cassettes/get_story_owners.json
+- test/vcr/cassettes/get_story_with_owners.json
 - test/vcr/cassettes/get_story_with_tasks.json
 - test/vcr/cassettes/get_tasks.json
 - test/vcr/cassettes/get_tasks_for_story.json

data/lib/tracker_api/resources/base.rb

@@ -1,16 +0,0 @@
-require 'virtus'
-
-module TrackerApi
-  module Resources
-    module Base
-      def self.included(base)
-        base.class_eval do
-          include Virtus.model
-          include Equalizer.new(:id)
-
-          attribute :id, Integer
-        end
-      end
-    end
-  end
-end