v2gpti 1.1.9 → 1.2.0

data/spec/git-pivotal-tracker-integration/util/story_spec.rb

@@ -15,7 +15,7 @@
 
 require 'spec_helper'
 require 'git-pivotal-tracker-integration/util/story'
-require 'pivotal-tracker'
+require 'tracker_api'
 
 describe GitPivotalTrackerIntegration::Util::Story do
 
@@ -33,9 +33,9 @@ describe GitPivotalTrackerIntegration::Util::Story do
     story = double('story')
     story.should_receive(:name)
     story.should_receive(:description).and_return("description-1\ndescription-2")
-    PivotalTracker::Note.should_receive(:all).and_return([
-      PivotalTracker::Note.new(:noted_at => Date.new, :text => 'note-1')
-    ])
+    # PivotalTracker::Note.should_receive(:all).and_return([
+    #   PivotalTracker::Note.new(:noted_at => Date.new, :text => 'note-1')
+    # ])
 
     GitPivotalTrackerIntegration::Util::Story.pretty_print story
 
@@ -43,7 +43,6 @@ describe GitPivotalTrackerIntegration::Util::Story do
       "      Title: \n" +
       "Description: description-1\n" +
       "             description-2\n" +
-      "     Note 1: note-1\n" +
       "\n")
   end
 
@@ -51,7 +50,7 @@ describe GitPivotalTrackerIntegration::Util::Story do
     story = double('story')
     story.should_receive(:name)
     story.should_receive(:description)
-    PivotalTracker::Note.should_receive(:all).and_return([])
+    story.should_receive(:comments).and_return([])
 
     GitPivotalTrackerIntegration::Util::Story.pretty_print story
 
@@ -64,7 +63,8 @@ describe GitPivotalTrackerIntegration::Util::Story do
     story = double('story')
     story.should_receive(:name)
     story.should_receive(:description).and_return('')
-    PivotalTracker::Note.should_receive(:all).and_return([])
+    story.should_receive(:comments).and_return([])
+
 
     GitPivotalTrackerIntegration::Util::Story.pretty_print story
 
@@ -74,8 +74,7 @@ describe GitPivotalTrackerIntegration::Util::Story do
   end
 
   it 'should select a story directly if the filter is a number' do
-    @project.should_receive(:stories).and_return(@stories)
-    @stories.should_receive(:find).with(12345678).and_return(@story)
+    @project.should_receive(:story).and_return(@story)
 
     story = GitPivotalTrackerIntegration::Util::Story.select_story @project, '12345678'
 
@@ -83,37 +82,30 @@ describe GitPivotalTrackerIntegration::Util::Story do
   end
 
   it 'should select a story if the result of the query is a single story' do
-    @project.should_receive(:stories).and_return(@stories)
-    @stories.should_receive(:all).with(
-      :current_state => %w(rejected unstarted unscheduled),
-      :limit => 1,
-      :story_type => 'release'
-    ).and_return([@story])
-    @story.stub(:story_type) {'release'}
+    @project.should_receive(:stories).and_return([@story])
+    @story.stub(:story_type) {'feature'}
     @story.stub(:name) {'story_name'}
+    @story.stub(:labels){''}
+    @story.stub(:estimate){ 1}
 
     @menu.stub(:prompt=)
     @menu.stub(:choice)
     GitPivotalTrackerIntegration::Util::Story.should_receive(:choose) { |&arg| arg.call @menu }.and_return(@story)
 
-    story = GitPivotalTrackerIntegration::Util::Story.select_story @project, 'release', 1
+    story = GitPivotalTrackerIntegration::Util::Story.select_story @project
 
     expect(story).to be(@story)
   end
 
   it 'should prompt the user for a story if the result of the query is more than a single story' do
