Class: Pipekit::Request

Inherits:
Object
  • Object
show all
Includes:
HTTParty
Defined in:
lib/pipekit/request.rb

Constant Summary collapse

PIPEDRIVE_URL = 
"https://api.pipedrive.com/v1"
DEFAULT_PAGINATION_LIMIT = 
500

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource) ⇒ Request

Returns a new instance of Request.

[View source]

13
14
15
16
 
# File 'lib/pipekit/request.rb', line 13

def initialize(resource)
  @resource = resource
  self.class.debug_output $stdout if Config.fetch(:debug_requests)
end

Instance Attribute Details

#resource ⇒ Object (readonly)

Returns the value of attribute resource.


67
68
69
 
# File 'lib/pipekit/request.rb', line 67

def resource
  @resource
end

Instance Method Details

#_get(uri, query, result) ⇒ Object

[View source]

69
70
71
72
 
# File 'lib/pipekit/request.rb', line 69

def _get(uri, query, result)
  return result.response unless result.fetch_next_request?
  _get(uri, query, result + get_request(uri, query, result.next_start))
end

#get(id = "", query = {}) ⇒ Object

Public: Pipedrive GET API call - does a GET request to the Pipedrive API based on the resource passed in the initialiser

id - If the resource being searched for has an id query - An optional query string start - The offset with which to start the query

As long as “request_all_pages” is not set to false in the config this will recursively call ‘#get` until all the pages of the request have been fetched from pipedrive Pipedrive until everything available has been received

[View source]

54
55
56
57
 
# File 'lib/pipekit/request.rb', line 54

def get(id = "", query = {})
  uri = uri(id)
  _get(uri, query, get_request(uri, query))
end

#get_request(uri, query, start = 0) ⇒ Object

[View source]

74
75
76
77
 
# File 'lib/pipekit/request.rb', line 74

def get_request(uri, query, start = 0)
  response = self.class.get(uri, options(query: {limit: pagination_limit, start: start}.merge(query)))
  Result.new(resource, response)
end

#options(query: {}, body: {}) ⇒ Object

[View source]

87
88
89
90
91
92
 
# File 'lib/pipekit/request.rb', line 87

def options(query: {}, body: {})
  {
    query: query.merge(api_token: Config.fetch(:api_token)),
    body: parse_body(body)
  }
end

#pagination_limit ⇒ Object

[View source]

115
116
117
 
# File 'lib/pipekit/request.rb', line 115

def pagination_limit
  Config.fetch(:pagination_limit, DEFAULT_PAGINATION_LIMIT)
end

#parse_body(body) ⇒ Object

Replaces custom fields with their Pipedrive ID if the ID is defined in the configuration

So if the body looked like this with a custom field called middle_name:

{ middle_name: “Dave” }

And it has a Pipedrive ID (“123abc”), this will put in this custom ID

{ “123abc”: “Dave” }

meaning you don’t have to worry about the custom IDs

[View source]

107
108
109
110
111
112
113
 
# File 'lib/pipekit/request.rb', line 107

def parse_body(body)
  body.reduce({}) do |result, (field, value)|
    value = Config.field_value_id(resource, field, value)
    field = Config.field_id(resource, field)
    result.tap { |result| result[field] = value }
  end
end

#post(data) ⇒ Object

[View source]

63
64
65
 
# File 'lib/pipekit/request.rb', line 63

def post(data)
  response_from self.class.post(uri, options(body: data))
end

#put(id, data) ⇒ Object

[View source]

59
60
61
 
# File 'lib/pipekit/request.rb', line 59

def put(id, data)
  response_from self.class.put(uri(id), options(body: data))
end

#response_from(response_data) ⇒ Object

[View source]

79
80
81
 
# File 'lib/pipekit/request.rb', line 79

def response_from(response_data)
  Result.response(resource, response_data)
end

#search_by_field(field:, value:) ⇒ Object

Public: Pipedrive /searchField API call.

type - Type of the field:

:person - person fields
:deal - deal fields

field - The name of the field.

If it's the custom field the id of the field should be stored in `config/pipedrive.yml`.

value - The value of the field.

Examples

search_by_field(field: :cohort, value: 119)
search_by_field(field: :github_username, value: "octocat")

Returns an array of Response objects or throws a ResourceNotFoundError if it couldn’t find anything.

This also uses the “request_all_pages” config option when set to do multiple requests, getting around Pipedrive’s pagination

[View source]

37
38
39
40
41
 
# File 'lib/pipekit/request.rb', line 37

def search_by_field(field:, value:)
  query = search_by_field_query(field, value)

  get_request("/searchResults/field", query).response
end

#search_by_field_query(field = nil, value = nil) ⇒ Object

[View source]

119
120
121
122
123
124
125
126
127
 
# File 'lib/pipekit/request.rb', line 119

def search_by_field_query(field = nil, value = nil)
  {
    field_type: "#{resource}Field",
    field_key: Config.field_id(resource, field),
    return_item_ids: true,
    term: Config.field_value_id(resource, field, value),
    exact_match: 1
  }
end

#uri(id = "") ⇒ Object

[View source]

83
84
85
 
# File 'lib/pipekit/request.rb', line 83

def uri(id = "")
  "/#{resource}s/#{id}".chomp("/")
end