tracker_api 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a0fc8286762942b07822c2dc7efa7478eff2a9
-  data.tar.gz: 117233a3c81bbcd6177a006f1098bdcef00af6c4
+  metadata.gz: 5c9ea2a8e243027907fcc5a9c85368a6d6b8b42e
+  data.tar.gz: 572d93e69c9d3ee8ed9e92f0601581aa8e266223
 SHA512:
-  metadata.gz: 1c275fb7385aa58a03575e5278450f6c7606bb1080b4d782da6d827049a5026c57b7612422a3aef32cf73a36bd32f3b6aa150299502ee1adce02d95388f5c9fd
-  data.tar.gz: 2f3b1b746c5afaa4d28af7d2e1bd3b784354a3d6de23f286f25dd55a6d36f706293c3817a4f041915ee031bd891354258fc05f429bb903b415016dc54be4c22b
+  metadata.gz: ef0fe7129801167c7222534634b95ac652db1b7640b9bf2e14b4f3094ecff528a0d1b7361a85dbbbde276e72590cdc6aee7db84c12c246e514121cb7fa305cd2
+  data.tar.gz: d0fbe2d2d61c05aaadaf3e246abc85e0068d84572fcc807a11fa0f313afc0d6163053f70d38b1585ab627ce4ac45819ce0b9ccfcbcf84dd0599ba746075f8cd2

data/README.md

@@ -68,6 +68,8 @@ task.save                                                                 # Mark
 epics = project.epics                                                     # Get all epics for a project
 epic  = epics.first
 label = epic.label                                                        # Get an epic's label
