proclaimer 0.2.0

data/lib/proclaimer/engine.rb

@@ -0,0 +1,20 @@
+module Proclaimer
+  class Engine < Rails::Engine
+    require "spree/core"
+    isolate_namespace Spree
+    engine_name "proclaimer"
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/proclaimer/version.rb

@@ -0,0 +1,3 @@
+module Proclaimer
+  VERSION = "0.2.0".freeze
+end

data/lib/proclaimer.rb

@@ -0,0 +1,9 @@
+require "spree_core"
+require "proclaimer/engine"
+require "proclaimer/configuration"
+
+module Proclaimer
+  def self.configure(&block)
+    Configuration.new.instance_eval(&block)
+  end
+end

data/proclaimer.gemspec

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+require "./lib/proclaimer/version"
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = "proclaimer"
+  s.version = Proclaimer::VERSION
+  s.summary = "An easy, and extensible transactional event notification " +
+    "add on for Spree."
+  s.description = s.summary
+  s.required_ruby_version = ">= 2.2.0"
+
+  s.authors = ["Prem Sichanugrist", "Vincent Franco", "David Freerksen"]
+  s.homepage  = "https://github.com/groundctrl/proclaimer"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = "lib"
+  s.requirements << "none"
+
+  s.add_dependency "spree_backend", "~> 3.0.0"
+
+  s.add_development_dependency "capybara", "~> 2.4"
+  s.add_development_dependency "coffee-rails"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "factory_girl", "~> 4.5"
+  s.add_development_dependency "rspec-rails",  "~> 3.1"
+  s.add_development_dependency "sass-rails", "~> 4.0.2"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "pry-byebug"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+require "proclaimer/configuration"
+
+RSpec.describe Proclaimer::Configuration do
+  before do
+    stub_const "PAYLOAD", Object.new
+  end
+
+  after do
+    ActiveSupport::Notifications.unsubscribe(/^spree\./)
+  end
+
+  describe "#subscribe" do
+    context "subscription" do
+      it "supports subscribing to an event with given event name" do
+        event_name = nil
+        payload = nil
+
+        configuration.subscribe("order.complete") do |*args|
+          event_name = args.first
+          payload = args.second
+        end
+
+        trigger_event "spree.order.complete", PAYLOAD
+
+        expect(event_name).to eq "spree.order.complete"
+        expect(payload).to eq PAYLOAD
+      end
+
+      it "supports subscribing to any event starting with given string" do
+        event_name = nil
+        payload = nil
+
+        configuration.subscribe("order") do |*args|
+          event_name = args.first
+          payload = args.second
+        end
+
+        trigger_event "spree.order.complete", PAYLOAD
+
+        expect(event_name).to eq "spree.order.complete"
+        expect(payload).to eq PAYLOAD
+      end
+    end
+
+    context "callable" do
+      it "raises error if the given object does not respond to call" do
+        expect { configuration.subscribe("event", :nope) }.
+          to raise_error(ArgumentError, /call/)
+      end
+    end
+  end
+
+  describe "#subscribe_all" do
+    context "subscription" do
+      it "subscribe to all spree events" do
+        event_name = nil
+        payload = nil
+
+        configuration.subscribe_all do |*args|
+          event_name = args.first
+          payload = args.second
+        end
+
+        trigger_event "spree.order.complete", PAYLOAD
+
+        expect(event_name).to eq "spree.order.complete"
+        expect(payload).to eq PAYLOAD
+      end
+
+      it "does not subscribe to non-spree event" do
+        event_name = nil
+        payload = nil
+
+        configuration.subscribe_all do |*args|
+          event_name = args.first
+          payload = args.second
+        end
+
+        trigger_event "some.other.event", {}
+
+        expect(event_name).to be_nil
+        expect(payload).to be_nil
+      end
+    end
+
+    context "callable" do
+      it "raises error if the given object does not respond to call" do
+        expect { configuration.subscribe_all(:nope) }.
+          to raise_error(ArgumentError, /call/)
+      end
+    end
+  end
+
+  def configuration
+    Proclaimer::Configuration.new
+  end
+
+  def trigger_event(event_name, payload)
+    ActiveSupport::Notifications.instrument(event_name, payload)
+  end
+end

data/spec/models/spree/order_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+RSpec.describe Spree::Order do
+  before { stub_const("EMPTY_PAYLOAD", Object.new) }
+
+  context "when order is first created" do
+    it "does not instrument any order event" do
+      payload = EMPTY_PAYLOAD
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        /^spree\.order/
+      ) do
+        create(:order)
+
+        expect(payload).to eq EMPTY_PAYLOAD
+      end
+    end
+  end
+
+  context "when order is complete" do
+    it "instruments order.complete event" do
+      payload = EMPTY_PAYLOAD
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        "spree.order.complete"
+      ) do
+        order = create(:order_with_line_items, state: "confirm")
+        create(:payment, amount: order.total, order: order)
+        order.next!
+
+        expect(payload[:order]).to eq order
+      end
+    end
+  end
+end

data/spec/models/spree/order_updater_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module Spree
+  RSpec.describe OrderUpdater, type: :model do
+
+    describe "#update_shipments_with_status_tracking" do
+      it "calls shipment#broadcast on shipments that have changed state" do
+        fake_shipments = [
+          fake_shipment_with_state('pending', 'ready'),
+          fake_shipment_with_state('pending')
+        ]
+        fake_order = double(Order, shipments: fake_shipments)
+        updater = described_class.new(fake_order)
+
+        updater.update_shipments
+
+        expect(fake_shipments.first).to have_received(:broadcast_state)
+        expect(fake_shipments.last).not_to have_received(:broadcast_state)
+      end
+
+      def fake_shipment_with_state(*states)
+        spy(Shipment).tap do |shipment|
+          allow(shipment).to receive(:state).and_return(*states)
+        end
+      end
+    end
+  end
+end

data/spec/models/spree/payment_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+RSpec.describe Spree::Payment do
+  context "when payment is complete" do
+    it "instruments payment.complete event" do
+      payload = nil
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        "spree.payment.complete"
+      ) do
+        payment = create(:payment)
+        payment.complete
+
+        expect(payload[:payment]).to eq payment
+      end
+    end
+  end
+end

data/spec/models/spree/refund_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Spree::Refund do
+  before { stub_const("EMPTY_PAYLOAD", Object.new) }
+
+  context "when refund have not been processed" do
+    it "does not instrument any refund event" do
+      payload = EMPTY_PAYLOAD
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        /^spree\.refund/
+      ) do
+        build(:refund)
+
+        expect(payload).to eq EMPTY_PAYLOAD
+      end
+    end
+  end
+
+  context "when the refund has been processed" do
+    it "instruments refund.complete event" do
+      payload = EMPTY_PAYLOAD
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        "spree.refund.complete"
+      ) do
+        refund = create(:refund, payment: create(:payment, amount: 100))
+
+        expect(payload[:refund]).to eq refund
+      end
+    end
+  end
+end

data/spec/models/spree/shipment_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+RSpec.describe Spree::Shipment do
+  context "when shipment is pending" do
+    it "instruments shipment.pending event" do
+      payload = nil
+
+      ActiveSupport::Notifications.subscribed(
+        -> (*args) { payload = args.last },
+        "spree.shipment.pending"
+      ) do
+        shipment = create(:shipment)
+
+        expect(payload[:shipment]).to eq shipment
+      end
+    end
+  end
+
+  context "when shipment is ready" do
+    it "instruments shipment.ready event" do
+      shipment = create(:shipment)
+      allow(shipment).to receive(:determine_state) { 'ready' }
+      allow(ActiveSupport::Notifications).to receive(:instrument)
+
+      shipment.ready
+
+      expect(ActiveSupport::Notifications).
+        to have_received(:instrument).
+        with("spree.shipment.ready", shipment: shipment)
+    end
+  end
+
+  context "when shipment is canceled" do
+    it "instruments shipment.canceled event" do
+      shipment = create(:shipment)
+      allow(ActiveSupport::Notifications).to receive(:instrument)
+
+      shipment.cancel
+
+      expect(ActiveSupport::Notifications).
+        to have_received(:instrument).
+        with("spree.shipment.canceled", shipment: shipment)
+    end
+  end
+
+  describe "#broadcast_state" do
+    it "instruments shipment.STATE event" do
+      shipment = build(:shipment, state: 'pending')
+      allow(ActiveSupport::Notifications).to receive(:instrument)
+
+      shipment.broadcast_state
+
+      expect(ActiveSupport::Notifications).
+        to have_received(:instrument).
+        with("spree.shipment.pending", shipment: shipment)
+    end
+  end
+end

data/spec/proclaimer_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "proclaimer"
+
+RSpec.describe Proclaimer do
+  describe "configure" do
+    it "initialize a configuration object and passing in the block" do
+      configuration = double(:configuration)
+      given_block = -> {}
+      received_block = nil
+      allow(Proclaimer::Configuration).
+        to receive(:new).and_return(configuration)
+      allow(configuration).to receive(:instance_eval) do |&block|
+        received_block = block
+      end
+
+      Proclaimer.configure(&given_block)
+
+      expect(configuration).to have_received(:instance_eval)
+      expect(received_block).to eq given_block
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+# Run Coverage report
+require "simplecov"
+SimpleCov.start do
+  add_filter "spec/dummy"
+  add_group "Controllers", "app/controllers"
+  add_group "Helpers", "app/helpers"
+  add_group "Mailers", "app/mailers"
+  add_group "Models", "app/models"
+  add_group "Views", "app/views"
+  add_group "Libraries", "lib"
+end
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+require "rspec/rails"
+require "database_cleaner"
+require "ffaker"
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+
+# Requires factories and other useful helpers defined in spree_core.
+require "spree/testing_support/authorization_helpers"
+require "spree/testing_support/capybara_ext"
+require "spree/testing_support/controller_requests"
+require "spree/testing_support/factories"
+require "spree/testing_support/url_helpers"
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group"s spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree"s routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you"re not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV["FAIL_FAST"] || false
+  config.order = "random"
+
+  # Include helpers for controller test
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+  config.include Devise::TestHelpers, type: :controller
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: proclaimer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Prem Sichanugrist
+- Vincent Franco
+- David Freerksen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_backend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy, and extensible transactional event notification add on for Spree.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- app/models/spree/order_decorator.rb
+- app/models/spree/order_updater_decorator.rb
+- app/models/spree/payment_decorator.rb
+- app/models/spree/refund_decorator.rb
+- app/models/spree/shipment_decorator.rb
+- bin/rails
+- bin/rake
+- lib/proclaimer.rb
+- lib/proclaimer/configuration.rb
+- lib/proclaimer/engine.rb
+- lib/proclaimer/version.rb
+- proclaimer.gemspec
+- spec/configuration_spec.rb
+- spec/models/spree/order_spec.rb
+- spec/models/spree/order_updater_spec.rb
+- spec/models/spree/payment_spec.rb
+- spec/models/spree/refund_spec.rb
+- spec/models/spree/shipment_spec.rb
+- spec/proclaimer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/groundctrl/proclaimer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An easy, and extensible transactional event notification add on for Spree.
+test_files:
+- spec/configuration_spec.rb
+- spec/models/spree/order_spec.rb
+- spec/models/spree/order_updater_spec.rb
+- spec/models/spree/payment_spec.rb
+- spec/models/spree/refund_spec.rb
+- spec/models/spree/shipment_spec.rb
+- spec/proclaimer_spec.rb
+- spec/spec_helper.rb