pipedrive-connect 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e4b1a077e77ca44298953e658c3b83e37845ed292dcf3c334275c6e15f682e
-  data.tar.gz: b7c5b32c1b7ec0a4335aa0305d863dc2179d0e7c4f667f80f4984712b1bd7903
+  metadata.gz: 2281f9b37f07b817f422ff7d3d8b254901850051e49a14b8f9e8e5d8e6882046
+  data.tar.gz: 52a88a1f8d811197c860821ce67937ebb381aef36b78f9a683f849f84e818e11
 SHA512:
-  metadata.gz: 5ce8e1d269278a87b626eaa2cb9a135ff0276327476668369c01f94156544ed02c8f2f4b366176faa2e87a115a9aadb6e0edbd19f5a67247e347c060384739f3
-  data.tar.gz: 4c3651542de50c276b1f896a8e101e8ec06d6c1da335869fcbceee534859858143663aaf8dc3a91f73ee0d6eacf5abd8c768de4f2b0f799fecb307f58b956f33
+  metadata.gz: 8d754a927d1aff43105a9c74a2ac650a7750ddc1c092c5dfc8c45a58cecc9fa857e55aaabc3a0bed7afbd42afed9b8500514e62fa25d6491f5433531b06a10d2
+  data.tar.gz: e84716ef498f0bd319e036c7e2fdc6df88ac9b9c0d43ab978f41ff0003721747c2a27e0db4192fee8de6c9ee862b220bf28e0d5197dd3c6353dcbb22f4fa7fa2

data/CHANGELOG.md

@@ -4,7 +4,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.2.10] - 2022-10-19
+
+- Implement `empty?` (or `no_content?`) method on all the models when the response is No content (204 HTTP code)
+- Add option to treat 204 HTTP code (No Content) as 404 HTTP code (Not found)
+
 ## [1.2.9] - 2022-10-13
+
 - Add `find_by_deal` method to `Subscription`to allow finding of subscriptions by `deal_id`.
 
 ## [1.2.8] - 2022-10-11

data/README.md

@@ -97,6 +97,29 @@ new_acme.update(name: "Acme the new Inc")
 new_acme.delete
 ```
 
+### 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.
+
+For these cases a method `empty?` within the model responds `true`.
+
+For instance:
+
+```ruby
+# Asuming the subscription is not found but still return with empty body
+subscription = Pipedrive::Subscription.find_by_deal(123)
+subscription.empty? # true
+subscription.no_content? # true - is an alias of empty?
+```
+
+In case you want to override that behavior treating **no content** as **not found**, there is an option for that:
+
+```ruby
+Pipedrive.treat_no_content_as_not_found = true
+# Will raise a instance of Pipedrive::NotFoundError if subscription
+subscription = Pipedrive::Subscription.find_by_deal(123)
+```
+
 ### 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.

data/lib/pipedrive/resource.rb

@@ -116,7 +116,7 @@ module Pipedrive
       # init data
       @data = data
       # generate the methods
-      data.each_key do |k|
+      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] ||
@@ -152,5 +152,10 @@ module Pipedrive
     protected def fetch_value(key, is_custom_field)
       @data[is_custom_field ? self.class.inverted_fields_dicc.dig(key) : key]
     end
+
+    def no_content?
+      @data.nil? || @data.empty?
+    end
+    alias empty? no_content?
   end
 end

data/lib/pipedrive/util.rb

@@ -3,10 +3,19 @@
 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?
+      if response.status == 204
+        return {} unless Pipedrive.treat_no_content_as_not_found
 
-      Pipedrive.raise_error(response.status, rjson)
+        Pipedrive.raise_error(404, error: "HTTP 204 status code received. No content")
+      end
+
+      json_body = JSON.parse(response.body, symbolize_names: symbolize_names)
+
+      if response.success?
+        json_body
+      else
+        Pipedrive.raise_error(response.status, json_body)
+      end
     end
 
     def self.debug(message)

data/lib/pipedrive/version.rb

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

data/lib/pipedrive.rb

@@ -27,7 +27,12 @@ module Pipedrive
   BASE_URL = "https://api.pipedrive.com/v1"
 
   class << self
-    attr_accessor :api_key, :logger, :debug, :debug_http, :debug_http_body
+    attr_accessor :api_key,
+                  :logger,
+                  :debug,
+                  :debug_http,
+                  :debug_http_body,
+                  :treat_no_content_as_not_found
   end
 
   @logger = Logger.new(STDOUT)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday