resource_subscriber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a9dae7ba936613f12121ad3a9f9410d0d2ab58b
+  data.tar.gz: b326e9c13469a191400a661e301a5021210aeb07
+SHA512:
+  metadata.gz: 42ac1ee74dadc403cd5f9ec61ebd107fc19bd02f80c748cbd3dd1f7e7be55d0310d007ca4e6ab399a83206fec0743820f23c6e8c46fdf92891aa8e4a669597b9
+  data.tar.gz: 4541121bb3043aa70baf9b98045ec50dfb802bf859ab626059f518333827cd589a94cc2cf71a1a3afe1cd927bbc06f72719c761bef273cb7b8d99fa0d270ce26

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resource_subscriber.gemspec
+gemspec
+
+gem 'action_subscriber', :github => 'jasonayre/action_subscriber'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jason Ayre
+
+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,95 @@
+# ResourceSubscriber
+
+Publish/Subscribe to ActiveRecord model events via ActionSubscriber, work with them in model form.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resource_subscriber'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resource_subscriber
+
+## Usage
+
+### Setting Up Routes
+``` ruby
+::ActionSubscriber.draw_routes do
+  [ :created, :updated, :destroyed ].each do |action|
+    route ::DataWarehouse::PurchasesSubscriber, action, :stack => :resourceful, :exchange => :events
+  end
+end
+```
+
+### Publishing Model Changes
+``` ruby
+module Ecommerce
+  class Purchase < ::ActiveRecord::Base
+    include ::ResourceSubscriber::Publishable
+    resource_publisher.publish_as 'ecommerce/purchases'
+    #can also specify exchange
+    #resource_publisher.publish_as 'blog/posts', :exchange => 'events'
+  end
+end
+```
+
+### Setting Up Subscriber
+``` ruby
+module DataWarehouse
+  class PurchasesSubscriber < ::ActionSubscriber::Base
+    include ::ResourceSubscriber::Resourceful
+
+    def created
+      record_sale
+    end
+
+    def updated
+      record_reversal if was_chaged_back? || was_returned?
+    end
+
+    def destroyed
+      record_reversal if was_chaged_back? || was_returned?
+    end
+
+    private
+    def was_charged_back?
+      was_changed?(:status, :from => :processed, :to => :charged_back)
+    end
+
+    def was_returned?
+      was_changed?(:status, :from => :processed, :to => :returned)
+    end
+
+    def record_reversal
+      #do whatever
+    end
+
+    def record_sale
+      #store purchase in a data warehouse table
+    end
+  end
+end
+```
+
+## 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]/resource_subscriber.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "resource_subscriber"
+
+# 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

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/resource_subscriber/auto_inject.rb

@@ -0,0 +1,30 @@
+module ResourceSubscriber
+  module AutoInject
+    extend ::ActiveSupport::Concern
+
+    included do
+      class_attribute :_required_dependencies
+      self._required_dependencies = ::Set.new
+    end
+
+    def initialize(**options)
+      self.class.ensure_required_dependencies(**options)
+
+      options.each_pair do |k,v|
+        instance_variable_set(:"@#{k}", v)
+      end
+    end
+
+    module ClassMethods
+      def required_dependencies(*args)
+        self._required_dependencies = self._required_dependencies + args
+        self.__send__(:attr_accessor, *args)
+      end
+
+      def ensure_required_dependencies(**options)
+        _missing_dependencies = _required_dependencies.select{ |dep| !options.key?(dep) }
+        raise ::StandardError.new("Missing Required Dependencies #{_missing_dependencies.join(',')}", _missing_dependencies) if _missing_dependencies.any?
+      end
+    end
+  end
+end

data/lib/resource_subscriber/changes.rb

@@ -0,0 +1,21 @@
+module ResourceSubscriber
+  class Changes < SimpleDelegator
+    def initialize(changes)
+      @changes = changes.with_indifferent_access
+    end
+
+    def __getobj__
+      @changes
+    end
+
+    def was_changed?(attribute_name, to:nil, from:nil)
+      result = true
+      value = self[attribute_name]
+      result &&= !!value
+      result &&= self.key?(attribute_name)
+      result &&= (to == self[attribute_name][1]) if to
+      result &&= (from == self[attribute_name][0]) if from
+      result
+    end
+  end
+end

data/lib/resource_subscriber/message.rb

@@ -0,0 +1,7 @@
+module ResourceSubscriber
+  class Message < ::Trax::Core::Types::Struct
+    string :resource_type
+    json :resource
+    json :changes
+  end
+end

data/lib/resource_subscriber/middlewares/has_changes.rb

@@ -0,0 +1,14 @@
+module ResourceSubscriber
+  module Middlewares
+    class HasChanges
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        env["changes"] = ::ResourceSubscriber::Changes.new(env["payload"]["changes"])
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/resource_subscriber/middlewares/resourceful.rb

@@ -0,0 +1,16 @@
+module ResourceSubscriber
+  module Middlewares
+    class Resourceful
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        attributes = env["payload"]["resource"]
+        model = env["payload"]["resource_type"].constantize
+        env["resource"] = model.find(attributes["id"])
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/resource_subscriber/middlewares.rb

@@ -0,0 +1,8 @@
+module ResourceSubscriber
+  module Middlewares
+    extend ::ActiveSupport::Autoload
+
+    autoload :HasChanges
+    autoload :Resourceful
+  end
+end

data/lib/resource_subscriber/publishable.rb

@@ -0,0 +1,33 @@
+module ResourceSubscriber
+  module Publishable
+    extend ::ActiveSupport::Concern
+
+    included do
+      after_commit :publish_created, :on => :create
+      after_commit :publish_updated, :on => :update
+      after_commit :publish_destroyed, :on => :destroy
+
+      self.class_attribute :resource_publisher
+      self.resource_publisher = ::ResourceSubscriber::Publisher.new(model: self, config: ::ResourceSubscriber::PublisherConfig.new)
+    end
+
+    module ClassMethods
+      def publish_to(routing_key, exchange:'events')
+        self.resource_publisher.config.exchange = exchange
+        self.resource_publisher.config.routing_key = routing_key
+      end
+    end
+
+    def publish_created
+      self.resource_publisher.publish_resource_message('created', self)
+    end
+
+    def publish_destroyed
+      self.resource_publisher.publish_resource_message('destroyed', self)
+    end
+
+    def publish_updated
+      self.resource_publisher.publish_resource_message('updated', self)
+    end
+  end
+end

data/lib/resource_subscriber/publisher.rb

@@ -0,0 +1,26 @@
+module ResourceSubscriber
+  class Publisher
+    include ::ResourceSubscriber::AutoInject
+
+    required_dependencies :model, :config
+
+    def resource_base_class_name
+      @resource_base_class_name ||= model.base_class.name
+    end
+
+    def publish_resource_message(action, resource)
+      message = ::ResourceSubscriber::Message.new(
+        :resource => resource.attributes,
+        :resource_type => resource_base_class_name,
+        :changes => resource.previous_changes
+      ).to_json
+
+      ::ActionSubscriber::Publisher.publish_async("#{self.config.routing_key}.#{action}", message, self.config.exchange, :content_type => 'application/json')
+    end
+
+    def publish_as(routing_key, exchange:'events')
+      self.config[:exchange] = exchange
+      self.config[:routing_key] = routing_key
+    end
+  end
+end

data/lib/resource_subscriber/publisher_config.rb

@@ -0,0 +1,6 @@
+module ResourceSubscriber
+  class PublisherConfig < ::Trax::Core::Types::Struct
+    string :exchange, :default => "events"
+    string :routing_key, :default => ""
+  end
+end

data/lib/resource_subscriber/railtie.rb

@@ -0,0 +1,13 @@
+module ResourceSubscriber
+  class Railtie < ::Rails::Railtie
+    ::ActiveSupport.on_load(:action_subscriber_routes) do
+      stack :resourceful do
+        use ::ResourceSubscriber::Middlewares::HasChanges
+        use ::ResourceSubscriber::Middlewares::Resourceful
+
+        ::ActiveSupport.run_load_hooks(:resource_subscriber_resourceful_stack, self)
+        self
+      end
+    end
+  end
+end

data/lib/resource_subscriber/resourceful.rb

@@ -0,0 +1,18 @@
+module ResourceSubscriber
+  module Resourceful
+    extend ::ActiveSupport::Concern
+
+    attr_accessor :resource, :changes
+
+    def initialize(*args)
+      super(*args)
+
+      @resource = env["resource"]
+      @changes = env["changes"]
+    end
+
+    def was_changed?(*args, **options)
+      @changes.was_changed?(*args, **options)
+    end
+  end
+end

data/lib/resource_subscriber/version.rb

@@ -0,0 +1,3 @@
+module ResourceSubscriber
+  VERSION = "0.1.0"
+end

data/lib/resource_subscriber.rb

@@ -0,0 +1,24 @@
+require "resource_subscriber/version"
+require 'active_support/all'
+require 'action_subscriber'
+require 'trax_core'
+
+module ResourceSubscriber
+  extend ::ActiveSupport::Autoload
+
+  autoload :AutoInject
+  autoload :Changes
+  autoload :Message
+  autoload :Middlewares
+  autoload :Railtie
+  autoload :Resourceful
+  autoload :Publishable
+  autoload :Publisher
+  autoload :PublisherConfig
+
+  def self.load_railtie
+    ::ResourceSubscriber::Railtie
+  end
+
+  load_railtie if defined?(Rails)
+end

data/resource_subscriber.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resource_subscriber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resource_subscriber"
+  spec.version       = ResourceSubscriber::VERSION
+  spec.authors       = ["Jason Ayre"]
+  spec.email         = ["jasonayre@gmail.com"]
+
+  spec.summary       = %q{Resourceful enhancements for action_subscriber}
+  spec.description   = %q{Resourceful enhancements for action_subscriber}
+  spec.homepage      = "https://github.com/jasonayre/resource_subscriber"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "action_subscriber"
+  spec.add_dependency "trax_core"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: resource_subscriber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Ayre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: action_subscriber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trax_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Resourceful enhancements for action_subscriber
+email:
+- jasonayre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resource_subscriber.rb
+- lib/resource_subscriber/auto_inject.rb
+- lib/resource_subscriber/changes.rb
+- lib/resource_subscriber/message.rb
+- lib/resource_subscriber/middlewares.rb
+- lib/resource_subscriber/middlewares/has_changes.rb
+- lib/resource_subscriber/middlewares/resourceful.rb
+- lib/resource_subscriber/publishable.rb
+- lib/resource_subscriber/publisher.rb
+- lib/resource_subscriber/publisher_config.rb
+- lib/resource_subscriber/railtie.rb
+- lib/resource_subscriber/resourceful.rb
+- lib/resource_subscriber/version.rb
+- resource_subscriber.gemspec
+homepage: https://github.com/jasonayre/resource_subscriber
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Resourceful enhancements for action_subscriber
+test_files: []