pair 0.0.3 → 0.0.4

data/.rvmrc

@@ -1,13 +1,2 @@
-rvm 1.9.2-p180@pair-gem --create
-
-bundler=`gem list bundler | grep bundler`
-if [ $? -eq 1 ] ; then
-  echo "Installing bundler for project:\n\n";
-  gem install --pre bundler;
-
-  echo; read -s -n 1 -p "Run bundler install y/n" confirm; echo; echo;
-  if [ "$confirm" == "y" ]; then
-    bundle install;
-  fi
-fi
+rvm 1.9.3-p125@pair-gem --create
 

data/CHANGES

@@ -0,0 +1,9 @@
+rel 0.0.3
+
+* Add configuration component that sets config values in yaml
+
+rel 0.0.4
+
+* Add initial notifications configuration
+* Add growl for notifications on mac, supports lion and gntp
+

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    pair (0.0.2)
+    pair (0.0.4)
       httparty (~> 0.8.1)
+      ruby_gntp (~> 0.3.4)
 
 GEM
   remote: http://rubygems.org/
@@ -11,7 +12,7 @@ GEM
     httparty (0.8.1)
       multi_json
       multi_xml
-    multi_json (1.0.3)
+    multi_json (1.0.4)
     multi_xml (0.4.1)
     rake (0.9.2.2)
     rspec (2.7.0)
@@ -22,6 +23,7 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    ruby_gntp (0.3.4)
 
 PLATFORMS
   ruby

data/lib/pair.rb

@@ -1,9 +1,16 @@
 module Pair
+  APPLICATION_NAME = "Pair"
+  APPLICATION_DOMAIN = "www.pairmill.com"
+
+  ICON_APPLICATION = "http://#{APPLICATION_DOMAIN}/images/emblem-earth.png"
+  ICON_SESSION_JOIN = "http://#{APPLICATION_DOMAIN}/images/pair-network-join.png"
+  ICON_SESSION_PART = "http://#{APPLICATION_DOMAIN}/images/pair-network-part.png"
 end
 
 require "pair/version"
 
 require "pair/os"
 require "pair/config"
+require "pair/notification"
 require "pair/api"
 require "pair/session"

data/lib/pair/api.rb

@@ -7,7 +7,7 @@ module Pair
     extend self
 
     def setup
-      base_uri ENV['BASE_URI'] || 'api.pairmill.com'
+      base_uri Pair.config.host
       default_params :api_token => Pair.config.api_token
       yield
     end

data/lib/pair/cli.rb

@@ -24,14 +24,17 @@ module Pair
       when 'config'
         require "pair/cli/config"
         Config.run!(arguments)
+      when 'notify'
+        require "pair/cli/notify"
+        Notify.run!(arguments)
       else
         unknown_command(command)
       end
-    rescue ApiTokenMissingError, EnableSSHError => error
+    rescue ApiTokenMissingError, EnableSSHError, Pair::Notification::GNTPError => error
       handle_error error.message, false
     rescue SystemExit
       raise
-    rescue
+    rescue Exception => except
       handle_error "  Please contact support@pairmill.com, there\n" +
                    "  was an issue creating your session.", $-d
     end

data/lib/pair/cli/config.rb

@@ -14,13 +14,13 @@ module Pair
                         "Options:" +
                         "\n"
 
-          opts.on("--api-token KEY") do |key|
+          opts.on("-t", "--api-token KEY") do |key|
             options[:api_token] = key
           end
 
-#          opts.on("--enable-ssh") do
-#            options[:enable_ssh] = true
-#          end
+          opts.on("-g", "--growl") do
+            options[:growl] = true
+          end
         end
       end
     end

data/lib/pair/cli/host.rb

@@ -16,7 +16,7 @@ module Pair
           raise ApiTokenMissingError.new("api-token is required. try --help to understand how")
         end
 
-        unless config.ssh_enabled?
+        unless config.ssh_on?
           raise EnableSSHError.new("ssh is not enabled, turn on ssh daemon to continue")
         end
 

data/lib/pair/cli/notify.rb

