pipedrive-connect 1.2.14 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdbad8b1fea466decfba502bd303d1dbd80e71bd9902baaaaa5f94ac53466bee
-  data.tar.gz: 4de6d7d9e2f791a993cdfe3bc6d678379b7009b13e684a87389aa6ebbcfa1e37
+  metadata.gz: 802a599c26c15ec1dd3dca1ec4601dae2e1687138f4208a979e1da0bb4a3a80b
+  data.tar.gz: a330bd75c0dc1713873e82fad5014c2091b1b50933ebaf7f4021b14d3c8bd846
 SHA512:
-  metadata.gz: 6bc678ae0f3aacea13f25f0af9426b88d27c13563ad89cdbf8cb934b32687bcc0b3316749ff0c14417e252553dd887b7bf00ad6a1cd26db5273d5a9d3c3460a7
-  data.tar.gz: b89e76e137037be243b0403a5bce4a2809db8cd5054b07177fd4fffba56f6954ee3726f282a32dc4a6b8290ea9df36243d6a32db8530741e222a7670c28c043e
+  metadata.gz: 862a75c93af2ab058fac2bc491ed0125bbc9cc8beff21c32a7b53c2874010d3bf5759978f92917cdd786fe83510f4e0bc67bf4b07eee825f065aa02821375be0
+  data.tar.gz: 81656beb8265d16d4f6105b3046ede92cbf3a08555b696f9960e979ed343abf17abb0437055330d3c37080d053e145e4a30173b640aac3f42b3031784878fbe6

data/CHANGELOG.md

@@ -2,8 +2,20 @@
 
 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.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`
+- Add `Pipedrive::Participant` resource and add the association to `Pipedrive::Deal`
+- BREAKING CHANGE: Removed `delete_attached_product` in favor of `delete_product` passing a hash of params instead of an instance of `Pipedrive::Resource`
+- BREAKING CHANGE: `add_product` changed method signature because of the changes introduced in `has_many`
+
 ## [1.2.14] - 2023-01-31
 
 - The codebase paginates until fetching all the fields so the diccionary of custom fields is complete (checkout `lib/pipedrive/fields` for more info)

data/README.md

@@ -97,6 +97,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 represent 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/lib/pipedrive/resource.rb

@@ -66,12 +66,14 @@ module Pipedrive
         response.dig(:data, :items).map { |d| new(d.dig(:item)) }
       end
 
-      def has_many(resource_name, class_name:)
+      def has_many(resource_name, args = {})
+        class_name = args[: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
+        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
@@ -80,14 +82,30 @@ 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|
+          response = request(
+            :post,
+            "#{resource_url}/#{resource_name}",
+            params.merge(id: id)
+          )
+          Object.const_get(class_name).new(response.dig(:data))
+        end
+
+        define_method("delete_#{singular}") do |resource_id|
+          response = request(:delete, "#{resource_url}/#{resource_name}/#{resource_id}")
+          response[:success]
         end
       end
     end

data/lib/pipedrive/resources/deal.rb

@@ -6,28 +6,6 @@ module Pipedrive
     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
-
-    # DELETE /deals/:id/products/:product_attachment_id
-    # Detach a product from this deal
-    def delete_attached_product(product_attachment_id)
-      response = request(:delete, "#{resource_url}/products/#{product_attachment_id}")
-      response[:success]
-    end
+    has_many :participants, class_name: "Participant"
   end
 end

data/lib/pipedrive/resources/participant.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  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.rb

@@ -14,6 +14,7 @@ require "pipedrive/resources/lead_source"
 require "pipedrive/resources/lead"
 require "pipedrive/resources/organization"
 require "pipedrive/resources/organization_field"
+require "pipedrive/resources/participant"
 require "pipedrive/resources/pipeline"
 require "pipedrive/resources/product"
 require "pipedrive/resources/person"

data/lib/pipedrive/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.2.14
+  version: 1.3.1
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,6 +67,7 @@ files:
 - lib/pipedrive/resources/note.rb
 - lib/pipedrive/resources/organization.rb
 - lib/pipedrive/resources/organization_field.rb
+- lib/pipedrive/resources/participant.rb
 - lib/pipedrive/resources/person.rb
 - lib/pipedrive/resources/pipeline.rb
 - lib/pipedrive/resources/product.rb