hostedhooks 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 589ce3bf7f35913ded48306ae3d4ec7a9424c9c351b773e189e0cc5fb0fae4ec
-  data.tar.gz: f746e4e7f92460b9b087a2fdaddbaa9baf96f9648736326f17440525c89f6642
+  metadata.gz: f6053d809a77d73f584f112c4064ebd1df468ab161489152f0561b4bcd60bcd5
+  data.tar.gz: 690263c92f20b52f3e39a8e1572b589be019c9faa323d4c5666448acbdc9e0c7
 SHA512:
-  metadata.gz: 38a3988a0930be8cf7a1e17828e393a20086e13e5b90b57663dccd8a350909c6e70570664f9b58cf540c6ec18a7ddeb2f9909a4f8b57a306dd8fd81646f769af
-  data.tar.gz: 9a4270c7d3a75b704e5681e61bc3258d7105a49d037d2b3a4e35e4474bf6492d876b4683f13ff643f89e42cb1f202806a6c261565ebab0fed878a3134f3cfbc7
+  metadata.gz: 4be889cf06a7c80b75605cad00b8b61ff16f84fddcb133fcd019a2c0860757b6cf5b244434d725d1f5a5654efe6e2327e4d3f75490edef11feb846a645ea1f13
+  data.tar.gz: 0251c4bce5cefcb38e47903b081b7bda063a546a64074e575df7291dbde0fdf28cf8d95fd55e23fc97fa81784d94e2cf3aaaba3b5a5bc407c85d28c9c879245c

data/README.md

@@ -1,6 +1,6 @@
 # HostedHooks Ruby Gem
 
