irc-notify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b1f6125a6fb0e594d0764e5c49127fc3252042e
+  data.tar.gz: 2b5358bb0523a3e30e7d0a0ba5421498d411f450
+SHA512:
+  metadata.gz: 066e0cafa15cc4606f837c2875c6437cebf0c89b8c25becb5046c374a23fadbe325caad4d0bccc2268b6c7665ad343f06e84b3ab36d29b7a55978ce016cffc69
+  data.tar.gz: ab6dc383aa63ed3d9bd8e2cc3586f46ebc4781be6f129ace5f513fddeacb7f74c88a0b0827c614934b40b79a8a3cf2e691b41b4508262311bada125869f94dc0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2.1.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+platform :rbx do
+  gem "rubysl"
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard "bundler" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cli: "-fs --color --order rand" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/irc-notify/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Henrik Hodne
+
+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.markdown

@@ -0,0 +1,23 @@
+irc-notify
+==========
+
+irc-notify is a very small IRC library meant for publishing notifications to
+IRC. It's used by [Travis CI](https://travis-ci.org) to publish IRC
+notifications.
+
+Basic example
+-------------
+
+``` Ruby
+require "irc-notify"
+client = IrcNotify::Client.build("irc.example.com", 6697, ssl: true)
+
+client.register("nick")
+client.notify("#channel", "Hello, world!")
+client.quit
+```
+
+Installation
+------------
+
+    $ gem install irc-notify

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/irc-notify.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "irc-notify/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "irc-notify"
+  spec.version = IrcNotify::VERSION
+  spec.authors = ["Henrik Hodne"]
+  spec.email = ["henrik@hodne.io"]
+  spec.description = "irc-notify is a minimal library for publishing IRC notifications"
+  spec.summary = "irc-notify is a minimal library for publishing IRC notifications"
+  spec.homepage = "https://github.com/henrikhodne/irc-notify"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/irc-notify.rb

@@ -0,0 +1,5 @@
+require "irc-notify/version"
+require "irc-notify/client"
+
+module IrcNotify
+end

data/lib/irc-notify/client.rb

@@ -0,0 +1,89 @@
+module IrcNotify
+  class Client
+    def self.build(host, port = 6667, options = {})
+      require "socket"
+      socket = TCPSocket.new(host, port)
+      if options[:ssl]
+        require "openssl"
+        ssl_context = OpenSSL::SSL::SSLContext.new
+        ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context).tap do |sock|
+          sock.sync = true
+          sock.connect
+        end
+      end
+
+      new(socket)
+    end
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    def register(nick, options = {})
+      print("PASS #{options[:password]}") if options[:password]
+      print("NICK #{nick}")
+      print("USER #{nick} * * :#{nick}")
+
+      loop do
+        case @socket.gets
+        when /00[1-4] #{Regexp.escape(nick)}/
+          break
+        when /^PING\s*:\s*(.*)$/
+          print("PONG #{$1}")
+        end
+      end
+
+      identify_nickserv(options[:nickserv_password]) if options[:nickserv_password]
+    end
+
+    def notify(channel, message, options = {})
+      join(channel, options[:channel_key]) if options.fetch(:join, true)
+      if options[:notice]
+        notice(channel, message)
+      else
+        privmsg(channel, message)
+      end
+    end
+
+    def quit(message = nil)
+      message = " :#{message}" if message
+      print("QUIT#{message}")
+      @socket.gets until @socket.eof?
+    end
+
+    private
+
+    def identify_nickserv(password)
+      privmsg("NickServ", "IDENTIFY #{password}")
+      loop do
+        case @socket.gets
+        when /^:NickServ/i
+          break
+        when /^PING\s*:\s*(.*)$/
+          print("PONG #{$1}")
+        end
+      end
+    end
+
+    def privmsg(receiver, message)
+      print("PRIVMSG #{receiver} :#{message}")
+    end
+
+    def notice(receiver, message)
+      print("NOTICE #{receiver} :#{message}")
+    end
+
+    def join(channel, key = nil)
+      if key
+        print("JOIN #{channel} #{key}")
+      else
+        print("JOIN #{channel}")
+      end
+    end
+
+    def print(line)
+      @socket.print("#{line}\r\n")
+    end
+  end
+end

data/lib/irc-notify/version.rb

@@ -0,0 +1,3 @@
+module IrcNotify
+  VERSION = "0.0.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe IrcNotify::Client do
+  let(:nick) { "Bob" }
+  let(:socket) { double("socket", print: nil, gets: "001 #{nick}") }
+  subject(:client) { described_class.new(socket) }
+
+  describe "#register" do
+    it "sends NICK and USER" do
+      expect(socket).to receive(:print).with("NICK #{nick}\r\n").ordered
+      expect(socket).to receive(:print).with("USER #{nick} * * :#{nick}\r\n").ordered
+
+      client.register(nick)
+    end
+
+    context "with password" do
+      it "sends PASS before NICK and USER" do
+        expect(socket).to receive(:print).with("PASS foobar\r\n").ordered
+        expect(socket).to receive(:print).with("NICK #{nick}\r\n").ordered
+        expect(socket).to receive(:print).with("USER #{nick} * * :#{nick}\r\n").ordered
+
+        client.register(nick, password: "foobar")
+      end
+    end
+
+    context "with NickServ password" do
+      before(:each) do
+        allow(socket).to receive(:gets).and_return("001 #{nick}", ":NickServ foo")
+      end
+
+      it "messages NickServ with password" do
+        expect(socket).to receive(:print).with("NICK #{nick}\r\n").ordered
+        expect(socket).to receive(:print).with("USER #{nick} * * :#{nick}\r\n").ordered
+        expect(socket).to receive(:print).with("PRIVMSG NickServ :IDENTIFY foobar\r\n")
+
+        client.register(nick, nickserv_password: "foobar")
+      end
+    end
+  end
+
+  describe "#notify" do
+    it "joins the channel" do
+      client.notify("#channel", "hello, world!")
+      expect(socket).to have_received(:print).with("JOIN #channel\r\n")
+    end
+
+    it "sends the message" do
+      client.notify("#channel", "Hello, world!")
+      expect(socket).to have_received(:print).with("PRIVMSG #channel :Hello, world!\r\n")
+    end
+
+    context "with a channel key" do
+      it "joins the channel with the key" do
+        client.notify("#channel", "Hello, world!", channel_key: "foobar")
+        expect(socket).to have_received(:print).with("JOIN #channel foobar\r\n")
+      end
+    end
+
+    context "when enabling :notice flag" do
+      it "sends a notice" do
+        client.notify("#channel", "Hello, world!", notice: true)
+        expect(socket).to have_received(:print).with("NOTICE #channel :Hello, world!\r\n")
+      end
+    end
+
+    context "when passing join: false" do
+      it "does not join the channel" do
+        client.notify("#channel", "hello, world!", join: false)
+        expect(socket).not_to have_received(:print).with(match(/^JOIN/))
+      end
+    end
+  end
+
+  describe "#quit" do
+    before(:each) do
+      allow(socket).to receive(:eof?).and_return(true)
+    end
+
+    it "sends the command" do
+      client.quit("Goodbye")
+      expect(socket).to have_received(:print).with("QUIT :Goodbye\r\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+GEM_ROOT = File.expand_path("../../", __FILE__)
+$:.unshift(File.join(GEM_ROOT, "lib"))
+
+require "irc-notify"

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: irc-notify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henrik Hodne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: guard
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: guard-bundler
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: guard-rspec
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: irc-notify is a minimal library for publishing IRC notifications
+email:
+- henrik@hodne.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- irc-notify.gemspec
+- lib/irc-notify.rb
+- lib/irc-notify/client.rb
+- lib/irc-notify/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/henrikhodne/irc-notify
+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.1.5
+signing_key: 
+specification_version: 4
+summary: irc-notify is a minimal library for publishing IRC notifications
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb