convoy.rb 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f33937f312b1c892facfce7d871bb972fd0f18ccd4fd0480697e91cd7a8b1662
-  data.tar.gz: 8f8335fc9c3257ad80d68c07fda93fe3066792a0acdb55b1e9c3c9c89da73521
+  metadata.gz: 0bb0d6490ecbfd2a8bbef2429e9057ee9861dd7504d182c58e4bb68b9be929f1
+  data.tar.gz: e1e2a181c570f0d04af0a07ade86e9fef2839c3528ab1132fdb535fa8d209bb4
 SHA512:
-  metadata.gz: 6efa47b6410966a4ee0fd8d254210a5e1e201634544725585739e7b2f80b562b82d5c8ee621bb4890095da43f755f15e410aa2ef77e6e0495e4089c5848e321a
-  data.tar.gz: 680f6f45ab3fc28ea5ef4236d0b8a26676566ba927d4a9f352c0921af03c4a32735fbce7ce9fc75c37733b4dae65f6c5597c7724ba52afdeee1c3d78ab457d02
+  metadata.gz: 2e16c445680e2290940c5d23eb712c26b2b1d893f3e254940fecdb77b0dc1413eb5ed9bfd66b0e52476a14924d86f3b08937d1510ce8c663f6e6105901eb5ef4
+  data.tar.gz: 6a0db61a950f75867be10eae911c15812f6b5987957d514f362445b52eb9558f994712283590d01bbf042688a6aa608e9e6f6b87722bf3f754902dbb6e9eef67

data/README.md

@@ -1,15 +1,12 @@
 # Convoy
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/convoy`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is the official Convoy Ruby SDK. This SDK contains methods for easily interacting with Convoy's API. Below are examples to get you started. For additional examples, please see our official documentation at (https://convoy.readme.io/reference)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'convoy'
+gem 'convoy.rb'
 ```
 
 And then execute:
