pipedrive-connect 1.3.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 802a599c26c15ec1dd3dca1ec4601dae2e1687138f4208a979e1da0bb4a3a80b
-  data.tar.gz: a330bd75c0dc1713873e82fad5014c2091b1b50933ebaf7f4021b14d3c8bd846
+  metadata.gz: 131444c95f6ebc0388e1bbc98d1a9e3b6093a18e4c66d3e97865a05bc68b3a78
+  data.tar.gz: 3ac8c7f3a256c9c7cc0c0bf2e2bd13d272f1ee89d556b4e549e8593762451f6f
 SHA512:
-  metadata.gz: 862a75c93af2ab058fac2bc491ed0125bbc9cc8beff21c32a7b53c2874010d3bf5759978f92917cdd786fe83510f4e0bc67bf4b07eee825f065aa02821375be0
-  data.tar.gz: 81656beb8265d16d4f6105b3046ede92cbf3a08555b696f9960e979ed343abf17abb0437055330d3c37080d053e145e4a30173b640aac3f42b3031784878fbe6
+  metadata.gz: 7d66f1e1446e979020acd1216ef46a6a90e2910248a52fecaf62371adf79fd5af22c0d95e26f7b576a02c63a395289b684f246b4657278d321f0e01d82981593
+  data.tar.gz: 6a993a356288b5d470d44653cc646942b9485d9e9fb21b955204c7347acb84854cfb840e4971bc4df254160ff8bb30a4a93e854aedbac9fc10838d5ab3b598e9

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  run-rspec-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7, 3.4]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/.gitignore

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

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

@@ -5,9 +5,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 
+## [2.0.1] - 2025-04-17
+
+- Fix bugs instroduced with version 2 where the base url for v1 was broken.
+- Add github actions
+
+## [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).
+- **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
 

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

@@ -1,3 +1,5 @@
+[![Run tests](https://github.com/getonbrd/pipedrive-connect/actions/workflows/ci.yml/badge.svg)](https://github.com/getonbrd/pipedrive-connect/actions/workflows/ci.yml)
+
 # Pipedrive API Ruby library
 
 Pipedrive::Connect provides a convenient access to the Pipedrive API from applications written in the Ruby language.
@@ -53,6 +55,50 @@ 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/).
@@ -116,7 +162,7 @@ product_attachment =
 
 # detach a product from a deal
 # Note: product attachment is not the product per se
-# but the record that represent the attachment
+# but the record that represents the attachment
 deal.delete_product(product_attachment.id)
 ```
 

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,32 @@ 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 api_version_prefix
+          return api_version if api_version == :v1
+
+          "api/#{api_version}"
+        end
+
+        def api_base_url
+          "#{BASE_URL}/#{api_version_prefix}"
+        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 +43,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: api_base_url,
             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/errors.rb

@@ -61,9 +61,9 @@ module Pipedrive
 
     error_data =
       response
-      .fetch(:data, {})
-      .inspect
-      .concat(response.fetch(:additional_data, {}).inspect)
+        .fetch(:data, {})
+        .inspect
+        .concat(response.fetch(:additional_data, {}).inspect)
 
     error_class = ERROR_CLASS_MAP[status.to_s]
     raise error_class.new(message, status, error_data) if error_class

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/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/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.1"
+  VERSION = "2.0.1"
 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"
 
   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,13 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Get on Board
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,12 +23,12 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-description:
 email: team@getonbrd.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -86,7 +85,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
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +93,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby binding for the pipedrive API.
 test_files: []