pipedrive-connect 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eea5a65d7d2e39294f3fa5a4a48fc0435776e3b026d315da8bad5ad6f167bdb
-  data.tar.gz: 9f36431228dfed9f9e05cad2083796d5ab2806c9195821b901df9a81893eef0d
+  metadata.gz: f18dde5f2e0550c63819b8720d7a0cd8f6e5ce569a395caf1fa6b81d65a4e99d
+  data.tar.gz: 4d7c2ffb0aaa8b0a34abe54edcfd544e93082e228cd0ae667295a965a12c502c
 SHA512:
-  metadata.gz: 598554f66789fa6be6e2896fba4badb65c2cfa757e2e084ad30496cac5f5dce5845b1900f6976d4c6d94fdfde2c0dcfd89a0e4449a18198daa55126453b6d204
-  data.tar.gz: 18c041a8723dc4d4a8e9f9c636daeec1ef549346d62d149baf1602019c70f30cd3b71d0bf18a23bfbee2d9b170d7551d90a87c9fc2af7e3ed5a155aefc9083d9
+  metadata.gz: fbfc929ac2babe044204650a120181ad1a5b88fd7284c9373b9b6b36fa48d8007640ae39aa10a685eda15783528d2da7c77e0022f823394ab0017ebdc2b01b12
+  data.tar.gz: 0ee028a57c6651e12109a858f542f1cf7a633266074508c9351a9c8604afbfceac330df2d29b314690dff7cb28fa9a8f994eee75d543b14ba6b7a3776ba68c76

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /Gemfile.lock
 .rvmrc
+.tool-versions

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   NewCops: enable
 
   DisplayCopNames: true
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Metrics/BlockLength:
   Max: 40

data/CHANGELOG.md

@@ -2,8 +2,17 @@
 
 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/).
 
+## [2.0.0] - 2025-04-11
+- **BREAKING change**: Minimum ruby version updated to 2.7.
+- Added options for using new V2 API endpoints. Resource `Pipedrive::Activity` switched to new V2 endpoint.
+- Documentation updates with information on V1/V2 API endpoint switching.
+## [1.3.1] - 2023-06-01
+
+- **BREAKING change**: Generated `delete_*` method has been refactored to receive the `id` of the record to be dettached or deleted - instead of the resource per se -, for instance: `deal.delete_product(attached_product_id)`. This is because the API behaves different depending on the endpoint, like in case of `#DELETE /deals/{id}/products/{product_attachment_id}` that receives an id corresponding to the attachment id (not a product, but a different record).
+
 ## [1.3.0] - 2023-04-17
 
 - Modify `has_many` to generate methods to `add` and `delete` resources. ie. `add_participant`, `add_product`, `delete_product`

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 
 group :development do
   gem "byebug"
+  gem "faraday-net_http", require: true
   gem "mocha"
   gem "pry"
   gem "rspec"

data/README.md

@@ -53,6 +53,49 @@ require 'pipedrive'
 Pipedrive.api_key = ENV["PIPEDRIVE_API_KEY"]
 ```
 
+### Pipedrive API versions
+
+Pipedrive has started adding new V2 endpoints to their API. You can change which API endpoint is accessed by setting up
+the enpoint access on the configuration settings
+
+```ruby
+# by default set up to use V2 api endpoints (as of version 2.0.0)
+irb(main):001:0> Pipedrive.api_version
+=> :v2
+
+# use only V1 api endpoints
+irb(main):005:0> Pipedrive.use_v1_api!
+=> :v1
+irb(main):006:0> Pipedrive.api_version
+=> :v1
+
+# change back to using V2 api endpoints
+irb(main):009:0> Pipedrive.use_v2_api!
+=> :v2
+irb(main):010:0> Pipedrive.api_version
+=> :v2
+```
+*Please note:* not all resources have V2 api endpoint. For these resources the V2 setting will be ignored and the
+V1 endpoints will always be used.
+
+```ruby
+irb(main):030:0> Pipedrive.use_v2_api!
+=> :v2
+irb(main):031:0> Pipedrive.api_version
+=> :v2
+irb(main):032:0> Pipedrive::Lead.api_version
+=> :v1
+```
+
+### Backwards Compatibility
+
+To maintain backwards compatibility, you can explicitly set the API version to V1 in your application's configuration:
+
+```ruby
+# Set to use V1 API endpoints for all resources
+Pipedrive.use_v1_api!
+```
+
 ### 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/).
@@ -97,6 +140,29 @@ new_acme.update(name: "Acme the new Inc")
 new_acme.delete
 ```
 
+### Has many methods
+
+```ruby
+deal = Pipedrive::Deal.retrieve 1
+person = Pipedrive::Person.retrieve 1
+product = Pipedrive::Product.retrieve 1
+
+# add a participant
+deal.add_participant(person_id: person.id)
+
+# attach a product to a deal returning the attachment data
+product_attachment =
+  deal.add_product(product_id: product.id,
+                   item_price: 99,
+                   quantity: 2,
+                   discount_percentage: 5)
+
+# detach a product from a deal
+# Note: product attachment is not the product per se
+# but the record that represents the attachment
+deal.delete_product(product_attachment.id)
+```
+
 ### 204 No Content responses
 
 Some endpoints of the API return the HTTP status code **204** which is still a success code returning no data (empty body). This could be confusing but probably has a rationale behind.

data/bin/console