+
+workspaces = client.workspaces                                            # Get person's multi-project workspaces
 ```
 
 ## Eager Loading

data/lib/tracker_api.rb

@@ -42,6 +42,8 @@ module TrackerApi
     autoload :Notifications, 'tracker_api/endpoints/notifications'
     autoload :Project, 'tracker_api/endpoints/project'
     autoload :Projects, 'tracker_api/endpoints/projects'
+    autoload :Workspace, 'tracker_api/endpoints/workspace'
+    autoload :Workspaces, 'tracker_api/endpoints/workspaces'
     autoload :Stories, 'tracker_api/endpoints/stories'
     autoload :Story, 'tracker_api/endpoints/story'
     autoload :StoryOwners, 'tracker_api/endpoints/story_owners'
@@ -68,6 +70,7 @@ module TrackerApi
     autoload :PrimaryResource, 'tracker_api/resources/primary_resource'
     autoload :Project, 'tracker_api/resources/project'
     autoload :ProjectMembership, 'tracker_api/resources/project_membership'
+    autoload :Workspace, 'tracker_api/resources/workspace'
     autoload :Story, 'tracker_api/resources/story'
     autoload :Task, 'tracker_api/resources/task'
     autoload :TimeZone, 'tracker_api/resources/time_zone'

data/lib/tracker_api/client.rb

@@ -128,6 +128,23 @@ module TrackerApi
       Endpoints::Project.new(self).get(id, params)
     end
 
+    # Get workspace
+    #
+    # @param [Hash] params
+    # @return [TrackerApi::Resources::Workspace]
+    def workspace(id, params={})
+      Endpoints::Workspace.new(self).get(id, params)
+    end
+
+    # Get workspaces
+    #
+    # @param [Hash] params
+    # @return [Array[TrackerApi::Resources::Workspace]]
+    def workspaces(params={})
+      Endpoints::Workspaces.new(self).get(params)
+    end
+
+
     # Get information about the authenticated user
     #
     # @return [TrackerApi::Resources::Me]

data/lib/tracker_api/endpoints/workspace.rb

@@ -0,0 +1,17 @@
+module TrackerApi
+  module Endpoints
+    class Workspace
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(id, params={})
+        data = client.get("/my/workspaces/#{id}", params: params).body
+
+        Resources::Workspace.new({ client: client }.merge(data))
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/workspaces.rb

@@ -0,0 +1,19 @@
+module TrackerApi
+  module Endpoints
+    class Workspaces
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(params={})
+        data = client.paginate('/my/workspaces', params: params)
+        raise Errors::UnexpectedData, 'Array of workspaces expected' unless data.is_a? Array
+
+        data.map { |workspace| Resources::Workspace.new({ client: client }.merge(workspace))
+        }
+      end
+    end
+  end
+end

data/lib/tracker_api/resources/me.rb

@@ -12,6 +12,7 @@ module TrackerApi
       attribute :project_ids, [Integer]
       attribute :projects, [MembershipSummary]
       attribute :workspace_ids, [Integer]
+      attribute :workspaces, [Workspace]
       attribute :email, String
       attribute :receives_in_app_notifications, Boolean
       attribute :kind, String

data/lib/tracker_api/resources/workspace.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Resources
+    class Workspace
+      include Shared::Base
+
+      attribute :client
+
+      attribute :person, Person
+      attribute :person_id, Integer
+      attribute :created_at, DateTime
+      attribute :project_ids, [Integer]
+      attribute :projects, [Project]
+      attribute :kind, String
+      attribute :name, String
+
+    end
+  end
+end

data/lib/tracker_api/version.rb

@@ -1,3 +1,3 @@
 module TrackerApi
-  VERSION = '1.1.1'
+  VERSION = '1.2.1'
 end

data/test/client_test.rb

@@ -61,6 +61,40 @@ describe TrackerApi::Client do
     end
   end
 
+  describe '.workspace' do
+    let(:pt_user) { PT_USER_1 }
+    let(:client) { TrackerApi::Client.new token: pt_user[:token] }
+
+    it 'gets a workspace by id' do
+      VCR.use_cassette('get workspace', record: :new_episodes) do
+        workspace = client.workspace(pt_user[:workspace_id])
+
+        workspace.must_be_instance_of TrackerApi::Resources::Workspace
+        workspace.id.must_equal pt_user[:workspace_id]
+        workspace.name.wont_be_empty
+      end
+    end
+  end
+
+
+  describe '.workspaces' do
+    let(:pt_user) { PT_USER_2 }
+    let(:client) { TrackerApi::Client.new token: pt_user[:token] }
+
+    it 'gets all workspaces' do
+      VCR.use_cassette('get all workspaces', record: :new_episodes) do
+        workspaces = client.workspaces(fields: ':default,projects(id,name)')
+
+        workspaces.wont_be_empty
+        workspace = workspaces.first
+        workspace.must_be_instance_of TrackerApi::Resources::Workspace
+        workspace.id.must_equal pt_user[:workspace_id]
+      end
+    end
+  end
+
+
+
   describe '.me' do
     let(:pt_user) { PT_USER_1 }
     let(:client) { TrackerApi::Client.new token: pt_user[:token] }

data/test/minitest_helper.rb

@@ -25,8 +25,8 @@ VCR.configure do |c|
 end
 
 # These API Tokens are for a user with just one Public Sample Project
-PT_USER_1 = { username: 'trackerapi1', password: 'trackerapi1', token: 'd55c3bc1f74346b843ca84ba340b29bf', project_id: 1027488 }
-PT_USER_2 = { username: 'trackerapi2', password: 'trackerapi2', token: 'ab4c5895f57995bb7547986eacf91160', project_id: 1027492 }
+PT_USER_1 = { username: 'trackerapi1', password: 'trackerapi1', token: 'd55c3bc1f74346b843ca84ba340b29bf', project_id: 1027488, workspace_id: 375106 }
+PT_USER_2 = { username: 'trackerapi2', password: 'trackerapi2', token: 'ab4c5895f57995bb7547986eacf91160', project_ids: [1027488, 1027492], workspace_id: 581707 }
 PT_USER_3 = { username: 'trackerapi3', password: 'trackerapi3', token: '77f9b9a466c436e6456939208c84c973', project_id: 1027494 }
 PT_USERS  = [PT_USER_1, PT_USER_2, PT_USER_3]
 

data/test/story_test.rb

@@ -76,8 +76,6 @@ describe TrackerApi::Resources::Story do
 
   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

data/test/vcr/cassettes/get_all_workspaces.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/my/workspaces?fields=%3Adefault%2Cprojects%28id%2Cname%29","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.7 (x86_64-darwin14.0; ruby) TrackerApi/1.1.1 Faraday/0.9.2"],"X-TrackerToken":["ab4c5895f57995bb7547986eacf91160"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"Cache-Control":["max-age=0, private, must-revalidate"],"Date":["Wed, 25 May 2016 02:27:49 GMT"],"X-Request-Id":["8ea94bdaa44758cd41af559a957129bb"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"a80576b5a281d7a36a8e3aada2cb8c7c\""],"X-Runtime":["0.063218"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger Enterprise"],"Server":["nginx + Phusion Passenger"],"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\":\"workspace\",\"projects\":[{\"id\":1027488,\"name\":\"My Sample Project\"},{\"id\":1027492,\"name\":\"My Sample Project\"}],\"id\":581707,\"name\":\"Multi-Project Workspace\",\"person_id\":1266316,\"project_ids\":[1027488,1027492]}]"},"http_version":null},"recorded_at":"Wed, 25 May 2016 02:27:49 GMT"}],"recorded_with":"VCR 3.0.2"}

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.7 (x86_64-darwin14.0; ruby) TrackerApi/1.1.1 Faraday/0.9.2"],"X-TrackerToken":["d55c3bc1f74346b843ca84ba340b29bf"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"Cache-Control":["max-age=0, private, must-revalidate"],"Date":["Wed, 25 May 2016 02:39:30 GMT"],"X-Tracker-Project-Version":["128"],"X-Request-Id":["9ad7de7b05ba5ba68829f040e57bcbe8"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"1fdca41d3806416d2ff9d2521aa430ba\""],"X-Runtime":["0.078259"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger Enterprise"],"Server":["nginx + Phusion Passenger"],"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\":\"2016-05-24T22:30:07Z\",\"story_type\":\"bug\",\"name\":\"Some product photos not scaled properly when browsing products++++++++\",\"description\":\"+++++++++\",\"current_state\":\"started\",\"requested_by_id\":1266314,\"url\":\"https://www.pivotaltracker.com/story/show/66728004\",\"project_id\":1027488,\"owner_ids\":[1266314,1266316],\"owners\":[{\"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\"}],\"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\":14060665,\"project_id\":1027488,\"kind\":\"label\",\"name\":\"super-special-label\",\"created_at\":\"2016-02-12T23:45:13Z\",\"updated_at\":\"2016-02-12T23:45:13Z\"}],\"owned_by_id\":1266314}"},"http_version":null},"recorded_at":"Wed, 25 May 2016 02:39:30 GMT"}],"recorded_with":"VCR 3.0.2"}

data/test/vcr/cassettes/get_workspace.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/my/workspaces/375106","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.7 (x86_64-darwin14.0; ruby) TrackerApi/1.1.1 Faraday/0.9.2"],"X-TrackerToken":["d55c3bc1f74346b843ca84ba340b29bf"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"Cache-Control":["max-age=0, private, must-revalidate"],"Date":["Wed, 25 May 2016 02:27:50 GMT"],"X-Request-Id":["053ec593d3e5d88b17ad2197fa9300ec"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"f99a89b7ccb408ba3825caea4c88e1b0\""],"X-Runtime":["0.065733"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger Enterprise"],"Server":["nginx + Phusion Passenger"],"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\":\"workspace\",\"id\":375106,\"name\":\"Multi-Project Workspace\",\"person_id\":1266314,\"project_ids\":[1027488]}"},"http_version":null},"recorded_at":"Wed, 25 May 2016 02:27:50 GMT"}],"recorded_with":"VCR 3.0.2"}

data/test/vcr/cassettes/get_workspace_projects.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://www.pivotaltracker.com/services/v5/my/workspaces/581707?fields=%3Adefault%2Cprojects%28id%2Cname%29","body":{"encoding":"US-ASCII","string":""},"headers":{"User-Agent":["Ruby/2.1.7 (x86_64-darwin14.0; ruby) TrackerApi/1.1.1 Faraday/0.9.2"],"X-TrackerToken":["ab4c5895f57995bb7547986eacf91160"]}},"response":{"status":{"code":200,"message":null},"headers":{"Content-Type":["application/json; charset=utf-8"],"Status":["200 OK"],"Cache-Control":["max-age=0, private, must-revalidate"],"Date":["Wed, 25 May 2016 02:27:49 GMT"],"X-Request-Id":["1010962fe376409c1e8e83de9b3c05be"],"X-UA-Compatible":["IE=Edge,chrome=1"],"ETag":["\"58110b19fda6dfb316c0b93fff8aab95\""],"X-Runtime":["0.052909"],"X-Rack-Cache":["miss"],"X-Powered-By":["Phusion Passenger Enterprise"],"Server":["nginx + Phusion Passenger"],"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\":\"workspace\",\"projects\":[{\"id\":1027488,\"name\":\"My Sample Project\"},{\"id\":1027492,\"name\":\"My Sample Project\"}],\"id\":581707,\"name\":\"Multi-Project Workspace\",\"person_id\":1266316,\"project_ids\":[1027488,1027492]}"},"http_version":null},"recorded_at":"Wed, 25 May 2016 02:27:48 GMT"}],"recorded_with":"VCR 3.0.2"}

data/test/workspace_test.rb

@@ -0,0 +1,26 @@
+require_relative 'minitest_helper'
+
+describe TrackerApi::Resources::Workspace do
+  let(:pt_user) { PT_USER_2 }
+  let(:client) { TrackerApi::Client.new token: pt_user[:token] }
+  let(:workspace_id) { pt_user[:workspace_id] }
+  let(:workspace) { VCR.use_cassette('get workspace') { client.workspace(workspace_id) } }
+
+  describe '.projects' do
+    it 'gets all projects for this workspace' do
+      VCR.use_cassette('get workspace projects', record: :new_episodes) do
+        workspace = client.workspace(pt_user[:workspace_id], fields: ':default,projects(id,name)')
+        projects = workspace.projects
+
+        projects.wont_be_empty
+
+        projects.size.must_equal 2
+        projects.first.must_be_instance_of TrackerApi::Resources::Project
+
+        pt_user[:project_ids].must_include projects.first.id
+        pt_user[:project_ids].must_include projects.last.id
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracker_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Forest Carlisle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -239,6 +239,8 @@ files:
 - lib/tracker_api/endpoints/story_owners.rb
 - lib/tracker_api/endpoints/task.rb
 - lib/tracker_api/endpoints/tasks.rb
+- lib/tracker_api/endpoints/workspace.rb
+- lib/tracker_api/endpoints/workspaces.rb
 - lib/tracker_api/error.rb
 - lib/tracker_api/logger.rb
 - lib/tracker_api/resources/account.rb
@@ -259,6 +261,7 @@ files:
 - lib/tracker_api/resources/story.rb
 - lib/tracker_api/resources/task.rb
 - lib/tracker_api/resources/time_zone.rb
+- lib/tracker_api/resources/workspace.rb
 - lib/tracker_api/version.rb
 - lib/virtus/attribute/nullify_blank.rb
 - lib/virtus/dirty_attribute.rb
@@ -278,6 +281,7 @@ files:
 - test/vcr/cassettes/create_task.json
 - test/vcr/cassettes/get_all_notifications.json
 - test/vcr/cassettes/get_all_projects.json
+- test/vcr/cassettes/get_all_workspaces.json
 - test/vcr/cassettes/get_another_story.json
 - test/vcr/cassettes/get_current_iteration.json
 - test/vcr/cassettes/get_done_iterations.json
@@ -295,17 +299,21 @@ files:
 - test/vcr/cassettes/get_story_activity.json
 - test/vcr/cassettes/get_story_comments.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
 - test/vcr/cassettes/get_tasks_when_stories_filtered.json
 - test/vcr/cassettes/get_unscheduled_stories.json
 - test/vcr/cassettes/get_unscheduled_story.json
+- test/vcr/cassettes/get_workspace.json
+- test/vcr/cassettes/get_workspace_projects.json
 - test/vcr/cassettes/save_story.json
 - test/vcr/cassettes/save_story_with_multiple_changes.json
 - test/vcr/cassettes/save_story_with_new_label.json
 - test/vcr/cassettes/save_task.json
 - test/vcr/cassettes/update_story_to_create_activity.json
+- test/workspace_test.rb
 - tracker_api.gemspec
 homepage: https://github.com/dashofcode/tracker_api
 licenses:
@@ -347,6 +355,7 @@ test_files:
 - test/vcr/cassettes/create_task.json
 - test/vcr/cassettes/get_all_notifications.json
 - test/vcr/cassettes/get_all_projects.json
+- test/vcr/cassettes/get_all_workspaces.json
 - test/vcr/cassettes/get_another_story.json
 - test/vcr/cassettes/get_current_iteration.json
 - test/vcr/cassettes/get_done_iterations.json
@@ -364,14 +373,18 @@ test_files:
 - test/vcr/cassettes/get_story_activity.json
 - test/vcr/cassettes/get_story_comments.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
 - test/vcr/cassettes/get_tasks_when_stories_filtered.json
 - test/vcr/cassettes/get_unscheduled_stories.json
 - test/vcr/cassettes/get_unscheduled_story.json
+- test/vcr/cassettes/get_workspace.json
+- test/vcr/cassettes/get_workspace_projects.json
 - test/vcr/cassettes/save_story.json
 - test/vcr/cassettes/save_story_with_multiple_changes.json
 - test/vcr/cassettes/save_story_with_new_label.json
 - test/vcr/cassettes/save_task.json
 - test/vcr/cassettes/update_story_to_create_activity.json
+- test/workspace_test.rb