pubsub_notifier 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf75609870b5f43818cd6ca1c2b320bbf1ad2fe
-  data.tar.gz: 7ead5b1b9bfe7e0f432bd7267277b38bba21393f
+  metadata.gz: 13e73599289fcded1fd12387534077d115c28d31
+  data.tar.gz: 4337c6889ec8b6529f3d17460094fee035e3e0f5
 SHA512:
-  metadata.gz: 5d39a9e1533fda09d47a66de943b58442d7cff8ea77fd9fcb19a1f9b3f5e0f91cc77a39c948ecbf59526662258a140880768a1623ebb51e756a7097c75586291
-  data.tar.gz: 06e2db840248b5c0f1d84138b8ad50806f3916baf79e01672eda2e9d9c5c35721f12fccd1f2ea6cbbf01c846480382d3f6f9a9cb9c59db6da6f5c576e13cbf04
+  metadata.gz: 231a15d1f6b997f1810b7d33052c563a8d82abb8cfabfcc7e441c22ec7c3d2d2a8635ce4b0d0f8586b45d1860b57e3deccae3496ef606c508e172fc1b5cbb158
+  data.tar.gz: fd4dbf254a6540e1d7088e07a3d9d6e02cd3db1fbd2e344140cf777a9738f1aa1bee4a0bf6afcad0cc1e63ddeb23f64f197b3785bb8d7ec06d7a7fd468be8a89

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Creates a test rails app for the specs to run against"
+task :setup do
+  require "rails/version"
+  system("mkdir spec/rails") unless File.exist?("spec/rails")
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb -T -B --skip-spring --skip-listen --skip-sprockets"
+end
 
-task :default => :spec
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/rails/templates/notifier.tt

@@ -1,6 +1,7 @@
 <% module_namespacing do -%>
 class <%= class_name %>Notifier < ApplicationNotifier
-  use :slack
+  use :logger
+  # use :slack, channel: '#general', username: 'username', icon_emoji: ':grinning:'
 
   def success(recipient)
     notify_success("#{self.class}##{__method__} called with #{recipient.class}.")

data/lib/generators/rspec/notifier_generator.rb

@@ -1,4 +1,4 @@
-module RSpec
+module Rspec
   module Generators
     class NotifierGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("../templates", __FILE__)

data/lib/pubsub_notifier/proxy.rb

@@ -27,7 +27,7 @@ module PubsubNotifier
       pubsub.call(event, self)
     end
 
-    alias_method :pubilish, :broadcast
+    alias_method :publish, :broadcast
 
     private
 

data/lib/pubsub_notifier/version.rb

@@ -1,3 +1,3 @@
 module PubsubNotifier
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

data/spec/integration_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe "integration test" do
+  describe "broadcasting" do
+    let(:user) { create(:user) }
+
+    it "broadcast to all subscribers" do
+      expect { user.broadcast(:success) }.not_to raise_error
+    end
+
+    it "broadcast to a part of subscribers" do
+      expect { user.broadcast(:failure) }.not_to raise_error
+    end
+  end
+end

data/spec/lib/acts_as_notifier_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+require "pubsub_notifier/acts_as_notifier"
+
+RSpec.describe PubsubNotifier::ActsAsNotifier do
+  let(:dummy) do
+    Class.new do
+      include PubsubNotifier::ActsAsNotifier
+      acts_as_notifier
+
+      class << self
+        def action_methods
+          %w[welcome]
+        end
+      end
+    end
+  end
+
+  before do
+    allow_any_instance_of(ActionMailer::MessageDelivery).to receive(:deliver)
+  end
+
+  describe ".method_missing" do
+    subject { dummy.send(method_name) }
+
+    context "when method_name is included one of actions" do
+      let(:method_name) { :welcome }
+      it { is_expected.to be_a ActionMailer::MessageDelivery }
+    end
+
+    context "when method_name is not included one of actions" do
+      let(:method_name) { :hello }
+
+      it "returns raise error" do
+        expect { subject }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Base do
+  let(:client) do
+    Class.new do
+      attr_reader :name, :options
+
+      def initialize(options = {})
+        @name    = :client
+        @options = options
+      end
+    end
+  end
+
+  let(:logger) do
+    Class.new do
+      attr_reader :name, :options
+
+      def initialize(options = {})
+        @name    = :logger
+        @options = options
+      end
+    end
+  end
+
+  let(:name)    { :dummy }
+  let(:options) { { superman: 12345 } }
+
+  before do
+    configuration = double(:configuration, clients: { name => client, :logger => logger })
+    allow(PubsubNotifier).to receive(:config).and_return(configuration)
+  end
+
+  it "sets client" do
+    described_class.use(name, options)
+    expect(described_class.client).to be_a client
+    expect(described_class.client.name).to eq :client
+    expect(described_class.client.options).to eq options
+
+    described_class.use(:logger, options)
+    expect(described_class.client).to be_a logger
+    expect(described_class.client.name).to eq :logger
+    expect(described_class.client.options).to eq options
+
+    described_class.use(:undefined, options)
+    expect(described_class.client).to be_a logger
+    expect(described_class.client.name).to eq :logger
+    expect(described_class.client.options).to eq options
+  end
+
+  it "returns client" do
+    expect(described_class.client).not_to be_nil
+    expect(described_class.client).not_to be logger
+  end
+end

data/spec/lib/broadcasters/active_job_broadcaster_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Broadcasters::ActiveJobBroadcaster do
+  let(:broadcaster) { described_class.new }
+  let(:configured_job) { double(:configured_job) }
+
+  let(:subscriber) do
+    Struct.new(:name) do
+      attr_reader :name
+    end
+  end
+
+  subject { broadcaster.broadcast(subscriber.new(name: :sub), nil, nil, nil) }
+
+  context "when global_id is not blank" do
+    before do
+      allow(broadcaster).to receive(:configured_job).and_return(configured_job)
+      allow(configured_job).to receive(:perform_later).and_return(:perform_later)
+    end
+
+    it { is_expected.to eq :perform_later }
+  end
+
+  context "when global_id is blank" do
+    before do
+      allow(broadcaster).to receive(:configured_job).and_return(configured_job)
+      allow(configured_job).to receive(:perform_later).and_raise(::ActiveJob::SerializationError)
+      allow(configured_job).to receive(:perform_now).and_return(:perform_now)
+    end
+
+    it { is_expected.to eq :perform_now }
+  end
+end

data/spec/lib/broadcasters_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Broadcasters::Base do
+  let(:broadcaster) { described_class.new }
+
+  describe "#configure" do
+    before { broadcaster.configure(x: 1, y: -> { 2 }) }
+
+    it "sets option with value" do
+      expect(broadcaster.options[:x]).to eq 1
+    end
+
+    it "sets option with proc" do
+      expect(broadcaster.options[:y]).to eq 2
+    end
+  end
+
+  describe "#broadcast" do
+    it { expect { broadcaster.broadcast(nil, nil, nil) }.to raise_error(NotImplementedError) }
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Client::Base do
+  let(:client) { described_class.new }
+
+  describe ".configure" do
+    it { expect { described_class.configure(&:object_id) }.to raise_error(NameError) }
+  end
+
+  describe ".config" do
+    it { expect { described_class.config }.to raise_error(NameError) }
+  end
+
+  describe "#notify_success" do
+    it { expect { client.notify_success("message") }.to raise_error(NotImplementedError) }
+  end
+
+  describe "#notify_failure" do
+    it { expect { client.notify_failure("message") }.to raise_error(NotImplementedError) }
+  end
+end
+
+RSpec.describe PubsubNotifier::Client::LoggerClient do
+  let(:client) { described_class.new }
+
+  describe "#notify_success" do
+    it { expect { client.notify_success("message") }.not_to raise_error }
+  end
+
+  describe "#notify_failure" do
+    it { expect { client.notify_failure("message") }.not_to raise_error }
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Config do
+  let(:config) { described_class.new }
+  it { expect(config.logger).to be_a Logger }
+  it { expect(config.clients).to be_a Hash }
+end

