pipedrive_ruby 1.0.1.pre15

data/lib/pipedrive_client.rb

@@ -0,0 +1,24 @@
+# share commum methods for resources
+module PipedriveRuby
+  # This class is for hold the client informations (API TOKEN, resources)
+  class PipedriveClient
+
+    attr_reader :api_token
+
+    def initialize(api_token)
+      @api_token = api_token
+    end
+
+    # this delegation is only to allow user make PipedriveClient.new("token").resource
+    # where resource could be deals organizations etc...
+    def method_missing(method)
+      begin
+        class_name = 'PipedriveRuby::' + method.to_s.split("_").collect(&:capitalize).join
+        Object.const_get(class_name).new(self)
+      rescue NameError
+        "#{method} class not found"
+      end
+    end
+
+  end
+end

data/lib/pipedrive_ruby/version.rb

@@ -0,0 +1,4 @@
+module PipedriveRuby
+  # version of gem
+  VERSION = "1.0.1.pre15"
+end

data/lib/pipedrive_ruby.rb

@@ -0,0 +1,48 @@
+require 'pipedrive_ruby/version'
+require 'http'
+require 'pipedrive_client'
+require 'http_factory'
+require 'resources/base'
+
+require 'resources/deals'
+require 'resources/organizations'
+require 'resources/activities'
+require 'resources/activitiy_fields'
+require 'resources/activity_types'
+require 'resources/authorizations'
+require 'resources/currencies'
+require 'resources/deal_fields'
+require 'resources/push_notifications'
+require 'resources/recents'
+require 'resources/search_results'
+require 'resources/user_settings'
+require 'resources/users'
+require 'resources/products'
+
+
+# TODO (Felipe Borges Ferreira)
+require 'resources/email_messages'
+require 'resources/email_threads'
+require 'resources/files'
+require 'resources/global_messages'
+require 'resources/goals'
+require 'resources/note_fields'
+require 'resources/notes'
+require 'resources/organization_fields'
+require 'resources/organization_relationships'
+require 'resources/permission_sets'
+require 'resources/person_fields'
+require 'resources/persons'
+require 'resources/pipelines'
+require 'resources/product_fields'
+require 'resources/roles'
+require 'resources/stages'
+require 'resources/user_connections'
+#
+
+# If you need to use the PipedriveAPI
+# https://developers.pipedrive.com/v1
+module PipedriveRuby
+  # this is the url for API V1
+  API_URL = 'https://api.pipedrive.com/v1'.freeze
+end

data/lib/resources/activities.rb

@@ -0,0 +1,9 @@
+# Activities are appointments/tasks/events on a calendar that can be associated with a Deal, a Person and an Organization.
+# Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular User.
+# Note that activities can also be created without a specific date/time.
+module PipedriveRuby
+  # Available calls (all, find, create, update, remove, remove_many)
+  class Activities < PipedriveRuby::Base
+    def_delegators :endpoints, :all, :find, :create, :update, :remove, :remove_many
+  end
+end

data/lib/resources/activitiy_fields.rb

@@ -0,0 +1,6 @@
+# ActivityFields represent different fields that Activity has.
+module PipedriveRuby
+  class ActivityFields < PipedriveRuby::Base
+    def_delegators :endpoints, :all
+  end
+end

data/lib/resources/activity_types.rb

@@ -0,0 +1,11 @@
+# ActivityTypes represent different kinds of activities that can be stored.
+# Each ActivityType is presented to the user with an icon and a name.
+# Additionally, a color can be defined (not implemented in the Pipedrive app as of today).
+# ActivityTypes are linked to Activities via ActivityType.key_string = Activity.type.
+# The key_string will be generated by the API based on the given name of the ActivityType upon creation, and cannot be changed.
+# ActivityTypes should be presented to the user in an ordered manner, using the ActivityType.order_nr value.
+module PipedriveRuby
+  class ActivityTypes < PipedriveRuby::Base
+    def_delegators :endpoints, :all, :create, :update, :remove, :remove_many
+  end
+end

