hooky 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4ac174ee771e0182a89813e6b5f7d7ad7cd7f3e96c66501ea3f4b3896178da8
+  data.tar.gz: 9d14c7457574de4fb30281ba31b4f9facfbc38d3eeaaa6187fb4aab2b85ee3d6
+SHA512:
+  metadata.gz: 55265fd5efbf927e15fc4934b3542d6a9befb9937e94f3d3a3103fd75c4d2c0c4956840484b4519622c196c9531d2b4ca1b1466451308506fa4cc47dd89ced8c
+  data.tar.gz: c5cadff1fe0503a1c270f374da5c56df4e1c1dbdda00358c888f4b0c807cc66582aa065263d344aaa84f1c18b62f722c477c42a033add57c75185499c46deaa7

data/README.md

@@ -0,0 +1,60 @@
+# Hooky
+
+Hooky is a Ruby gem that provides a simple way to test webhooks.
+
+By storing example request data and configuration in a `.hooky` directory in your Rails root directory, you can easily
+test webhooks by running `hooky <webhook_name>`.
+
+You can create as many webhooks as you required but they must be named like so:
+
+- `.hooky/<webhook_name>/data.json`
+- `.hooky/<webhook_name>/config.json`
+
+The `config.json` file contains details such as the URL, HTTP Method and any headers. For example:
+
+```json
+{
+  "url": "https://example.com/webhooks/order.created",
+  "method": "GET",
+  "headers": {
+    "Content-Type": "application/json"
+  }
+}
+```
+
+The `data.json` file will be the request body that is sent. For example:
+
+```json
+{
+  "id": 123,
+  "name": "John Doe"
+}
+```
+
+## Installation
+
+Install the gem by running `gem install hooky`.
+
+## Usage
+
+```bash
+# To add the hooky gem to your Gemfile, create a .hooky directory and create an example webhook, run:
+hooky init
+
+# To test a webhook, run:
+hooky hook <webhook_name>
+```
+
+To add the gem to your Rails app and create an example webhook, run `bundle exec hooky init`. This will create a `.hooky`
+directory and
+
+
+Then to test this webhook, run `rails hooky order.created` and it will send a request to the URL specified in the `data.json` file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/hooky.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/hooky

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Prevent failures from being reported twice.
+Thread.report_on_exception = false
+
+require "bundler/setup"
+require "hooky"
+
+begin
+  Hooky::CLI.start(ARGV)
+rescue => e
+  puts "  \e[31mERROR (#{e.class}): #{e.message}\e[0m"
+  puts e.backtrace if ENV["VERBOSE"]
+  exit 1
+end

data/lib/hooky/cli.rb

@@ -0,0 +1,80 @@
+require "thor"
+
+module Hooky
+
+  class CLI < Thor
+
+    def self.exit_on_failure?() true end
+
+    desc "list", "List all hooks"
+    def list
+      puts Hooky::Hook.all
+    end
+
+    desc "hook [HOOK]", "Run a hook"
+    def hook(hook)
+      h = Hooky::Hook.new(hook)
+
+      puts "Running hook #{hook}..."
+      puts h.send_request
+
+      # puts h.config_file
+      # puts h.data_file
+    end
+
+    desc "init", "Create example hook, add Hooky to Gemfile and create a bin/hooky binstub"
+    def init
+      require "fileutils"
+
+      unless (example_dir = Pathname.new(File.expand_path(".hooky/example"))).exist?
+        example_dir.mkpath
+        Pathname.new(File.expand_path("templates/example_hook", __dir__)).each_child do |sample_hook|
+          FileUtils.cp sample_hook, example_dir, preserve: true
+        end
+        puts "Created example hook in .hooky/example"
+      end
+
+      if (binstub = Pathname.new(File.expand_path("bin/hooky"))).exist?
+        puts "Binstub already exists in bin/hooky (remove first to create a new one)"
+      else
+        puts "Adding hookyrb to Gemfile and bundle..."
+
+        `bundle add hooky --group "development, test"`
+        `bundle binstubs hooky`
+
+        puts "Created binstub file in bin/hooky"
+      end
+    end
+
+    desc "version", "Show Hooky version"
+    def version
+      puts Hooky::VERSION
+    end
+
+  end
+
+end
+
+# SSHKit uses instance eval, so we need a global const for ergonomics
+# KAMAL = Kamal::Commander.new
+
+
+# require "thor"
+
+# module Hookynew
+
+#   class Cli < Thor
+
+#     desc "hello NAME", "say hello to NAME"
+#     def hello(name)
+#       puts "Hello #{name}"
+#     end
+
+#     desc "list", "list all hooks"
+#     def list
+#       puts Hookynew::Hook.all
+#     end
+
+#   end
+
+# end

data/lib/hooky/hook.rb