@@ -0,0 +1,40 @@
+module Pair
+  class Cli
+    class Notify < self
+      def run!
+        parse!
+
+        Notification.dispatcher.gntp_notify(options)
+      end
+
+      def parse!
+        opts = parse do |opts|
+          opts.banner = "Usage #{$0.split("/").last} notify" +
+                        "\n\n" +
+                        "Options:" +
+                        "\n"
+
+          opts.on("-t", "--title title") do |title|
+            options[:title] = title
+          end
+
+          opts.on("-n", "--notification name") do |name|
+            options[:name] = name
+          end
+
+          opts.on("-m", "--message text") do |text|
+            options[:text] = text
+          end
+
+          opts.on("-i", "--icon url") do |url|
+            options[:icon] = url
+          end
+
+          opts.on("-s", "--sticky") do
+            options[:sticky] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pair/config.rb

@@ -18,13 +18,6 @@ module Pair
       self.output = output
     end
 
-#    def api_token
-#      self[:api_token] ||= begin
-#        print "Please input your API token for Pair: "
-#        gets.chomp
-#      end
-#    end
-
     def method_missing(method, *args, &block)
       method = method.to_s
 
@@ -39,27 +32,33 @@ module Pair
       self[:api_token]
     end
 
-    def enable_ssh
-      self[:enable_ssh]
+    def ssh_enabled?
+      self[:ssh_enabled]
     end
 
-    def ssh_enabled?
-      if Pair::OS.x?
+    def growl_enabled?
+      self[:growl_enabled]
+    end
+
+    # FIXME: Does this belong in config?
+    def ssh_on?
+      if Pair::OS.os_x?
         `systemsetup -getremotelogin`.match("Remote Login: On")
+      elsif Pair::OS.linux?
+        `ps aux | grep sshd | grep -v grep` != ""
       end
     end
 
     def update(options = {})
       if options.is_a? Hash
-        options.each do |k,v|
-          config.transaction do
-            host_config[k] = v
-          end
+        options.each do |key, value|
+          self[key] = value
         end
       end
     end
 
     protected
+
     def [](key)
       config.transaction do
         host_config[key]

data/lib/pair/notification.rb

@@ -0,0 +1,27 @@
+require "pair/notification/custom_errors"
+require "pair/notification/dispatcher"
+require "pair/notification/o_s_x_dispatcher"
+require "pair/notification/linux_dispatcher"
+
+module Pair
+  class Notification
+    attr_reader :dispatch
+
+    class << self
+      def dispatcher(options = {})
+        if Pair::OS.os_x?
+          dispatch = OSXDispatcher.new(options)
+        else
+          dispatch = LinuxDispatcher.new(options)
+        end
+
+        if block_given?
+          yield dispatch
+        else
+          dispatch
+        end
+      end
+    end
+  end
+end
+

data/lib/pair/notification/custom_errors.rb

@@ -0,0 +1,5 @@
+module Pair
+  class Notification
+    class GNTPError < StandardError; end
+  end
+end

data/lib/pair/notification/dispatcher.rb

@@ -0,0 +1,24 @@
+module Pair
+  class Notification
+    class Dispatcher
+      attr_accessor :logger, :enabled
+
+      def initialize(options = {})
+        @enabled = Pair.config.growl_enabled?
+        @logger = options[:logger] || STDOUT
+      end
+
+      def session_join(user, session)
+        raise NotImplementedError
+      end
+
+      def session_part(user, session)
+        raise NotImplementedError
+      end
+
+      def gntp_notify
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/pair/notification/growl_logger.rb

@@ -0,0 +1,6 @@
+require 'growl'
+
+module Pair
+  class Notification
+  end
+end

data/lib/pair/notification/linux_dispatcher.rb

@@ -0,0 +1,8 @@
+module Pair
+  class Notification
+    class LinuxDispatcher < Dispatcher
+      def initialize(options)
+      end
+    end
+  end
+end

data/lib/pair/notification/o_s_x_dispatcher.rb

