Pipedrive.com API wrapper
Add this line to your application's Gemfile:
gem 'pipedrive.rb'
And then execute:
$ bundle
Or install it yourself as:
$ gem install pipedrive.rb
You need initialize Person client:
client = ::Pipedrive::Person.new('api_token')You can get person's JSON data:
person = client.find_by_id(12345)
person.success? # check what request was successful
person.data # JSON data of person entityYou can update person:
res = client.update(12345, name: 'New Name', 'custom_field_key' => 'value')
res.success? # check what request was successful
res.data # updated JSON data of personOr you can update person with only hash what include id:
res = client.update(id: 12345, name: 'New Name', 'custom_field_key' => 'value')You can get the list of all persons:
all_persons = client.all # all persons - can be a time consume operation
all_persons = client.all(start: 200) # Skipping first 200 personsOr you can get first page of persons:
first_page = client.chunk(start: 200, limit: 10) # get 10 records after skipping 200Or you can iterate by all persons:
client.each(start: 200) do |json_item|
# some logic
endOr you can work with enumerate:
client.each(start: 100).select {|x| x['company_id'] == 12345}If you need use only one pipedrive account for whole application, then you can create config/initializer/pipedrive.rb file with next content:
Pipedrive.setup do |n|
n.api_token = ENV['PIPEDRIVE_API_TOKEN']
endAnd you can skip providing api_token to the entities classes.
- Fork it ( https://github.com/amoniacou/pipedrive/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request