data/lib/resources/authorizations.rb

@@ -0,0 +1,16 @@
+# Authorization objects can be fetched without an API token but using an email and password.
+# Fetching the Authorization objects essentially allows you to authorize users based on their login credentials and retrieve the underlying API tokens associated with the given user.
+# Note that any given user an Authorization object per each company he/she belongs to.
+module PipedriveRuby
+  # Returns all authorizations for a particular user.
+  # Authorization objects contain the API tokens the user has with different company accounts in Pipedrive. These can be fetched without an API token but using the email and password of the user.
+  class Authorizations < PipedriveRuby::Base
+
+    def all(authorization)
+      create(authorization)
+    end
+
+    def_delegators :endpoints, :create
+
+  end
+end

data/lib/resources/base.rb

@@ -0,0 +1,17 @@
+module PipedriveRuby
+  # responsable for interface all resources with PipedriveClient
+    class Base
+      extend Forwardable
+
+      attr_reader :client,:endpoints,:base_url
+
+      def initialize(pipedrive_client)
+          class_name = self.class.name
+          @client = pipedrive_client
+          @endpoints = PipedriveRuby::HttpFactory.new(class_name, @client)
+      end
+
+      def_delegators :endpoints, :custom_get, :custom_post, :custom_delete
+
+    end
+end

data/lib/resources/currencies.rb

@@ -0,0 +1,13 @@
+# Supported currencies which can be used to represent the monetary value of a Deal, or a value of any monetary type custom field.
+# The Currency.code field must be used to point to a currency.
+# Currency.code is the ISO-4217 format currency code for non-custom currencies.
+# You can differentiate custom and non-custom currencies using the is_custom_flag property.
+# For custom currencies, it is intended that the formatted sums are displayed in the UI using the following format: [sum][non-breaking space character][currency.symbol], for example: 500 users.
+# Custom currencies cannot be added or removed via the API yet — rather the admin users of the account must configure them from the Pipedrive app
+module PipedriveRuby
+  # Returns all supported currencies in given account which should be used when saving monetary values with other objects.
+  # The 'code' parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.
+  class Currencies < PipedriveRuby::Base
+    def_delegators :endpoints, :all
+  end
+end

data/lib/resources/deal_fields.rb

@@ -0,0 +1,10 @@
+# DealFields represent the near-complete schema for a Deal in the context of the company of the authorized user.
+# Each company can have a different schema for their Deals, with various custom fields. In the context of using DealFiels as a schema for defining the data fields of a Deal, it must be kept in mind that some types of custom fields can have additional data fields which are not separate DealFields per se.
+# Such is the case with monetary, daterange and timerange fields – each of these fields will have one additional data field in addition to the one presented in the context of DealFields.
+# For example, if there is a monetary field with the key 'ffk9s9' stored on the account, 'ffk9s9' would hold the numeric value of the field, and 'ffk9s9_currency' would hold the ISO currency code that goes along with the numeric value.
+# To find out which data fields are available, fetch one Deal and list its keys.
+module PipedriveRuby
+  class DealFields < PipedriveRuby::Base
+    def_delegators :endpoints, :all, :find, :create, :update, :remove, :remove_many
+  end
+end

data/lib/resources/deals.rb

