pipedrive-connect 1.2.6 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e705f90cd87169ced3f60343e12dc37b327620287f432fafb67801057568fb3c
-  data.tar.gz: e424975763b80cb7d3af1f29ffd2f6625cd53dc5a752383419443e143e9ce81d
+  metadata.gz: 2281f9b37f07b817f422ff7d3d8b254901850051e49a14b8f9e8e5d8e6882046
+  data.tar.gz: 52a88a1f8d811197c860821ce67937ebb381aef36b78f9a683f849f84e818e11
 SHA512:
-  metadata.gz: 1e0bd348c7478ceb95af39b0edfc33b7914a216bfe20d9ce51a799f64ff2642a193be605dbc2fd46d77a040ee3c9c6fb87653d5396453af5b708fa23030bd3dc
-  data.tar.gz: c627679cf39a5fdabc0901ced1664bdb6b551119db5805a477177d62bd176ea70b6bdc18ef1c375f9cbf2a9e92b42998d96e97b9ebcd21d9b457160874c5fe4a
+  metadata.gz: 8d754a927d1aff43105a9c74a2ac650a7750ddc1c092c5dfc8c45a58cecc9fa857e55aaabc3a0bed7afbd42afed9b8500514e62fa25d6491f5433531b06a10d2
+  data.tar.gz: e84716ef498f0bd319e036c7e2fdc6df88ac9b9c0d43ab978f41ff0003721747c2a27e0db4192fee8de6c9ee862b220bf28e0d5197dd3c6353dcbb22f4fa7fa2

data/CHANGELOG.md

@@ -4,6 +4,26 @@ 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
+
+- Add the new resource `Pipedrive::OrganizationField`
+- Add activities (as a `has_many` relationship) to `Pipedrive::Person`
+- Provide better error information also maping the status code to a class according to https://pipedrive.readme.io/docs/core-api-concepts-http-status-codes (check lib/pipedrive/errors.rb)
+
+## [1.2.7] - 2022-09-23
+
+- Add `Subscription` resource with additional `create_recurring`, `update_recurring` and `cancel_recurring` methods.
+- Changed faraday dependency to allow more flexibility
+
 ## [1.2.6] - 2022-07-11
 
 - Add `delete_attached_product` method to `Deal`

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/errors.rb

@@ -2,12 +2,13 @@
 
 module Pipedrive
   class PipedriveError < StandardError
-    attr_reader :code
+    attr_reader :code, :data
 
-    def initialize(message = nil, code = nil)
+    def initialize(message = nil, code = nil, data = nil)
       super(message)
       @message = message
       @code = code
+      @data = data
     end
 
     def message
@@ -15,8 +16,60 @@ module Pipedrive
       "#{code_str}#{@message}"
     end
   end
+
+  # As documented at https://pipedrive.readme.io/docs/core-api-concepts-http-status-codes
   class SettingError < PipedriveError; end
   class AuthenticationError < PipedriveError; end
   class NotFoundError < PipedriveError; end
+  class BadRequestError < PipedriveError; end
+  class UnauthorizedError < PipedriveError; end
+  class PaymentRequiredError < PipedriveError; end
+  class ForbiddenError < PipedriveError; end
+  class MethodNotAllowedError < PipedriveError; end
+  class GoneError < PipedriveError; end
+  class UnsupportedMediaTypeError < PipedriveError; end
+  class UnprocessableEntityError < PipedriveError; end
+  class TooManyRequestsError < PipedriveError; end
+  class InternalServerError < PipedriveError; end
+  class NotImplementedError < PipedriveError; end
+  class ServiceUnavailableError < PipedriveError; end
   class UnkownAPIError < PipedriveError; end
+
+  ERROR_CLASS_MAP = {
+    "400" => BadRequestError,
+    "401" => UnauthorizedError,
+    "402" => PaymentRequiredError,
+    "403" => ForbiddenError,
+    "404" => NotFoundError,
+    "405" => MethodNotAllowedError,
+    "410" => GoneError,
+    "415" => UnsupportedMediaTypeError,
+    "422" => UnprocessableEntityError,
+    "429" => TooManyRequestsError,
+    "500" => InternalServerError,
+    "501" => NotImplementedError,
+    "503" => ServiceUnavailableError,
+  }.freeze
+
+  def raise_error(status, response)
+    return if [200, 201].include?(status)
+
+    message =
+      [response.dig(:error), response.dig(:error_info)]
+      .compact
+      .join(". ")
+
+    error_data =
+      response
+      .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
+
+    raise UnkownAPIError.new(message, status, error_data)
+  end
+
+  module_function :raise_error
 end

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/organization_field.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class OrganizationField < Resource
+    self.resources_url = "organizationFields"
+  end
+end

