camper_van 0.0.10 → 0.0.11

data/README.md

@@ -53,6 +53,8 @@ Connect, and `/LIST` will show you the irc channels / campfire rooms you
 have access to. To connect to more than one subdomain, make a separate
 connection for each.
 
+If your IRC client (mIRC) doesn't allow `:` in the password, you can use `-`.
+
 Your campfire subdomain should be just the subdomain part. If your campfire url
 is `mycompany.campfirenow.com`, your subdomain would be `mycompany`.
 

data/bin/camper_van

@@ -46,6 +46,8 @@ Options:
 
   opt :pid, 'Path of the PID file', :type => :string,
     :default => '/var/run/camper_van.pid'
+
+  opt :part_on_away, 'Part from channels when going away'
 end
 
 opts = Trollop.with_standard_exception_handling parser do
@@ -80,7 +82,8 @@ else
     :ssl_cert => opts[:ssl_cert],
     :ssl_verify_peer => opts[:ssl_verify_peer],
     :daemon => opts[:daemon],
-    :pid => opts[:pid]
+    :pid => opts[:pid],
+    :part_on_away => opts[:part_on_away]
   )
 
 end

data/camper_van.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = "~> 1.9.2"
 
-  s.add_dependency "eventmachine", "~> 0.12.10"
-  s.add_dependency "firering", "~> 1.2.0"
+  s.add_dependency "eventmachine", "~> 1.0.3"
+  s.add_dependency "firering", "~> 1.3.0"
   s.add_dependency "logging", "~> 1.5.1"
   s.add_dependency "trollop", "~> 1.16.2"
 

data/lib/camper_van/ircd.rb

@@ -17,7 +17,7 @@ module CamperVan
     attr_reader :subdomain, :api_key
 
     # Information for the connected user
-    attr_reader :nick, :user, :host
+    attr_reader :nick, :user, :host, :away
 
     # A Hash of connected CampfireChannels
     attr_reader :channels
@@ -26,6 +26,9 @@ module CamperVan
     # Set to false when shutting down so extra commands are ignored.
     attr_reader :active
 
+    # Additional options
+    attr_reader :options
+
     MOTD = <<-motd
       Welcome to CamperVan.
       To see what campfire rooms are available to the
@@ -40,11 +43,18 @@ module CamperVan
 
     # Public: initialize an IRC server connection
     #
-    # client - the EM connection representing the IRC client
-    def initialize(client)
+    # client  - the EM connection representing the IRC client
+    # options - a Hash of additional options, defaults to {}
+    #           :part_on_away - leave connected campfire rooms when irc client
+    #                           goes away, rejoin when coming back
+    #
+    def initialize(client, options = {})
       @client = client
       @active = true
       @channels = {}
+      @away = false
+      @saved_channels = []
+      @options = options
     end
 
     # The campfire client
@@ -95,6 +105,13 @@ module CamperVan
         shutdown
       else
         @subdomain, @api_key = *args.first.split(":")
+
+        # allow alternate '-' separator
+        if !@api_key
+          # split on the last occurrence of '-':
+          @subdomain, @api_key = *args.first.split(/-(?=[^-]+$)/)
+        end
+
         # ignore full "mycompany.campfirenow.com" being set as the subdomain
         @subdomain = subdomain.split(".").first
       end
@@ -243,7 +260,24 @@ module CamperVan
     end
 
     handle :away do |args|
-      # ignore silently, there's no campfire API for this
+      if @away
+        user_reply 305, "You are no longer marked as being away"
+        if options[:part_on_away]
+          @saved_channels.each do |channel|
+            join_channel channel
+          end
+          @saved_channels = []
+        end
+      else
+        user_reply 306, "You have been marked as being away"
+        if options[:part_on_away]
+          @saved_channels = channels.keys
+          channels.values.each do |channel|
+            channel.part
+          end
+        end
+      end
+      @away = !@away
     end
 
     handle :quit do |args|

data/lib/camper_van/server.rb

@@ -109,7 +109,7 @@ module CamperVan
       @lt2_delimiter = "\r\n"
 
       # start up the IRCD for this connection
-      @ircd = IRCD.new(self)
+      @ircd = IRCD.new(self, options)
 
       if options[:ssl]
         logger.info "starting TLS for #{remote_ip}"

data/lib/camper_van/version.rb

@@ -1,3 +1,3 @@
 module CamperVan
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/camper_van/ircd_spec.rb

@@ -22,6 +22,8 @@ describe CamperVan::IRCD do
 
   class TestIRCD < CamperVan::IRCD
     attr_writer :campfire
+    attr_writer :away
+    attr_accessor :saved_channels
   end
 
   before :each do
@@ -42,6 +44,18 @@ describe CamperVan::IRCD do
       @server.api_key.must_equal "asdf1234"
     end
 
+    it "allows '-' as a domain/api key separator" do
+      @server.handle :pass => ["test-asdf1234"]
+      @server.subdomain.must_equal "test"
+      @server.api_key.must_equal "asdf1234"
+    end
+
+    it "uses the *last* '-' as the separator in a domain/api key pair" do
+      @server.handle :pass => ["test-subdomain-asdf1234"]
+      @server.subdomain.must_equal "test-subdomain"
+      @server.api_key.must_equal "asdf1234"
+    end
+
     it "only uses the subdomain if a full domain is specified" do
       @server.handle :pass => ["test.campfirenow.com:asdf1234"]
       @server.subdomain.must_equal "test"
@@ -238,6 +252,71 @@ describe CamperVan::IRCD do
 
     end
 
+    context "with an AWAY command" do
+      before :each do
+        # register
+        @server.handle :pass => ["test:1234asdf"]
+        @server.handle :nick => ["nathan"]
+        @server.handle :user => ["nathan", 0, 0, "Nathan"]
+      end
+
+      context "with part_on_away set" do
+        before :each do
+          @server.options[:part_on_away] = true
+
+          @server.campfire = Class.new do
+            def rooms
+              yield [
+                OpenStruct.new(:name => "Test"),
+                OpenStruct.new(:name => "Day Job")
+              ]
+            end
+          end.new
+
+          @server.handle :join => ["#test"]
+          @channel = MiniTest::Mock.new
+          @server.channels["#test"] = @channel
+
+          @connection.sent.clear
+        end
+
+        after :each do
+          @channel.verify
+        end
+
+        it "parts joined channels when not away" do
+          @channel.expect :part, nil
+          @server.away = false
+          @server.handle :away => ["bbl..."]
+          @server.away.must_equal true
+        end
+
+        it "rejoins previous channels when away" do
+          @channel.expect :join, nil
+          @server.saved_channels = ["#test"]
+          @server.away = true
+          @server.handle :away => []
+          @server.away.must_equal false
+        end
+      end
+
+      context "without part_on_away set" do
+        it "calls #away while not away" do
+          @server.away = false
+          @server.handle :away => ["bbl..."]
+          @server.away.must_equal true
+          @connection.sent.last.must_equal ":nathan!nathan@127.0.0.1 306 :You have been marked as being away"
+        end
+
+        it "returns from #away while away" do
+          @server.away = true
+          @server.handle :away => []
+          @server.away.must_equal false
+          @connection.sent.last.must_equal ":nathan!nathan@127.0.0.1 305 :You are no longer marked as being away"
+        end
+      end
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camper_van
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.10
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.10
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: firering
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1732883802111020027
+      hash: -1560684573150717162
 requirements: []
 rubyforge_project: camper_van
 rubygems_version: 1.8.23