tracker_api 1.8.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b93cdb4a9ba207f6a81cdf67cebfddcdf2f3e99b
-  data.tar.gz: de0f6b60cd0b86cf669fa499efae9acdacd472e5
+SHA256:
+  metadata.gz: 7d0c3f349c8d57bc33c44401068ae359892d33a8d8ed2c5c20ed96110fe02b3b
+  data.tar.gz: adac66edc9ddf17883734c6908b1cce46cbac8b932702a7c3f31573b0ad38b13
 SHA512:
-  metadata.gz: 992fbbca70adb9c0b3ff361eefae0b18d672e74c733d874d8fab8938b336266a8005c8d4c9579a00dfd0ec8d27ef54169174cd2be1c420cf9aa0f3cf9fe0ef0b
-  data.tar.gz: d265ae95db9afb5e32d795e2beee4bfad199abb37840d00d8661909fefcef6129cd73f1a540275cc8bd9dee1413278da8526b47652c1984d2b4255c64bd89916
+  metadata.gz: ea30f0006b6dff8684c3d46381d65ddfc00d3a481fbcea3489f844c7bb2c687b065e618114af8cd4392c63d770fcf1ad1ea86aad1305a5c8fca4f95ba58d7150
+  data.tar.gz: e67ea8cd72e9947862bdd58230aecea038e311a14ecb081f65545003f2fb3d7924c680c55a4d34a1711492f9509a2da6c368d1c93689c7b9f92f2a91e8faf267

data/.travis.yml

@@ -5,7 +5,8 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
-  # - "jruby"
+  - 2.5
+  - "jruby"
   #  - rbx
   #  - "1.8.7"
 # uncomment this line if your project needs to run something other than `rake`:

data/README.md

@@ -86,6 +86,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

@@ -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]
@@ -36,7 +36,7 @@ module TrackerApi
       @connection = Faraday.new({ url: @url }.merge(connection_options)) do |builder|
         # response
         builder.use Faraday::Response::RaiseError
-        builder.response :json
+        builder.response :json, content_type: /\bjson/ # e.g., 'application/json; charset=utf-8'
 
         # request
         builder.request :multipart
@@ -190,7 +190,8 @@ module TrackerApi
       opts[:params] = options[:params] || {}
       opts[:token]  = options[:token] || @token
       headers       = { 'User-Agent'     => USER_AGENT,
-                        'X-TrackerToken' => opts.fetch(:token) }.merge(options.fetch(:headers, {}))
+                        'X-TrackerToken' => opts.fetch(:token),
+                        'Accept' => 'application/json' }.merge(options.fetch(:headers, {}))
 
       CONVENIENCE_HEADERS.each do |h|
         if header = options[h]
@@ -222,11 +223,12 @@ module TrackerApi
         req.body = body
       end
       response
-    rescue Faraday::Error::ClientError => e
-      case e.response[:status]
+    rescue Faraday::ClientError, Faraday::ServerError => e
+      status_code = e.response[:status]
+      case status_code
       when 400..499 then raise TrackerApi::Errors::ClientError.new(e)
       when 500..599 then raise TrackerApi::Errors::ServerError.new(e)
-      else raise "Expected 4xx or 5xx HTTP status code"
+      else raise "Expected 4xx or 5xx HTTP status code; got #{status_code} instead."
       end
     end
 

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/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/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

data/lib/tracker_api/resources/cycle_time_details.rb

@@ -0,0 +1,21 @@
+module TrackerApi
+  module Resources
+    class CycleTimeDetails
+      include Shared::Base
+
+      attribute :project_id, Integer
+      attribute :iteration_number, Integer
+      attribute :total_cycle_time, Integer
+      attribute :started_time, Integer
+      attribute :started_count, Integer
+      attribute :finished_time, Integer
+      attribute :finished_count, Integer
+      attribute :delivered_time, Integer
+      attribute :delivered_count, Integer
+      attribute :rejected_time, Integer
+      attribute :rejected_count, Integer
+      attribute :story_id, Integer
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/daily_history_container.rb

@@ -0,0 +1,13 @@
+module TrackerApi
+  module Resources
+    class DailyHistoryContainer
+      include Shared::Base
+
+      attribute :project_id, Integer
+      attribute :iteration_number, Integer
+      attribute :header, [String]
+      attribute :data, [Enumerable]
+      attribute :kind, String
+    end
+  end
+end

data/lib/tracker_api/resources/iteration.rb

@@ -24,6 +24,20 @@ module TrackerApi
       def stories=(data)
         super.each { |s| s.client = client }
       end
+
+      # Provides a list of all the cycle_time_details of each story in the iteration.
+      #
+      # @return [Array[CycleTimeDetails]] array of cycle_time_details of iterations in this project
+      def cycle_time_details
+        Endpoints::Iteration.new(client).get_analytics_cycle_time_details(project_id, number)
+      end
+
+      # Returns per day information of story points and counts by state for the given iteration.
+      #
+      # @return [DailyHistoryContainer]
+      def get_history
+        Endpoints::Iteration.new(client).get_history(project_id, number)
+      end
     end
   end
 end

data/lib/tracker_api/resources/project.rb

@@ -131,6 +131,19 @@ module TrackerApi
         Endpoints::Stories.new(client).get(id, params)
       end
 
+      # Provides a list of all the releases in the project.
+      #
+      # @param [Hash] params
+      # @option params [String] :with_state A release's current_state which all returned releases must match.
+      #   Valid enumeration values: accepted, delivered, finished, started, rejected, unstarted, unscheduled
+      # @option params [Integer] :offset With the first release in your priority list as 0,
+      #   the index of the first release you want returned.
+      # @option params [Integer] :limit The number of releases you want returned.
+      # @return [Array[Release]] releases associated with this project
+      def releases(params={})
+        Endpoints::Releases.new(client).get(id, params)
+      end
+
       # Provides a list of all the memberships in the project.
       #
       # @param [Hash] params

data/lib/tracker_api/resources/release.rb

@@ -0,0 +1,29 @@
+module TrackerApi
+  module Resources
+    class Release
+      include Shared::Base
+
+      attribute :client
+
+      attribute :project_id, Integer
+      attribute :name, String
+      attribute :description, String
+      attribute :current_state, String # (accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled)
+      attribute :accepted_at, DateTime
+      attribute :deadline, DateTime
+      attribute :labels, [Label]
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :url, String
+      attribute :kind, String
+
+      # Provides a list of all the stories in the release.
+      #
+      # @param [Hash] params
+      # @return [Array[Story]] stories of this release
+      def stories(params={})
+        Endpoints::Stories.new(client).get_release(project_id, id, params)
+      end
+    end
+  end
+end