-A Ruby library for [HostedHooks](https://www.hostedhooks.com) - a Webhooks as a Service Platform
+A Ruby library for [HostedHooks](https://www.hostedhooks.com),  a Webhooks as a Service Platform
 
 ## Installation
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ### Authentication
 
-Initialize the gem with your API key [found here](https://www.hostedhooks.com/settings/account).
+Initialize the gem with your API key that is [found here](https://www.hostedhooks.com/settings/account)
 
      client = HostedHooks::Client.new('API_KEY')
 
@@ -30,10 +30,8 @@ Initialize the gem with your API key [found here](https://www.hostedhooks.com/se
 
     client.get_endpoint("endpoint_uuid")
 
-
 ### Get a collection of records
 
-
     client.list_subscriptions("app_uuid")
 
 ### Create a record
@@ -46,19 +44,21 @@ Initialize the gem with your API key [found here](https://www.hostedhooks.com/se
 
 
 ## Resources
-
-* Apps
-* Subscriptions
-* Endpoints
-* Webhook Events
-* Messages
+* [Apps](https://developer.hostedhooks.com/#apps)
+* [Subscriptions](https://developer.hostedhooks.com/#subscriptions)
+* [Endpoints](https://developer.hostedhooks.com/#endpoints)
+* [Webhook Events](https://developer.hostedhooks.com/#webhook-events)
+* [Messages](https://developer.hostedhooks.com/#messages)
+* [Webhook Attempts](https://developer.hostedhooks.com/#webhook-attempts)
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hostedhooks-ruby. 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/HostedHooks/hostedhooks-ruby/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/HostedHooks/hostedhooks-ruby. 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/HostedHooks/hostedhooks-ruby/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
 Everyone interacting in the Hostedhooks::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HostedHooks/hostedhooks-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+The gem is available as open source under the terms of the MIT License.

data/lib/hostedhooks/client.rb

@@ -8,8 +8,8 @@ module HostedHooks
 
     # Apps
 
-    def list_apps
-      get_response("/apps")
+    def list_apps(params = {})
+      get_response("/apps", params.slice(:page, :per_page, :offset))
     end
 
     def create_app(payload = {})
@@ -22,12 +22,12 @@ module HostedHooks
 
     # Subscriptions
 
-    def get_subscription(uuid)
-      get_response "/subscriptions/#{uuid}"
+    def get_subscription(uuid, params = {})
+      get_response("/subscriptions/#{uuid}", params.slice(:page, :per_page, :offset))
     end
 
-    def list_subscriptions(app_uuid)
-      get_response("/apps/#{app_uuid}/subscriptions")
+    def list_subscriptions(app_uuid, params = {})
+      get_response("/apps/#{app_uuid}/subscriptions", params.slice(:page, :per_page, :offset))
     end
 
     def create_subscription(app_uuid, payload = {})
@@ -36,50 +36,63 @@ module HostedHooks
 
     # Endpoints
 
-    def get_endpoint(app_uuid, endpoint_uuid)
-      get_response "/apps/#{app_uuid}/endpoints/#{endpoint_uuid}"
+    def get_endpoint(app_uuid, endpoint_uuid, params = {})
+      get_response("/apps/#{app_uuid}/endpoints/#{endpoint_uuid}", params.slice(:page, :per_page, :offset))
     end
 
-    def list_endpoints(app_uuid)
-      get_response("/apps/#{app_uuid}/endpoints")
+    def list_endpoints(app_uuid, params = {})
+      get_response("/apps/#{app_uuid}/endpoints", params.slice(:page, :per_page, :offset))
     end
 
-    def create_subscription(subscription_uuid, payload = {})
+    def create_endpoint(subscription_uuid, payload = {})
       post_response "/subscriptions/#{subscription_uuid}/endpoints", payload.slice(:url, :enabled_events, :version, :status, :description)
     end
 
-    def update_app(subscription_uuid, endpoint_uuid, payload = {})
+    def update_endpoint(subscription_uuid, endpoint_uuid, payload = {})
       patch_response "/subscriptions/#{subscription_uuid}/endpoints/#{endpoint_uuid}", payload.slice(:url, :enabled_events, :version, :status, :description)
     end
 
     # Webhook Events
 
-    def list_webhook_events(app_uuid)
-      get_response("/apps/#{app_uuid}/webhook_events")
+    def list_webhook_events(app_uuid, params = {})
+      get_response("/apps/#{app_uuid}/webhook_events", params.slice(:page, :per_page, :offset))
     end
 
     # Messages
 
     def create_app_message(app_uuid, payload = {})
-      post_response "/apps/#{app_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+      post_response "/apps/#{app_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id, :override_payload)
     end
 
     def create_subscription_message(subscription_uuid, payload = {})
-      post_response "/subscriptions/#{subscription_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+      post_response "/subscriptions/#{subscription_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id, :override_payload)
     end
 
     def create_endpoint_message(subscription_uuid, endpoint_uuid, payload = {})
-      post_response "/subscriptions/#{subscription_uuid}/endpoints/#{endpoint_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id)
+      post_response "/subscriptions/#{subscription_uuid}/endpoints/#{endpoint_uuid}/messages", payload.slice(:event_type, :data, :version, :event_id, :override_payload)
+    end
+
+    # Webhook Attempts
+
+    def get_webhook_attempt(app_uuid, webhook_attempt_uuid)
+      get_response("/apps/#{app_uuid}/webhook_attempts/#{webhook_attempt_uuid}")
+    end
+
+    def list_webhook_attempts(app_uuid, params = {})
+      get_response("/apps/#{app_uuid}/webhook_attempts", params.slice(:page, :per_page, :offset))
     end
 
     private
 
     HOSTEDHOOKS_API_ENDPOINT = "https://hostedhooks.com/api/v1"
 
-    def get_response(url)
-    	response = HTTParty.get("#{HOSTEDHOOKS_API_ENDPOINT}#{url}", timeout: 3, headers: { 'Authorization' => "Bearer #{@api_key}" })
+    def get_response(url, params=nil)
+      if params
+        pagination_query = "?#{params.to_query}"
+      end
+    	response = HTTParty.get("#{HOSTEDHOOKS_API_ENDPOINT}#{url}#{pagination_query || ''}", timeout: 3, headers: { 'Authorization' => "Bearer #{@api_key}" })
       body = JSON.parse(response.body)
-      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return {"error" => body['error'], "code" => response.code} if response.code >= 400
       return body
     end
 
@@ -93,7 +106,7 @@ module HostedHooks
     		}
     	)
       body = JSON.parse(response.body)
-    	return {"error" => body['message'], "code" => response.code} if response.code >= 400
+    	return {"error" => body['error'], "code" => response.code} if response.code >= 400
     	return body
     end
 
@@ -107,7 +120,7 @@ module HostedHooks
     		}
     	)
       body = JSON.parse(response.body)
-      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return {"error" => body['error'], "code" => response.code} if response.code >= 400
       return body
     end
 

data/lib/hostedhooks/version.rb

@@ -1,3 +1,3 @@
 module HostedHooks
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hostedhooks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ian Grabill
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - ian@hostedhooks.com
 executables: []
@@ -48,7 +48,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/HostedHooks/hostedhooks-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A ruby library for the HostedHooks API
 test_files: []