tracker_api 1.9.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c69ed80fbe1f4d8cb18311a4df2807c7131678c79a4f2c8a54f39fa766a180
-  data.tar.gz: 9e69d8cfcfb3291ea39ed720685b761430aa12c83f8389ef100bde47f83ddb7b
+  metadata.gz: 6d6e9b2c5ba26b416431288d39fe55c9309b753f8ba59572975cf5f424a328a4
+  data.tar.gz: 18f138d620e770815349ddad72c728055c7ca35cfdfa89170daf410c4f3db39e
 SHA512:
-  metadata.gz: 385942ec74532ff4285005b5477c3e6070f4a5ecdbe51fb2cbd91b8897a518599c31f90e6b91fd8101cb61a494462b8e4563c7f2c9356f258282a4fcaaf4b7d8
-  data.tar.gz: 92788d5cbc49ae6393fd1012f508c91ffe68e2ff29ee38821abc1dc83e928d5374ea6c78a257bcc3838152e797536f828a9fa7310f98946683c076631aa6c72c
+  metadata.gz: fbd90b8f2549b18d5d22f4f1dbf743db182db643be68b4920daaff25f68ebdf3664785903118afc106edf44ae58474e54ac1b582e3b063428f7e6c5f47ec1096
+  data.tar.gz: ab1c688fbf08697ecb2705031f82a842357756ff812e0295ffd1dcbac43131db038379225e4265bc554fdc16852af8a205a16d2c0a46978024ee4a5a29cae84a

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,34 @@
+name: Ruby Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test
+    - name: Upload Coverage
+      uses: paambaati/codeclimate-action@v2.7.5
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      with:
+        coverageLocations: ${{github.workspace}}/coverage/.resultset.json:simplecov
+      if: matrix.ruby-version == '2.7'

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in tracker_api.gemspec
 gemspec
 
-gem 'coveralls', group: :test, require: false
-
+# pinned until code climate figures out the new output format https://github.com/codeclimate/test-reporter/issues/418
+gem 'simplecov', '< 0.18', require: false, group: :test

data/README.md