@@ -0,0 +1,55 @@
+require "httparty"
+
+module Hooky
+  class Hook
+
+    attr_accessor :directory
+
+    def initialize(directory)
+      @directory = directory
+    end
+
+    def self.all
+      Dir.glob(".hooky/*").map{|d| d.gsub(".hooky/", "")}
+    end
+
+    def config_file
+      File.read(".hooky/#{directory}/config.json")
+    end
+
+    def data_file
+      File.read(".hooky/#{directory}/data.json")
+    end
+
+    def config
+      JSON.parse(config_file)
+    end
+
+    def data
+      JSON.parse(data_file)
+    end
+
+    def url
+      config["url"]
+    end
+
+    def headers
+      config["headers"]
+    end
+
+    def httparty
+      if config["method"] =~ /GET/
+        HTTParty.get(url, body: data, headers: headers)
+      elsif config["method"] =~ /POST/
+        HTTParty.post(url, body: data, headers: headers)
+      end
+    end
+
+    def send_request
+      resp = httparty
+
+      resp.response
+    end
+
+  end
+end

data/lib/hooky/templates/example_hook/config.json

@@ -0,0 +1,7 @@
+{
+  "url": "http://localhost:3000/example",
+  "method": "GET",
+  "headers": {
+    "Content-Type": "application/json"
+  }
+}

data/lib/hooky/templates/example_hook/data.json

@@ -0,0 +1,7 @@
+{
+  "payment_id": "chg_abc123",
+  "amount": 100,
+  "currency": "USD",
+  "status": "pending",
+  "created_at": "2019-01-01T00:00:00Z"
+}

data/lib/hooky/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hooky
+  VERSION = "2.0.0"
+end

data/lib/hooky.rb

@@ -1,5 +1,8 @@
-# Git hooks in Rake. See <tt>README.rdoc</tt> for details.
+require "hooky/version"
+
+module Hooky
+
+  autoload :CLI, "hooky/cli"
+  autoload :Hook, "hooky/hook"
 
-class Hooky
-  VERSION = "1.0.0"
 end

metadata

@@ -1,81 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hooky
-version: !ruby/object:Gem::Version 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
-- John Barnette
-autorequire: 
+authors:
+- Dean Perry
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2009-08-20 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.2
-    version: 
-description: |-
-  Hooky lets you write Git repository hooks with Rake. If you already
-  have a Rakefile, write your hooks in Ruby! Hooky provides Tasks for
-  most Git hooks, and lets you easily add behavior.
-  
-  Git hooks are powerful: Check the Git documentation (linked above) for
-  detailed descriptions and lifecycle order.
-email: 
-- jbarnette@rubyforge.org
-executables: []
-
+date: 2023-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description:
+email:
+- dean@deanpcmad.com
+executables:
+- hooky
 extensions: []
-
-extra_rdoc_files: 
-- Manifest.txt
-- CHANGELOG.rdoc
-- README.rdoc
-files: 
-- .autotest
-- CHANGELOG.rdoc
-- Manifest.txt
-- README.rdoc
-- Rakefile
+extra_rdoc_files: []
+files:
+- README.md
+- bin/hooky
 - lib/hooky.rb
-- lib/hooky/tasks.rb
-- test/test_hooky.rb
-has_rdoc: true
-homepage: http://github.com/jbarnette/hooky
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+- lib/hooky/cli.rb
+- lib/hooky/hook.rb
+- lib/hooky/templates/example_hook/config.json
+- lib/hooky/templates/example_hook/data.json
+- lib/hooky/version.rb
+homepage: https://github.com/deanpcmad/hooky
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: hooky
-rubygems_version: 1.3.5
-signing_key: 
-specification_version: 3
-summary: Hooky lets you write Git repository hooks with Rake
-test_files: 
-- test/test_hooky.rb
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Hooky is a tool for testing webhooks
+test_files: []

data/.autotest

@@ -1,5 +0,0 @@
-require "autotest/restart"
-
-Autotest.add_hook :initialize do |at|
-  at.testlib = "minitest/autorun"
-end

data/CHANGELOG.rdoc

@@ -1,3 +0,0 @@
-=== 1.0.0 / 2009-08-20
-
-* Birthday!

data/Manifest.txt

@@ -1,8 +0,0 @@
-.autotest
-CHANGELOG.rdoc
-Manifest.txt
-README.rdoc
-Rakefile
-lib/hooky.rb
-lib/hooky/tasks.rb
-test/test_hooky.rb

data/README.rdoc