@@ -6,6 +6,7 @@ require "bundler/setup"
 require "pipedrive"
 require "pry"
 require "irb"
+require "faraday/net_http"
 
 # 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.

data/lib/pipedrive/api_operations/request.rb

@@ -8,12 +8,22 @@ module Pipedrive
       end
 
       module ClassMethods
+        def supports_v2_api?
+          # default setting, override in resources as required
+          false
+        end
+
+        def api_version
+          supports_v2_api? ? Pipedrive.api_version : :v1
+        end
+
         def request(method, url, params = {})
           check_api_key!
           raise "Not supported method" \
             unless %i[get post put patch 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 }
@@ -23,18 +33,21 @@ module Pipedrive
               req.params.merge!(params)
             end
           end
+
           Util.serialize_response(response)
         end
 
         def api_client
           @api_client = Faraday.new(
-            url: BASE_URL,
+            url: "#{BASE_URL}/#{api_version}",
             headers: { "Content-Type": "application/json" }
           ) do |faraday|
             if Pipedrive.debug_http
               faraday.response :logger, Pipedrive.logger,
-                               bodies: Pipedrive.debug_http_body
+                               bodies:  Pipedrive.debug_http_body
             end
+
+            faraday.adapter Pipedrive.faraday_adapter
           end
         end
 

data/lib/pipedrive/merge.rb

@@ -5,10 +5,13 @@ module Pipedrive
     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))
+      response = request(
+        :put,
+        "#{resource_url}/merge",
+        merge_with_id: with_id
+      )
+
+      self.class.new(response[:data])
     end
   end
 end

data/lib/pipedrive/resource.rb

@@ -73,7 +73,7 @@ module Pipedrive
                 "For example has_many :deals, class_name: 'Deal'"
         end
         class_name_lower_case = class_name.downcase
-        singular = args[:singular] || class_name_lower_case[0..-1]
+        singular = args[:singular] || class_name_lower_case
         # always include all the data of the resource
         options = { "include_#{class_name_lower_case}_data": 1 }
         # add namespace to class_name
@@ -82,14 +82,16 @@ module Pipedrive
           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
-            data[:metadata] = data
-            if data.key?(class_name_as_sym)
-              data = data.merge(data.delete(class_name_as_sym))
+          response
+            .dig(:data)
+            &.map do |data|
+              class_name_as_sym = class_name_lower_case.to_sym
+              data[:metadata] = data
+              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
-            Object.const_get(class_name).new(data)
-          end
         end
 
         define_method("add_#{singular}") do |params|
@@ -101,10 +103,8 @@ module Pipedrive
           Object.const_get(class_name).new(response.dig(:data))
         end
 
-        define_method("delete_#{singular}") do |resource|
-          raise "Param *resource* is not an instance of Pipedrive::Resource" \
-            unless resource.is_a?(Pipedrive::Resource)
-          response = request(:delete, "#{resource_url}/#{resource_name}/#{resource.id}")
+        define_method("delete_#{singular}") do |resource_id|
+          response = request(:delete, "#{resource_url}/#{resource_name}/#{resource_id}")
           response[:success]
         end
       end

data/lib/pipedrive/resources/activity.rb

@@ -4,5 +4,9 @@ module Pipedrive
   class Activity < Resource
     include Fields
     self.resources_url = "activities"
+
+    def self.supports_v2_api?
+      true
+    end
   end
 end

data/lib/pipedrive/resources/deal.rb

@@ -7,5 +7,9 @@ module Pipedrive
 
     has_many :products, class_name: "Product"
     has_many :participants, class_name: "Participant"
+
+    def self.supports_v2_api?
+      false
+    end
   end
 end

data/lib/pipedrive/resources/participant.rb

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

data/lib/pipedrive/resources/person.rb

@@ -4,7 +4,7 @@ module Pipedrive
   class Person < Resource
     include Fields
     include Merge
-    
+
     has_many :deals, class_name: "Deal"
     has_many :activities, class_name: "Activity"
   end

data/lib/pipedrive/resources/product.rb

@@ -3,5 +3,9 @@
 module Pipedrive
   class Product < Resource
     include Fields
+
+    def self.supports_v2_api?
+      false
+    end
   end
 end

data/lib/pipedrive/version.rb

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

data/lib/pipedrive.rb

@@ -24,7 +24,7 @@ require "pipedrive/merge"
 require "pipedrive/resources"
 
 module Pipedrive
-  BASE_URL = "https://api.pipedrive.com/v1"
+  BASE_URL = "https://api.pipedrive.com/api"
 
   class << self
     attr_accessor :api_key,
@@ -33,7 +33,25 @@ module Pipedrive
                   :debug_http,
                   :debug_http_body,
                   :treat_no_content_as_not_found
+
+    attr_writer :faraday_adapter
+
+    def use_v2_api!
+      @api_version = :v2
+    end
+
+    def use_v1_api!
+      @api_version = :v1
+    end
+
+    def api_version
+      @api_version || :v2
+    end
+
+    def faraday_adapter
+      @faraday_adapter || :net_http
+    end
   end
 
-  @logger = Logger.new(STDOUT)
+  @logger = Logger.new($stdout)
 end

data/pipedrive-connect.gemspec

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+$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.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.7.0")
 
-  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["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"
+  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.
@@ -30,4 +29,5 @@ Gem::Specification.new do |spec|
 
   # dependencies
   spec.add_dependency("faraday", "< 3")
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,6 +86,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -94,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="