pipedrive-connect 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4da043a8e3905c7fb4e906bff586866892f698168956953f90d5cac1efb74df
+  data.tar.gz: 2a7e1f744337017cc62ca332ccf9099ae3dbabe2a2a3fb186dc80915593b89a3
+SHA512:
+  metadata.gz: 7d4c23b5883caa37c3b5e9f111331ba42696f4db5ab93c261668ed6494ab2542c8ab0d9b9a7cf0319b73ba73e27ad079230db5da9bf047fd684ca61d6d2b430f
+  data.tar.gz: 74ada44b6ac31a5d28569c7eb004d13da26c92e13c2934c80ee984160f1fe7fbfed2d6e5fe7dab8f3d59600e022df5ef04d637a1745424b9755766567f7847cc

data/.gitignore

@@ -0,0 +1,11 @@
+/pipedrive-*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  NewCops: enable
+
+  DisplayCopNames: true
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    # `context` in tests are blocks and get quite large, so exclude the test
+    # directory from having to adhere to this rule.
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    # Test classes get quite large, so exclude the test directory from having
+    # to adhere to this rule.
+    - "test/**/*.rb"
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 51
+
+# Offense count: 12
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 6
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 8
+Metrics/PerceivedComplexity:
+  Max: 17
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+  # Offense count: 23
+
+# Offense count: 86
+Style/Documentation:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: true
+  AllowedMethods: has_many
+
+Layout/LineLength:
+  Max: 90

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.formatOnSave": true,
+  "files.trimTrailingWhitespace": true,
+
+  // Rubocop settings
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.onSave": true
+}

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+This file contains all notable changes to this project.
+This project adheres to [Semantic Versioning](http://semver.org/).
+This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
+
+## [1.2.4] - 2021-09-13
+
+- Add `Pipedrive.debug_http_body`for debugging the http payload
+- Fix bugs with `POST`/`PUT` endpoints
+## [1.2.3] - 2021-09-10
+
+- Add `Pipedrive.debug` so basic debug info is not displayed out of the box.
+- Add `Pipedrive.debug_http` for debugging http traffic.
+- Fix bug in some resources when no fields filtering was provided.
+
+## [1.2.2] - 2021-05-11
+
+- Fix bug introduced by v1.2.0 where `has_many` removed the chance to pass extra parameters.
+
+## [1.2.1] - 2021-05-10
+
+- Some endpoints like `deals/:id/products` allow to expand the response with `include_product_data` that include an attr `product` with all the data - including the custon fields - of the products. The deafult for that option is `false` or `0`. I personally think this is redundant, so this version overrides this behavior by passing `true` or `1` and deleging the attr `product` by merging its content with the body itself, at the end `/products` should return `products`. On future versions this option would be passed to the `has_many` method, like `has_many :products, class_name: "Product", include_data: false`
+
+## [1.2.0] - 2021-06-05
+
+- Add Lead, LeadLabel, LeadLabel and Goal models.
+
+## [1.1.0] - 2020-09-07
+
+- Add capability to merge organizations, people and deals. See [the doc here](https://developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id_merge).
+
+## [1.0.1] - 2020-07-07
+
+- Fixes unitialized constant error when the class_name within has_many definition doesn't contain the namespace
+
+## [1.0] - 2020-06-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at team@getonbrd.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "byebug"
+  gem "mocha"
+  gem "rspec"
+  gem "rubocop"
+  gem "simplecov", require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Get on Board (https://www.getonbrd.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# Pipedrive API Ruby library
+
+Pipedrive::Connect provides a convenient access to the Pipedrive API from applications written in the Ruby language.
+
+It abstracts the developer from having to deal with API requests by mapping the list of the core resources like Organization, Person or Deal to ruby classes and objects.
+
+Key features:
+
+- Easy to setup.
+- Map core concepts in Pipedrive to ruby classes.
+- Allow access to relationships among these concepts like accessing all the persons within an organization or its deals.
+- Abstract the developer from having to deal with custom fields by doing it internally.
+
+## Documentation
+
+Check the original API doc at: https://pipedrive.readme.io/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pipedrive-connect", github: "getonbrd/pipedrive-connect"
+```
+
+then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install pipedrive-connect
+```
+
+## Usage
+
+Configure the library by initializing it with the **api key** you can find in your [setttings page at Pipedrive](https://yourcompany.pipedrive.com/settings/api).
+
+```ruby
+Pipedrive.api_key = "abc123"
+```
+
+In case of using rails, do it via an initalizer:
+
+```ruby
+# file: app/initializers/pipedrive.rb
+
+require 'pipedrive'
+
+Pipedrive.api_key = ENV["PIPEDRIVE_API_KEY"]
+```
+
+### Models
+
+Access your data in pipedrive via the models (for the complete list check out the directory `lib/pipedrive/resources`). You'll find that most of these classes are documented in the [API Reference](https://developers.pipedrive.com/docs/api/v1/).
+
+For example to search, retrieve, access, create, update or delete an organization:
+
+```ruby
+# search for organizations with the term "Acme Inc" in any of their fields
+# return an array of Pipedrive::Organization instances
+orgs = Pipedrive::Organization.search("Acme Inc")
+
+# specify it is an exact match and reduce the scope to name and address
+orgs = Pipedrive::Organization.search(
+  "Acme Inc",
+  extact_match: true,
+  fields: [:name, :address]
+)
+
+# Want to paginate across all the organizations sorting them by name?
+orgs = Pipedrive::Organization.all(
+  "Acme Inc",
+  start: 0,
+  limit: 100,
+  sort: :name
+)
+
+# if you know the id then retrieve the org
+acme = Pipedrive::Organization.retrieve(123)
+acme.name
+
+# get access to the activities, deals and persons of the org
+acme.activities
+acme.deals
+acme.persons
+
+# create a new one
+new_branch = Pipedrive::Organization.create(name: "New Acme Inc")
+# update the name
+new_acme.update(name: "Acme the new Inc")
+
+# ot simply delete it
+new_acme.delete
+```
+
+### Custom Fields
+
+Pipedrive gives you the chance to add additional data by creating custom fields that are not included by default. Deals, Persons, Organizations and Products can all contain custom fields.
+
+[See the doc here](https://pipedrive.readme.io/docs/core-api-concepts-custom-fields).
+
+The issue with accessing a custom field via the API is that you have to know the assigned key, for instance, let's say we added a custom field called `domain` of type _text_ to the `Organization` in Pipedrive. If we would want to add a new organization using the API, this "would" be the code:
+
+```ruby
+org = Pipedrive::Organization.create(
+  name: "Acme Inc",
+  "sab55f505ca47dda0b4811f9ea5df00020540b80": "acme.com"
+)
+```
+
+Yeah, we know what you are thinking, not convinient at all. Well, we definitely think the same, so we fixed it by abstracting us (the devs) from having to know such key.
+
+So, using Pipedrive::Connect it is as it should always be:
+
+```ruby
+org = Pipedrive::Organization.create(
+  name: "Acme Inc",
+  domain: "acme.com"
+)
+
+# By the way, in case you are curious and want to know what all the fields
+# within an Organization are, just call:
+org.fields
+
+# or, this works too
+Pipedrive::Organization.fields
+```
+
+## Debuging
+
+Show basic debugging info:
+
+```ruby
+Pipedrive.debug = true
+```
+
+show extended HTTP traffic information:
+
+```ruby
+Pipedrive.debug_http = true
+
+# and to also show the body payloads
+Pipedrive.debug_http_body = true
+```
+
+## Development
+
+Run the set up:
+
+```sh
+$ bundle
+```
+
+Run the specs:
+
+```sh
+$ bundle exec rspec
+```
+
+Run the linter:
+
+```sh
+$ bundle exec rubocop
+```
+
+## Contributing
+
+1. Fork it.
+1. Create your feature branch (git checkout -b my-new-feature).
+1. Commit your changes (git commit -am 'Add some feature').
+1. Push to the branch (git push origin my-new-feature).
+1. Create a new Pull Request.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/getonbrd/pipedrive-connect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/getonbrd/pipedrive-connect/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Pipedrive::Connect project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/getonbrd/pipedrive-connect/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pipedrive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pipedrive/api_operations/create.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module APIOperations
+    module Create
+      def create(params)
+        response = request(
+          :post,
+          resource_url,
+          search_for_fields(params)
+        )
+        new(response.dig(:data))
+      end
+    end
+  end
+end

data/lib/pipedrive/api_operations/delete.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module APIOperations
+    module Delete
+      def delete
+        request(:delete, resource_url)
+      end
+    end
+  end
+end

data/lib/pipedrive/api_operations/request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module APIOperations
+    module Request
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def request(method, url, params = {})
+          check_api_key!
+          raise "Not supported method" \
+            unless %i[get post put delete].include?(method)
+
+          Util.debug "#{name} #{method.upcase} #{url}"
+          response = api_client.send(method) do |req|
+            req.url url
+            req.params = { api_token: Pipedrive.api_key }
+            if %i[post put].include?(method)
+              req.body = params.to_json
+            else
+              req.params.merge!(params)
+            end
+          end
+          Util.serialize_response(response)
+        end
+
+        def api_client
+          @api_client = Faraday.new(
+            url: BASE_URL,
+            headers: { "Content-Type": "application/json" }
+          ) do |faraday|
+            if Pipedrive.debug_http
+              faraday.response :logger, Pipedrive.logger,
+                               bodies: Pipedrive.debug_http_body
+            end
+          end
+        end
+
+        protected def check_api_key!
+          return if Pipedrive.api_key
+
+          raise AuthenticationError, "No API key provided. " \
+                                     "Set your API key using 'Pipedrive.api_key = <API-KEY>'"
+        end
+      end
+
+      protected def request(method, url, params = {})
+        self.class.request(method, url, params)
+      end
+    end
+  end
+end

data/lib/pipedrive/api_operations/update.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module APIOperations
+    module Update
+      def update(params)
+        response = request(
+          :put,
+          resource_url,
+          search_for_fields(params)
+        )
+        update_attributes(response.dig(:data))
+      end
+    end
+  end
+end

data/lib/pipedrive/errors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class PipedriveError < StandardError
+    attr_reader :code
+
+    def initialize(message = nil, code = nil)
+      super(message)
+      @message = message
+      @code = code
+    end
+
+    def message
+      code_str = @code.nil? ? "" : "(Status #{@code}) "
+      "#{code_str}#{@message}"
+    end
+  end
+  class SettingError < PipedriveError; end
+  class AuthenticationError < PipedriveError; end
+  class NotFoundError < PipedriveError; end
+  class UnkownAPIError < PipedriveError; end
+end

data/lib/pipedrive/fields.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module Fields
+    def self.included(base)
+      class << base
+        attr_accessor :fields_url
+      end
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def fields
+        url = fields_url || "#{class_name.downcase}Fields"
+        data = request(:get, url).dig(:data)
+        # return a hash prefilled with
+        # the fields hash and name parameterized
+        # and the original array of fields (schema)
+        dicc = data.reduce({}) do |fields_dicc, field|
+          # snakify the name
+          snake_name = field.dig(:name).gsub(/\w+/).reduce([]) do |words, c|
+            words << c.downcase
+          end.join("_")
+
+          fields_dicc.merge(
+            field.dig(:key).to_sym => snake_name.to_sym
+          )
+        end
+        [dicc, data]
+      end
+    end
+
+    def fields
+      self.class.fields
+    end
+  end
+end

data/lib/pipedrive/merge.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module Merge
+    def merge(with_id:)
+      raise "with_id must be an integer" unless with_id&.is_a?(Integer)
+
+      response = request(:put,
+                         "#{resource_url}/merge",
+                         merge_with_id: with_id)
+      self.class.new(response.dig(:data))
+    end
+  end
+end

data/lib/pipedrive/resource.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Resource
+    include Pipedrive::APIOperations::Request
+    extend  Pipedrive::APIOperations::Create
+    include Pipedrive::APIOperations::Update
+    include Pipedrive::APIOperations::Delete
+
+    class << self
+      attr_accessor :resources_url
+    end
+
+    def self.class_name
+      name.split("::")[-1]
+    end
+
+    def self.resource_url
+      if self == Resource
+        raise NotImplementedError,
+              "Pipedrive::Resource is an abstract class. You should perform actions " \
+              "on its subclasses (Organization, Person, Deal, etc)"
+      end
+      resources_url || "#{class_name.downcase}s"
+    end
+
+    def self.fields_dicc
+      @fields_dicc ||= fields[0] if respond_to? :fields
+    end
+
+    def self.inverted_fields_dicc
+      @inverted_fields_dicc ||= fields_dicc&.invert
+    end
+
+    def self.search_for_fields(values)
+      return values unless values.is_a?(Hash) && fields_dicc&.any?
+
+      values.reduce({}) do |new_hash, (k, v)|
+        if inverted_fields_dicc[k]
+          new_hash.merge(inverted_fields_dicc[k] => v)
+        else
+          new_hash.merge(k => v)
+        end
+      end
+    end
+
+    def self.retrieve(id)
+      response = request(:get, "#{resource_url}/#{id}")
+      new(response.dig(:data))
+    end
+
+    def self.all(params = {})
+      response = request(:get, resource_url, params)
+      response.dig(:data)&.map { |d| new(d) }
+    end
+
+    def self.search(term, params = {})
+      response = request(
+        :get,
+        "#{resource_url}/search",
+        { term: term }.merge(params)
+      )
+      response.dig(:data, :items).map { |d| new(d.dig(:item)) }
+    end
+
+    def self.has_many(resource_name, class_name:)
+      unless resource_name && class_name
+        raise "You must specify the resource name and its class name " \
+              "For example has_many :deals, class_name: 'Deal'"
+      end
+      class_name_lower_case = class_name.downcase
+      # always include all the data of the resource
+      options = { "include_#{class_name_lower_case}_data": 1 }
+      # add namespace to class_name
+      class_name = "::Pipedrive::#{class_name}" unless class_name.include?("Pipedrive")
+      define_method(resource_name) do |params = {}|
+        response = request(:get,
+                           "#{resource_url}/#{resource_name}",
+                           params.merge(options))
+        response.dig(:data)&.map do |data|
+          class_name_as_sym = class_name_lower_case.to_sym
+          if data.key?(class_name_as_sym)
+            data = data.merge(data.delete(class_name_as_sym))
+          end
+          Object.const_get(class_name).new(data)
+        end
+      end
+    end
+
+    def initialize(data = {})
+      @data = @unsaved_data = {}
+      initialize_from_data(data)
+    end
+
+    def resource_url
+      "#{self.class.resource_url}/#{id}"
+    end
+
+    def search_for_fields(values)
+      self.class.search_for_fields(values)
+    end
+
+    def update_attributes(new_attrs)
+      new_attrs.delete("id")
+      @data.merge!(new_attrs)
+    end
+
+    def refresh
+      response = request(:get, resource_url)
+      initialize_from_data(response.dig(:data))
+    end
+
+    def initialize_from_data(data)
+      klass = self.class
+      # init data
+      @data = data
+      # generate the methods
+      data.each_key do |k|
+        # it could be a custom field diccionary
+        m, is_custom_field = klass.fields_dicc&.dig(k) &&
+                             [klass.fields_dicc&.dig(k), true] ||
+                             [k, false]
+
+        if m == :method
+          # Object#method is a built-in Ruby method that accepts a symbol
+          # and returns the corresponding Method object. Because the API may
+          # also use `method` as a field name, we check the arity of *args
+          # to decide whether to act as a getter or call the parent method.
+          klass.define_method(m) do |*args|
+            args.empty? ? fetch_value(m, is_custom_field) : super(*args)
+          end
+        else
+          klass.define_method(m) { fetch_value(m, is_custom_field) }
+        end
+
+        klass.define_method(:"#{m}=") do |value|
+          @data[m] = @unsaved_data[m] = value
+        end
+
+        next unless [FalseClass, TrueClass].include?(
+          fetch_value(m, is_custom_field).class
+        )
+
+        klass.define_method(:"#{m}?") do
+          fetch_value(m, is_custom_field)
+        end
+      end
+      self
+    end
+
+    protected def fetch_value(key, is_custom_field)
+      @data[is_custom_field ? self.class.inverted_fields_dicc.dig(key) : key]
+    end
+  end
+end

data/lib/pipedrive/resources/activity.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Activity < Resource
+    include Fields
+    self.resources_url = "activities"
+  end
+end

data/lib/pipedrive/resources/activity_type.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class ActivityType < Resource
+    self.resources_url = "activityTypes"
+  end
+end

data/lib/pipedrive/resources/call_log.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class CallLog < Resource
+    self.resources_url = "callLogs"
+  end
+end

data/lib/pipedrive/resources/currency.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Currency < Resource
+    self.resources_url = "currencies"
+  end
+end

data/lib/pipedrive/resources/deal.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Deal < Resource
+    include Fields
+    include Merge
+
+    has_many :products, class_name: "Product"
+
+    # POST /deals/:id/products
+    # Add a product to this deal
+    def add_product(product, params)
+      raise "Param *product* is not an instance of Pipedrive::Product" \
+        unless product.is_a?(Pipedrive::Product)
+      raise "Param :item_price is required" unless params.key?(:item_price)
+      raise "Param :quantity is required" unless params.key?(:quantity)
+
+      response = request(
+        :post,
+        "#{resource_url}/products",
+        params.merge(id: id, product_id: product.id)
+      )
+      Product.new(response.dig(:data))
+    end
+  end
+end

data/lib/pipedrive/resources/file.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class File < Resource; end
+end

data/lib/pipedrive/resources/filter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Filter < Resource; end
+end

data/lib/pipedrive/resources/global_message.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class GlobalMessage < Resource
+    self.resources_url = "globalMessages"
+  end
+end

data/lib/pipedrive/resources/goal.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Goal < Resource; end
+end

data/lib/pipedrive/resources/lead.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Lead < Resource; end
+end

data/lib/pipedrive/resources/lead_label.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class LeadLabel < Resource
+    self.resources_url = "leadLabels"
+  end
+end

data/lib/pipedrive/resources/lead_source.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class LeadSource < Resource
+    self.resources_url = "leadSources"
+  end
+end

data/lib/pipedrive/resources/note.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Note < Resource
+    include Fields
+  end
+end

data/lib/pipedrive/resources/organization.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Organization < Resource
+    include Fields
+    include Merge
+
+    has_many :activities, class_name: "Activity"
+    has_many :deals, class_name: "Deal"
+    has_many :persons, class_name: "Person"
+  end
+end

data/lib/pipedrive/resources/person.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Person < Resource
+    include Fields
+    include Merge
+  end
+end

data/lib/pipedrive/resources/pipeline.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Pipeline < Resource; end
+end

data/lib/pipedrive/resources/product.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Product < Resource
+    include Fields
+  end
+end

data/lib/pipedrive/resources/stage.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Stage < Resource; end
+end

data/lib/pipedrive/resources/team.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Team < Resource; end
+end

data/lib/pipedrive/resources/user.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class User < Resource; end
+end

data/lib/pipedrive/resources/webhook.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Webhook < Resource; end
+end

data/lib/pipedrive/resources.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "pipedrive/resources/activity"
+require "pipedrive/resources/activity_type"
+require "pipedrive/resources/call_log"
+require "pipedrive/resources/currency"
+require "pipedrive/resources/deal"
+require "pipedrive/resources/file"
+require "pipedrive/resources/filter"
+require "pipedrive/resources/global_message"
+require "pipedrive/resources/goal"
+require "pipedrive/resources/lead_label"
+require "pipedrive/resources/lead_source"
+require "pipedrive/resources/lead"
+require "pipedrive/resources/organization"
+require "pipedrive/resources/pipeline"
+require "pipedrive/resources/product"
+require "pipedrive/resources/person"
+require "pipedrive/resources/note"
+require "pipedrive/resources/stage"
+require "pipedrive/resources/team"
+require "pipedrive/resources/user"
+require "pipedrive/resources/webhook"

data/lib/pipedrive/util.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module Util
+    def self.serialize_response(response, symbolize_names: true)
+      rjson = JSON.parse(response.body, symbolize_names: symbolize_names)
+      return rjson if response.success?
+
+      raise_error(response.status, rjson)
+    end
+
+    def self.raise_error(status, response)
+      case status
+      when 404
+        raise NotFoundError.new(response.dig(:error), status)
+      else
+        raise UnkownAPIError.new(response.dig(:error), status)
+      end
+    end
+
+    def self.debug(message)
+      Pipedrive.logger&.debug(message) if Pipedrive.debug
+    end
+  end
+end

data/lib/pipedrive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  VERSION = "1.2.4"
+end

data/lib/pipedrive.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "logger"
+require "faraday"
+require "json"
+
+# Version
+require "pipedrive/version"
+
+# API operations
+require "pipedrive/api_operations/request"
+require "pipedrive/api_operations/create"
+require "pipedrive/api_operations/update"
+require "pipedrive/api_operations/delete"
+
+# Support classes
+require "pipedrive/resource"
+require "pipedrive/errors"
+require "pipedrive/util"
+require "pipedrive/fields"
+require "pipedrive/merge"
+
+# Named API Resources
+require "pipedrive/resources"
+
+module Pipedrive
+  BASE_URL = "https://api.pipedrive.com/v1"
+
+  class << self
+    attr_accessor :api_key, :logger, :debug, :debug_http, :debug_http_body
+  end
+
+  @logger = Logger.new(STDOUT)
+end

data/pipedrive-connect.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "pipedrive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pipedrive-connect"
+  spec.version       = Pipedrive::VERSION
+  spec.authors       = "Get on Board"
+  spec.email         = "team@getonbrd.com"
+
+  spec.summary   = "Ruby binding for the pipedrive API."
+  spec.homepage      = "https://github.com/getonbrd/pipedrive-connect"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/getonbrd/pipedrive-connect"
+  spec.metadata["changelog_uri"] = "https://github.com/getonbrd/pipedrive-connect/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # dependencies
+  spec.add_dependency("faraday", "~> 1.3")
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pipedrive-connect
+version: !ruby/object:Gem::Version
+  version: 1.2.4
+platform: ruby
+authors:
+- Get on Board
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description:
+email: team@getonbrd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pipedrive.rb
+- lib/pipedrive/api_operations/create.rb
+- lib/pipedrive/api_operations/delete.rb
+- lib/pipedrive/api_operations/request.rb
+- lib/pipedrive/api_operations/update.rb
+- lib/pipedrive/errors.rb
+- lib/pipedrive/fields.rb
+- lib/pipedrive/merge.rb
+- lib/pipedrive/resource.rb
+- lib/pipedrive/resources.rb
+- lib/pipedrive/resources/activity.rb
+- lib/pipedrive/resources/activity_type.rb
+- lib/pipedrive/resources/call_log.rb
+- lib/pipedrive/resources/currency.rb
+- lib/pipedrive/resources/deal.rb
+- lib/pipedrive/resources/file.rb
+- lib/pipedrive/resources/filter.rb
+- lib/pipedrive/resources/global_message.rb
+- lib/pipedrive/resources/goal.rb
+- lib/pipedrive/resources/lead.rb
+- lib/pipedrive/resources/lead_label.rb
+- lib/pipedrive/resources/lead_source.rb
+- lib/pipedrive/resources/note.rb
+- lib/pipedrive/resources/organization.rb
+- lib/pipedrive/resources/person.rb
+- lib/pipedrive/resources/pipeline.rb
+- lib/pipedrive/resources/product.rb
+- lib/pipedrive/resources/stage.rb
+- lib/pipedrive/resources/team.rb
+- lib/pipedrive/resources/user.rb
+- lib/pipedrive/resources/webhook.rb
+- lib/pipedrive/util.rb
+- lib/pipedrive/version.rb
+- pipedrive-connect.gemspec
+homepage: https://github.com/getonbrd/pipedrive-connect
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/getonbrd/pipedrive-connect
+  source_code_uri: https://github.com/getonbrd/pipedrive-connect
+  changelog_uri: https://github.com/getonbrd/pipedrive-connect/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Ruby binding for the pipedrive API.
+test_files: []