@@ -0,0 +1,72 @@
+# Deals represent ongoing, lost or won sales to an Organization or to a Person.
+# Each deal has a monetary value and must be placed in a Stage. Deals can be owned by a User, and followed by one or many Users.
+# Each Deal consists of standard data fields but can also contain a number of custom fields. The custom fields can be recognized by long hashes as keys.
+# These hashes can be mapped against DealField.key. The corresponding label for each such custom field can be obtained from DealField.name.
+module PipedriveRuby
+    # This class should hold all endpoints that are specific of deals
+    class Deals < PipedriveRuby::Base
+
+        def delete_follower(deal, user)
+        end
+
+        def products(deal)
+          custom_get(:path => "#{deal['id']}/products",
+                      :params => {:include_product_data => 1}
+                    )
+        end
+
+        def add_product(deal, product)
+        end
+
+        def update_product(deal, product)
+        end
+
+        def delete_product(deal, product)
+        end
+
+        def activities(deal)
+            custom_get(:path => "#{deal['id']}/activities")
+        end
+
+        def log(deal)
+          custom_get(:path => "#{deal['id']}/flow")
+        end
+
+        def add_participant(deal, person)
+        end
+
+        def participants(deal)
+          custom_get(:path => "#{deal['id']}/participants")
+        end
+
+        def delete_participant(deal, participant)
+        end
+
+        def emails(deal)
+          custom_get(:path => "#{deal['id']}/emailMessages")
+        end
+
+        def find_by_title(term)
+            find_by(term)
+        end
+
+        def timeline
+        end
+
+        def_delegators :endpoints,
+                                  :add_follower,
+                                  :all,
+                                  :find,
+                                  :find_by,
+                                  :files,
+                                  :followers,
+                                  :create,
+                                  :duplicate,
+                                  :merge,
+                                  :permitted_users,
+                                  :remove,
+                                  :remove_many,
+                                  :update
+
+    end
+end

data/lib/resources/email_messages.rb

@@ -0,0 +1,5 @@
+# EmailMessages represent e-mail messages sent or received through Pipedrive designated e-mail account.
+# Messages are grouped in threads.
+# The Mailbox feature must be enabled on the Pipedrive account in order for these APIs to work properly.
+class EmailMessages
+end

data/lib/resources/email_threads.rb

@@ -0,0 +1,4 @@
+# EmailThreads represent e-mail message threads which contain individual e-mail messages.
+# The Mailbox feature must be enabled on the Pipedrive account in order for these APIs to work properly.
+class EmailThreads
+end

data/lib/resources/files.rb

@@ -0,0 +1,4 @@
+# Files are documents of any kind (images, spreadsheets, text files, etc) that are uploaded to Pipedrive, and usually associated with a particular Deal, Person or Organization.
+# Note that the API currently does not support downloading files although it lets you retrieve file meta info along retrieve a download URL where the file can be downloaded using a standard HTTP GET request.
+class Files
+end

data/lib/resources/filters.rb

@@ -0,0 +1,4 @@
+# Each filter is essentially a set of data validation conditions. A filter of the same kind can be applied when fetching list of Deals, Persons, Organizations, Products or Deals in the context of a Pipeline. When applied, only items matching the conditions of the filter are returned.
+# Detailed definitions of filter conditions and additional functionality is not yet available.
+class Filters
+end

data/lib/resources/global_messages.rb

@@ -0,0 +1,3 @@
+# Get or dismiss global messages
+class GlobalMessages
+end

data/lib/resources/goals.rb

@@ -0,0 +1,4 @@
+# Goals help your team meet your sales targets. All goals are automatically carried over to the next period, e.g. when a week ends all the active weekly goals are automatically started for the next week as well.
+# This means less hassle for you.
+class Goals
+end

data/lib/resources/note_fields.rb

@@ -0,0 +1,3 @@
+# NoteFields represent different fields that Note has.
+class NoteFields
+end

data/lib/resources/notes.rb

@@ -0,0 +1,4 @@
+# Notes are pieces of textual (HTML-formatted) information that can be attached to Deals, Persons and Organizations.
+# Notes are usually displayed in the UI in a chronological order – newest first – and in context with other updates regarding the item they are attached to.
+class Notes
+end

data/lib/resources/organization_fields.rb