@@ -18,11 +15,90 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install convoy
+    $ gem install convoy.rb
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setup Client
+
+```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
+```
+
+### 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.
+
+```ruby
+endpoint = Convoy::Endpoint.new(
+  app_id,
+  data: {
+    "description": "Endpoint One",
+    "http_timeout": "1m",
+    "url": "https://webhook.site/73932854-a20e-4d04-a151-d5952e873abd"
+  }
+)
+
+endpoint_response = endpoint.save
+```
+
+### Subscribe For Events
+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: [ "*" ]
+    }
+  }
+)
+
+subscription_response = subscription.save
+```
+
+### Publish an Event
+Now let's publish an event.
+
+```ruby
+event = Convoy::Event.new(
+  data: {
+    app_id: app_id,
+    event_type: "wallet.created",
+    data: {
+      status: "completed",
+      event_type: "wallet.created",
+      description: "transaction successful"
+    }
+  }
+)
+
+event_response = event.save
+```
 
 ## Development
 
@@ -35,10 +111,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/convoy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/convoy/blob/master/CODE_OF_CONDUCT.md).
 
 
-## License
+## Credits
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+- [Frain](https://github.com/frain-dev)
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Convoy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/convoy/blob/master/CODE_OF_CONDUCT.md).
+The MIT License (MIT). Please see [License File](LICENSE) for more information.

data/lib/convoy/api_operations/delete.rb

@@ -11,7 +11,7 @@ module Convoy
       end
 
       def delete
-        send_request(resource_url, :delete, params: @params)
+        send_request(resource_uri, :delete, params: @params)
       end
 
       def self.included(base)

data/lib/convoy/api_operations/get.rb

@@ -11,7 +11,7 @@ module Convoy
       end
 
       def get
-        send_request(resource_url, :get, params: @params)
+        send_request(resource_uri, :get, params: @params)
         @data = @response['data']
       end
 

data/lib/convoy/api_operations/list.rb

@@ -13,7 +13,7 @@ module Convoy
       end
 
       def list
-        send_request(resource_url, :get, params: @params)
+        send_request(resource_uri, :get, params: @params)
         @data = @response['data']
       end
 

data/lib/convoy/api_operations/request.rb

@@ -34,8 +34,6 @@ module Convoy
 
         if !config.api_key.nil?
           request['Authorization'] = "Bearer #{config.api_key}"
-        else
-          request.basic_auth config.username, config.password
         end
 
         # Build HTTP Client.

data/lib/convoy/api_operations/save.rb

@@ -12,12 +12,12 @@ module Convoy
 
       def update(data = {})
         @data = data unless data.empty?
-        send_request(resource_url, :put, data: @data, params: @params)
+        send_request(resource_uri, :put, data: @data, params: @params)
       end
 
       def save
         method = @id.nil? ? :post : :put
-        send_request(resource_url, method, data: @data, params: @params)
+        send_request(resource_uri, method, data: @data, params: @params)
       end
 
       def self.included(base)

data/lib/convoy/api_resource.rb

@@ -26,5 +26,19 @@ module Convoy
     def_delegators :@data, :size, :map, :each
 
     attr_reader :response
+
+    def initialize(**kwargs)
+      @params = kwargs[:params].nil? ? {} : kwargs[:params]
+      @query = kwargs[:query].nil? ? {} : kwargs[:query]
+      @data = kwargs[:data].nil? ? {} : kwargs[:data]
+    end
+
+    def project_base_uri
+      if @config.project_id.nil?
+        raise ArgumentError, "Project ID not supplied"
+      end
+
+      "#{@config.base_uri}/#{@config.path_version}/projects/#{@config.project_id}"
+    end
   end
 end

data/lib/convoy/convoy_configuration.rb

@@ -3,16 +3,15 @@ module Convoy
 
     attr_accessor :ssl
     attr_accessor :debug
-    attr_accessor :username
-    attr_accessor :password
     attr_accessor :api_key
     attr_accessor :base_uri
     attr_accessor :path_version
     attr_accessor :logger
     attr_accessor :log_level
+    attr_accessor :project_id
 
     def initialize
-      @base_uri = "https://dashboard.getconvoy.io"
+      @base_uri = "https://dashboard.getconvoy.io/api"
       @path_version = "/v1"
       @ssl = true
       @debug = false

data/lib/convoy/resources/api_key.rb

@@ -8,17 +8,17 @@ module Convoy
 
     def initialize(id = nil, config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/security/keys"
+        return "#{project_base_uri}/security/keys"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/security/keys" + "/#{@id}"
+      "#{project_base_uri}/security/keys/#{@id}"
     end
   end
 end

data/lib/convoy/resources/delivery_attempt.rb

@@ -4,20 +4,19 @@ module Convoy
     include ApiOperations::List
 
     def initialize(eventId = nil, id = nil, config = Convoy.config, **kwargs)
-      @eventId = eventId
       @id = id
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
+      @eventId = eventId
       @config = config
+      
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/events/#{@eventId}" + 
-               "/deliveryattempts"
+        return "#{project_base_uri}/events/#{@eventId}/deliveryattempts"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/events/#{@eventId}/deliveryattempts" + 
-      "/#{@id}"
+      "#{project_base_uri}/events/#{@eventId}/deliveryattempts/#{@id}"
     end
   end
 end

data/lib/convoy/resources/endpoint.rb

@@ -6,21 +6,19 @@ module Convoy
     include ApiOperations::List
     extend ApiOperations::Create
 
-    def initialize(app_id = nil, id = nil, config = Convoy.config, **kwargs)
-      @app_id = app_id
+    def initialize(id = nil, config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
-      @config = config
+      @config = config 
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/applications/#{@app_id}/endpoints"
+        return "#{project_base_uri}/endpoints"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/applications/#{@app_id}/endpoints" +
-      "/#{@id}"
+      "#{project_base_uri}/endpoints/#{@id}"
     end
   end
 end

data/lib/convoy/resources/event.rb

@@ -8,17 +8,17 @@ module Convoy
 
     def initialize(id = nil , config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/events"
+        return "#{project_base_uri}/events"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/events/#{@id}"
+      "#{project_base_uri}/events/#{@id}"
     end
   end
 end

data/lib/convoy/resources/event_delivery.rb

@@ -4,20 +4,19 @@ module Convoy
     include ApiOperations::List
 
     def intialize(eventId = nil, id = nil, config = Convoy.config, **kwargs)
-      @eventId = eventId
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @id = id
+      @eventId = eventId
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/events/#{@eventId}" +
-          "/eventdelivery"
+        return "#{project_base_uri}/events/#{@eventId}/eventdelivery"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/events/#{@eventId}/eventdelivery" +
-      "/#{@id}"
+      "#{project_base_uri}/events/#{@eventId}/eventdelivery/#{@id}"
     end
 
     # TODO: resend event delivery.

data/lib/convoy/resources/{group.rb → project.rb}

@@ -1,5 +1,5 @@
 module Convoy
-  class Group < ApiResource
+  class Project < ApiResource
     include ApiOperations::Get
     include ApiOperations::Save
     include ApiOperations::Delete
@@ -8,17 +8,17 @@ module Convoy
 
     def initialize(id = nil, config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/groups"
+        return "#{@config.base_uri}/#{@config.path_version}/projects"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/groups" + "/#{@id}"
+      "#{@config.base_uri}/#{@config.path_version}/projects" + "/#{@id}"
     end
 
   end

data/lib/convoy/resources/source.rb

@@ -7,17 +7,17 @@ module Convoy
 
     def initialize(id = nil, config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url 
+    def resource_uri 
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/sources"
+        return "#{project_base_uri}/sources"
       end
 
-      "#{@config.base_uri}/#{@config.path_version}/sources" + "/#{@id}"
+      "#{project_base_uri}/sources/#{@id}"
     end
   end
 end

data/lib/convoy/resources/subscription.rb

@@ -7,17 +7,17 @@ module Convoy
 
     def initialize(id = nil, config = Convoy.config, **kwargs)
       @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
       @config = config
+
+      super(kwargs)
     end
 
-    def resource_url
+    def resource_uri
       if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/subscriptions"
+        return "#{project_base_uri}/subscriptions"
       end
       
-      "#{@config.base_uri}/#{@config.path_version}/subscriptions" + "/#{@id}"
+      "#{project_base_uri}/subscriptions/#{@id}"
     end
   end
 end

data/lib/convoy/util.rb

@@ -0,0 +1,15 @@
+module Convoy
+  module Util
+    # Constant time string comparison to prevent timing attacks
+    # Code borrowed from ActiveSupport
+    def self.secure_compare(str_a, str_b)
+      return false unless str_a.bytesize == str_b.bytesize
+
+      l = str_a.unpack "C#{str_a.bytesize}"
+
+      res = 0
+      str_b.each_byte { |byte| res |= byte ^ l.shift }
+      res.zero?
+    end
+  end
+end

data/lib/convoy/version.rb

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

data/lib/convoy/webhook.rb

@@ -0,0 +1,91 @@
+module Convoy
+
+  class SignatureVerificationError < StandardError
+  end
+
+  DEFAULT_TOLERANCE = 300
+  DEFAULT_ENCODING = "hex"
+  DEFAULT_HASH = "SHA256"
+
+  # webhook := Webhook.new(secret)
+  #
+  # With Tolerance
+  # webhook := Webhook.new(secret, tolerance: 500)
+  #
+  # with Encoding
+  # webhook = Webhook.new(secret, encoding: "base64")
+  #
+  # With Encoding and Tolerance
+  # webhook = Webhook.new(secret, encoding: "base64", tolerance: 900)
+  #
+  # Verify request
+  # webhook.verify(payload, headers)
+
+  class Webhook
+    def initialize(secret, encoding: DEFAULT_ENCODING, tolerance: DEFAULT_TOLERANCE, hash: DEFAULT_HASH)
+      @secret = secret
+      @encoding = encoding
+      @tolerance = tolerance
+      @hash = hash
+    end
+
+    def verify(payload, sig_header)
+      # 1. Detect Signature Type.
+      is_advanced = (sig_header.split(",")).length > 1
+      
+      if is_advanced
+        verify_advanced_signature(payload, sig_header)
+        return
+      end
+
+      verify_simple_signature(payload, sig_header)
+    end
+
+    private 
+
+    def verify_simple_signature(payload, sig_header)
+      return Util.secure_compare(compute_signature(payload), sig_header)
+    end
+
+    def verify_advanced_signature
+      timestamp_header, signatures = get_timestamp_and_signatures(sig_header)
+
+      verify_timestamp(timestamp_header)
+
+      unless signatures.any? { |s| Util.secure_compare(expected_sig, s) }
+        raise SignatureVerificationError.new,
+        "No signatures found matching the expected signature for payload"
+      end
+    end
+
+    def verify_timestamp(timestamp_header)
+      begin
+        now = Integer(Time.now)
+        timestamp = Integer(timestamp_header)
+      rescue
+        raise SignatureVerificationError, "Could parse timestamp header"
+      end
+
+      if timestamp < (now - @tolerance)
+        raise SignatureVerificationError, "Message timestamp too old"
+      end
+    end
+
+    # return encoded string
+    def compute_signature(payload)
+      case @encoding
+      when "hex":
+        return OpenSSL::HMAC.hexdigest(@hash, @secret, payload)
+      when "base64":
+        hmac = OpenSSL::HMAC.digest(@hash, @secret, payload)
+        return Base64.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]]
+    end
+  end
+end

data/lib/convoy.rb

@@ -23,12 +23,11 @@ module Convoy
     # Some of them have defaults
     def_delegators :@config, :ssl, :ssl=
     def_delegators :@config, :debug, :debug=
-    def_delegators :@config, :username, :username=
-    def_delegators :@config, :password, :password=
     def_delegators :@config, :api_key, :api_key=
     def_delegators :@config, :base_uri, :base_uri=
     def_delegators :@config, :logger, :logger=
     def_delegators :@config, :log_level, :log_level=
     def_delegators :@config, :path_version, :path_version=
+    def_delegators :@config, :project_id, :project_id=
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convoy.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Subomi Oluwalana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -54,15 +54,16 @@ files:
 - lib/convoy/errors.rb
 - lib/convoy/instrumentation.rb
 - lib/convoy/resources/api_key.rb
-- lib/convoy/resources/application.rb
 - lib/convoy/resources/delivery_attempt.rb
 - lib/convoy/resources/endpoint.rb
 - lib/convoy/resources/event.rb
 - lib/convoy/resources/event_delivery.rb
-- lib/convoy/resources/group.rb
+- lib/convoy/resources/project.rb
 - lib/convoy/resources/source.rb
 - lib/convoy/resources/subscription.rb
+- lib/convoy/util.rb
 - lib/convoy/version.rb
+- lib/convoy/webhook.rb
 homepage: https://getconvoy.io
 licenses:
 - MIT

data/lib/convoy/resources/application.rb

@@ -1,23 +0,0 @@
-module Convoy
-  class Application < ApiResource
-    include ApiOperations::Save
-    include ApiOperations::Delete
-    include ApiOperations::List
-    extend ApiOperations::Create
-
-    def initialize(id = nil, config = Convoy.config, **kwargs)
-      @id = id
-      @data = kwargs[:data].nil? ? {} : kwargs[:data]
-      @params = kwargs[:params].nil? ? {} : kwargs[:params]
-      @config = config
-    end
-
-    def resource_url
-      if @id.nil?
-        return "#{@config.base_uri}/#{@config.path_version}/applications"
-      end
-
-      "#{@config.base_uri}/#{@config.path_version}/applications" + "/#{@id}"
-    end
-  end
-end