Giter VIP home page Giter VIP logo

pipedrive.rb's Introduction

Pipedrive

Build Status Code Climate

Pipedrive.com API wrapper

Installation

Add this line to your application's Gemfile:

gem 'pipedrive.rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pipedrive.rb

Usage

Person

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 entity

You 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 person

Or 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 persons

Or you can get first page of persons:

first_page = client.chunk(start: 200, limit: 10) # get 10 records after skipping 200

Or you can iterate by all persons:

client.each(start: 200) do |json_item|
  # some logic
end

Or you can work with enumerate:

client.each(start: 100).select {|x| x['company_id'] == 12345}

Rails integration

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']
end

And you can skip providing api_token to the entities classes.

Contributing

  1. Fork it ( https://github.com/amoniacou/pipedrive/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.