-    @project.should_receive(:stories).and_return(@stories)
-    @stories.should_receive(:all).with(
-      :current_state => %w(rejected unstarted unscheduled),
-      :limit => 5,
-      :story_type => 'feature'
-    ).and_return([
-      PivotalTracker::Story.new(:name => 'name-1'),
-      PivotalTracker::Story.new(:name => 'name-2')
+    @project.should_receive(:stories).and_return([
+      TrackerApi::Resources::Story.new(:name => 'name-1',:estimate  => 1,:story_type => 'feature'),
+      TrackerApi::Resources::Story.new(:name => 'name-2',:estimate  => 1)
     ])
     @menu.should_receive(:prompt=)
     @menu.should_receive(:choice).with('name-1')
     @menu.should_receive(:choice).with('name-2')
+    @menu.should_receive(:choice).with('Quit')
     GitPivotalTrackerIntegration::Util::Story.should_receive(:choose) { |&arg| arg.call @menu }.and_return(@story)
 
     story = GitPivotalTrackerIntegration::Util::Story.select_story @project, 'feature'
@@ -122,17 +114,14 @@ describe GitPivotalTrackerIntegration::Util::Story do
   end
 
   it 'should prompt the user with the story type if no filter is specified' do
-    @project.should_receive(:stories).and_return(@stories)
-    @stories.should_receive(:all).with(
-      :current_state => %w(rejected unstarted unscheduled),
-      :limit => 5
-    ).and_return([
-      PivotalTracker::Story.new(:story_type => 'chore', :name => 'name-1'),
-      PivotalTracker::Story.new(:story_type => 'bug', :name => 'name-2')
+    @project.should_receive(:stories).and_return([
+      TrackerApi::Resources::Story.new(:story_type => 'chore', :name => 'name-1'),
+      TrackerApi::Resources::Story.new(:story_type => 'bug', :name => 'name-2')
     ])
     @menu.should_receive(:prompt=)
     @menu.should_receive(:choice).with('CHORE   name-1')
     @menu.should_receive(:choice).with('BUG     name-2')
+    @menu.should_receive(:choice).with('Quit')
     GitPivotalTrackerIntegration::Util::Story.should_receive(:choose) { |&arg| arg.call @menu }.and_return(@story)
 
     story = GitPivotalTrackerIntegration::Util::Story.select_story @project

data/tracker_api/lib/tracker_api/client.rb

@@ -0,0 +1,241 @@
+module TrackerApi
+  class Client
+    USER_AGENT          = "Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) TrackerApi/#{TrackerApi::VERSION} Faraday/#{Faraday::VERSION}".freeze
+
+    # Header keys that can be passed in options hash to {#get},{#paginate}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    attr_reader :url, :api_version, :token, :logger, :connection, :auto_paginate, :last_response
+
+    # Create Pivotal Tracker API client.
+    #
+    # @param [Hash] options the connection options
+    # @option options [String] :token API token to use for requests
+    # @option options [String] :url Main HTTP API root
+    # @option options [Boolean] :auto_paginate Client should perform pagination automatically. Default true.
+    # @option options [String] :api_version The API version URL path
+    # @option options [String] :logger Custom logger
+    # @option options [String] :adapter Custom http adapter to configure Faraday with
+    # @option options [String] :connection_options Connection options to pass to Faraday
+    #
+    # @example Creating a Client
+    #   Client.new token: 'my-super-special-token'
+    def initialize(options={})
+      url                = options.fetch(:url, 'https://www.pivotaltracker.com')
+      @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)
+      connection_options = options.fetch(:connection_options, { ssl: { verify: true } })
+      @auto_paginate     = options.fetch(:auto_paginate, true)
+      @token             = options[:token]
+      raise 'Missing required options: :token' unless @token
+
+      @connection = Faraday.new({ url: @url }.merge(connection_options)) do |builder|
+        # response
+        builder.use Faraday::Response::RaiseError
+        builder.response :json
+
+        # request
+        builder.request :multipart
+        builder.request :json
+
+        builder.use TrackerApi::Logger, @logger
+        builder.adapter adapter
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def get(path, options = {})
+      request(:get, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def post(path, options = {})
+      request(:post, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def put(path, options = {})
+      request(:put, parse_query_and_convenience_headers(path, options))
+    end
+
+    # Make one or more HTTP GET requests, optionally fetching
+    # the next page of results from information passed back in headers
+    # based on value in {#auto_paginate}.
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatenation of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response.
+    # @return [Array]
+    def paginate(path, options = {}, &block)
+      opts           = parse_query_and_convenience_headers path, options.dup
+      auto_paginate  = opts[:params].delete(:auto_paginate) { |k| @auto_paginate }
+      @last_response = request :get, opts
+      data           = @last_response.body
+      raise TrackerApi::Errors::UnexpectedData, 'Array expected' unless data.is_a? Array
+
+      if auto_paginate
+        pager = Pagination.new @last_response.headers
+
+        while pager.more?
+          opts[:params].update(pager.next_page_params)
+
+          @last_response = request :get, opts
+          pager          = Pagination.new @last_response.headers
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.body) if @last_response.body.is_a?(Array)
+          end
+        end
+      end
+
+      data
+    end
+
+    # Get projects
+    #
+    # @param [Hash] params
+    # @return [Array[TrackerApi::Resources::Project]]
+    def projects(params={})
+      Endpoints::Projects.new(self).get(params)
+    end
+
+    # Get project
+    #
+    # @param [Hash] params
+    # @return [TrackerApi::Resources::Project]
+    def project(id, params={})
+      Endpoints::Project.new(self).get(id, params)
+    end
+
+    # Get information about the authenticated user
+    #
+    # @return [TrackerApi::Resources::Me]
+    def me
+      Endpoints::Me.new(self).get
+    end
+
+    # Get information about a client story without knowing what project the story belongs to
+    #
+    # @param [String] story_id
+    # @return [TrackerApi::Resources::Story]
+    def story(story_id)
+      Endpoints::Story.new(self).get_story(story_id)
+    end
+
+    # Get notifications for the authenticated person
+    #
+    # @param [Hash] params
+    # @return [Array[TrackerApi::Resources::Notification]]
+    def notifications(params={})
+      Endpoints::Notifications.new(self).get(params)
+    end
+
+    # Provides a list of all the activity performed the authenticated person.
+    #
+    # @param [Hash] params
+    # @return [Array[TrackerApi::Resources::Activity]]
+    def activity(params={})
+      Endpoints::Activity.new(self).get(params)
+    end
+
+    private
+
+    def parse_query_and_convenience_headers(path, options)
+      raise 'Path can not be blank.' if path.to_s.empty?
+
+      opts = { body: options[:body] }
+
+      opts[:url]    = options[:url] || File.join(@url, @api_version, path.to_s)
+      opts[:method] = options[:method] || :get
+      opts[:params] = options[:params] || {}
+      opts[:token]  = options[:token] || @token
+      headers       = { 'User-Agent'     => USER_AGENT,
+                        'X-TrackerToken' => opts.fetch(:token) }.merge(options.fetch(:headers, {}))
+
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options[h]
+          headers[h] = header
+        end
+      end
+      opts[:headers] = headers
+
+      opts
+    end
+
+    def request(method, options = {})
+      url     = options.fetch(:url)
+      params  = options[:params] || {}
+      body    = options[:body]
+      headers = options[:headers]
+
+      if (method == :post || method == :put) && options[:body].nil?
+        body                    = params.to_json
+        headers['Content-Type'] = 'application/json'
+
+        params = {}
+      end
+
+      @last_response = response = connection.send(method) do |req|
+        req.url(url)
+        req.headers.merge!(headers)
+        req.params.merge!(params)
+        req.body = body
+      end
+      response
+    rescue Faraday::Error::ClientError => e
+      raise TrackerApi::Error.new(e)
+    end
+
+    class Pagination
+      attr_accessor :headers, :total, :limit, :offset, :returned
+
+      def initialize(headers)
+        @headers  = headers
+        @total    = headers['x-tracker-pagination-total'].to_i
+        @limit    = headers['x-tracker-pagination-limit'].to_i
+        @offset   = headers['x-tracker-pagination-offset'].to_i
+        @returned = headers['x-tracker-pagination-returned'].to_i
+
+        # if offset is negative (e.g. Iterations Endpoint).
+        #   For the 'Done' scope, negative numbers can be passed, which
+        #   specifies the number of iterations preceding the 'Current' iteration.
+        # then need to adjust the negative offset to account for a smaller total,
+        #   and set total to zero since we are paginating from -X to 0.
+        if @offset < 0
+          @offset = -@total if @offset.abs > @total
+          @total  = 0
+        end
+      end
+
+      def more?
+        (offset + limit) < total
+      end
+
+      def next_offset
+        offset + limit
+      end
+
+      def next_page_params
+        { limit: limit, offset: next_offset }
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/activity.rb

@@ -0,0 +1,38 @@
+module TrackerApi
+  module Endpoints
+    class Activity
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(params={})
+        data = client.paginate("/my/activity", params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of activities expected' unless data.is_a? Array
+
+        data.map do |activity|
+          Resources::Activity.new({ client: client }.merge(activity))
+        end
+      end
+
+      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
+
+        data.map do |activity|
+          Resources::Activity.new({ client: client }.merge(activity))
+        end
+      end
+
+      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
+
+        data.map do |activity|
+          Resources::Activity.new({ client: client }.merge(activity))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/comments.rb

@@ -0,0 +1,27 @@
+module TrackerApi
+  module Endpoints
+    class Comments
+      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}/comments", params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
+
+        data.map do |comment|
+          Resources::Comment.new({ story_id: story_id }.merge(comment))
+        end
+      end
+
+      def create_with_attachment(project_id, story_id, text, file_attachment)
+        comment = {:text => text, :file_attachments => [file_attachment.attributes]}
+        data = client.post("/projects/#{project_id}/stories/#{story_id}/comments", params: comment).body
+
+        Resources::Comment.new({ client: client }.merge(data))
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/epic.rb

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

data/tracker_api/lib/tracker_api/endpoints/epics.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Epics
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      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
+
+        data.map do |epic|
+          Resources::Epic.new({ project_id: project_id }.merge(epic))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/file_attachment.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Endpoints
+    class FileAttachment
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(project_id, file_name, content_type)
+        body = {file: Faraday::UploadIO.new(file_name, content_type)}
+        data = client.post("/projects/#{project_id}/uploads", body: body).body
+        Resources::FileAttachment.new({ client: client }.merge(data))
+      end
+
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/iterations.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Iterations
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      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
+
+        data.map do |iteration|
+          Resources::Iteration.new({ client: client, project_id: project_id }.merge(iteration))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/me.rb

@@ -0,0 +1,17 @@
+module TrackerApi
+  module Endpoints
+    class Me
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get
+        data = client.get("/me").body
+
+        Resources::Me.new(data)
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/memberships.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Memberships
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      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
+
+        data.map do |membership|
+          Resources::ProjectMembership.new({ project_id: project_id }.merge(membership))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/notifications.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Notifications
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(params={})
+        data = client.paginate('/my/notifications', params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of notifications expected' unless data.is_a? Array
+
+        data.map do |notification|
+          Resources::Notification.new({ client: client }.merge(notification))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/project.rb

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

data/tracker_api/lib/tracker_api/endpoints/projects.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Endpoints
+    class Projects
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(params={})
+        data = client.paginate('/projects', params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of projects expected' unless data.is_a? Array
+
+        data.map { |project| Resources::Project.new({ client: client }.merge(project)) }
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/stories.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Stories
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      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
+
+        data.map do |story|
+          Resources::Story.new({ client: client, project_id: project_id }.merge(story))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/endpoints/story.rb

@@ -0,0 +1,37 @@
+module TrackerApi
+  module Endpoints
+    class Story
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, id)
+        data = client.get("/projects/#{project_id}/stories/#{id}").body
+
+        Resources::Story.new({ client: client, project_id: project_id }.merge(data))
+      end
+
+      def get_story(story_id)
+        data = client.get("/stories/#{story_id}").body
+
+        Resources::Story.new({ client: client }.merge(data))
+      end
+
+      def create(project_id, params={})
+        data = client.post("/projects/#{project_id}/stories", params: params).body
+
+        Resources::Story.new({ client: client }.merge(data))
+      end
+
+      def update(story, params={})
+        raise ArgumentError, 'Valid story required to update.' unless story.instance_of?(Resources::Story)
+
+        data = client.put("/projects/#{story.project_id}/stories/#{story.id}", params: params).body
+
+        story.attributes = data
+      end
+    end
+  end
+end