active_webhook 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc8acd1e3d7b0ab18220c1550c4036bd52317f4bf8e57d6ff86935703f241e45
+  data.tar.gz: aac9a54fced0844aa949f155c6df5fbcc6fe386b9df701e6e1ef9fa1d8b4cf2e
+SHA512:
+  metadata.gz: d7c48dbcb856125ee8d951e1ad9998e02048a96aaa452b63a1042b98503d5ed003bdecf6efbd2e7012aeed7deb09c27e5a11d64bd72fb61683c642f6ea5f25b8
+  data.tar.gz: ec57e66ad519b0e2a65ed97cd4e750146466a0ffa6ba300826d10c3acf0a55ffb4e49712176d6a9e60afe94b88efc375dacec9444e7de55dec6c7a1fbfc135a8

data/.env.sample

@@ -0,0 +1 @@
+SIDEKIQ_SOMETHING=1

data/.gitignore

@@ -0,0 +1,63 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*~
+log/*
+measurement/*
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format progress
+--color
+--require spec_helper
+--order rand

data/.rubocop.yml

@@ -0,0 +1,86 @@
+# I can't get the requires to work with sublime:
+# SEE: https://github.com/pderichs/sublime_rubocop/issues/66
+# -- https://gist.github.com/topher6345/4f921ca3e7938132563e
+# -- https://forum.sublimetext.com/t/run-command-after-saving-file/44016
+# -- https://medium.com/devnetwork/running-rubocop-only-on-modified-files-a21aed86e06d
+# -- https://code.tutsplus.com/tutorials/how-to-create-a-sublime-text-2-plugin--net-22685
+
+# -- https://github.com/SublimeLinter/SublimeLinter-rubocop/issues/19
+#    -- https://github.com/fnando/sublime-codefmt
+#    -- https://github.com/fnando/sublime-switch-case
+#    -- https://github.com/fnando/sublime-rubocop-completion/issues/1
+# required these fixes:
+#    -- install PackageDev https://forum.sublimetext.com/t/pathlib-not-found-in-purchased-version/49978
+#    -- download all 3 packages via git clone rather than package manager
+#    -- renamed several files and directories to match
+#    -- brew update
+#    -- brew doctor
+#    -- brew install prettier yapf
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*.rake"
+    - "config/**/*"
+    - "Rakefile"
+    - "spec/**/*.rb"
+    - "*.gemspec"
+
+Layout/LineLength:
+  Max: 120
+
+Style/BlockComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/StringHashKeys:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/DotPosition:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/NamedSubject:
+  Enabled: false
+# Rails:
+#   Enabled: true
+

data/.todo

@@ -0,0 +1,48 @@
+
+
+-------------------------------------------------------------------------------------
+
+...meanwhile, back at planet scope...
+
+bundle exec rspec spec/gql/v2/objects/organization_type_spec.rb spec/gql/v2/objects/user_type_spec.rb spec/gql/v2/objects/query_type_spec.rb spec/gql/v2/objects/webhook_* spec/gql/v2/mutations/webhook_subscriptions/* spec/libs/acts_as_webhook_spec.rb spec/gql/*/schema_type_spec.rb
+
+
+1. deploy (wait until friday)
+   1. create new repo
+   1. squash
+   1. push
+
+
+-------------------------------------------------------------------------------------
+
+...meanwhile, back at planet active_webbhook...
+
+1. deploy (wait until friday)
+   1. create new repo
+   1. squash
+   1. push
+
+-------------------------------------------------------------------------------------
+# everything below this line is optional
+
+1. add rate limiting
+
+1. update the readme
+   - list all config options with brief descriptions (and link to config file for more information)
+   - list all gem dependencies for each adapter
+   - change customization to separate use cases
+
+1. solve rubygems
+
+1. fix generator
+   - didn't work for scope
+   - rename active_webhook_config.rb to initializers/active_webhook.rb
+   ? add option to install models & factories (see devise) [accept list of models to create & namespace]
+
+
+
+
+
+
+
+

data/.travis.yml

