patch_retention 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fadb1c62a03723e009e23b6e20980f4d1e345497c03f1bdceb327e589ffdac22
-  data.tar.gz: 2667403dfe8ede9f30573e9384d42d2b5c89d51b69b9d851a6a87a9090cce8ed
+  metadata.gz: cf00b3a8f5069ab659bab2ca865777f408e86eaeca6335900d4be57b889b9c92
+  data.tar.gz: 925189b1b36aba6f33ae5f10f609c3471f49ceeb964dc748205ea8c71d1f5cfa
 SHA512:
-  metadata.gz: 8b8b7f12cbcdc4b1ad2e2d9cc371ac6919b6430ee4b829a116ec6e1cba01e71919c5bd06e6fc78eca419c07c1378ef3c102f08871e41200725536bb5cdb32e67
-  data.tar.gz: 8439450f9ee0fcb12daa2045acc6716c6f6e45cb2c4ce6ae7b2bfead467b6e044eb9a538dfb5d8a39c0e46329d432a8de914e40d5d85122f577ab8c41988e849
+  metadata.gz: d17b4a0602ba7463f3baaade37c65cc70774f18af352a89a171f5c0d4f6b7e0a7a2ed338a8711653969c8c5e33f1a35fae09fc470f512b8212082f25bb03ea57
+  data.tar.gz: c3f0012eb7e348acf60cecf0a997e05c812cdf5ad14aed02cfe2837f53bd7e4107c91e417d226403f79e7dc95dc01bca26bc562c990d7583e244d309e543d6ed

data/CHANGELOG.md

@@ -4,6 +4,9 @@
 
 - Support proxying to a different host
 - Submit responses with JSON format and headers to preserve data types