data/spec/lib/proxy_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Proxy do
+  let(:model) do
+    Class.new do
+      include PubsubNotifier::Proxy
+    end
+  end
+
+  let(:instance) { model.new }
+
+  describe ".subscribe" do
+    subject { model.subscribe(subscriber_name) }
+
+    context "when subscriber_name exists" do
+      let(:subscriber_name) { :Hash }
+      it { expect { subject }.not_to raise_error }
+    end
+
+    context "when subscriber_name does not exists" do
+      let(:subscriber_name) { :Undefined }
+      it { expect { subject }.to raise_error(NameError) }
+    end
+  end
+
+  describe ".pubsub" do
+    subject { model.pubsub }
+    it { is_expected.to be_a PubsubNotifier::Pubsub }
+  end
+
+  describe "#broadcast" do
+    subject { instance.broadcast(event) }
+
+    context "when model has subscribed" do
+      before do
+        model.subscribe :Hash
+        model.subscribe :String
+      end
+
+      context "with calling exist event" do
+        let(:event) { :eql? }
+        it { expect { subject }.not_to raise_error }
+      end
+
+      context "with calling not exist event" do
+        let(:event) { :undefined_method_event }
+        it { expect { subject }.not_to raise_error }
+      end
+    end
+
+    context "when model has not subscribed" do
+      let(:event) { :object_id }
+      it { expect { subject }.not_to raise_error }
+    end
+  end
+
+  describe "#publish" do
+    it { expect(instance).to be_respond_to(:publish) }
+  end
+end

data/spec/lib/pubsub_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::Pubsub do
+  describe "#call" do
+    let(:pubsub) { described_class.new }
+
+    subject { pubsub.call(:event) }
+
+    it "calls broadcast" do
+      expect(pubsub).to receive(:broadcast).and_return(true)
+      is_expected.to be true
+    end
+  end
+end

data/spec/lib/slack_client_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+RSpec.describe PubsubNotifier::SlackClient do
+  let(:client)  { described_class.new }
+  let(:message) { "message" }
+  let(:webhook_url) { "https://hooks.slack.com/services/_____/_____/______" }
+
+  before do
+    expect(client).to receive(:webhook_url).and_return(webhook_url)
+    expect(Net::HTTP).to receive(:post_form).and_return(true)
+  end
+
+  describe "#notify_success" do
+    subject { client.notify_success(message) }
+    it { is_expected.to be true }
+  end
+
+  describe "#notify_failure" do
+    subject { client.notify_failure(message) }
+    it { is_expected.to be true }
+  end
+end

data/spec/pubsub_notifier_spec.rb

@@ -1,32 +1,50 @@
 require "spec_helper"
 
 RSpec.describe PubsubNotifier do
-  let(:user)   { User.new }
-  let(:member) { Member.new }
-
-  describe "#publish_notifier" do
-    it "calls success method on subscribed classes" do
-      expect_any_instance_of(AdminNotifier).to receive(:success).once
-      expect_any_instance_of(UserNotifier).to receive(:success).once
-      user.broadcast(:success)
+  describe ".configure" do
+    subject { described_class.configure(&:logger) }
+    it { is_expected.to be_a Logger }
+  end
+
+  describe ".config" do
+    subject { described_class.config }
+    it { is_expected.to be_an_instance_of described_class::Config }
+  end
+
+  describe ".register_client" do
+    let(:name)  { :client }
+    let(:klass) { Object }
+
+    before do
+      described_class.register_client(name, klass)
+    end
+
+    after do
+      described_class.config.clients.delete(name)
     end
 
-    it "calls logger methods on subscribed classes" do
-      expect_any_instance_of(Logger).to receive(:debug).exactly(4).times
-      member.broadcast(:success)
-      member.broadcast(:failure)
+    it "registers notification client" do
+      expect(described_class.config.clients.has_key?(name)).to be true
     end
+  end
+
+  describe ".register_broadcaster" do
+    let(:name)  { :client }
+    let(:klass) { Object }
 
-    it "calls only_admin methods on subscribed classes" do
-      expect_any_instance_of(AdminNotifier).to receive(:only_admin).once
-      expect_any_instance_of(UserNotifier).not_to receive(:only_admin).once
-      member.broadcast(:only_admin)
+    subject { described_class.register_broadcaster(name, klass) }
+
+    before do
+      config = double("configuration", broadcaster: true)
+      allow(Wisper).to receive(:configuration).and_return(config)
     end
 
-    it "calls only_user methods on subscribed classes" do
-      expect_any_instance_of(UserNotifier).to receive(:only_user).once
-      expect_any_instance_of(AdminNotifier).not_to receive(:only_user).once
-      member.broadcast(:only_user)
+    it "register broadcaster" do
+      is_expected.to be true
     end
   end
+
+  describe ".init!" do
+    it { expect { described_class.init! }.not_to raise_error }
+  end
 end