proclaimer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f828bb32881de602413bf79b13d3d7cfe93e75e1
+  data.tar.gz: 22716b13b309b4fe2d049eefb1f8d28bf93e699d
+SHA512:
+  metadata.gz: 8721b30d047b3f7ff45becdee6933ad63b083cbbcb010e3dba79b3cbee9b1374842355a104b3aacfcceb7ddea9e71ecd1c71e38532de26f8138a1ecf338c1e57
+  data.tar.gz: 47e10b63f25a17f165dd0a54050824c5f5d5c43254ae4342ee0db493be48fd01d3912c1b0e70bfc6a7a2badfc7500721bd990d281231a112febc80184b511637

data/.gitignore

@@ -0,0 +1,39 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+pkg
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Spree dummy application
+/spec/dummy

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - "2.1"
+  - "2.2"

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "spree", github: "spree/spree", branch: "3-0-stable"
+# Provides basic authentication functionality for testing parts of your engine
+gem "spree_auth_devise", github: "spree/spree_auth_devise", branch: "3-0-stable"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,376 @@
+GIT
+  remote: git://github.com/spree/spree.git
+  revision: c621abd94ead37e85d4171550fc11ac4f03439ac
+  branch: 3-0-stable
+  specs:
+    spree (3.0.4.beta)
+      spree_api (= 3.0.4.beta)
+      spree_backend (= 3.0.4.beta)
+      spree_cmd (= 3.0.4.beta)
+      spree_core (= 3.0.4.beta)
+      spree_frontend (= 3.0.4.beta)
+      spree_sample (= 3.0.4.beta)
+    spree_api (3.0.4.beta)
+      rabl (~> 0.9.4.pre1)
+      spree_core (= 3.0.4.beta)
+      versioncake (~> 2.3.1)
+    spree_backend (3.0.4.beta)
+      bootstrap-sass (~> 3.3.1)
+      jquery-rails (~> 4.0.3)
+      jquery-ui-rails (~> 5.0.0)
+      select2-rails (= 3.5.9.1)
+      spree_api (= 3.0.4.beta)
+      spree_core (= 3.0.4.beta)
+      sprockets-rails (~> 2.2)
+    spree_cmd (3.0.4.beta)
+      thor (~> 0.14)
+    spree_core (3.0.4.beta)
+      activemerchant (~> 1.47.0)
+      acts_as_list (~> 0.6)
+      awesome_nested_set (~> 3.0.1)
+      cancancan (~> 1.10.1)
+      carmen (~> 1.0.0)
+      deface (~> 1.0.0)
+      ffaker (~> 1.16)
+      font-awesome-rails (~> 4.0)
+      friendly_id (~> 5.1.0)
+      highline (~> 1.6.18)
+      httparty (~> 0.11)
+      json (~> 1.7)
+      kaminari (~> 0.15, >= 0.15.1)
+      monetize (~> 1.1)
+      paperclip (~> 4.2.0)
+      paranoia (~> 2.1.0)
+      premailer-rails
+      rails (~> 4.2.2)
+      ransack (~> 1.4.1)
+      responders
+      state_machines-activerecord (~> 0.2)
+      stringex
+      truncate_html (= 0.9.2)
+      twitter_cldr (~> 3.0)
+    spree_frontend (3.0.4.beta)
+      bootstrap-sass (~> 3.3.1)
+      canonical-rails (~> 0.0.4)
+      jquery-rails (~> 4.0.3)
+      spree_api (= 3.0.4.beta)
+      spree_core (= 3.0.4.beta)
+      sprockets-rails (~> 2.2)
+    spree_sample (3.0.4.beta)
+      spree_core (= 3.0.4.beta)
+
+GIT
+  remote: git://github.com/spree/spree_auth_devise.git
+  revision: b554f307e5aa887110a70d54f8967c284f881375
+  branch: 3-0-stable
+  specs:
+    spree_auth_devise (3.0.0)
+      devise (~> 3.4.1)
+      devise-encryptable (= 0.1.2)
+      json
+      multi_json
+      spree_core (~> 3.0.0)
+
+PATH
+  remote: .
+  specs:
+    proclaimer (0.2.0)
+      spree_backend (~> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemerchant (1.47.0)
+      activesupport (>= 3.2.14, < 5.0.0)
+      builder (>= 2.1.2, < 4.0.0)
+      i18n (>= 0.6.9)
+      nokogiri (~> 1.4)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    acts_as_list (0.7.2)
+      activerecord (>= 3.0)
+    addressable (2.3.8)
+    arel (6.0.3)
+    autoprefixer-rails (5.2.1.1)
+      execjs
+      json
+    awesome_nested_set (3.0.2)
+      activerecord (>= 4.0.0, < 5)
+    bcrypt (3.1.10)
+    bootstrap-sass (3.3.5)
+      autoprefixer-rails (>= 5.0.0.1)
+      sass (>= 3.2.19)
+    builder (3.2.2)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    camertron-eprun (1.1.0)
+    cancancan (1.10.1)
+    canonical-rails (0.0.9)
+      rails (>= 3.1, < 5.0)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    carmen (1.0.2)
+      activesupport (>= 3.0.0)
+    cldr-plurals-runtime-rb (1.0.0)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.7)
+      climate_control (>= 0.0.3, < 1.0)
+    coderay (1.1.0)
+    coffee-rails (4.1.0)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    colorize (0.7.7)
+    columnize (0.9.0)
+    css_parser (1.3.6)
+      addressable
+    database_cleaner (1.4.1)
+    deface (1.0.1)
+      colorize (>= 0.5.8)
+      nokogiri (~> 1.6.0)
+      polyglot
+      rails (>= 3.1)
+    devise (3.4.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    devise-encryptable (0.1.2)
+      devise (>= 2.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    execjs (2.5.2)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    ffaker (1.32.1)
+    font-awesome-rails (4.4.0.0)
+      railties (>= 3.2, < 5.0)
+    friendly_id (5.1.0)
+      activerecord (>= 4.0.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    highline (1.6.21)
+    hike (1.2.3)
+    htmlentities (4.3.4)
+    httparty (0.13.5)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.7.0)
+    jquery-rails (4.0.4)
+      rails-dom-testing (~> 1.0)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.5)
+      railties (>= 3.2.16)
+    json (1.8.3)
+    kaminari (0.16.3)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    monetize (1.3.1)
+      money (~> 6.6)
+    money (6.6.1)
+      i18n (>= 0.6.4, <= 0.7.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    orm_adapter (0.5.0)
+    paperclip (4.2.4)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      cocaine (~> 0.5.5)
+      mime-types
+    paranoia (2.1.3)
+      activerecord (~> 4.0)
+    polyamorous (1.2.0)
+      activerecord (>= 3.0)
+    polyglot (0.3.5)
+    premailer (1.8.4)
+      css_parser (>= 1.3.6)
+      htmlentities (>= 4.0.0)
+    premailer-rails (1.8.2)
+      actionmailer (>= 3, < 5)
+      premailer (~> 1.7, >= 1.7.9)
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.2.0)
+      byebug (~> 5.0)
+      pry (~> 0.10)
+    rabl (0.9.4.pre1)
+      activesupport (>= 2.3.14)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    ransack (1.4.1)
+      actionpack (>= 3.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      i18n
+      polyamorous (~> 1.1)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sass (3.2.19)
+    sass-rails (4.0.5)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.2)
+      sprockets (~> 2.8, < 3.0)
+      sprockets-rails (~> 2.0)
+    select2-rails (3.5.9.1)
+      thor (~> 0.14)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (2.12.4)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    state_machines (0.4.0)
+    state_machines-activemodel (0.3.0)
+      activemodel (~> 4.1)
+      state_machines (>= 0.4.0)
+    state_machines-activerecord (0.3.0)
+      activerecord (~> 4.1)
+      state_machines-activemodel (>= 0.3.0)
+    stringex (2.5.2)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    truncate_html (0.9.2)
+    twitter_cldr (3.2.1)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.0.0)
+      json
+      tzinfo
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    versioncake (2.3.1)
+      actionpack (>= 3.2)
+      activesupport (>= 3.2)
+      railties (>= 3.2)
+      tzinfo
+    warden (1.2.3)
+      rack (>= 1.0)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (~> 2.4)
+  coffee-rails
+  database_cleaner
+  factory_girl (~> 4.5)
+  proclaimer!
+  pry-byebug
+  rspec-rails (~> 3.1)
+  sass-rails (~> 4.0.2)
+  simplecov
+  spree!
+  spree_auth_devise!
+  sqlite3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ground(ctrl)
+
+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,58 @@
+Proclaimer
+==========
+
+An easy, and extensible transactional event notification add on for Spree
+
+Installation
+------------
+
+Add proclaimer to your Gemfile:
+
+```ruby
+gem "proclaimer"
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g proclaimer:install
+```
+
+Usage
+-----
+
+Use `Proclaimer.configure` block to setup subscription:
+
+```ruby
+Proclaimer.configure do |config|
+  # Subscribe to a particular event
+  config.subscribe("order.complete") do |event, payload|
+    # ...
+  end
+
+  # Subscribe to any events related to order
+  config.subscribe("order") do |event, payload|
+    # ...
+  end
+
+  # Subscribe to any Spree events
+  config.subscribe_all do |event, payload|
+    # ...
+  end
+end
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to
+building the dummy app if it does not exist, then it will run specs. The dummy
+app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+Copyright (c) 2015 ground(ctrl), released under the MIT License

data/Rakefile

@@ -0,0 +1,30 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+require "spree/testing_support/extension_rake"
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV["LIB_NAME"] = "proclaimer"
+  Rake::Task["extension:test_app"].invoke
+  Rake::Task["test_app:cleanup"].invoke
+end
+
+desc "Remove references to JavaScript and CSS files from dummy app"
+task "test_app:cleanup" do
+  Dir["#{__dir__}/spec/dummy/vendor/**/all.{css,js}"].each do |path|
+    content = File.read(path).sub(%r<^.*require spree/\S+/proclaimer.*$>, "")
+    File.open(path, "w") { |file| file.write(content) }
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,14 @@
+module Spree
+  Order.class_eval do
+    state_machine.after_transition to: :complete, do: :notify_order_completion
+
+    private
+
+    def notify_order_completion
+      ActiveSupport::Notifications.instrument(
+        "spree.order.complete",
+        order: self
+      )
+    end
+  end
+end

data/app/models/spree/order_updater_decorator.rb

@@ -0,0 +1,14 @@
+module Spree
+  OrderUpdater.class_eval do
+    def update_shipments_with_state_tracking
+      shipment_states = shipments.map(&:state)
+      update_shipments_without_state_tracking
+
+      shipments.each_with_index do |shipment, index|
+        shipment.broadcast_state if shipment_states[index] != shipment.state
+      end
+    end
+
+    alias_method_chain :update_shipments, :state_tracking
+  end
+end

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,16 @@
+module Spree
+  Payment.class_eval do
+    state_machine.after_transition \
+      to: :completed,
+      do: :notify_payment_completion
+
+    private
+
+    def notify_payment_completion
+      ActiveSupport::Notifications.instrument(
+        "spree.payment.complete",
+        payment: self
+      )
+    end
+  end
+end

data/app/models/spree/refund_decorator.rb

@@ -0,0 +1,14 @@
+module Spree
+  Refund.class_eval do
+    after_create :notify_refund_processed
+
+    private
+
+    def notify_refund_processed
+      ActiveSupport::Notifications.instrument(
+        "spree.refund.complete",
+        refund: self
+      )
+    end
+  end
+end

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,24 @@
+module Spree
+  Shipment.class_eval do
+    after_create :notify_shipment_pending
+    state_machine.after_transition to: :ready, do: :notify_shipment_ready
+    state_machine.after_transition to: :canceled, do: :notify_shipment_canceled
+
+    def broadcast_state
+      notification_event(state)
+    end
+
+    private
+
+    %i(pending resume ready canceled).each do |type|
+      define_method(:"notify_shipment_#{type}") { notification_event type }
+    end
+
+    def notification_event(type)
+      ActiveSupport::Notifications.instrument(
+        "spree.shipment.#{type}",
+        shipment: self
+      )
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/proclaimer/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/proclaimer/configuration.rb

@@ -0,0 +1,24 @@
+require "active_support/notifications"
+
+module Proclaimer
+  class Configuration
+    def subscribe(event_name, callable = Proc.new)
+      if callable.respond_to?(:call)
+        ActiveSupport::Notifications.subscribe(
+          /^spree\.#{Regexp.escape(event_name)}/,
+          -> (event, *args, payload) do
+            callable.call(event, payload)
+          end
+        )
+      else
+        raise \
+          ArgumentError,
+          "Callback must be a block or object responding to #call."
+      end
+    end
+
+    def subscribe_all(callable = Proc.new)
+      subscribe("", callable)
+    end
+  end
+end