@@ -0,0 +1,14 @@
+# SEE: https://docs.travis-ci.com/user/languages/ruby/
+
+language: ruby
+rvm:
+  - 2.5.3
+before_install:
+  - gem install bundler:1.17.3
+install:
+  - bundle _1.17.3_ install --jobs=3 --retry=3
+  - bundle exec rake db:reset
+env:
+  # - 'TEST_RAILS_VERSION="~> 5.2.3"'
+  # - 'TEST_RAILS_VERSION="~> 6.0.3"'
+  - 'TEST_RAILS_VERSION="~> 6.1.3.2"'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (02-Jul-2021)
+
+* Initial public release

data/DEV_README.md

@@ -0,0 +1,199 @@
+## inspired by
+
+`https://benediktdeicke.com/2017/09/sending-webhooks-with-rails/`
+
+## look at importing server from https://github.com/nsweeting/activehook
+
+## bootstrapped with:
+
+`bundle gem active_webhook --test=rspec --mit`
+
+## bootstrapped dummy rails app with
+
+`rails new dummy --skip-spring --skip-listen --skip-bootsnap --skip-action-text --skip-active-storage --skip-action-cable --skip-action-mailer --skip-action-mailbox --skip-test --skip-system-test --skip-active-job --skip-active-record --skip-javascript`
+
+[then dicarded and used fully dummy]
+
+[SEE](https://lokalise.com/blog/create-a-ruby-gem-basics/)
+[SEE](https://lokalise.com/blog/how-to-create-a-ruby-gem-testing-suite/)
+
+rails d model active_webhook/subscription
+
+rails d model active_webhook/topic
+
+rails g model active_webhook/subscription \
+ user_id:integer \
+ state:tinyint \
+ topic_key:string \
+ topic_version:string \
+ updated_at:datetime \
+ disabled_reason:string \
+ format:string \
+ callback_url:text \
+ company_id:integer \
+ query:text
+
+rails g model active_webhook/topic \
+ key:string \
+ version:string \
+ state:tinyint \
+ query:string \
+
+
+-------------------------------------------------------------------------------------
+# everything below this line is deferred until needed
+
+1. consolidate formatting/*_adapter.rb into hook/builder.rb
+   - change content_type & encoded_data methods use ActiveWebhook.configuration.content_type
+   - add ActiveWebhook.configuration.builder
+   - delete Hook (in favor of basic hash) ?
+
+1. add `config.queueing.delay` trigger(in: nil) => [1.second]
+   - do not add to Topic or Subscription models (because they aren't loaded before check for performance reasons)
+   - evaluate to config.nil? ? method.option : config.value
+   - configure each queuing adapter to pass delay to underlying implementation
+
+1. add `config.buffering.adapter` => [:disabled, :enabled, Buffering::BaseAdapter]
+   - introduce shim into queueing/base_adapter#call that passes to active_webbhook/buffer/*adapter and back
+   - make sure that all queuing adapters delay after buffer is flushed
+   - add buffer/disabled_adapter and buffer/enabled_adapter
+   - implement as follows:
+     - if enabled, require `request_store`
+     - monkey_patch transaction block (or observe callbacks)
+     - add `buffer.t_level` and `buffer.entries`
+     - store t_level with buffer entry args
+     - on rollback, `buffer.entries.delete` where `entry.t_level` >= `buffer.t_level`; then `buffer.t_level -= 1`
+     - on commit, `buffer.entries.t.level -= 1` where `entry.t_level` >= `buffer.t_level`; then `buffer.t_level -= 1`
+     - if rails, `ActionController.include ActiveWebhook::Buferable` that wraps each action with `begin; ActiveWebhook.buffer.start; ensure; ActiveWebhook.buffer.flush; end
+       - note: Def controller might require different implementation from transactions; need to research transaction callbacks and commits during transaction
+       - https://github.com/steveklabnik/request_store
+       - https://www.justinweiss.com/articles/better-globals-with-a-tiny-activesupport-module/
+
+1. add `ActiveWebhook.cancel(...same args as trigger)`
+   - clears matching `buffer.entries` via `buffer.cancel(**kwargs)`
+   - relies on `config.buffer.eq?(a, b)`
+
+1. add `config.buffering.remove_duplicates` and trigger(remove_duplicates: nil, **) [true, false]
+   - do not add to Topic or Subscription models (because they aren't loaded before check for performance reasons)
+   - evaluate to config.nil? ? method.option : config.value
+   - raise runtime error if true and bufferring_adapter is disabled
+   - relies on `config.buffer.eq?(a, b)`
+
+1. add `config.delivery.retry_count` and trigger(retry_count: nil, **) [true, false]
+   - do not add to Topic or Subscription models (because they aren't loaded before check for performance reasons)
+   - evaluate to config.nil? ? method.option : config.value
+   - solve how to specify retry count with exponential backoff for each queuing adapter
+   - match option name to active_job
+
+1. add `config.delivery.time_limit` and trigger(time_limit: nil, **) [true, false]
+   - do not add to Topic or Subscription models (because they aren't loaded before check for performance reasons)
+   - evaluate to config.nil? ? method.option : config.value
+   - solve how to specify time limit for each queuing adapter
+   - match option name to active_job
+
+1. add jid to context in syncronous queuing adapter (if possible)
+   - solve how to generate an auto increment Id across servers (maybe hash or hex a server id and counter; could store server in db and load on start)
+   - https://www.google.com/search?q=rails+set+global+variable+per+request&client=safari&hl=en-us&ei=xF3NYKDaKYX_-wSAu5KIAw&oq=rails+set+global+variable+per+request
+
+
+
+Scratchpad
+---
+# in spec/spec_helper.rb
+
+# Restablish connection (severed from app load)
+ActiveRecord::Base.establish_connection(DB_CONFIG)
+
+# log sql (as level debug)
+ActiveRecord::Base.logger = Rails.logger
+
+
+----
+# in Rakefile
+
+# require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+#   Bundler::GemHelper.install_tasks
+# rescue LoadError
+#   puts "although not required, bundler is recommended for running the tests"
+# end
+# require "rake"
+
+# RSpec::Core::RakeTask.new(:spec) do |spec|
+#   spec.pattern = 'spec/**/*_spec.rb'
+# end
+
+# namespace :db do
+#   desc "Create the database"
+#   task :create do
+#     initialize_rake_environment
+#     if ActiveRecord::Base.connection.respond_to? :create_database
+#       ActiveRecord::Base.connection.create_database(DB_CONFIG["database"])
+#     else
+#       ActiveRecord::Base.connection.send :connect
+#     end
+#     puts "Database created."
+#   end
+
+#   desc "Migrate the database"
+#   task :migrate do
+#     initialize_rake_environment
+#     ActiveRecord::Base.connection.migration_context.migrate
+#     Rake::Task["db:schema"].invoke
+#     puts "Database migrated."
+#   end
+
+#   desc "Drop the database"
+#   task :drop do
+#     initialize_rake_environment
+#     ActiveRecord::Base.connection.close
+#     if ActiveRecord::Base.connection.respond_to? :drop_database
+#       ActiveRecord::Base.connection.drop_database(DB_CONFIG["database"])
+#     else
+#       f = [__dir__, "db", "#{ENV['RACK_ENV']}.sqlite3"].join("/")
+#       File.delete(f) if File.exist?(f)
+#     end
+#     puts "Database deleted."
+#   end
+
+#   desc "Reset the database"
+#   task :reset => %i[drop create migrate]
+
+#   desc "Create a db/schema.rb file that is portable against any DB supported by AR"
+#   task :schema do
+#     initialize_rake_environment
+#     require "active_record/schema_dumper"
+#     filename = "db/schema.rb"
+#     File.open(filename, "w:utf-8") do |file|
+#       ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+#     end
+#   end
+# end
+
+# namespace :g do
+#   desc "Generate migration"
+#   task :migration do
+#     initialize_rake_environment
+#     name = ARGV[1] || raise("Specify name: rake g:migration your_migration")
+#     timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+#     path = File.expand_path("../db/migrate/#{timestamp}_#{name}.rb", __FILE__)
+#     migration_class = name.split("_").map(&:capitalize).join
+
+#     File.open(path, "w") do |file|
+#       file.write <<~FILE
+#         class #{migration_class} < ActiveRecord::Migration
+#           def self.up
+#           end
+#           def self.down
+#           end
+#         end
+#       FILE
+#     end
+
+#     puts "Migration #{path} created"
+#     abort # needed stop other tasks
+#   end
+# end
+
+
+

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_webhook.gemspec
+gemspec