convoy.rb 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb0d6490ecbfd2a8bbef2429e9057ee9861dd7504d182c58e4bb68b9be929f1
-  data.tar.gz: e1e2a181c570f0d04af0a07ade86e9fef2839c3528ab1132fdb535fa8d209bb4
+  metadata.gz: e8f15617864719123de4834de4b15ae72db7ab5015e9a58a5abd51e4d08dbdac
+  data.tar.gz: 41e3736a899549a250bdfe9067e7b8c9d8cbbd24662c4eba4e6f2bebedabe3d0
 SHA512:
-  metadata.gz: 2e16c445680e2290940c5d23eb712c26b2b1d893f3e254940fecdb77b0dc1413eb5ed9bfd66b0e52476a14924d86f3b08937d1510ce8c663f6e6105901eb5ef4
-  data.tar.gz: 6a0db61a950f75867be10eae911c15812f6b5987957d514f362445b52eb9558f994712283590d01bbf042688a6aa608e9e6f6b87722bf3f754902dbb6e9eef67
+  metadata.gz: 65ec9158b0afd2ca52b44133f70aa9355ba515c520a78eddc95d1e2d576917c2a5e1bf9a40dae5caf6bc5e3f14a9b5798700a2c9928df03a10d9453198b30273
+  data.tar.gz: a60f5bc98eef97a940fad99c84111c164f6948ce01c17929cea9c712ec1403084b293119895e88138f0284c1fc53419e797b5944cabcf55fc8159c312884a417

data/README.md

@@ -20,39 +20,20 @@ Or install it yourself as:
 ## Usage
 
 ### Setup Client
-
+To configure your client, provide your `api_key` and `project_id`, see below:
 ```ruby
 require 'convoy'
 
 Convoy.ssl = true
 Convoy.api_key = "CO.M0aBe..."
-Convoy.path_version = "v1"
-Convoy.base_uri = "https://dashboard.getconvoy.io/api"
-
-```
-
-### Creating an application
-An application represents a user's application trying to receive webhooks. Once you create an application, you'll receive a `uid` as part of the response that you should save and supply in subsequent API calls to perform other requests such as creating an event.
-
-```ruby
-app = Convoy::Application.new(
-  params: {
-    groupID: "c3637195-53cd-4eba-b9df-e7ba9479fbb2"
-  },
-  data: {
-    name: "Integration One"
-  }
-)
-
-app_response = app.save
+Convoy.project_id = "23b1..."
 ```
 
