pipedrive-connect 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eea5a65d7d2e39294f3fa5a4a48fc0435776e3b026d315da8bad5ad6f167bdb
-  data.tar.gz: 9f36431228dfed9f9e05cad2083796d5ab2806c9195821b901df9a81893eef0d
+  metadata.gz: 802a599c26c15ec1dd3dca1ec4601dae2e1687138f4208a979e1da0bb4a3a80b
+  data.tar.gz: a330bd75c0dc1713873e82fad5014c2091b1b50933ebaf7f4021b14d3c8bd846
 SHA512:
-  metadata.gz: 598554f66789fa6be6e2896fba4badb65c2cfa757e2e084ad30496cac5f5dce5845b1900f6976d4c6d94fdfde2c0dcfd89a0e4449a18198daa55126453b6d204
-  data.tar.gz: 18c041a8723dc4d4a8e9f9c636daeec1ef549346d62d149baf1602019c70f30cd3b71d0bf18a23bfbee2d9b170d7551d90a87c9fc2af7e3ed5a155aefc9083d9
+  metadata.gz: 862a75c93af2ab058fac2bc491ed0125bbc9cc8beff21c32a7b53c2874010d3bf5759978f92917cdd786fe83510f4e0bc67bf4b07eee825f065aa02821375be0
+  data.tar.gz: 81656beb8265d16d4f6105b3046ede92cbf3a08555b696f9960e979ed343abf17abb0437055330d3c37080d053e145e4a30173b640aac3f42b3031784878fbe6

data/CHANGELOG.md

@@ -2,8 +2,13 @@
 
 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`

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

@@ -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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday