pipedrive-connect 1.2.9 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e4b1a077e77ca44298953e658c3b83e37845ed292dcf3c334275c6e15f682e
-  data.tar.gz: b7c5b32c1b7ec0a4335aa0305d863dc2179d0e7c4f667f80f4984712b1bd7903
+  metadata.gz: 9893998dfcae74b8d260672486acecd728c90e0106ac31ecfa0a9346ecff7d16
+  data.tar.gz: 56cd3850aec29c134a9b4ebe909fed4521e082bdf7336da21fcee487bbfba162
 SHA512:
-  metadata.gz: 5ce8e1d269278a87b626eaa2cb9a135ff0276327476668369c01f94156544ed02c8f2f4b366176faa2e87a115a9aadb6e0edbd19f5a67247e347c060384739f3
-  data.tar.gz: 4c3651542de50c276b1f896a8e101e8ec06d6c1da335869fcbceee534859858143663aaf8dc3a91f73ee0d6eacf5abd8c768de4f2b0f799fecb307f58b956f33
+  metadata.gz: 68014fe619c968921a3875415317fe72f4fccc9c2b9cc1860d5ce0d45d551b40d820b4a9e0caba90371066f661c584a5d782cd7cda9efeb1e11d09df6237f488
+  data.tar.gz: 0e890a6305abdd0fe15d7700bef130fe0d4bcb8b0de5f4dcc42b904ae83d89dedf8c1fe11afa38cdb05f40de6708e3854f14726ebbb5d87bfcbb6bfc0e00489c

data/CHANGELOG.md

@@ -4,7 +4,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/).
 
+## [1.2.11] - 2022-11-21
+
+- Added `find` method for user to work for the `find` endpoint of the Pipedrive API
+
+## [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

@@ -64,11 +64,11 @@ For example to search, retrieve, access, create, update or delete an organizatio
 # return an array of Pipedrive::Organization instances
 orgs = Pipedrive::Organization.search("Acme Inc")
 
-# specify it is an exact match and reduce the scope to name and address
+# specify it is an exact match and reduce the scope to the fields name and address (CSV string)
 orgs = Pipedrive::Organization.search(
   "Acme Inc",
-  extact_match: true,
-  fields: [:name, :address]
+  exact_match: true,
+  fields: [:name, :address].join(",")
 )
 
 # Want to paginate across all the organizations sorting them by name?
@@ -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 no content is returned
+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/resources/user.rb

@@ -1,5 +1,22 @@
 # frozen_string_literal: true
 
 module Pipedrive
-  class User < Resource; end
+  class User < Resource
+    # GET /v1/users/find/
+    # Find users by their name or email
+    def self.find(term, search_by_email)
+      params = { term: term }
+      params = params.merge({ search_by_email: 1 }) if search_by_email
+      response = request(
+        :get,
+        "#{resource_url}/find",
+        params
+      )
+      items = response[:data]
+
+      return [] if items.nil?
+
+      items.map { |d| new(d) }
+    end
+  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.11"
 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.11
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday