party_bus 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d526f259f98615d1033f8f20ad39a85905887801869d3d8a310f918ef15f573e
+  data.tar.gz: 5c236342dd0240f092384100d12134581ef44fb86857e07763671e0e0db5063b
+SHA512:
+  metadata.gz: eee14f6918b50c233fc80676f200e4874fa5af1ce08652fe24346e57cc405904ba266c6011b2ce6b1d1a733252fc82fc96b0415c930059cff145c024caebad80
+  data.tar.gz: edc96243ed5531be52ada3d8da9d2e9094c4f0665a0b01faafcd70ceddbd7a4f5fa0c78ec4f9d5dace52e525090cbb34a63445e853c594ecb19be7fc4b43797f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.6

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at corey@aridsoftware.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in party_bus.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 12.0"
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "webmock", "~> 3.14"
+end
+
+gem "byebug", "~> 11.1"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    party_bus (0.1.11)
+      activemodel (>= 6.0)
+      activesupport (>= 6.0)
+      after_do (~> 0.4.0)
+      httparty (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.2.4)
+      activesupport (= 7.0.2.4)
+    activesupport (7.0.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    after_do (0.4.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
+    multi_xml (0.6.0)
+    public_suffix (4.0.7)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  party_bus!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 corey jergensen
+
+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/README.md

@@ -0,0 +1,54 @@
+# PartyBus
+
+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/party_bus`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "party_bus", git: "git@github.com:arid-software/party-bus-ruby.git", branch: "main"
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Generate project initializer.
+
+    $ bin/rails generate party_bus <api key>
+
+Add the helper to any object you would like to observe events. To add the helper to every model in your rails application.
+
+    class ApplicationRecord < ActiveRecord::Base
+      primary_abstract_class
+
+      include Publishable
+    end
+
+Control which methods file events with the `publish_on` class method.
+
+      publish_on [:create,  :my_method, :my_other_method]
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/party_bus. 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/[USERNAME]/party_bus/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PartyBus project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/party_bus/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "party_bus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/party_bus/party_bus_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+class PartyBusGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :api_key, required: true, :desc => "required"
+
+  desc "Configures the bugsnag notifier with your API key"
+
+  def create_initializer_file
+    initializer "party_bus.rb" do
+      <<-EOF
+PartyBus.configure do |config|
+  config.api_key = #{api_key.inspect}
+end
+      EOF
+    end
+  end
+end

data/lib/party_bus/client.rb

@@ -0,0 +1,47 @@
+module PartyBus
+  class Client
+    def self.post(
+      entity_id: PartyBus.configuration.entity_id,
+      path:,
+      body:
+    )
+      return { success: true } unless PartyBus.configuration.enabled
+
+      response = HTTParty.post(
+        "#{PartyBus.configuration.api_url}#{path}",
+        body: body.to_json,
+        default_timeout: 10,
+        headers: headers,
+        query: { entity_id: entity_id }
+      )
+
+      parse_response(response)
+    end
+
+    def self.parse_response(response)
+      if response.success?
+        {
+          success: true,
+          serialized_result: response.parsed_response
+        }
+      else
+        {
+          success: false,
+          errors: [response.parsed_response]
+        }
+      end
+    end
+
+    def self.headers
+      {
+        'Accept': 'application/json',
+        'Authorization': authorization,
+        'Content-Type': 'application/json'
+      }
+    end
+
+    def self.authorization
+      "Bearer #{PartyBus.configuration.api_key}"
+    end
+  end
+end

data/lib/party_bus/configuration.rb

@@ -0,0 +1,19 @@
+module PartyBus
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_url
+    attr_accessor :enabled
+    attr_accessor :entity_id
+    attr_accessor :source_id
+    attr_accessor :stripped_attributes
+
+    def initialize
+      self.api_key = nil
+      self.api_url = "https://party-bus.gigalixirapp.com"
+      self.enabled = ENV['RUBY_ENV'] != 'test' && ENV['RAILS_ENV'] != 'test'
+      self.entity_id = nil
+      self.source_id = nil
+      self.stripped_attributes = []
+    end
+  end
+end

data/lib/party_bus/events/create.rb

@@ -0,0 +1,32 @@
+module PartyBus
+  module Events
+    class Create
+      def self.perform_using(entity_id: nil, payload:, resource_type:, resource_action:, source_id:)
+        new(entity_id, resource_type, resource_action, payload, source_id).perform
+      end
+
+      def initialize(entity_id, resource_type, resource_action, payload, source_id)
+        @entity_id = entity_id
+        @resource_type = resource_type
+        @resource_action = resource_action
+        @payload = payload
+        @source_id = source_id
+      end
+
+      def perform
+        @response ||= PartyBus::Client.post(
+          entity_id: @entity_id,
+          path: '/api/v1/events',
+          body: {
+            event: {
+              payload: @payload,
+              resource_type: @resource_type,
+              resource_action: @resource_action,
+              source_id: @source_id
+            }
+          }
+        )
+      end
+    end
+  end
+end

data/lib/party_bus/models/concerns/publishable.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Publishable
+  extend ActiveSupport::Concern
+
+  included do
+    extend AfterDo
+
+    def self.publish_on(*methods)
+      # after_commit hook for active record methods
+      after_commit :pb_after_create, on: :create if methods.flatten.include?(:create)
+      after_commit :pb_after_update, on: :update if methods.flatten.include?(:update)
+      after_commit :pb_after_destroy, on: :destroy if methods.flatten.include?(:destroy)
+
+      # after_do hook for other methods
+      special_methods = methods.flatten.reject { |m| [:create, :update, :destroy].include?(m) }
+      if special_methods.any?
+        after special_methods do |method_name, *args, _return_val, instance|
+          pb_create_event(**instance.pb_serialize(method_name))
+        end
+      end
+    end
+
+    def pb_after_create
+      self.class.pb_create_event(**pb_serialize("created"))
+    end
+
+    def pb_after_update
+      self.class.pb_create_event(**pb_serialize("updated"))
+    end
+
+    def pb_after_destroy
+      self.class.pb_create_event(**pb_serialize("destroyed"))
+    end
+
+    def self.pb_create_event(attributes)
+      PartyBus::Events::Create.perform_using(**attributes)
+    end
+
+    # This method is overrideable in case the resource name in party bus differs
+    # from the model name. By default we just use the model name.
+    def pb_resource_name
+      self.class.to_s
+    end
+
+    def pb_serialize(action = nil)
+      payload = if self.respond_to?(:attributes)
+        self.attributes
+      else
+        self.instance_values
+      end
+        .deep_symbolize_keys
+        .except(*pb_stripped_attributes)
+
+      {
+        entity_id: entity_id,
+        payload: payload,
+        resource_type: pb_resource_name,
+        resource_action: action,
+        source_id: pb_source_id,
+      }
+    end
+
+    # These attributes are stripped by default
+    def pb_stripped_attributes
+      PartyBus.configuration.stripped_attributes
+    end
+
+    def pb_entity_id
+      PartyBus.configuration.entity_id
+    end
+
+    def pb_source_id
+      PartyBus.configuration.source_id
+    end
+  end
+end

data/lib/party_bus/version.rb

@@ -0,0 +1,3 @@
+module PartyBus
+  VERSION = "0.1.11"
+end

data/lib/party_bus.rb

@@ -0,0 +1,28 @@
+require "rubygems"
+require "thread"
+
+require "active_model"
+require "active_support/concern"
+require "after_do"
+require "httparty"
+
+require "party_bus/version"
+require "party_bus/client"
+require "party_bus/configuration"
+require "party_bus/events/create"
+require "party_bus/models/concerns/publishable"
+
+module PartyBus
+  LOCK = Mutex.new
+
+  class << self
+    def configure(validate_api_key=true)
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration = nil unless defined?(@configuration)
+      @configuration || LOCK.synchronize { @configuration ||= PartyBus::Configuration.new }
+    end
+  end
+end

data/party_bus.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/party_bus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "party_bus"
+  spec.version       = PartyBus::VERSION
+  spec.authors       = ["corey jergensen"]
+  spec.email         = ["corey@aridsoftware.com"]
+
+  spec.summary       = %q{Get on the PartyBus.}
+  spec.description   = %q{This is the gem for PartyBus.}
+  spec.homepage      = "https://github.com/arid-software.com/party-bus-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/arid-software/party-bus-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/arid-software/party-bus-ruby/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("after_do", '~> 0.4.0')
+  spec.add_runtime_dependency("httparty", '~> 0.20.0')
+  spec.add_runtime_dependency("activemodel", ">= 6.0")
+  spec.add_runtime_dependency("activesupport", ">= 6.0")
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: party_bus
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- corey jergensen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: after_do
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This is the gem for PartyBus.
+email:
+- corey@aridsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/party_bus/party_bus_generator.rb
+- lib/party_bus.rb
+- lib/party_bus/client.rb
+- lib/party_bus/configuration.rb
+- lib/party_bus/events/create.rb
+- lib/party_bus/models/concerns/publishable.rb
+- lib/party_bus/version.rb
+- party_bus.gemspec
+homepage: https://github.com/arid-software.com/party-bus-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arid-software.com/party-bus-ruby
+  source_code_uri: https://github.com/arid-software/party-bus-ruby
+  changelog_uri: https://github.com/arid-software/party-bus-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_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'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Get on the PartyBus.
+test_files: []