webhook_manager 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f63d3140b89d251249964362c0ef8f41b79340093bf0e7b969316559bc704296
-  data.tar.gz: 91da772e4b60d21cee5bf6aa57046e9d90b1e9ce00f6ea367e02bfdbee4045b2
+  metadata.gz: 9a409506ecbfcdf2f334beab456bbe6f604386d9307a808eed7df0665269c1de
+  data.tar.gz: 5d8332fea7454ae717751bdade1e71ceb7e5f57a7e10a3af583cb1e8c3742b1d
 SHA512:
-  metadata.gz: 53f0c7a46473594d61cc6ebb97a2c06e57049fabd7ebe90e00eff342f523d1cafcbf431d35e1b86c2d07c668c1359a4e7ea3c86194b00e09ddedf8918f899ffd
-  data.tar.gz: f69ff8766c98195011c8645e8736f3d92723783948074e509c6bfe9e03bb49b1301c5cb4b0f9542b76955e3e13525b134ed12101e441cab37dcef7eb23ea5a85
+  metadata.gz: daf3a1e0cedddde23f8072eb747309cdaab49b1175a58ffb30bdcade8f1e7e30b102f823e0dc82aa17bfbf4a8ffcb3e90117c7e89f1878b124018674a6139b61
+  data.tar.gz: 40c9202e731932e37876f222223033627fc92414aaae957a02d06c322ff080fd56e73d0e421c1e1b6d5f212b0521379d878c5b76eaa450f3d29781efdc16602a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webhook_manager (0.1.3)
+    webhook_manager (0.2.0)
       faraday (~> 0.17.3)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # WebhookManager
 
-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/webhook_manager`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A gem that integrates the https://gethooky.com API for plain Ruby or Ruby on Rails applications.
 
 ## Installation
 
@@ -22,7 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Initialize the class with your Hooky API key:
+
+```ruby
+client = WebhookManager::Webhook.new(HOOKY_API_KEY)
+```
+
+2. Send your webhook
+
+Note: Payload expect a Ruby Hash. It will be automatically converted to JSON
+
+```ruby
+client.trigger!(event_name: "any.event.name", payload: {foo: "bar"})
+```
 
 ## Development
 

data/lib/webhook_manager.rb

@@ -4,6 +4,7 @@ require "faraday"
 require "json"
 
 require_relative "webhook_manager/version"
+require_relative "webhook_manager/globals"
 
 module WebhookManager
   class Error < StandardError; end
@@ -11,9 +12,9 @@ module WebhookManager
   class Webhook
     attr_accessor :conn
 
-    def initialize(url, api_key)
+    def initialize(api_key)
       @conn = Faraday::Connection.new(
-        url: url,
+        url: HOOKY_API,
         headers: {
           "Authorization" => "ApiKey #{api_key}",
           "Content-Type" => "application/json"
@@ -60,7 +61,7 @@ module WebhookManager
       elsif res.status == 401
         raise Error.new("Unauthorized access to the API!")
       else
-        raise Error.new("Something went wrong calling the hooky API!")
+        raise Error.new("Something went wrong calling the hooky API! #{res.body}")
       end
     end
   end

data/lib/webhook_manager/globals.rb

@@ -0,0 +1 @@
+HOOKY_API = "https://app.hooky.me/api/v1".freeze

data/lib/webhook_manager/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webhook_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Luay Bseiso
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,6 +58,7 @@ files:
 - bin/console
 - bin/setup
 - lib/webhook_manager.rb
+- lib/webhook_manager/globals.rb
 - lib/webhook_manager/version.rb
 - webhook_manager.gemspec
 homepage: https://github.com/buttercloud/webhook_manager