webhook_manager 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4e1224298a76102a03f6a14d343b0f37acc585c108b9cb8d2882615e5b5602
-  data.tar.gz: 71daaa526b6d99dec5b1c2d1a4fe74fda605e033ce599bfdd8bebc71783ebd07
+  metadata.gz: ba06ee724e738a0db42ee39e9360d8d86b757de54a62822f0965b99b1de8181f
+  data.tar.gz: 29b1e905350368051adb56a0b19952063261944731feed5056d049c9f3afffdc
 SHA512:
-  metadata.gz: 5d7d1c00928b1de5cb83b42e688d3380ec499bf798aa1be2d15fe597a7888521b3463f62e4e83ab13165bf25f8af131c7990bf74f27449e92c44d12798e361c8
-  data.tar.gz: ad27917c3c258e90bc059a51cf7953ab93c3eb5ee341b614efc281f3292d5998eadddeb49979cde07b108e8f58d90d02a91b8c8715df25f291f6d92eabc561b7
+  metadata.gz: 22db9baa25354dd6ae030204874734c1fde9485c29752ee34cc4a7ebe3032503a3c34115e0703b01e587a23d7cf15568a13c8f7bc5e0a8b067ed52da6bc46025
+  data.tar.gz: 649f45f5337f95e479f4afc4d49d69785aa64de35ca648eb387e3c96360e2669594704f34a9de0de9f8345a2dae27e051b9309db7621bced8ae52e37a8b690eb

data/.gitignore

@@ -10,4 +10,7 @@
 # rspec failure tracking
 .rspec_status
 .DS_Store
-/.vscode
+/.vscode
+Gemfile.lock
+.ruby-version
+.ruby-gemset

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"
@@ -22,13 +23,25 @@ module WebhookManager
     end
 
     def trigger!(event_name:, payload:)
-      res = @conn.post("webhook_events/trigger", { event_name: event_name, event_payload: payload }.to_json)
+      begin
+        res = @conn.post("webhook_events/trigger", {webhook_event: { event_name: event_name, event_payload: payload }}.to_json)
+      rescue Faraday::ConnectionFailed => e
+        raise Error.new("Could not connect to API")
+      rescue Faraday::TimeoutError => e
+        raise Error.new("Time out error")
+      end
 
       handle_reponse(res)
     end
 
     def update_status(event_id:, status:)
-      res = @conn.post("webhook_events/update_status", { event_id: event_id, status: status }.to_json)
+      begin
+        res = @conn.post("webhook_events/update_status", { event_id: event_id, event_status: status }.to_json)
+      rescue Faraday::ConnectionFailed => e
+        raise Error.new("Could not connect to API")
+      rescue Faraday::TimeoutError => e
+        raise Error.new("Time out error")
+      end
 
       handle_reponse(res)
     end
@@ -39,13 +52,16 @@ module WebhookManager
       if res.status == 200
         data = JSON.parse(res.body)
 
-        if data["status"] == "ERROR"
+        case data["status"]
+        when "ERROR"
           raise "Something went wrong: #{data["errors"].join(", ")}"
-        elsif data["status"] == "OK"
+        when "OK"
           true
         end
+      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.gethooky.com/api/v1".freeze

data/lib/webhook_manager/version.rb

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

data/webhook_manager.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |spec|
   spec.description   = "A gem to manage webhook triggers"
   spec.homepage      = "https://github.com/buttercloud/webhook_manager"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
 
@@ -30,8 +29,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "faraday", ">= 1.2.0"
+  spec.add_dependency "faraday", "~> 0.17.3"
   spec.add_development_dependency "pry"
+  
+  spec.required_ruby_version = '>= 2.1'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: webhook_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Luay Bseiso
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -48,16 +48,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - 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
@@ -76,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.ruby-gemset

@@ -1 +0,0 @@
-webhook_manager

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.7.2

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    webhook_manager (0.1.0)
-      faraday (>= 1.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.1)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    faraday (1.2.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    method_source (1.0.0)
-    multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.2)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.7.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  x86_64-darwin-17
-
-DEPENDENCIES
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.7.0)
-  webhook_manager!
-
-BUNDLED WITH
-   2.2.3