@@ -0,0 +1,8 @@
+# OrganizationFields represent the near-complete schema for an Organization in the context of the company of the authorized user.
+# Each company can have a different schema for their Organizations, with various custom fields.
+# In the context of using OrganizationFiels as a schema for defining the data fields of an Organization, it must be kept in mind that some types of custom fields can have additional data fields which are not separate OrganizationFields per se.
+# Such is the case with monetary, daterange and timerange fields – each of these fields will have one additional data field in addition to the one presented in the context of OrganizationFields.
+# For example, if there is a monetary field with the key 'ffk9s9' stored on the account, 'ffk9s9' would hold the numeric value of the field, and 'ffk9s9_currency' would hold the ISO currency code that goes along with the numeric value.
+# To find out which data fields are available, fetch one Organization and list its keys.
+class OrganizationFields
+end

data/lib/resources/organization_relationships.rb

@@ -0,0 +1,3 @@
+# Hangle organization relationships, pipedrive allow you yo have organization associations
+class OrganizationRelationships
+end

data/lib/resources/organizations.rb

@@ -0,0 +1,7 @@
+# Organizations are companies and other kinds of organizations you are making Deals with.
+# Persons can be associated with organizations so that each organization can contain one or more Persons.
+module PipedriveRuby
+    class Organizations < PipedriveRuby::Base
+        def_delegators :endpoints, :all, :find, :create, :update
+    end
+end

data/lib/resources/permission_sets.rb

@@ -0,0 +1,3 @@
+# Hangle PermissionSets
+class PermissionSets
+end

data/lib/resources/person_fields.rb

@@ -0,0 +1,3 @@
+# PersonFields represent the near-complete schema for a Person in the context of the company of the authorized user. Each company can have a different schema for their Persons, with various custom fields. In the context of using PersonFields as a schema for defining the data fields of a Person, it must be kept in mind that some types of custom fields can have additional data fields which are not separate PersonFields per se. Such is the case with monetary, daterange and timerange fields – each of these fields will have one additional data field in addition to the one presented in the context of PersonFields. For example, if there is a monetary field with the key 'ffk9s9' stored on the account, 'ffk9s9' would hold the numeric value of the field, and 'ffk9s9_currency' would hold the ISO currency code that goes along with the numeric value. To find out which data fields are available, fetch one Person and list its keys.
+class PersonFields
+end

data/lib/resources/persons.rb

@@ -0,0 +1,4 @@
+# Organizations are companies and other kinds of organizations you are making Deals with.
+# Persons can be associated with organizations so that each organization can contain one or more Persons.
+class Persons
+end

data/lib/resources/pipelines.rb

@@ -0,0 +1,3 @@
+# Pipelines are essentially ordered collections of Stages.
+class Pipelines
+end

data/lib/resources/product_fields.rb

@@ -0,0 +1,8 @@
+# ProductFields represent the near-complete schema for a Product in the context of the company of the authorized user.
+# Each company can have a different schema for their Products, with various custom fields.
+# In the context of using ProductFields as a schema for defining the data fields of a Product, it must be kept in mind that some types of custom fields can have additional data fields which are not separate ProductFields per se.
+# Such is the case with monetary, daterange and timerange fields – each of these fields will have one additional data field in addition to the one presented in the context of ProductFields.
+# For example, if there is a monetary field with the key 'ffk9s9' stored on the account, 'ffk9s9' would hold the numeric value of the field, and 'ffk9s9_currency' would hold the ISO currency code that goes along with the numeric value.
+# To find out which data fields are available, fetch one Product and list its keys.
+class ProductFields
+end

data/lib/resources/products.rb

@@ -0,0 +1,29 @@
+# Products are the goods or services you are dealing with.
+# Each product can have N different price points - first, each Product can have a price in N different currencies, and secondly, each Product can have N variations of itself, each having N prices different currencies.
+# Note that only one price per variation per currency is supported.
+# Products can be instantiated to Deals. In the context of instatiation, a custom price, quantity, duration and discount can be applied.
+module PipedriveRuby
+  class Products < PipedriveRuby::Base
+
+    def deals(product)
+      custom_get(:path => "#{product['id']}/deals")
+    end
+
+    def find_by_name(term)
+      find_by(term)
+    end
+
+    def_delegators :endpoints,
+                              :add_follower,
+                              :all,
+                              :delete_follower,
+                              :find,
+                              :find_by,
+                              :files,
+                              :followers,
+                              :create,
+                              :permitted_users,
+                              :update,
+                              :remove
+  end
+end

