Class: TrackerApi::Client

Inherits:
Object show all
Defined in:
lib/tracker_api/client.rb

Defined Under Namespace

Classes: Pagination

Constant Summary collapse

USER_AGENT = 
"Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}) TrackerApi/#{TrackerApi::VERSION} Faraday/#{Faraday::VERSION}".freeze
CONVENIENCE_HEADERS =

Header keys that can be passed in options hash to #get,#paginate

Set.new([:accept, :content_type])

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, &block) ⇒ Client

Create Pivotal Tracker API client.

Examples:

Creating a Client

Client.new token: 'my-super-special-token'

Parameters:

  • options (Hash) (defaults to: {}) —

    the connection options

Options Hash (options):

  • :token (String) —

    API token to use for requests

  • :url (String) —

    Main HTTP API root

  • :auto_paginate (Boolean) —

    Client should perform pagination automatically. Default true.

  • :api_version (String) —

    The API version URL path

  • :logger (String) —

    Custom logger

  • :adapter (String) —

    Custom http adapter to configure Faraday with

  • :connection_options (String) —

    Connection options to pass to Faraday



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/tracker_api/client.rb', line 23

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')
  @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

  @faraday_block = block if block_given?

  @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
    @faraday_block.call(builder) if @faraday_block
    builder.adapter adapter
  end
end

Instance Attribute Details

#api_version ⇒ Object (readonly)

Returns the value of attribute api_version.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def api_version
  @api_version
end

#auto_paginate ⇒ Object (readonly)

Returns the value of attribute auto_paginate.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def auto_paginate
  @auto_paginate
end

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def connection
  @connection
end

#last_response ⇒ Object (readonly)

Returns the value of attribute last_response.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def last_response
  @last_response
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def logger
  @logger
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def token
  @token
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



8
9
10
 
# File 'lib/tracker_api/client.rb', line 8

def url
  @url
end

Instance Method Details

#activity(params = {}) ⇒ Array[TrackerApi::Resources::Activity]

Provides a list of all the activity performed the authenticated person.

Parameters:

  • params (Hash) (defaults to: {})

Returns:



202
203
204
 
# File 'lib/tracker_api/client.rb', line 202

def activity(params={})
  Endpoints::Activity.new(self).get(params)
end

#create_workspace(params) ⇒ TrackerApi::Resources::Workspace

Create a new workspace.

Parameters:

  • params (Hash) —

    attributes to create the workspace with

Returns:



144
145
146
 
# File 'lib/tracker_api/client.rb', line 144

def create_workspace(params)
  Endpoints::Workspace.new(self).create(params)
end

#delete(path, options = {}) ⇒ Faraday::Response

Make a HTTP DELETE request

Parameters:

  • path (String) —

    The path, relative to api endpoint

  • options (Hash) (defaults to: {}) —

    Query and header params for request

Returns:

  • (Faraday::Response) 


83
84
85
 
# File 'lib/tracker_api/client.rb', line 83

def delete(path, options = {})
  request(:delete, parse_query_and_convenience_headers(path, options))
end

#epic(epic_id, params = {}) ⇒ TrackerApi::Resources::Epic

Get information about an epic without knowing what project the epic belongs to

Parameters:

  • epic_id (String)
  • params (Hash) (defaults to: {})

Returns:



186
187
188
 
# File 'lib/tracker_api/client.rb', line 186

def epic(epic_id, params={})
  Endpoints::Epic.new(self).get_epic(epic_id, params)
end

#get(path, options = {}) ⇒ Faraday::Response

Make a HTTP GET request

Parameters:

  • path (String) —

    The path, relative to api endpoint

  • options (Hash) (defaults to: {}) —

    Query and header params for request

Returns:

  • (Faraday::Response) 


56
57
58
 
# File 'lib/tracker_api/client.rb', line 56

def get(path, options = {})
  request(:get, parse_query_and_convenience_headers(path, options))
end

#me ⇒ TrackerApi::Resources::Me

Get information about the authenticated user

Returns:



168
169
170
 
# File 'lib/tracker_api/client.rb', line 168

def me
  Endpoints::Me.new(self).get
end

#notifications(params = {}) ⇒ Array[TrackerApi::Resources::Notification]

Get notifications for the authenticated person

Parameters:

  • params (Hash) (defaults to: {})

Returns:



194
195
196
 
# File 'lib/tracker_api/client.rb', line 194

def notifications(params={})
  Endpoints::Notifications.new(self).get(params)
end

#paginate(path, options = {}, &block) ⇒ Array

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.

Parameters:

  • path (String) —

    The path, relative to #api_endpoint

  • options (Hash) (defaults to: {}) —

    Query and header params for request

  • 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.

Returns:

Raises:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/tracker_api/client.rb', line 98

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

#post(path, options = {}) ⇒ Faraday::Response

Make a HTTP POST request

Parameters:

  • path (String) —

    The path, relative to api endpoint

  • options (Hash) (defaults to: {}) —

    Query and header params for request

Returns:

  • (Faraday::Response) 


65
66
67
 
# File 'lib/tracker_api/client.rb', line 65

def post(path, options = {})
  request(:post, parse_query_and_convenience_headers(path, options))
end

#project(id, params = {}) ⇒ TrackerApi::Resources::Project

Get project

Parameters:

  • params (Hash) (defaults to: {})

Returns:



136
137
138
 
# File 'lib/tracker_api/client.rb', line 136

def project(id, params={})
  Endpoints::Project.new(self).get(id, params)
end

#projects(params = {}) ⇒ Array[TrackerApi::Resources::Project]

Get projects

Parameters:

  • params (Hash) (defaults to: {})

Returns:



128
129
130
 
# File 'lib/tracker_api/client.rb', line 128

def projects(params={})
  Endpoints::Projects.new(self).get(params)
end

#put(path, options = {}) ⇒ Faraday::Response

Make a HTTP PUT request

Parameters:

  • path (String) —

    The path, relative to api endpoint

  • options (Hash) (defaults to: {}) —

    Query and header params for request

Returns:

  • (Faraday::Response) 


74
75
76
 
# File 'lib/tracker_api/client.rb', line 74

def put(path, options = {})
  request(:put, parse_query_and_convenience_headers(path, options))
end

#story(story_id, params = {}) ⇒ TrackerApi::Resources::Story

Get information about a client story without knowing what project the story belongs to

Parameters:

  • story_id (String)
  • params (Hash) (defaults to: {})

Returns:



177
178
179
 
# File 'lib/tracker_api/client.rb', line 177

def story(story_id, params={})
  Endpoints::Story.new(self).get_story(story_id, params)
end

#workspace(id, params = {}) ⇒ TrackerApi::Resources::Workspace

Get workspace

Parameters:

  • params (Hash) (defaults to: {})

Returns:



152
153
154
 
# File 'lib/tracker_api/client.rb', line 152

def workspace(id, params={})
  Endpoints::Workspace.new(self).get(id, params)
end

#workspaces(params = {}) ⇒ Array[TrackerApi::Resources::Workspace]

Get workspaces

Parameters:

  • params (Hash) (defaults to: {})

Returns:



160
161
162
 
# File 'lib/tracker_api/client.rb', line 160

def workspaces(params={})
  Endpoints::Workspaces.new(self).get(params)
end