@@ -0,0 +1,66 @@
+require 'ruby_gntp'
+
+module Pair
+  class Notification
+    class OSXDispatcher < Dispatcher
+      attr_reader :growl, :app_icon
+
+      NOTIFICATIONS = [{:name => "Session Events", :enabled => true}]
+
+      def initialize(options = {})
+        @app_icon = options.delete(:app_icon)
+        super
+
+        register_growl if Pair.config.growl_enabled?
+
+      rescue Errno::ECONNREFUSED => except
+        raise Pair::Notification::GNTPError.new("Growl notification transfer protocol is not enabled, either start growl or disable growl via pair config")
+      end
+
+      def register_growl
+        @growl = GNTP.new(Pair::APPLICATION_NAME)
+        @growl.register application_hash
+      end
+
+      def session_join(user, session)
+        gntp_notify({
+          :name => "Session Events", :title => "Pair Message",
+          :text => "#{user} joined session \"#{session}\"",
+          :icon => Pair::ICON_SESSION_JOIN, :sticky => true
+        })
+      end
+      
+      def session_part(user, session)
+        gntp_notify({
+          :name => "Session Events", :title => "Pair Message",
+          :text => "#{user} parted session \"#{session}\"",
+          :icon => Pair::ICON_SESSION_JOIN, :sticky => true
+        })
+      end
+
+
+      def gntp_notify(options)
+        if enabled
+          if block_given?
+            yield @growl
+          end
+
+          if options[:text]
+            options = {
+              :name => "Session Events", :title => "",
+              :icon => @app_icon, :sticky => false
+            }.merge(options)
+
+            @growl.notify(options)
+          end
+        end
+      end
+
+      private
+
+      def application_hash
+        { :app_icon => Pair::ICON_APPLICATION, :notifications => NOTIFICATIONS }
+      end
+    end
+  end
+end

data/lib/pair/os.rb

@@ -1,13 +1,11 @@
-require 'rbconfig'
-
 module Pair
   module OS
-    def linux?
-      !RbConfig::CONFIG['target_os'].match("linux").nil?
+    def self.linux?
+      RUBY_PLATFORM =~ /linux/
     end
 
-    def self.x?
-      !RbConfig::CONFIG['target_os'].match("darwin").nil?
+    def self.os_x?
+      RUBY_PLATFORM =~ /darwin/
     end
   end
 end

data/lib/pair/version.rb

@@ -1,3 +1,3 @@
 module Pair
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/pair.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Pair::VERSION
 
   gem.add_dependency("httparty", "~> 0.8.1")
+  gem.add_dependency("ruby_gntp", "~> 0.3.4")
 
   gem.add_development_dependency("rake")
   gem.add_development_dependency("rspec", "~> 2.7.0")

data/spec/fixtures/config/rspec.pair.yml

@@ -0,0 +1,5 @@
+---
+api.pairmill.com:
+  :api_token: XXXXXXXXXXXXXXXXXXXX
+  :growl_enabled: true
+  :ssh_enabled: true

data/spec/fixtures/config/rspec_no_growl_enabled.pair.yml

@@ -0,0 +1,4 @@
+---
+api.pairmill.com:
+  :api_token: XXXXXXXXXXXXXXXXXXXX
+  :ssh_enabled: true

data/spec/fixtures/config/rspec_no_ssh_enabled.pair.yml

@@ -0,0 +1,4 @@
+---
+api.pairmill.com:
+  :api_token: XXXXXXXXXXXXXXXXXXXX
+  :growl_enabled: true

data/spec/pair/config_spec.rb

@@ -9,15 +9,58 @@ describe Pair::Config do
 
   let(:config) { described_class.new(host, stdin, stdout) }
 
-  before do
-    config_hash = {}
-    YAML::Store.stub!(:new => config_hash)
-    def config_hash.transaction
-      yield
+  describe "when accessing a proper configuration yml" do
+    before do
+      yaml_store = YAML::Store.new("spec/fixtures/config/rspec.pair.yml")
+      YAML::Store.stub!(:new).and_return(yaml_store)
+    end
+
+    it "returns the api_token" do
+      Pair::Config.new.api_token.should == "XXXXXXXXXXXXXXXXXXXX"
+    end
+
+    it "is growl enabled" do
+      Pair::Config.new.should be_growl_enabled
+    end
+
+    it "is ssh enabled" do
+      Pair::Config.new.should be_ssh_enabled
+    end
+  end
+
+  describe "when missing growl_enabled in the config" do
+    before do
+      yaml_store = YAML::Store.new("spec/fixtures/config/rspec_no_growl_enabled.pair.yml")
+      YAML::Store.stub!(:new).and_return(yaml_store)
+    end
+
+    it "is not growl enabled" do
+      config = Pair::Config.new
+      config.should_not be_growl_enabled
+    end
+  end
+
+  describe "when missing ssh_enabled in the config" do
+    before do
+      yaml_store = YAML::Store.new("spec/fixtures/config/rspec_no_ssh_enabled.pair.yml")
+      YAML::Store.stub!(:new).and_return(yaml_store)
+    end
+
+    it "is not ssh enabled" do
+      config = Pair::Config.new
+      config.should_not be_ssh_enabled
     end
   end
 
   context "for different hosts" do
+    before do
+      config_hash = {}
+      YAML::Store.stub!(:new => config_hash)
+      def config_hash.transaction
+        yield
+      end
+    end
+
     it "has a different set of configs for each host" do
       host1, host2 = "api.domain.com", "api.beta.domain.com"
       config1 = described_class.new(host1)
@@ -34,24 +77,13 @@ describe Pair::Config do
   end
 
   describe '#api_token' do
-#    context "when none is saved" do
-#      it "prompts for key to be entered" do
-#        response = "abc123"
-#        stdin << "#{response}\n"
-#        stdin.rewind
-#
-#        config.api_token.should == response
-#
-#        stdout.rewind
-#        stdout.read.should == "Please input your API token for Pair: "
-#      end
-#
-#      it "saves the key" do
-#        stdin.should_receive(:gets).once.and_return("abc123\n")
-#        config.api_token
-#        config.api_token
-#      end
-#    end
+    before do
+      config_hash = {}
+      YAML::Store.stub!(:new => config_hash)
+      def config_hash.transaction
+        yield
+      end
+    end
 
     context "when one is already saved" do
       it "returns the saved value" do

data/spec/pair/notification/dispatcher_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Pair::Notification::Dispatcher do
+  before do
+    Pair.stub_chain(:config, :growl_enabled?).and_return(false)
+  end
+
+  describe "when initializing" do
+    it "uses the STDOUT for logging by default" do
+      Pair::Notification.dispatcher.logger == STDOUT
+    end
+
+    it "uses the logger provided as a parameter" do
+      logger = mock('a logger')
+      Pair::Notification::Dispatcher.new(:logger => logger).logger.should == logger
+    end
+  end
+end

data/spec/pair/notification/o_s_x_dispatcher_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Pair::Notification::OSXDispatcher do
+  describe "when using lion" do
+    before do
+      @growl = mock('gntp', :register => true, :notify => true)
+      GNTP.stub!(:new).and_return(@growl)
+      Pair.stub_chain(:config, :growl_enabled?).and_return(true)
+      Pair::OS.stub!(:os_x?).and_return(true)
+    end
+
+    describe "when initializing" do
+      it "is an OSXDispatcher" do
+        Pair::Notification.dispatcher.class.should be(Pair::Notification::OSXDispatcher)
+      end
+
+      it "registers the application" do
+        @growl.should_receive(:register)
+        Pair::Notification.dispatcher
+      end
+    end
+
+    describe "notifications" do
+      it "includes session events" do
+        Pair::Notification::OSXDispatcher::NOTIFICATIONS.should == [
+          {:name => "Session Events", :enabled => true}
+        ]
+      end
+    end
+
+    describe "when registering an application" do
+      it "creates a growl network transfer protocol object" do
+        GNTP.should_receive(:new).and_return(@growl)
+        Pair::Notification.dispatcher
+      end
+    end
+
+    describe "sending a growl network notification" do
+      it "calls gntp notify" do
+        a_message_hash = {
+          :text => "some text", :name => "Session Events", :title => "a title",
+          :icon => "http://#{Pair::APPLICATION_DOMAIN}/test.png", :sticky => false
+        }
+
+        @growl.should_receive(:notify).with(a_message_hash)
+        dispatcher = Pair::Notification.dispatcher.gntp_notify(a_message_hash)
+      end
+    end
+  end
+end