+- Add `reset_configuration` method to reset the configuration
+- Fix `delete` method to return true when the response is 204
+- Allow users to pass a config object for any request, and use the config object for the connection
 
 ## [0.1.0] - 2023-12-03
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_retention (0.1.0)
+    patch_retention (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,11 +4,15 @@
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add patch_retention
+```bash
+$ bundle add patch_retention
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install patch_retention
+```bash
+$ gem install patch_retention
+```
 
 ## Usage
 
@@ -20,6 +24,7 @@ For local environment, you can set the following environment variables:
 PATCH_RETENTION_API_URL='your_custom_api_url' # Optional, by default is set to: https://api.patchretention.com/v2
 PATCH_RETENTION_CLIENT_ID='your_client_id'
 PATCH_RETENTION_CLIENT_SECRET='your_client_secret'
+PATCH_RETENTION_PROXY_URL='your_proxy_url' # Optional, for routing requests through a proxy
 ```
 
 Credentials might also be set in the initializer:
@@ -29,6 +34,7 @@ PatchRetention.configure do |config|
     config.api_url = 'your_custom_api_url' # Optional, by default is set to: https://api.patchretention.com/v2
     config.client_id = 'your_client_id'
     config.client_secret = 'your_client_secret'
+    config.proxy_url = 'your_proxy_url' # Optional, for routing requests through a proxy
 end
 ```
 
@@ -36,10 +42,12 @@ end
 
 First, you need to configure the gem with your API credentials.
 
-Then, you can use the gem's methods to interact with the API. For example, to retrieve all contacts:
+Then, you can use the gem's methods to interact with the API.
 
 **Contacts:**
 
+To retrieve all contacts:
+
 ```ruby
 contacts = PatchRetention::Contacts.all
 ```
@@ -54,24 +62,43 @@ To create a contact:
 
 ```ruby
 contact = PatchRetention::Contacts.find_or_create_by(
-            contact_params: {
-              first_name: 'John',
-              last_name: 'Doe',
-              email: 'john.doe@playbypoint.com',
-              phone: '1234567890',
-              address: '123 Main St',
-              city: 'New York',
-              state: 'NY',
-              zip: '10001',
-              country: 'US',
-              company: 'PlayByPoint',
-              job_title: 'Developer'
-            },
-            query_params: {
-              email: 'john.doe@playbypoint.com',
-              phone: '1234567890'
-            }
-          )
+  contact_params: {
+    first_name: 'John',
+    last_name: 'Doe',
+    email: 'john.doe@playbypoint.com',
+    phone: '1234567890',
+    address: '123 Main St',
+    city: 'New York',
+    state: 'NY',
+    zip: '10001',
+    country: 'US',
+    company: 'PlayByPoint',
+    job_title: 'Developer'
+  },
+  query_params: {
+    email: 'john.doe@playbypoint.com',
+    phone: '1234567890'
+  }
+)
+```
+
+To update a contact:
+
+```ruby
+contact = PatchRetention::Contacts.update(1, {
+  first_name: 'John',
+  last_name: 'Doe',
+  email: 'john.doe@example.com',
+  phone: '1234567890',
+  sms_on: true,
+  email_on: true
+})
+```
+
+To delete a contact:
+
+```ruby
+PatchRetention::Contacts.delete(1)
 ```
 
 **Events**
@@ -92,34 +119,33 @@ To create an event:
 
 ```ruby
 event = PatchRetention::Events.create(
-            event_type: 'order.finished',
-            primary_key_details: {
-                key: 'email',
-                value: 'john.doe@pbp.com'
-            },
-            data: {
-                "external_id": "1234567890",
-                "subtotal_amount": 3000,
-                "total_tax": 300,
-                "total_amount": 3300,
-                "total_discounts": 0,
-                "facility_id": 1,
-            },
-            contact_details: {
-                upsert: true,
-                params: {
-                    # Optional, if upsert is true
-                    first_name: 'John',
-                    last_name: 'Doe',
-                    email: 'john.doe@pbp.com',
-                    phone: '1234567890',
-                    address: '123 Main St',
-                    city: 'New York'
-                }
-
-            },
-            at: Time.now,
-          )
+  event_type: 'order.finished',
+  primary_key_details: {
+    key: 'email',
+    value: 'john.doe@pbp.com'
+  },
+  data: {
+    "external_id": "1234567890",
+    "subtotal_amount": 3000,
+    "total_tax": 300,
+    "total_amount": 3300,
+    "total_discounts": 0,
+    "facility_id": 1,
+  },
+  contact_details: {
+    upsert: true,
+    params: {
+      # Optional, if upsert is true
+      first_name: 'John',
+      last_name: 'Doe',
+      email: 'john.doe@pbp.com',
+      phone: '1234567890',
+      address: '123 Main St',
+      city: 'New York'
+    }
+  },
+  at: Time.now,
+)
 ```
 
 ## Development

data/lib/patch_retention/contacts/delete.rb

@@ -4,9 +4,9 @@ module PatchRetention::Contacts::Delete
   include PatchRetention::Util
   extend self
 
-  def call(id)
+  def call(id, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.delete("#{PatchRetention::Contacts::API_PATH}/#{id}")
+      PatchRetention.connection(config).delete("#{PatchRetention::Contacts::API_PATH}/#{id}")
     end
   end
 end

data/lib/patch_retention/contacts/find.rb

@@ -19,9 +19,9 @@ module PatchRetention::Contacts::Find
   # @param id [Integer] The ID of the contact to find.
   # @return [Object] The response from the PatchRetention API.
   # @raise [PatchRetention::Error] If the API returns a status other than 200.
-  def by_id(id)
+  def by_id(id, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.get("#{PatchRetention::Contacts::API_PATH}/#{id}")
+      PatchRetention.connection(config).get("#{PatchRetention::Contacts::API_PATH}/#{id}")
     end
   end
 
@@ -31,9 +31,9 @@ module PatchRetention::Contacts::Find
   # @param offset [Integer] The number of contacts to skip before starting to collect the result set.
   # @return [Object] The response from the PatchRetention API.
   # @raise [PatchRetention::Error] If the API returns a status other than 200.
-  def all(limit, offset)
+  def all(limit, offset, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.get(PatchRetention::Contacts::API_PATH) do |req|
+      PatchRetention.connection(config).get(PatchRetention::Contacts::API_PATH) do |req|
         req.params["limit"] = limit
         req.params["offset"] = offset
       end

data/lib/patch_retention/contacts/find_or_create.rb

@@ -13,11 +13,11 @@ module PatchRetention::Contacts::FindOrCreate
     email_on
   ].freeze
 
-  def call(contact_params:, query_params:)
+  def call(contact_params:, query_params:, config: nil)
     contact_params = contact_params.slice(*ALLOWED_CONTACT_PARAMS)
 
     raise_error_if_present do
-      PatchRetention.connection.patch(PatchRetention::Contacts::API_PATH) do |req|
+      PatchRetention.connection(config).patch(PatchRetention::Contacts::API_PATH) do |req|
         req.params["search"] = build_search_string(query_params)
         req.body = contact_params
       end

data/lib/patch_retention/contacts/update.rb

@@ -4,9 +4,9 @@ module PatchRetention::Contacts::Update
   include PatchRetention::Util
   extend self
 
-  def call(id, contact_params)
+  def call(id, contact_params, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.put("#{PatchRetention::Contacts::API_PATH}/#{id}") do |req|
+      PatchRetention.connection(config).put("#{PatchRetention::Contacts::API_PATH}/#{id}") do |req|
         req.body = contact_params.to_json
       end
     end

data/lib/patch_retention/contacts.rb

@@ -4,27 +4,28 @@ class PatchRetention::Contacts
   API_PATH = "contacts"
 
   class << self
-    def find(id)
-      Find.by_id(id)
+    def find(id, config = nil)
+      Find.by_id(id, config)
     end
 
-    def all(limit: 30, offset: 0)
-      Find.all(limit, offset)
+    def all(limit = 30, offset = 0, config = nil)
+      Find.all(limit, offset, config)
     end
 
-    def find_or_create_by(contact_params:, query_params: {})
+    def find_or_create_by(contact_params:, query_params: {}, config: nil)
       FindOrCreate.call(
         contact_params: contact_params,
-        query_params: query_params
+        query_params: query_params,
+        config: config
       )
     end
 
-    def update(id, attributes = {})
-      Update.call!(id, attributes)
+    def update(id, attributes = {}, config = nil)
+      Update.call!(id, attributes, config)
     end
 
-    def delete(id)
-      Delete.call(id)
+    def delete(id, config = nil)
+      Delete.call(id, config)
     end
   end
 end

data/lib/patch_retention/events/create.rb

@@ -4,7 +4,7 @@ module PatchRetention::Events::Create
   include PatchRetention::Util
   extend self
 
-  def call(event_type:, primary_key_details:, data:, at:, contact_details:)
+  def call(event_type:, primary_key_details:, data:, at:, contact_details:, config: nil)
     contact_upsert = contact_details[:upsert] || false
 
     params = {
@@ -18,14 +18,14 @@ module PatchRetention::Events::Create
     params.merge!(at: format_datetime(at)) unless at.nil?
     params.merge!(contact: contact_details[:params]) if contact_upsert && contact_details.key?(:params)
 
-    send_request(params)
+    send_request(params, config)
   end
 
   private
 
-  def send_request(params)
+  def send_request(params, config)
     raise_error_if_present do
-      PatchRetention.connection.post(PatchRetention::Events::API_PATH) do |req|
+      PatchRetention.connection(config).post(PatchRetention::Events::API_PATH) do |req|
         req.body = params
       end
     end

data/lib/patch_retention/events/find.rb

@@ -4,15 +4,15 @@ module PatchRetention::Events::Find
   include PatchRetention::Util
   extend self
 
-  def by_id(id)
+  def by_id(id, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.get("#{PatchRetention::Events::API_PATH}/#{id}")
+      PatchRetention.connection(config).get("#{PatchRetention::Events::API_PATH}/#{id}")
     end
   end
 
-  def all(limit, offset)
+  def all(limit, offset, config = nil)
     raise_error_if_present do
-      PatchRetention.connection.get(PatchRetention::Events::API_PATH) do |req|
+      PatchRetention.connection(config).get(PatchRetention::Events::API_PATH) do |req|
         req.params["limit"] = limit
         req.params["offset"] = offset
       end

data/lib/patch_retention/events.rb

@@ -4,21 +4,22 @@ class PatchRetention::Events
   API_PATH = "events"
 
   class << self
-    def find(id)
-      Find.by_id(id)
+    def find(id, config: nil)
+      Find.by_id(id, config)
     end
 
-    def all(limit: 30, offset: 0)
-      Find.all(limit, offset)
+    def all(limit: 30, offset: 0, config: nil)
+      Find.all(limit, offset, config)
     end
 
-    def create(event_type:, primary_key_details:, data:, at: nil, contact_details: {})
+    def create(event_type:, primary_key_details:, data:, at: nil, contact_details: {}, config: nil)
       Create.call(
         event_type: event_type,
         primary_key_details: primary_key_details,
         data: data,
         at: at,
-        contact_details: contact_details
+        contact_details: contact_details,
+        config: config
       )
     end
   end

data/lib/patch_retention/util.rb

@@ -11,7 +11,11 @@ module PatchRetention # rubocop:disable Style/ClassAndModuleChildren
       response = yield
       raise PatchRetention::Error, parse_error_message(response) unless response.status.between?(200, 206)
 
-      JSON.parse(response.body)
+      begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        true
+      end
     end
 
     # Parses the error message from the response.

data/lib/patch_retention/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PatchRetention
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/patch_retention.rb

@@ -21,13 +21,19 @@ module PatchRetention
       yield(configuration)
     end
 
-    def connection
+    def reset_configuration
+      @configuration = nil
+    end
+
+    def connection(config = nil)
+      config = config || configuration
+
       Faraday.new(
-        url: configuration.api_url,
-        proxy: configuration.proxy_url,
+        url: config.api_url,
+        proxy: config.proxy_url,
         headers: {
-          "Authorization" => "Bearer #{configuration.client_secret}",
-          "X-Account-Id" => configuration.client_id
+          "Authorization" => "Bearer #{config.client_secret}",
+          "X-Account-Id" => config.client_id
         }
       ) do |builder|
         builder.request :json

data/patch_retention.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/patch_retention/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "patch_retention"
+  spec.version = PatchRetention::VERSION
+  spec.authors = ["Playbypoint", "Gerardo Ortega"]
+  spec.email = ["webmaster@playbypoint.com", "g3ortega@gmail.com"]
+
+  spec.summary = "Patch Retention API wrapper."
+  spec.description = "Patch Retention API wrapper."
+  spec.homepage = "https://playbypoint.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://playbypoint.com"
+  spec.metadata["changelog_uri"] = "https://playbypoint.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patch_retention
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Playbypoint
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies: []
 description: Patch Retention API wrapper.
 email:
@@ -41,6 +41,7 @@ files:
 - lib/patch_retention/events/find.rb
 - lib/patch_retention/util.rb
 - lib/patch_retention/version.rb
+- patch_retention.gemspec
 - sig/patch_retention.rbs
 homepage: https://playbypoint.com
 licenses: