use_paragon 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4977ae9bf55dabf8686da9a46c7cf7bcf9fd7f162721a08b49899a9df3b08807
-  data.tar.gz: 790d1f453420f72bc196bbe29d4323cc04d559a0175fff436520deadf3580435
+  metadata.gz: 4eea99462114a73de8cdbaab838804f101429b1501c47e6f5f539f58ef0c6e4d
+  data.tar.gz: 6985b1ed30f785a7636e90df9cfa97cdb2a100742052b3f302b6ff4b3141bc7e
 SHA512:
-  metadata.gz: 560649657f7ecb06819b324347183695301d733f420e257fd5beb197f10f99d997be3184b61c9122a9a0c0bb935e88d0a0d700e51c6a05a10e7b481d06af182f
-  data.tar.gz: 57ea9e04630f118197f49c5f9a8ec3c362f6867d994da518d117db7833cb7b7c27e887b5440d3c077746b9cc6aaf9b3278d69bc207d962fadd3fb5af686ef22c
+  metadata.gz: 19441c40b4bed8fbd22d8dc001f623ff42009720dca8105066e434ebe14ee5ed23424616d440cc3ce65a1ff9fe062362297c79d5cdbce43b289b9964a0724ac8
+  data.tar.gz: 1a6ac16ae3785ea272efbeebd4b29448a2d7df4fcc5b8a2dcf4a57d316cd4fe5329293e9571e93dded724188a1d08416b2597e426a3a26d25be65545aa30bd86

data/README.md

@@ -48,43 +48,59 @@ UseParagon.configure do |config|
   config.private_key = YOUR_PRIVATE_KEY
   config.project_id = YOUR_PROJECT_ID
   # Additional configurations available and defaults.
-  # config.base_url = "https://zeus.useparagon.com"
+  # config.base_url = "https://zeus.useparagon.com"  # Change this for on-prem installations
   # config.logger = Logger.new(STDOUT)
   # config.logger_enabled = true
 end
 ```
 
+### On-Premise Installations
+
+For on-premise Paragon installations, you can configure a custom base URL:
+
+```ruby
+UseParagon.configure do |config|
+  config.private_key = YOUR_PRIVATE_KEY
+  config.project_id = YOUR_PROJECT_ID
+  config.base_url = "https://paragon.yourcompany.com"  # Your on-prem Paragon instance
+end
+```
+
 ## How to use
 ### Disable Workflow
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#disableworkflow-workflowid-string-greater-than-promise]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#disableworkflow-workflowid-string-greater-than-promise)
 
 Call disable Workflow to turn off a workflow for a user by ID.
 
     UseParagon::Workflow.new(user_id).disable("workflow_id")
 
 ### Get Integrations Metadata
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#getintegrationmetadata]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#getintegrationmetadata)
 
 Get the name, brandColor, and icon, for any of your active integration providers.
 
     UseParagon::Integration.new(user_id).metadata
 
 ### Get User
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#getuser-paragonuser]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#getuser-paragonuser)
 
 Retrieve the currently authenticated user and their connected integration state.
 
     UseParagon::User.new(user_id).get
 
 ### Workflow Event (App Events)
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#event-name-string-json-json]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#event-name-string-json-json)
 
 App Events can be sent from your application using the Paragon REST API.
 
     UseParagon::Workflow.new(user_id).event(event_name, payload = {})
 
+You can also pass custom headers:
+
+    UseParagon::Workflow.new(user_id).event(event_name, payload = {}, headers: { "X-Custom-Header" => "value" })
+
 ### Proxy Request 
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#request-integrationtype-string-path-string-requestoptions-requestinit-promise-less-than-unknown-gre]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#request-integrationtype-string-path-string-requestoptions-requestinit-promise-less-than-unknown-gre)
 
 Call proxy_request to send an API request to a third-party integration on behalf of one of your users
 
@@ -94,35 +110,39 @@ post, get, put, patch or delete.
     UseParagon::Integration.new(user_id).proxy_request(request_method, integration_type, integration_path, payload = {})
 
 ### Set User Metadata
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#setusermetadata-meta-object]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#setusermetadata-meta-object)
 
 Associate the authenticated user with metadata from your application. This metadata can be accessed with "Get User"
 
     UseParagon::User.new(user_id).metadata=({email: "example@example.com"})
 
 ### Uninstall Integration
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#workflow]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#workflow)
 
 Disconnect an integration for the authenticated user
 
     UseParagon::Integration.new(user_id).uninstall(integration_id)
 
 ### Workflow Request (Trigger)
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#workflow-1]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#workflow-1)
 
 Trigger a Paragon workflow that sends a custom response back to your app. Note: The workflow must be enabled and use a Request-type trigger.
 
     UseParagon::Workflow.new(user_id).request(workflow_id, payload = {})
 
+You can also pass custom headers:
+
+    UseParagon::Workflow.new(user_id).request(workflow_id, payload = {}, headers: { "X-Custom-Header" => "value" })
+
 ### Get Project's Integrations
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#get-projects-integrations]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#get-projects-integrations)
 
 Returns a list of the integrations enabled for the Paragon project by the ID in the URL. 
 
     UseParagon::Integration.new(user_id).list
 
 ### Get User's Connect Credentials
-(Paragon Documentation)[https://docs.useparagon.com/api/api-reference#get-users-connect-credentials]
+[Paragon Documentation](https://docs.useparagon.com/api/api-reference#get-users-connect-credentials)
 
 Returns a list of the user's Connect credentials (i.e., the accounts connected and authorized by the end user).
 

data/changelog.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-07-15
+
+### Added
+
+- Added an optional `headers` kwarg to `Workflow#request` and `Workflow#event` methods
+
+### Changed
+
+-
+
+### Deprecated
+
+-
+
+### Removed
+
+-
+
+### Fixed
+
+-
+
+### Security
+
+-

data/lib/use_paragon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UseParagon
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/use_paragon/workflow.rb

@@ -5,11 +5,14 @@ require "use_paragon/base"
 module UseParagon
   # API calls for workflows
   class Workflow < Base
-    def request(workflow_id, payload = {})
+    def request(workflow_id, payload, headers: {})
+      # connection.headers = connection.headers.merge(headers)
+      self.headers = headers
       connection.post(path("sdk/triggers/#{workflow_id}"), payload)
     end
 
-    def event(event_name, payload = {})
+    def event(event_name, payload = {}, headers: {})
+      self.headers = headers
       connection.post(path("sdk/events/trigger"), event_payload(event_name, payload))
     end
 
@@ -25,5 +28,9 @@ module UseParagon
         payload: payload
       }
     end
+
+    def headers=(headers)
+      connection.headers = connection.headers.merge(headers)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_paragon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Eduardo Candanedo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2025-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - lib/use_paragon.rb
 - lib/use_paragon/base.rb
 - lib/use_paragon/configuration.rb