data/lib/pipedrive/resources/person.rb

@@ -6,5 +6,6 @@ module Pipedrive
     include Merge
     
     has_many :deals, class_name: "Deal"
+    has_many :activities, class_name: "Activity"
   end
 end

data/lib/pipedrive/resources/subscription.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Subscription < Resource
+    # POST /subscriptions/recurring
+    # Adds a recurring subscription
+    def self.create_recurring(params)
+      response = request(
+        :post,
+        "#{resource_url}/recurring",
+        params
+      )
+      Subscription.new(response.dig(:data))
+    end
+    
+    # GET /subscriptions/find/:id
+    # Returns details of a recurring subscription by the deal ID
+    def self.find_by_deal(id)
+      response = request(:get,"#{resource_url}/find/#{id}")
+      new(response.dig(:data))
+    end
+
+    # PUT /subscriptions/recurring/:id
+    # Updates a recurring subscription
+    def update_recurring(params = {})
+      response = request(
+        :put,
+        "#{self.class.resource_url}/recurring/#{id}",
+        params
+      )
+      Subscription.new(response.dig(:data))
+    end
+
+    # PUT /subscriptions/recurring/:id/cancel
+    # Cancels a recurring subscription
+    def cancel_recurring(params = {})
+      response = request(
+        :put,
+        "#{self.class.resource_url}/recurring/#{id}/cancel",
+        params
+      )
+      Subscription.new(response.dig(:data))
+    end
+
+  end
+end

data/lib/pipedrive/resources.rb

@@ -13,6 +13,7 @@ require "pipedrive/resources/lead_label"
 require "pipedrive/resources/lead_source"
 require "pipedrive/resources/lead"
 require "pipedrive/resources/organization"
+require "pipedrive/resources/organization_field"
 require "pipedrive/resources/pipeline"
 require "pipedrive/resources/product"
 require "pipedrive/resources/person"
@@ -20,4 +21,5 @@ require "pipedrive/resources/note"
 require "pipedrive/resources/stage"
 require "pipedrive/resources/team"
 require "pipedrive/resources/user"
+require "pipedrive/resources/subscription"
 require "pipedrive/resources/webhook"

data/lib/pipedrive/util.rb

@@ -3,18 +3,18 @@
 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
 
-      raise_error(response.status, rjson)
-    end
+        Pipedrive.raise_error(404, error: "HTTP 204 status code received. No content")
+      end
+
+      json_body = JSON.parse(response.body, symbolize_names: symbolize_names)
 
-    def self.raise_error(status, response)
-      case status
-      when 404
-        raise NotFoundError.new(response.dig(:error), status)
+      if response.success?
+        json_body
       else
-        raise UnkownAPIError.new(response.dig(:error), status)
+        Pipedrive.raise_error(response.status, json_body)
       end
     end
 

data/lib/pipedrive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pipedrive
-  VERSION = "1.2.6"
+  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)

data/pipedrive-connect.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # dependencies
-  spec.add_dependency("faraday", "~> 1.3")
+  spec.add_dependency("faraday", "< 3")
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pipedrive-connect
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.10
 platform: ruby
 authors:
 - Get on Board
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
 description:
 email: team@getonbrd.com
 executables: []
@@ -66,10 +66,12 @@ files:
 - lib/pipedrive/resources/lead_source.rb
 - lib/pipedrive/resources/note.rb
 - lib/pipedrive/resources/organization.rb
+- lib/pipedrive/resources/organization_field.rb
 - lib/pipedrive/resources/person.rb
 - lib/pipedrive/resources/pipeline.rb
 - lib/pipedrive/resources/product.rb
 - lib/pipedrive/resources/stage.rb
+- lib/pipedrive/resources/subscription.rb
 - lib/pipedrive/resources/team.rb
 - lib/pipedrive/resources/user.rb
 - lib/pipedrive/resources/webhook.rb