data/lib/resources/push_notifications.rb

@@ -0,0 +1,10 @@
+# Manage subscriptions of push notifications / web hooks / REST hooks about data changes.
+# A subscription means a designated HTTP(S) endpoint which will receive a request every time a certain event happens on your Pipedrive account.
+# E.g. when you have subscribed to receive events about all new deals ('deal.added'), this HTTP(S) will receive a request per each such event.
+# See https://app.pipedrive.com/push_notifications#dialog:/push_notifications/help for detailed documentation of web hooks.
+module PipedriveRuby
+  # Returns data about all subscriptions.
+  class PushNotifications < PipedriveRuby::Base
+    def_delegators :endpoints, :all, :find, :create, :remove
+  end
+end

data/lib/resources/recents.rb

@@ -0,0 +1,6 @@
+module PipedriveRuby
+# Recent changes across all item types in Pipedrive (deals, persons, etc).
+  class Recents < PipedriveRuby::Base
+    def_delegators :endpoints, :all
+  end
+end

data/lib/resources/roles.rb

@@ -0,0 +1,3 @@
+# Pipedrive API has no comment on this resource
+class Roles
+end

data/lib/resources/search_results.rb

@@ -0,0 +1,14 @@
+module PipedriveRuby
+# Ordered reference objects, pointing to either Deals, Persons, Organizations, Files or Products.
+  class SearchResults < PipedriveRuby::Base
+
+    # Performs a search from a specific field's values. Results can be either the distinct values of the field (useful for searching autocomplete field values), or actual items IDs (deals, persons, organizations or products).
+    # Works only with the following field types: varchar, varchar_auto, double, address, text, phone, date.
+    def field(params={})
+      options = {:params => params}
+      options[:path] = 'field'
+      custom_get(options)
+    end
+    def_delegators :endpoints, :all, :custom_get
+  end
+end

data/lib/resources/stages.rb

@@ -0,0 +1,4 @@
+# Stage is a logical component of a Pipeline, and essentially a bucket that can hold a number of Deals.
+# In the context of the Pipeline a stage belongs to, it has an order number which defines the order of stages in that Pipeline.
+class Estages
+end

data/lib/resources/user_connections.rb

@@ -0,0 +1,7 @@
+# Manage user connections. For example, google.
+module PipedriveRuby
+  # Returns data about all connections for authorized user.
+  class UserConnections < PipedriveRuby::Base
+    def_delegators :endpoints, :all
+  end
+end

data/lib/resources/user_settings.rb

@@ -0,0 +1,6 @@
+module PipedriveRuby
+# Lists settings of authorized user.
+  class UserSettings < PipedriveRuby::Base
+    def_delegators :endpoints, :all
+  end
+end

data/lib/resources/users.rb

@@ -0,0 +1,5 @@
+# Users are people with access to your Pipedrive account.
+# A user may belong to one or many Pipedrive accounts, so deleting a user from one Pipedrive account will not remove the user from the data store if he/she is connected to multiple accounts.
+# Users should not be confused with Persons.
+class Users
+end

data/pipedrive_ruby.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipedrive_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipedrive_ruby"
+  spec.version       = PipedriveRuby::VERSION
+  spec.authors       = ["Felipe Borges Ferreira"]
+  spec.email         = ["lypborges@gmail.com"]
+
+  spec.summary       = %q{Wrapper for Pipedrive API call.}
+  spec.description   = %q{Gem for use Pipedrive API for multiple tokens.}
+  spec.homepage      = "https://github.com/lypborges/pipedrive_ruby"
+  spec.license       = "MIT"
+
+  spec.has_rdoc      = 'yard'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.1"
+  spec.add_development_dependency "byebug", "~> 9.0"
+  spec.add_development_dependency "codeclimate-test-reporter", "~>0.6"
+end