action_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af19d521073aeab2c5dea5e17414c7fdd9eeed9b
+  data.tar.gz: c733f3726e5c8d68ebb9932bb4b5a9569c02041c
+SHA512:
+  metadata.gz: e98eeeb295ac3e624ee27d3f8f987039bef7ca6f5cf7d9c2755d6b9241a7bcb29dde720f49b9f006390e9d999c4ca600498eb1caa1c451c575b3245c2c2c79c7
+  data.tar.gz: 460db4a0917fa92e0fd3b2152832ca7be26f280c24c7b14a62acbe22a4975981efda9ab984737fe0b25610b96d480b4c412327ebce6ad63d9b7312837d70bbef

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.4
+  - 2.3.1
+  - 2.4.0
+  - ruby-head
+before_install: gem install bundler -v 1.12.5
+
+notifications:
+  email:
+    recipients:
+      - stan001212@gmail.com
+    on_failure: change
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at a22301613@yahoo.com.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_notifier.gemspec
+gemspec
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stan Lo
+
+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,43 @@
+# ActionNotifier
+
+[![Build Status](https://travis-ci.org/st0012/action_notifier.svg?branch=master)](https://travis-ci.org/st0012/action_notifier)
+
+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/action_notifier`. 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 'action_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_notifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/action_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/action_notifier.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_notifier"
+  spec.version       = ActionNotifier::VERSION
+  spec.authors       = ["Stan Lo"]
+  spec.email         = ["stan001212@gmail.com"]
+
+  spec.summary       = %q{An abstract layer for Rails app to send notifications.}
+  spec.description   = %q{An abstract layer for Rails app to send notifications.}
+  spec.homepage      = "https://github.com/st0012/action_notifier"
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "actionpack", ">= 5.0"
+  spec.add_dependency "httparty"
+  spec.add_dependency "slack-notifier"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_notifier"
+
+# 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/action_notifier.rb

@@ -0,0 +1,19 @@
+require "abstract_controller"
+require "action_dispatch"
+require "active_support/rails"
+require "active_support/core_ext/class"
+require "active_support/core_ext/module/attr_internal"
+require "active_support/core_ext/string/inflections"
+require "active_support/lazy_load_hooks"
+require "httparty"
+require "action_notifier/version"
+require "action_notifier/exceptions"
+require "action_notifier/deliverers"
+
+module ActionNotifier
+  extend ::ActiveSupport::Autoload
+  autoload :Base
+  autoload :Message
+  autoload :MessageDelivery
+  # Your code goes here...
+end

data/lib/action_notifier/base.rb

@@ -0,0 +1,114 @@
+require "action_notifier/message_delivery"
+require "action_notifier/rescuable"
+
+module ActionNotifier
+  class Base < AbstractController::Base
+    include ActiveSupport::Configurable
+    include AbstractController::Rendering
+
+    include AbstractController::Helpers
+    include AbstractController::Translation
+    include AbstractController::Callbacks
+    include AbstractController::Caching
+    include AbstractController::UrlFor
+    include Rescuable
+
+    class_attribute :url
+
+    class_attribute :delivery_method
+    self.delivery_method = :post_request_deliverer
+
+    class << self
+      def to(url)
+        self.url = url
+      end
+
+      def notifier_name
+        @notifier_name ||= anonymous? ? "anonymous" : name.underscore
+      end
+
+      attr_writer :notifier_name
+      alias :controller_path :notifier_name
+
+      # Aliased by ::default_options=
+      def default(value = nil)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+      # Allows to set defaults through app configuration:
+      #
+      #    config.action_mailer.default_options = { from: "no-reply@example.org" }
+      alias :default_options= :default
+
+      # Wraps an email delivery inside of <tt>ActiveSupport::Notifications</tt> instrumentation.
+      #
+      # This method is actually called by the <tt>Mail::Message</tt> object itself
+      # through a callback when you call <tt>:deliver</tt> on the <tt>Mail::Message</tt>,
+      # calling +deliver_mail+ directly and passing a <tt>Mail::Message</tt> will do
+      # nothing except tell the logger you sent the email.
+      def deliver_notification(notification) #:nodoc:
+        ActiveSupport::Notifications.instrument("deliver.action_notifier") do |payload|
+          set_payload_for_mail(payload, notification)
+          yield # Let Mail do the delivery actions
+        end
+      end
+
+    private
+
+      def set_payload_for_mail(payload, mail)
+        payload[:mailer]     = name
+        payload[:message_id] = mail.message_id
+        payload[:subject]    = mail.subject
+        payload[:to]         = mail.to
+        payload[:from]       = mail.from
+        payload[:bcc]        = mail.bcc if mail.bcc.present?
+        payload[:cc]         = mail.cc  if mail.cc.present?
+        payload[:date]       = mail.date
+        payload[:mail]       = mail.encoded
+      end
+
+      def method_missing(method_name, *args)
+        if action_methods.include?(method_name.to_s)
+          MessageDelivery.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_all = false)
+        action_methods.include?(method.to_s) || super
+      end
+    end
+
+    attr_reader :message
+
+    def initialize
+      @message = Message.new
+    end
+
+    def notify(message:, url: nil, options: nil)
+      @message.body = message
+      @message.delivery_method = self.class.delivery_method
+      @message.url = url || self.class.url
+      @message.options = options || {}
+      @message
+    end
+
+    def process(method_name, *args) #:nodoc:
+      payload = {
+        notifier: self.class.name,
+        action: method_name,
+        args: args,
+        delivery_method: self.class.delivery_method
+      }
+
+      ActiveSupport::Notifications.instrument("process.action_notifier", payload) do
+        super
+      end
+    end
+
+    def notifier_name
+      self.class.notifier_name
+    end
+  end
+end

data/lib/action_notifier/deliverers.rb

@@ -0,0 +1,9 @@
+require "action_notifier/deliverers/base_deliverer"
+require "action_notifier/deliverers/post_request_deliverer"
+require "action_notifier/deliverers/slack_webhook_deliverer"
+
+module ActionNotifier
+  module Deliverers
+
+  end
+end

data/lib/action_notifier/deliverers/base_deliverer.rb

@@ -0,0 +1,17 @@
+module ActionNotifier
+  module Deliverers
+    class BaseDeliverer
+      extend Forwardable
+
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def deliver
+        raise "Not implement error."
+      end
+    end
+  end
+end

data/lib/action_notifier/deliverers/post_request_deliverer.rb

@@ -0,0 +1,13 @@
+module ActionNotifier
+  module Deliverers
+    class PostRequestDeliverer < BaseDeliverer
+      include HTTParty
+
+      def_delegators :@message, :url
+
+      def deliver
+        self.class.post(message.url, { body: message.body }.merge(message.options))
+      end
+    end
+  end
+end

data/lib/action_notifier/deliverers/slack_webhook_deliverer.rb

@@ -0,0 +1,19 @@
+require "slack-notifier"
+
+module ActionNotifier
+  module Deliverers
+    class SlackWebhookDeliverer < BaseDeliverer
+      def deliver
+        notifier.ping(message.body, message.options)
+      end
+
+      def notifier
+        @notifier ||= Slack::Notifier.new(message.url || webhook_url)
+      end
+
+      def webhook_url
+        ENV["SLACK_WEBHOOK_URL"]
+      end
+    end
+  end
+end

data/lib/action_notifier/exceptions.rb

@@ -0,0 +1,7 @@
+module ActionNotifier
+  class UnsupportedDeliverMethodError < StandardError
+    def initialize(msg)
+      super
+    end
+  end
+end

data/lib/action_notifier/message.rb

@@ -0,0 +1,19 @@
+module ActionNotifier
+  class Message
+    attr_accessor :body, :delivery_method, :url, :options
+
+    def deliver
+      deliverer.deliver
+    end
+
+    def deliverer
+      deliverer_name.constantize.new(self)
+    rescue NameError
+      raise UnsupportedDeliverMethodError, "Unsupported deliverer \"#{deliverer_name}\""
+    end
+
+    def deliverer_name
+      "ActionNotifier::Deliverers::#{delivery_method.to_s.camelize}"
+    end
+  end
+end

data/lib/action_notifier/message_delivery.rb

@@ -0,0 +1,44 @@
+require "delegate"
+
+module ActionNotifier
+  class MessageDelivery < Delegator
+    def initialize(notifier_class, action, *args) #:nodoc:
+      @notifier_class, @action, @args = notifier_class, action, args
+
+      # The notifier is only processed if we try to call any methods on it.
+      # Typical usage will leave it unloaded and call deliver_later.
+      @processed_notifier = nil
+      @notification_message = nil
+    end
+
+    def __getobj__ #:nodoc:
+      @notifier_message ||= processed_notifier.message
+    end
+
+    # Unused except for delegator internals (dup, marshaling).
+    def __setobj__(notifier_message) #:nodoc:
+      @notifier_message = notifier_message
+    end
+
+    def message
+      __getobj__
+    end
+
+    def processed?
+      @processed_notifier || @notifier_message
+    end
+
+    def deliver_now
+      processed_notifier.handle_exceptions do
+        message.deliver
+      end
+    end
+
+    private
+      def processed_notifier
+        @processed_notifier ||= @notifier_class.new.tap do |notifier|
+          notifier.process @action, *@args
+        end
+      end
+  end
+end

data/lib/action_notifier/railtie.rb

@@ -0,0 +1,20 @@
+require "action_notifier"
+require "rails"
+require "abstract_controller/railties/routes_helpers"
+
+module ActionNotifier
+  class Railtie < Rails::Railtie # :nodoc:
+    config.action_notifier = ActiveSupport::OrderedOptions.new
+    config.eager_load_namespaces << ActionNotifier
+
+    initializer "action_notifier.logger" do
+      ActiveSupport.on_load(:action_notifier) { self.logger ||= Rails.logger }
+    end
+
+    initializer "action_notifier.compile_config_methods" do
+      ActiveSupport.on_load(:action_notifier) do
+        config.compile_methods! if config.respond_to?(:compile_methods!)
+      end
+    end
+  end
+end

data/lib/action_notifier/rescuable.rb

@@ -0,0 +1,25 @@
+module ActionNotifier
+  module Rescuable
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    class_methods do
+      def handle_exception(exception) #:nodoc:
+        rescue_with_handler(exception) || raise(exception)
+      end
+    end
+
+    def handle_exceptions #:nodoc:
+      yield
+    rescue => exception
+      rescue_with_handler(exception) || raise
+    end
+
+    private
+      def process(*)
+        handle_exceptions do
+          super
+        end
+      end
+  end
+end

data/lib/action_notifier/test_case.rb

@@ -0,0 +1,7 @@
+require "active_support/testing/method_call_assertions"
+
+module ActionNotifier
+  class TestCase < ActiveSupport::TestCase
+    include ActiveSupport::Testing::MethodCallAssertions
+  end
+end

data/lib/action_notifier/version.rb

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: action_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stan Lo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: slack-notifier
+  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'
+description: An abstract layer for Rails app to send notifications.
+email:
+- stan001212@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_notifier.gemspec
+- bin/console
+- bin/setup
+- lib/action_notifier.rb
+- lib/action_notifier/base.rb
+- lib/action_notifier/deliverers.rb
+- lib/action_notifier/deliverers/base_deliverer.rb
+- lib/action_notifier/deliverers/post_request_deliverer.rb
+- lib/action_notifier/deliverers/slack_webhook_deliverer.rb
+- lib/action_notifier/exceptions.rb
+- lib/action_notifier/message.rb
+- lib/action_notifier/message_delivery.rb
+- lib/action_notifier/railtie.rb
+- lib/action_notifier/rescuable.rb
+- lib/action_notifier/test_case.rb
+- lib/action_notifier/version.rb
+homepage: https://github.com/st0012/action_notifier
+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: An abstract layer for Rails app to send notifications.
+test_files: []