rake_notification 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6a3378a9677b2056d89ebd7c7901b8612e82e67
-  data.tar.gz: 7e36ff689aa4d62697e3e6a2b9b2f8044d09e154
+  metadata.gz: 2a8517f309e1bea9d58fe584474dbaa145fa1aaa
+  data.tar.gz: 21f6dbca969770b2e71b63d32ea1083235f706b5
 SHA512:
-  metadata.gz: 38e812351b33202687047f77557370ffdbd3ec24fc2fe526c1761f86b483db0857777049e3ec23061b1ae2f23d634303b21ef869f0b729cc7299b6a942f67382
-  data.tar.gz: 780d0d7119135c8d1408670ef8a843866bffed2bd76472798ae9a0cdbe11e4bdc237d935bbe2072ed40d1401c7154cfb0b3bc844fcf73c0ba14b7bbded8aa0a1
+  metadata.gz: 8c53716a47671ea36cfcc23bed3a6969afd150f5f67b5ac83e51bd23339644440879834637ab24f67132387f2b30b9b12109628cf03e326edbeece360d28f236
+  data.tar.gz: c67b702b0f57212873bc258d5240b973a82f6791280a8f06a60281232f089126b945c9c30deef69c19ae3fd479c4fe0a12f471a0dc0c638d2ac6cb2d7c555098

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.1.3
+
+before_install:
+  - gem update bundler
+
+script:
+  - bundle exec rspec

data/README.md

@@ -1,5 +1,7 @@
 # RakeNotification
 