@@ -1,98 +0,0 @@
-= Hooky
-
-* http://github.com/jbarnette/hooky
-* http://www.kernel.org/pub/software/scm/git/docs/githooks.html
-
-== Description
-
-Hooky lets you write Git repository hooks with Rake. If you already
-have a Rakefile, write your hooks in Ruby! Hooky provides Tasks for
-most Git hooks, and lets you easily add behavior.
-
-Git hooks are powerful: Check the Git documentation (linked above) for
-detailed descriptions and lifecycle order.
-
-== Examples
-
-    # in your Rakefile
-    require "hooky/tasks"
-
-    task "git:applypatch-msg", [:file] do |_, args|
-      puts "Proposed git-am commit msg: #{IO.read(args[:file])}"
-    end
-
-    task "git:commit-msg", [:file] do |_, args|
-      puts "Proposed commit msg: #{IO.read(args[:file])}"
-    end
-
-    task "git:post-applypatch" do
-      puts "Patch applied by git-am!"
-    end
-
-    task "git:post-checkout", [:old, :new, :branch] do |_, args|
-      puts "you just switched branches!" if args[:branch]
-      puts "old SHA: #{args[:old]}, new SHA: #{args[:new]}"
-    end
-
-    task "git:post-commit"
-      puts "You made a commit!"
-    end
-
-    task "git:post-merge", [:squash] do |_, args|
-      puts "You just did a merge!"
-      puts "It was a squash." if args[:squash]
-    end
-
-    task "git:pre-applypatch" do
-      puts "git-am is about to commit a patch!"
-    end
-
-    task "git:pre-auto-gc" do
-      puts "git gc --auto is about to run!"
-    end
-
-    task "git:pre-commit" do
-      puts "You're about to commit!"
-    end
-
-    task "git:pre-rebase" do
-      puts "You're about to rebase!"
-    end
-
-    task "git:prepare-commit-msg", [:file, :source, :sha] do |_, args|
-      puts "Building a commit message!"
-    end
-
-== Installation
-
-    $ gem install hooky
-
-    # in your project
-    $ rake hooky:install
-
-<tt>hooky:install</tt> symlinks all hooks to
-<tt>.git/hooks/hooky</tt>, a stub that delegates to your Rakefile, but
-it won't overwrite any hooks you've already created.
-
-== License
-
-Copyright 2009 John Barnette (jbarnette@rubyforge.org)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,13 +0,0 @@
-require "rubygems"
-require "hoe"
-
-Hoe.plugin :doofus, :git
-
-Hoe.spec "hooky" do
-  developer "John Barnette", "jbarnette@rubyforge.org"
-
-  self.extra_rdoc_files = FileList["*.rdoc"]
-  self.history_file     = "CHANGELOG.rdoc"
-  self.readme_file      = "README.rdoc"
-  self.testlib          = :minitest
-end

data/lib/hooky/tasks.rb

@@ -1,66 +0,0 @@
-git_hooks = %w(applypatch-msg commit-msg post-applypatch post-checkout
-  post-commit post-merge pre-applypatch pre-auto-gc pre-commit
-  pre-rebase prepare-commit-msg)
-
-git_hook_files = git_hooks.collect { |f| ".git/hooks/#{f}" }
-
-git_hook_files.each do |f|
-  file f do |task|
-    sh "ln -s hooky #{task.name}"
-  end
-end
-
-desc "Install magical Rake Git hooks. Nondestructive."
-task "hooky:install" => [".git/hooks/hooky", *git_hook_files]
-
-file ".git/hooks/hooky" do |task|
-  File.open task.name, "w" do |f|
-    f.puts "#!/bin/sh"
-    f.puts "export HOOK=$0"
-    f.puts "export HOOK_ARGS=$@"
-    f.puts "rake -s hooky"
-  end
-
-  sh "chmod +x #{task.name}"
-end
-
-# These tasks are intentionally not described in Rake's -T output to
-# avoid clutter. The 'hooky' task dispatches to a specific hook
-# task. To add behavior to a Git hook in your own Rakefile, 'redefine'
-# the appropriate task.
-
-task :hooky do
-  ENV["HOOK"] && ENV["HOOK_ARGS"] or raise "Need HOOK and HOOK_ARGS."
-
-  hook = File.basename ENV["HOOK"]
-  args = ENV["HOOK_ARGS"].split /\s+/
-
-  warn({ :hook => hook, :args => args }.inspect) if ENV["DEBUG"]
-  Rake::Task["git:#{hook}"].invoke *args
-end
-
-task "git:applypatch-msg", [:file]
-
-task "git:commit-msg", [:file]
-
-task "git:post-applypatch"
-
-task "git:post-checkout", [:old, :new, :branch] do |_, args|
-  args.to_hash[:branch] = args[:branch] == "1"
-end
-
-task "git:post-commit"
-
-task "git:post-merge", [:squash] do |_, args|
-  args.to_hash[:squash] = args[:squash] == "1"
-end
-
-task "git:pre-applypatch"
-
-task "git:pre-auto-gc"
-
-task "git:pre-commit"
-
-task "git:pre-rebase"
-
-task "git:prepare-commit-msg", [:file, :source, :sha]

data/test/test_hooky.rb

@@ -1,8 +0,0 @@
-require "minitest/autorun"
-require "hooky"
-
-class TestHooky < MiniTest::Unit::TestCase
-  def test_sanity
-    flunk "write tests or I will kneecap you"
-  end
-end