-### Add an Endpoint to Application
-After creating an application, you'll need to add an endpoint to the application you just created. An endpoint represents a target URL to receive events.
+### Create Endpoint
+An endpoint represents a target URL to receive webhook events. You should create one endpoint per user/business or whatever scope works well for you. 
 
 ```ruby
 endpoint = Convoy::Endpoint.new(
-  app_id,
   data: {
     "description": "Endpoint One",
     "http_timeout": "1m",
@@ -69,25 +50,21 @@ After creating an endpoint, we need to susbcribe the endpoint to events.
 ```ruby
 subscription = Convoy::Subscription.new(
   data: {
-    app_id: app_id,
     endpoint_id: endpoint_id,
-    name: 'ruby subscription',
-    filter_config: {
-      event_types: [ "*" ]
-    }
+    name: 'ruby subscription'
   }
 )
 
 subscription_response = subscription.save
 ```
 
-### Publish an Event
-Now let's publish an event.
+### Send Event
+To send an event, you'll need to pass the `uid` from the endpoint we created earlier.
 
 ```ruby
 event = Convoy::Event.new(
   data: {
-    app_id: app_id,
+    endpoint_id: endpoint_id,
     event_type: "wallet.created",
     data: {
       status: "completed",

data/convoy.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Convoy ruby client to push webhook events from any ruby application."
   spec.homepage      = "https://getconvoy.io"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/frain-dev/convoy.rb"

data/lib/convoy/resources/api_key.rb

@@ -10,7 +10,7 @@ module Convoy
       @id = id
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri

data/lib/convoy/resources/delivery_attempt.rb

@@ -8,7 +8,7 @@ module Convoy
       @eventId = eventId
       @config = config
       
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri

data/lib/convoy/resources/endpoint.rb

@@ -10,7 +10,7 @@ module Convoy
       @id = id
       @config = config 
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri
@@ -20,5 +20,10 @@ module Convoy
 
       "#{project_base_uri}/endpoints/#{@id}"
     end
+
+    def pause
+      pause_uri = "#{resource_uri}/pause"
+      send_request(pause_uri, :post, data: @data, params: @params)
+    end
   end
 end

data/lib/convoy/resources/event.rb

@@ -10,7 +10,7 @@ module Convoy
       @id = id
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri
@@ -20,5 +20,10 @@ module Convoy
 
       "#{project_base_uri}/events/#{@id}"
     end
+
+    def fanout
+      fanout_uri = "#{resource_uri}/fanout"
+      send_request(fanout_uri, :post, data: @data, params: @params)
+    end
   end
 end

data/lib/convoy/resources/event_delivery.rb

@@ -8,7 +8,7 @@ module Convoy
       @eventId = eventId
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri
@@ -19,7 +19,15 @@ module Convoy
       "#{project_base_uri}/events/#{@eventId}/eventdelivery/#{@id}"
     end
 
-    # TODO: resend event delivery.
+    
+    def retry
+      retry_uri = "#{resource_uri}/resend"
+      send_request(retry_uri, :put, data: @data, params: @params)
+    end
 
+    def force_retry
+      force_retry_uri = "#{resource_uri}/forceresend"
+      send_request(force_retry_uri, :post, data: @data, params: @params)
+    end
   end
 end

data/lib/convoy/resources/portal_link.rb

@@ -0,0 +1,24 @@
+module Convoy
+  class PortalLink < ApiResource
+    include ApiOperations::Get
+    include ApiOperations::Save
+    include ApiOperations::List
+    include ApiOperations::Delete
+    extend ApiOperations::Create
+
+    def initialize(id = nil, config = Convoy.config, **kwargs)
+      @id = id
+      @config = config
+
+      super(**kwargs)
+    end
+
+    def resource_uri
+      if @id.nil?
+        return "#{project_base_uri}/portal-links"
+      end
+
+      "#{project_base_uri}/portal-links/#{@id}"
+    end
+  end
+end

data/lib/convoy/resources/project.rb

@@ -10,7 +10,7 @@ module Convoy
       @id = id
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri

data/lib/convoy/resources/source.rb

@@ -9,7 +9,7 @@ module Convoy
       @id = id
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri 

data/lib/convoy/resources/subscription.rb

@@ -9,7 +9,7 @@ module Convoy
       @id = id
       @config = config
 
-      super(kwargs)
+      super(**kwargs)
     end
 
     def resource_uri

data/lib/convoy/version.rb

@@ -1,3 +1,3 @@
 module Convoy
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/convoy/webhook.rb

@@ -34,8 +34,7 @@ module Convoy
       is_advanced = (sig_header.split(",")).length > 1
       
       if is_advanced
-        verify_advanced_signature(payload, sig_header)
-        return
+        return verify_advanced_signature(payload, sig_header)
       end
 
       verify_simple_signature(payload, sig_header)
@@ -47,15 +46,18 @@ module Convoy
       return Util.secure_compare(compute_signature(payload), sig_header)
     end
 
-    def verify_advanced_signature
+    def verify_advanced_signature(payload, sig_header)
       timestamp_header, signatures = get_timestamp_and_signatures(sig_header)
+      payload = "#{Integer(timestamp_header)},#{payload}"
 
       verify_timestamp(timestamp_header)
 
-      unless signatures.any? { |s| Util.secure_compare(expected_sig, s) }
+      unless signatures.any? { |s| Util.secure_compare(compute_signature(payload), s) }
         raise SignatureVerificationError.new,
         "No signatures found matching the expected signature for payload"
       end
+
+      return true
     end
 
     def verify_timestamp(timestamp_header)
@@ -74,18 +76,20 @@ module Convoy
     # return encoded string
     def compute_signature(payload)
       case @encoding
-      when "hex":
-        return OpenSSL::HMAC.hexdigest(@hash, @secret, payload)
-      when "base64":
+      when "hex"
+        val = OpenSSL::HMAC.hexdigest(@hash, @secret, payload)
+        return val
+      when "base64"
         hmac = OpenSSL::HMAC.digest(@hash, @secret, payload)
-        return Base64.encode64(hmac)
+        return Base64.strict_encode64(hmac)
       end
     end
 
     def get_timestamp_and_signatures(sig_header)
       list_items = sig_header.split(/,\s*/).map { |i| i.split("=", 2) }
       timestamp = Integer(list_items.select { |i| i[0] == "t" }[0][1])
-      [Time.at(timestamp), list_items[1]]
+      signatures = list_items[1..].map { |i| i[1] }
+      [Time.at(timestamp), signatures]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convoy.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Subomi Oluwalana
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2024-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -58,6 +58,7 @@ files:
 - lib/convoy/resources/endpoint.rb
 - lib/convoy/resources/event.rb
 - lib/convoy/resources/event_delivery.rb
+- lib/convoy/resources/portal_link.rb
 - lib/convoy/resources/project.rb
 - lib/convoy/resources/source.rb
 - lib/convoy/resources/subscription.rb
@@ -71,7 +72,7 @@ metadata:
   homepage_uri: https://getconvoy.io
   source_code_uri: https://github.com/frain-dev/convoy.rb
   changelog_uri: https://github.com/frain-dev/convoy.rb/blob/main/CHANGELOG
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,15 +80,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Convoy Ruby Client.
 test_files: []