+[![Build Status](https://img.shields.io/travis/mizoR/rake_notification/master.svg?style=flat)](https://travis-ci.org/mizoR/rake_notification)
+
 Notification of status for rake
 
 ## Installation
@@ -14,7 +16,43 @@ And then execute:
 
 ### Execution
 
-    $ bundle exec rake_notify your_task
+    $ bundle exec rake_notify awesome_task
+
+### Usage
+
+#### Ikachan Notifier
+
+```rb
+# config/rake_notification.rb
+
+endpoint = 'https://irc.example.com:4979/'
+channel  = '#rake_notification'
+ikachan  = RakeNotifier::Ikachan.new(endpoint, channel)
+
+Rake.application.register_interceptor ikachan
+Rake.application.register_observer    ikachan
+```
+
+#### Custom Notifier
+
+```rb
+# config/rake_notification.rb
+
+notifier = Object.new.tap do |o|
+  def o.started_task(task)
+    CustomNotifier.started(task).deliver
+  end
+
+  def o.completed_task(task, system_exit)
+    if !system_exit.success?
+      CustomNotifier.failed(task, system_exit)
+    end
+  end
+end
+
+Rake.application.register_interceptor notifier
+Rake.application.register_observer    notifier
+```
 
 ## Contributing
 

data/bin/rake_notify

@@ -9,10 +9,13 @@ end
 require 'rake'
 require 'rake_notification'
 
-using RakeNotification
+class Rake::Application
+  prepend RakeNotification
+end
 
-if File.exist?(RakeNotification.config_path)
+begin
   require RakeNotification.config_path
+rescue LoadError
 end
 
 Rake.application.run

data/lib/rake_notification/version.rb

@@ -1,3 +1,3 @@
 module RakeNotification
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rake_notification.rb

@@ -1,57 +1,56 @@
 require 'rake'
+require 'rake_notifier'
 
 module RakeNotification
   def self.config_path
-    './config/rake_notification.rb'
+    './config/rake_notification'
   end
 
-  refine Rake::Application do
-    def init(app_name='rake')
-      super
-    end
-
-    def reconstructed_command_line
-      @reconstructed_command_line ||= "#{File.basename($0)} #{ARGV.join(' ')}"
-    end
+  def reconstructed_command_line
+    @reconstructed_command_line ||= "#{File.basename($0)} #{ARGV.join(' ')}"
+  end
 
-    def register_observer(observer)
-      notification_observers << observer
-    end
+  def register_observer(observer)
+    notification_observers << observer
+  end
 
-    def register_interceptor(interceptor)
-      notification_interceptors << interceptor
-    end
+  def register_interceptor(interceptor)
+    notification_interceptors << interceptor
+  end
 
-    def run
-      inform_interceptors
-      super
-    rescue SystemExit => e
-      inform_observers(e)
-      raise e
-    else
-      inform_observers
-    end
+  def top_level
+    inform_interceptors rescue nil
+
+    super
+  rescue SystemExit => original_error
+    inform_observers(original_error) rescue nil
+    raise original_error
+  rescue Exception => original_error
+    inform_observers(SystemExit.new(1, original_error.message)) rescue nil
+    raise original_error
+  else
+    inform_observers rescue nil
+  end
 
-    private
+  private
 
-    def inform_interceptors
-      notification_interceptors.each do |interceptor|
-        interceptor.started_task(self)
-      end
+  def inform_interceptors
+    notification_interceptors.each do |interceptor|
+      interceptor.started_task(self)
     end
+  end
 
-    def inform_observers(system_exit=SystemExit.new(0))
-      notification_observers.each do |observer|
-        observer.completed_task(self, system_exit)
-      end
+  def inform_observers(system_exit=SystemExit.new(0))
+    notification_observers.each do |observer|
+      observer.completed_task(self, system_exit)
     end
+  end
 
-    def notification_interceptors
-      @notification_interceptors ||= []
-    end
+  def notification_interceptors
+    @notification_interceptors ||= []
+  end
 
-    def notification_observers
-      @notification_observers ||= []
-    end
+  def notification_observers
+    @notification_observers ||= []
   end
 end

data/lib/rake_notifier/ikachan.rb

@@ -0,0 +1,76 @@
+require 'active_support/core_ext/string/strip'
+require 'net/http'
+require 'uri'
+require 'pathname'
+
+module RakeNotifier
+  class Ikachan < Base
+
+    START_LABEL   = "\x02\x0307[START]\x0f"
+    SUCCESS_LABEL = "\x02\x0303[SUCCESS]\x0f"
+    FAILED_LABEL  = "\x02\x0304[FAILED]\x0f"
+
+    def initialize(url, channel)
+      @client = Client.new(url, channel)
+    end
+
+    def started_task(task)
+      notice <<-EOS.strip_heredoc
+        #{START_LABEL} $ #{task.reconstructed_command_line}
+        (from #{hostname} at #{Time.now} RAILS_ENV=#{rails_env})
+      EOS
+    end
+
+    def completed_task(task, system_exit)
+      label = system_exit.success? ? SUCCESS_LABEL : FAILED_LABEL
+      notice <<-EOS.strip_heredoc
+        #{label} $ #{task.reconstructed_command_line}
+        (exit #{system_exit.status} from #{hostname} at #{Time.now} RAILS_ENV=#{rails_env})
+      EOS
+    end
+
+    private
+
+    def notice(message)
+      message.each_line {|m| @client.notice m }
+    end
+
+    class Client
+      def initialize(url, channel)
+        @url     = url
+        @channel = channel
+      end
+
+      def join
+        request('/join', {channel: @channel})
+      end
+
+      def notice(message)
+        join
+        request('/notice', {channel: @channel, message: message})
+      end
+
+      def uri_for(path = nil)
+        uri = URI.parse("#{@url}/#{path}")
+        uri.path = Pathname.new(uri.path).cleanpath.to_s
+        uri
+      end
+
+      def request(path, params)
+        begin
+          uri = uri_for(path)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.open_timeout = http.read_timeout = 10
+
+          req = Net::HTTP::Post.new(uri.path)
+          req.form_data = params
+
+          http.request(req)
+        rescue StandardError, TimeoutError => e
+          $stderr.puts "#{e.class} #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/rake_notifier.rb

@@ -0,0 +1,17 @@
+require 'socket'
+
+module RakeNotifier
+  autoload :Ikachan, File.join(__dir__, 'rake_notifier', 'ikachan')
+
+  class Base
+    private
+
+    def hostname
+      Socket.gethostname rescue 'Anonymous'
+    end
+
+    def rails_env
+      ENV['RAILS_ENV'] || 'development'
+    end
+  end
+end

data/rake_notification.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
 end

data/spec/lib/rake_notification_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe RakeNotification do
-  using RakeNotification
-
   subject { app }
 
   let(:app) { Rake::Application.new }
@@ -10,48 +8,55 @@ describe RakeNotification do
   let(:notifier) { double('notifier') }
 
   before {
+    class Rake::Application; prepend RakeNotification; end
+
     allow(app).to receive(:invoke_task).and_return(true)
   }
 
   it { expect(described_class.config_path).to be_a String }
 
-  it { should be_respond_to :run }
+  it { is_expected.to be_respond_to :run }
 
   describe "#reconstruct_command_line" do
-    subject { app.reconstruct_command_line }
+    subject { app.reconstructed_command_line }
+
     it {
       app.init
-      expect(app.reconstructed_command_line).to be_a String
+      is_expected.to be_a String
     }
   end
 
   describe '#register_interceptor' do
+    subject { notifier }
+
     before { app.register_interceptor notifier }
 
-    it '#started_task が実行されること' do
-      expect(notifier).to     receive(:started_task).with(app)
-      expect(notifier).not_to receive(:completed_task)
+    it 'should receive started_task' do
+      is_expected.to     receive(:started_task).with(app)
+      is_expected.not_to receive(:completed_task)
 
       app.run
     end
   end
 
   describe '#register_observer' do
+    subject { notifier }
+
     before { app.register_observer notifier }
 
-    it '#completed_task が実行されること' do
-      expect(notifier).not_to receive(:started_task)
-      expect(notifier).to     receive(:completed_task)
+    it 'is_expected.to receive completed_task' do
+      is_expected.not_to receive(:started_task)
+      is_expected.to     receive(:completed_task)
 
       app.run
     end
 
-    context 'タスクの実行中に例外が発生' do
+    context 'raise error on invoking task' do
       before { app.stub(:invoke_task).and_raise(StandardError.new('Rake Error')) }
 
-      it '#completed_task が実行されること' do
-        expect(notifier).not_to receive(:started_task)
-        expect(notifier).to     receive(:completed_task).with(app, kind_of(SystemExit))
+      it 'should receive completed_task' do
+        is_expected.not_to receive(:started_task)
+        is_expected.to     receive(:completed_task).with(app, kind_of(SystemExit))
         begin
           $stderr.reopen('/dev/null', 'w')
           app.run

data/spec/lib/rake_notifier/ikachan/client_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe RakeNotifier::Ikachan::Client do
+  subject { client }
+
+  let(:client)  { described_class.new(url, channel) } 
+  let(:url)     { 'https://irc.example.com:4649' }
+  let(:channel) { '#rake_notification' }
+
+  describe '#uri_for' do
+    subject { client.uri_for('/notice') }
+
+    let(:path) { '/notice' }
+
+    its(:to_s) { is_expected.to eq "#{url}#{path}" } 
+  end
+end

data/spec/lib/rake_notifier/ikachan_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RakeNotifier::Ikachan do
+  subject { described_class.new(url, channel) }
+
+  let(:url) { 'https://irc.example.com:4979' }
+  let(:channel) { '#rake_notification' }
+
+  it { is_expected.to respond_to :started_task }
+  it { is_expected.to respond_to :completed_task }
+end

data/spec/lib/rake_notifier_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe RakeNotifier::Base do
+  subject { anonymous_class.new }
+
+  let(:anonymous_class) { Class.new(described_class) }
+
+  its(:hostname)  { is_expected.to be_a String }
+  its(:rails_env) { is_expected.to be_a String }
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
 require 'rspec'
+require 'rspec/its'
 require 'rake'
 require 'rake_notification'
+require 'rake_notifier'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake_notification
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mizokami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 
 email:
 - suzunatsu@yahoo.com
@@ -89,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,9 +111,13 @@ files:
 - bin/rake_notify
 - lib/rake_notification.rb
 - lib/rake_notification/version.rb
-- lib/rake_notification/whenever.rb
+- lib/rake_notifier.rb
+- lib/rake_notifier/ikachan.rb
 - rake_notification.gemspec
 - spec/lib/rake_notification_spec.rb
+- spec/lib/rake_notifier/ikachan/client_spec.rb
+- spec/lib/rake_notifier/ikachan_spec.rb
+- spec/lib/rake_notifier_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -126,4 +145,7 @@ specification_version: 4
 summary: Rake notification
 test_files:
 - spec/lib/rake_notification_spec.rb
+- spec/lib/rake_notifier/ikachan/client_spec.rb
+- spec/lib/rake_notifier/ikachan_spec.rb
+- spec/lib/rake_notifier_spec.rb
 - spec/spec_helper.rb

data/lib/rake_notification/whenever.rb

@@ -1 +0,0 @@
-job_type :rake_notify, "cd :path && :environment_variable=:environment :bundle_command rake_notify :task --silent :output"