data/spec/pair/notification_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pair::Notification do
+  describe "when using OSX lion" do
+    before do
+      @gntp = mock(GNTP, :register => true, :notify => true)
+      GNTP.stub!(:new).and_return(@gntp)
+
+      Pair::OS.stub!(:os_x?).and_return(true)
+      Pair.stub!(:config => stub(:growl_enabled? => true))
+    end
+
+    describe "when initializing" do
+      it "returns an OSXDispatcher class" do
+        Pair::Notification.dispatcher.class.should == Pair::Notification::OSXDispatcher
+      end
+
+      it "yields the OSXDispatcher class" do
+        Pair::Notification.dispatcher do |dispatcher|
+          dispatcher.should == dispatcher
+        end
+      end
+    end
+
+    describe "joining a session" do
+      it "notifies via growl notification transfer protocol" do
+        @gntp.should_receive(:notify).with({
+          :name => "Session Events", :title => "Pair Message",
+          :text => "chadwpry joined session \"SESSION_NAME\"",
+          :icon => Pair::ICON_SESSION_JOIN, :sticky => true
+        })
+        Pair::Notification.dispatcher.session_join("chadwpry", "SESSION_NAME")
+      end
+    end
+
+    describe "parting a session" do
+      it "notifies via growl notification transfer protocol" do
+        @gntp.should_receive(:notify).with({
+          :name => "Session Events", :title => "Pair Message",
+          :text => "chadwpry parted session \"SESSION_NAME\"",
+          :icon => Pair::ICON_SESSION_JOIN, :sticky => true
+        })
+        Pair::Notification.dispatcher.session_part("chadwpry", "SESSION_NAME")
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'fixture_helper'
 
-require 'pair/config'
+require 'pair'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pair
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000 -06:00
-default_executable: 
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2157594700 !ruby/object:Gem::Requirement
+  requirement: &70264343889540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +22,21 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *2157594700
+  version_requirements: *70264343889540
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: &70264343888060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264343888060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157594280 !ruby/object:Gem::Requirement
+  requirement: &70264343887120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157594280
+  version_requirements: *70264343887120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157593740 !ruby/object:Gem::Requirement
+  requirement: &70264343885680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,7 +55,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2157593740
+  version_requirements: *70264343885680
 description: Effortless remote pairing
 email:
 - me@bjeanes.com
@@ -59,6 +69,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- CHANGES
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -70,7 +81,14 @@ files:
 - lib/pair/cli/config.rb
 - lib/pair/cli/custom_errors.rb
 - lib/pair/cli/host.rb
+- lib/pair/cli/notify.rb
 - lib/pair/config.rb
+- lib/pair/notification.rb
+- lib/pair/notification/custom_errors.rb
+- lib/pair/notification/dispatcher.rb
+- lib/pair/notification/growl_logger.rb
+- lib/pair/notification/linux_dispatcher.rb
+- lib/pair/notification/o_s_x_dispatcher.rb
 - lib/pair/os.rb
 - lib/pair/session.rb
 - lib/pair/session/authorized_keys_file.rb
@@ -82,11 +100,16 @@ files:
 - spec/fixture_helper.rb
 - spec/fixtures/api_hosted_session.yml
 - spec/fixtures/api_joined_session.yml
+- spec/fixtures/config/rspec.pair.yml
+- spec/fixtures/config/rspec_no_growl_enabled.pair.yml
+- spec/fixtures/config/rspec_no_ssh_enabled.pair.yml
 - spec/fixtures/user_keys.yml
 - spec/pair/config_spec.rb
+- spec/pair/notification/dispatcher_spec.rb
+- spec/pair/notification/o_s_x_dispatcher_spec.rb
+- spec/pair/notification_spec.rb
 - spec/pair/session/authorized_keys_file_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://www.pairmill.com
 licenses: []
 post_install_message: 
@@ -107,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Pair with remote programmers with a single command.
@@ -115,7 +138,13 @@ test_files:
 - spec/fixture_helper.rb
 - spec/fixtures/api_hosted_session.yml
 - spec/fixtures/api_joined_session.yml
+- spec/fixtures/config/rspec.pair.yml
+- spec/fixtures/config/rspec_no_growl_enabled.pair.yml
+- spec/fixtures/config/rspec_no_ssh_enabled.pair.yml
 - spec/fixtures/user_keys.yml
 - spec/pair/config_spec.rb
+- spec/pair/notification/dispatcher_spec.rb
+- spec/pair/notification/o_s_x_dispatcher_spec.rb
+- spec/pair/notification_spec.rb
 - spec/pair/session/authorized_keys_file_spec.rb
 - spec/spec_helper.rb