@@ -1,10 +1,9 @@
 # TrackerApi
 
 [![Gem Version](https://badge.fury.io/rb/tracker_api.png)](http://badge.fury.io/rb/tracker_api)
-[![Build Status](https://travis-ci.org/dashofcode/tracker_api.png?branch=master)](https://travis-ci.org/dashofcode/tracker_api)
-[![Code Climate](https://codeclimate.com/github/dashofcode/tracker_api.png)](https://codeclimate.com/github/dashofcode/tracker_api)
-[![Coverage Status](https://coveralls.io/repos/dashofcode/tracker_api/badge.png?branch=master)](https://coveralls.io/r/dashofcode/tracker_api?branch=master)
-[![Dependency Status](https://gemnasium.com/dashofcode/tracker_api.png)](https://gemnasium.com/dashofcode/tracker_api)
+[![Build Status](https://github.com/ProductPlan/tracker_api/actions/workflows/ruby-tests.yml/badge.svg?branch=master)](https://github.com/ProductPlan/tracker_api/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c4602f519cd748d53492/maintainability)](https://codeclimate.com/github/ProductPlan/tracker_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c4602f519cd748d53492/test_coverage)](https://codeclimate.com/github/ProductPlan/tracker_api/test_coverage)
 
 This gem allows you to easily use the [Pivotal Tracker v5 API](https://www.pivotaltracker.com/help/api/rest/v5).
 
@@ -86,6 +85,10 @@ task = story.tasks.first                                                  # Get
 task.complete = true
 task.save                                                                 # Mark a task complete
 
+review = story.reviews.first                                              # Mark a review as complete
+review.status = 'pass'
+review.save
+
 epics = project.epics                                                     # Get all epics for a project
 epic  = epics.first
 label = epic.label                                                        # Get an epic's label

data/lib/tracker_api.rb

@@ -4,7 +4,7 @@ require 'tracker_api/version'
 require 'faraday'
 require 'faraday_middleware'
 require 'pathname'
-require 'mimemagic'
+require 'mini_mime'
 
 if defined?(ActiveSupport)
   require 'active_support/core_ext/object/blank'
@@ -38,8 +38,10 @@ module TrackerApi
 
   module Endpoints
     autoload :Activity, 'tracker_api/endpoints/activity'
+    autoload :Blockers, 'tracker_api/endpoints/blockers'
     autoload :Epic, 'tracker_api/endpoints/epic'
     autoload :Epics, 'tracker_api/endpoints/epics'
+    autoload :Iteration, 'tracker_api/endpoints/iteration'
     autoload :Iterations, 'tracker_api/endpoints/iterations'
     autoload :Labels, 'tracker_api/endpoints/labels'
     autoload :Me, 'tracker_api/endpoints/me'
@@ -62,6 +64,10 @@ module TrackerApi
     autoload :StoryTransitions, 'tracker_api/endpoints/story_transitions'
     autoload :Attachment, 'tracker_api/endpoints/attachment'
     autoload :Attachments, 'tracker_api/endpoints/attachments'
+    autoload :Releases, 'tracker_api/endpoints/releases'
+    autoload :Release, 'tracker_api/endpoints/release'
+    autoload :Review, 'tracker_api/endpoints/review'
+    autoload :Reviews, 'tracker_api/endpoints/reviews'
   end
 
   module Resources
@@ -71,6 +77,7 @@ module TrackerApi
     end
     autoload :Activity, 'tracker_api/resources/activity'
     autoload :Account, 'tracker_api/resources/account'
+    autoload :Blocker, 'tracker_api/resources/blocker'
     autoload :Change, 'tracker_api/resources/change'
     autoload :Epic, 'tracker_api/resources/epic'
     autoload :EpicsSearchResult, 'tracker_api/resources/epics_search_result'
@@ -93,5 +100,10 @@ module TrackerApi
     autoload :Webhook, 'tracker_api/resources/webhook'
     autoload :StoryTransition, 'tracker_api/resources/story_transition'
     autoload :FileAttachment, 'tracker_api/resources/file_attachment'
+    autoload :Release, 'tracker_api/resources/release'
+    autoload :CycleTimeDetails, 'tracker_api/resources/cycle_time_details'
+    autoload :DailyHistoryContainer, 'tracker_api/resources/daily_history_container'
+    autoload :Review, 'tracker_api/resources/review'
+    autoload :ReviewType, 'tracker_api/resources/review_type'
   end
 end

data/lib/tracker_api/client.rb

@@ -25,7 +25,7 @@ module TrackerApi
       @url               = Addressable::URI.parse(url).to_s
       @api_version       = options.fetch(:api_version, '/services/v5')
       @logger            = options.fetch(:logger, ::Logger.new(nil))
-      adapter            = options.fetch(:adapter, :excon)
+      adapter            = options.fetch(:adapter) { defined?(JRUBY_VERSION) ? :net_http : :excon }
       connection_options = options.fetch(:connection_options, { ssl: { verify: true } })
       @auto_paginate     = options.fetch(:auto_paginate, true)
       @token             = options[:token]
@@ -223,7 +223,7 @@ module TrackerApi
         req.body = body
       end
       response
-    rescue Faraday::Error::ClientError => e
+    rescue Faraday::ClientError, Faraday::ServerError => e
       status_code = e.response[:status]
       case status_code
       when 400..499 then raise TrackerApi::Errors::ClientError.new(e)

data/lib/tracker_api/endpoints/attachment.rb

@@ -19,7 +19,9 @@ module TrackerApi
       # end
 
       def get(comment)
-        data = client.get("/projects/#{comment.project_id}/stories/#{comment.story_id}/comments/#{comment.id}?fields=file_attachments").body["file_attachments"]
+        comment_target_slug = !comment.story_id.nil? ? "stories/#{comment.story_id}" : "epics/#{comment.epic_id}"
+
+        data = client.get("/projects/#{comment.project_id}/#{comment_target_slug}/comments/#{comment.id}?fields=file_attachments").body["file_attachments"]
         raise Errors::UnexpectedData, 'Array of file attachments expected' unless data.is_a? Array
 
         data.map do |file_attachment|

data/lib/tracker_api/endpoints/blockers.rb

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

data/lib/tracker_api/endpoints/comment.rb

@@ -7,16 +7,24 @@ module TrackerApi
         @client = client
       end
 
-      def create(project_id, story_id, params={})
-        data = client.post("/projects/#{project_id}/stories/#{story_id}/comments", params: params).body
+      def create(project_id, story_id: nil, epic_id: nil, params: {})
+        raise ArgumentError, 'One of story id or epic id must be provided.' if story_id.nil? && epic_id.nil?
+
+        comment_target_slug = !story_id.nil? ? "stories/#{story_id}" : "epics/#{epic_id}"
+
+        data = client.post("/projects/#{project_id}/#{comment_target_slug}/comments", params: params).body
         Resources::Comment.new({ client: client, project_id: project_id }.merge(data))
       end
 
       def update(comment, params={})
         raise ArgumentError, 'Valid comment required to update.' unless comment.instance_of?(Resources::Comment)
 
-        path = "/projects/#{comment.project_id}/stories/#{comment.story_id}/comments/#{comment.id}"
-        path += "?fields=:default,file_attachments" if params.represented.file_attachment_ids_to_add.present? || params.represented.file_attachment_ids_to_remove.present?
+        comment_target_slug = !comment.story_id.nil? ? "stories/#{comment.story_id}" : "epics/#{comment.epic_id}"
+
+        path = "/projects/#{comment.project_id}/#{comment_target_slug}/comments/#{comment.id}"
+        if params.represented.file_attachment_ids_to_add.present? || params.represented.file_attachment_ids_to_remove.present?
+          path += "?fields=:default,file_attachments"
+        end
         data = client.put(path, params: params).body
 
         comment.attributes = data
@@ -27,7 +35,9 @@ module TrackerApi
       def delete(comment)
         raise ArgumentError, 'Valid comment required to update.' unless comment.instance_of?(Resources::Comment)
 
-        client.delete("/projects/#{comment.project_id}/stories/#{comment.story_id}/comments/#{comment.id}").body
+        comment_target_slug = !comment.story_id.nil? ? "stories/#{comment.story_id}" : "epics/#{comment.epic_id}"
+
+        client.delete("/projects/#{comment.project_id}/#{comment_target_slug}/comments/#{comment.id}").body
       end
     end
   end

data/lib/tracker_api/endpoints/comments.rb

@@ -7,14 +7,19 @@ module TrackerApi
         @client = client
       end
 
-      def get(project_id, story_id, params={})
-        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/comments", params: params)
+      def get(project_id, story_id: nil, epic_id: nil, params: {})
+        raise ArgumentError, 'One of story id or epic id must be provided.' if story_id.nil? && epic_id.nil?
+
+        comment_target_slug = !story_id.nil? ? "stories/#{story_id}" : "epics/#{epic_id}"
+
+        data = client.paginate("/projects/#{project_id}/#{comment_target_slug}/comments", params: params)
         raise Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
 
         data.map do |comment|
-          Resources::Comment.new({ client: client,
-                                   project_id: project_id,
-                                   story_id: story_id }.merge(comment))
+          Resources::Comment.new({
+            client: client,
+            project_id: project_id
+          }.merge(comment))
         end
       end
     end

data/lib/tracker_api/endpoints/iteration.rb

@@ -0,0 +1,35 @@
+module TrackerApi
+  module Endpoints
+    class Iteration
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, iteration_number)
+        data = client.get("/projects/#{project_id}/iterations/#{iteration_number}").body
+
+        Resources::Iteration.new({ client: client, project_id: project_id }.merge(data))
+      end
+
+      def get_analytics_cycle_time_details(project_id, iteration_number)
+        data = client.paginate("/projects/#{project_id}/iterations/#{iteration_number}/analytics/cycle_time_details")
+        raise Errors::UnexpectedData, 'Array of cycle time details expected' unless data.is_a? Array
+
+        data.map do |cycle_time_details|
+          Resources::CycleTimeDetails.new(
+            { project_id: project_id, iteration_number: iteration_number }.merge(cycle_time_details)
+          )
+        end
+      end
+
+      def get_history(project_id, iteration_number)
+        data = client.get("/projects/#{project_id}/history/iterations/#{iteration_number}/days").body
+        raise Errors::UnexpectedData, 'Hash of history data expected' unless data.is_a? Hash
+
+        Resources::DailyHistoryContainer.new({ project_id: project_id, iteration_number: iteration_number }.merge(data))
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/release.rb

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

data/lib/tracker_api/endpoints/releases.rb

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

data/lib/tracker_api/endpoints/review.rb

@@ -0,0 +1,21 @@
+module TrackerApi
+  module Endpoints
+    class Review
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def update(review, params = {})
+        raise ArgumentError, 'Valid review required to update.' unless review.instance_of?(Resources::Review)
+
+        data = client.put("/projects/#{review.project_id}/stories/#{review.story_id}/reviews/#{review.id}", params: params).body
+
+        review.attributes = data
+        review.clean!
+        review
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/reviews.rb

@@ -0,0 +1,21 @@
+module TrackerApi
+  module Endpoints
+    class Reviews
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, story_id, params={})
+        params[:fields] ||= ":default,review_type"
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/reviews", params: params)
+        raise Errors::UnexpectedData, 'Successful responses to this request return an array containing zero or more instances of the review resource. This response was not an array.' unless data.is_a? Array
+
+        data.map do |review|
+          Resources::Review.new({ client: client, project_id: project_id }.merge(review))
+        end
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/search.rb

@@ -10,7 +10,7 @@ module TrackerApi
       def get(project_id, query, options={})
         raise ArgumentError, 'Valid query string required to search' unless query.is_a?(String)
 
-        options.key?(:body) ? options[:body][:query] = query : options[:body] = { query: query }
+        options[:params] = { query: query }
         data = client.get("/projects/#{project_id}/search", options).body
 
         raise Errors::UnexpectedData, 'Hash of search results expect' unless data.is_a? Hash

data/lib/tracker_api/endpoints/stories.rb

@@ -17,6 +17,16 @@ module TrackerApi
           Resources::Story.new({ client: client, project_id: project_id }.merge(story))
         end
       end
+
+      def get_release(project_id, release_id, params={})
+        data = client.paginate("/projects/#{project_id}/releases/#{release_id}/stories", params: params)
+
+        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))
+        end
+      end
     end
   end
 end

data/lib/tracker_api/error.rb

@@ -5,14 +5,24 @@ module TrackerApi
     def initialize(wrapped_exception)
       @wrapped_exception = wrapped_exception
       @response          = wrapped_exception.response
-      message            = if wrapped_exception.is_a?(Faraday::Error::ParsingError)
+      message            = if wrapped_exception.is_a?(Faraday::ParsingError)
                              wrapped_exception.message
-                           elsif wrapped_exception.is_a?(Faraday::Error::ClientError)
+                           elsif faraday_response_error?(wrapped_exception)
                              wrapped_exception.response.inspect
                            else
                              wrapped_exception.instance_variable_get(:@wrapped_exception).inspect
                            end
       super(message)
     end
+
+    private
+
+    # faraday 16.0 re-organized their errors. The errors we're interested in,
+    # Faraday::ClientError before 16.0 and Faraday::ServerError introduced in
+    # 16.0, are represented by this conditional.
+    def faraday_response_error?(wrapped_exception)
+      wrapped_exception.is_a?(Faraday::Error) &&
+        wrapped_exception.respond_to?(:response)
+    end
   end
 end

data/lib/tracker_api/file_utility.rb

@@ -2,7 +2,7 @@ module TrackerApi
   class FileUtility
     class << self
       def get_file_upload(file)
-        mime_type = MimeMagic.by_path(file)
+        mime_type = MiniMime.lookup_by_filename(file)
         { :file => Faraday::UploadIO.new(file, mime_type) }
       end
 

data/lib/tracker_api/resources/blocker.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Resources
+    class Blocker
+      include Shared::Base
+
+      attribute :client
+      attribute :project_id, Integer
+
+      attribute :story_id, Integer
+      attribute :person_id, Integer
+      attribute :description, String
+      attribute :resolved, Boolean
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+    end
+  end
+end