cinch-hangouts 0.0.1 → 1.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,5 +1,11 @@
 # Cinch::Plugins::Hangouts
 
+[![Gem Version](https://badge.fury.io/rb/cinch-hangouts.png)](http://badge.fury.io/rb/cinch-hangouts)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-hangouts.png)](https://gemnasium.com/bhaberer/cinch-hangouts)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-hangouts.png?branch=master)](https://travis-ci.org/bhaberer/cinch-hangouts)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-hangouts/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-hangouts?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-hangouts.png)](https://codeclimate.com/github/bhaberer/cinch-hangouts)
+
 Cinch Plugin for tracking Hangout URLs linked in the channel.
 
 ## Installation
@@ -26,7 +32,7 @@ Just add the plugin to your list:
       end
     end
 
-Then in channel use .hangouts to get notifications of the hangouts that have been linked recently.
+Then in channel use !hangouts to get notifications of the hangouts that have been linked recently.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-hangouts.gemspec

@@ -17,8 +17,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'cinch', '>= 2.0.0'
-  gem.add_dependency 'cinch-storage'
-  gem.add_dependency 'cinch-toolbox'
-  gem.add_dependency 'time-lord', '1.0.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'cinch-test'
+
+  gem.add_dependency 'cinch',         '~> 2.0.5'
+  gem.add_dependency 'cinch-storage', '~> 1.0.3'
+  gem.add_dependency 'cinch-toolbox', '~> 1.0.3'
+  gem.add_dependency 'time-lord',     '~> 1.0.1'
 end

data/lib/cinch-hangouts.rb

@@ -1,5 +1,4 @@
-require 'cinch-storage'
-require 'cinch-toolbox'
-require 'time-lord'
+require 'cinch/plugins/hangouts'
 require 'cinch/plugins/hangouts/version'
-require 'cinch/plugins/hangouts/hangouts'
+require 'cinch/plugins/hangouts/hangout'
+require 'cinch/plugins/hangouts/subscription'

data/lib/cinch/plugins/hangouts.rb

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+require 'cinch'
+require 'cinch-storage'
+require 'cinch/toolbox'
+require 'time-lord'
+
+module Cinch::Plugins
+  class Hangouts
+    include Cinch::Plugin
+    @@hangout_filename = ''
+    @@subscription_filename = ''
+
+    attr_accessor :storage
+
+    self.help = "Use .hangouts to see the info for any recent hangouts. You can also use .hangouts subscribe to sign up for notifications."
+
+    match /hangouts\z/,           method: :list_hangouts
+    match /hangouts subscribe/,   method: :subscribe
+    match /hangouts unsubscribe/, method: :unsubscribe
+
+    listen_to :channel
+
+    # This is the regex that captures hangout links in the following format:
+    #   https://plus.google.com/hangouts/_/fbae432b70a47bdf7786e53a16f364895c09d9f8
+    #
+    # The regex will need to be updated if the url scheme changes in the future.
+    HANGOUTS_REGEX = /plus\.google\.com\/hangouts\/_\/([a-f0-9]{40})/
+
+    def initialize(*args)
+      super
+      @@hangout_filename = config[:hangout_filename]           || 'yaml/hangouts.yml'
+      @@subscription_filename = config[:subscription_filename] || 'yaml/hangout_subscriptions.yml'
+
+      @expire_period     = config[:expire_period] || 120
+      @response_type     = config[:response_type] || :notice
+    end
+
+    def listen(m)
+      if hangout_id = m.message[HANGOUTS_REGEX, 1]
+        debug "#{hangout_id}"
+        if hangout = Hangout.find_by_id(hangout_id)
+          # If it's an old hangout capture a new expiration time
+          hangout.time = Time.now
+          hangout.save
+        else
+          hangout = Hangout.new(m.user.nick, hangout_id, Time.now)
+          hangout.save
+          Subscription.notify(hangout_id, @bot)
+        end
+      end
+    end
+
+    def subscribe(m)
+      nick = m.user.nick
+      if Subscription.for_user(nick)
+        msg = "You are already subscribed. "
+      else
+        sub = Subscription.new(nick)
+        sub.save
+        msg = "You are now subscribed. I will let you know when a hangout is linked. "
+      end
+      m.user.notice msg + "To unsubscribe use `.hangouts unsubscribe`."
+    end
+
+    def unsubscribe(m)
+      nick = m.user.nick
+      if Subscription.for_user(nick)
+        Subscription.for_user(nick).delete
+        msg = "You are now unsubscribed, and will no longer receive a messages. "
+      else
+        msg = "You are not subscribed. "
+      end
+      m.user.notice msg + "To subscribe use `.hangouts subscribe`."
+    end
+
+    def list_hangouts(m)
+      Hangout.delete_expired(@expire_period)
+      hangouts = Hangout.sorted
+
+      if hangouts.empty?
+        m.user.notice "No hangouts have been linked recently!"
+      else
+        m.user.notice "These hangouts have been linked in the last #{@expire_period} minutes. " +
+                   "They may or may not still be going."
+        hangouts.each do |hangout|
+          m.user.notice "#{hangout.nick} started a hangout at #{Hangout.url(hangout.id)} " +
+                     "it was last linked #{hangout.time.ago.to_words}"
+        end
+      end
+    end
+
+    def respond(m, message)
+      case @response_type
+      when :notice
+        m.user.notice message
+      when :pm
+        m.user.send message
+      end
+    end
+  end
+end

data/lib/cinch/plugins/hangouts/hangout.rb

@@ -0,0 +1,60 @@
+class Hangout < Cinch::Plugins::Hangouts
+  attr_accessor :nick, :id, :time
+
+  def initialize(nick, id, time)
+    @nick = nick
+    @id = id
+    @time = time
+  end
+
+  def save
+    storage = CinchStorage.new(@@hangout_filename)
+    storage.data[:hangouts] ||= Hash.new
+    storage.data[:hangouts][self.id] = self
+    storage.save
+  end
+
+  def to_yaml
+    { nick: @nick, id: @id, time: @time }
+  end
+
+  def self.find_by_id(id)
+    listing[id]
+  end
+
+  def self.delete_expired(expire_time)
+    return if listing.nil?
+    storage = read_file
+    storage.data[:hangouts].delete_if do |id, hangout|
+      (Time.now - hangout.time) > (expire_time * 60)
+    end
+    storage.save
+  end
+
+  def self.sorted
+    hangouts = listing.values
+    hangouts.sort! { |x,y| y.time <=> x.time }
+    return hangouts
+  end
+
+  def self.listing
+    read_file.data[:hangouts]
+  end
+
+  def self.url(id, shorten = true)
+    url = "https://plus.google.com/hangouts/_/#{id}"
+    return url unless shorten
+    Cinch::Toolbox.shorten(url)
+  end
+
+  private
+
+  def self.read_file
+    storage = CinchStorage.new(@@hangout_filename)
+    unless storage.data[:hangouts]
+      storage.data[:hangouts] = Hash.new
+      storage.save
+    end
+    storage
+  end
+end

data/lib/cinch/plugins/hangouts/subscription.rb

@@ -0,0 +1,52 @@
+class Subscription < Cinch::Plugins::Hangouts
+  attr_accessor :nick, :all_links
+
+  def to_yaml
+    { }
+  end
+
+  def initialize(nick)
+    @nick = nick
+    @all_links = false
+    save
+  end
+
+  def save
+    subs = Subscription.storage
+    subs.data[self.nick] = self
+    subs.save
+  end
+
+  def delete
+    subs = Subscription.storage
+    subs.data[self.nick] = nil
+    subs.save
+  end
+
+  def self.for_user(nick)
+    return nil unless list.key?(nick)
+    list[nick]
+  end
+
+  def self.list
+    Subscription.storage.data
+  end
+
+  def self.notify(hangout_id, bot)
+    nick = Hangout.find_by_id(hangout_id).nick
+    Subscription.list.each do |sub|
+      # Don't link the person who linked it.
+      if nick != sub.nick
+        user = Cinch::User.new(sub.nick, bot)
+        respond(user, "#{nick} just linked a new hangout at: #{Hangout.url(hangout_id)}")
+      end
+    end
+  end
+
+  private
+
+  def self.storage
+    CinchStorage.new(@@subscription_filename)
+  end
+end
+

data/lib/cinch/plugins/hangouts/version.rb

@@ -1,7 +1,7 @@
 module Cinch
   module Plugins
     class Hangouts
-      VERSION = "0.0.1"
+      VERSION = "1.0.0"
     end
   end
 end

data/spec/cinch-hangouts_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Cinch::Plugins::Hangouts do
+  include Cinch::Test
+
+  before(:each) do
+    files = { hangout_filename: '/tmp/hangout.yml',
+              subscription_filename: '/tmp/subscription.yml' }
+    files.values.each do |file|
+      File.delete(file) if File.exist?(file)
+    end
+    @bot = make_bot(Cinch::Plugins::Hangouts, files)
+  end
+
+  describe 'handling hangout links' do
+    it 'should return an error if no one has linked a hangout' do
+      get_replies(make_message(@bot, '!hangouts', { channel: '#foo' })).first.text.
+        should == "No hangouts have been linked recently!"
+    end
+
+    it 'should not capture a malformed (invalid chars) Hangout link' do
+      msg = make_message(@bot, Hangout.url('82b5cc7f76b7a%19c180416c2f509027!!d8856d', false),
+                               { :channel => '#foo' })
+      get_replies(msg).should be_empty
+      msg = make_message(@bot, '!hangouts')
+      get_replies(msg).first.text.
+        should == "No hangouts have been linked recently!"
+    end
+
+    it 'should not capture a malformed (wrong length) Hangout link' do
+      msg = make_message(@bot, Hangout.url('82b5cc', false),
+                               { :channel => '#foo' })
+      get_replies(msg).should be_empty
+      msg = make_message(@bot, '!hangouts')
+      get_replies(msg).first.text.
+        should == "No hangouts have been linked recently!"
+    end
+
+    it 'should capture a legit Hangout link and store it in @storage' do
+      msg = make_message(@bot, Hangout.url(random_hangout_id, false), { :channel => '#foo' })
+      get_replies(msg).should be_empty
+      sleep 1 # hack until 'time-lord' fix gets released
+      msg = make_message(@bot, '!hangouts')
+      reply = get_replies(msg).last.text
+      reply.should include "test started a hangout at"
+      reply.should match(/it was last linked \d seconds? ago/)
+    end
+
+    it 'should capture a legit Hangout link if it has trailing params' do
+      msg = make_message(@bot, Hangout.url(random_hangout_id + '?hl=en', false),
+                               { :channel => '#foo' })
+      get_replies(msg)
+      sleep 1 # hack until 'time-lord' fix gets released
+      msg = make_message(@bot, '!hangouts')
+      reply = get_replies(msg).last.text
+      reply.should include "test started a hangout at"
+      reply.should match(/it was last linked \d seconds? ago/)
+    end
+  end
+
+  describe 'subscriptions' do
+    it 'should allow users to subscribe' do
+      msg = make_message(@bot, '!hangouts subscribe')
+      get_replies(msg).first.text.
+        should include("You are now subscribed")
+    end
+
+    it 'should allow users to subscribe' do
+      msg = make_message(@bot, '!hangouts subscribe')
+      get_replies(msg).first.text.
+        should include("You are now subscribed")
+    end
+
+    it 'should inform users that they already subscribed' do
+      get_replies(make_message(@bot, '!hangouts subscribe'))
+      msg = make_message(@bot, '!hangouts subscribe')
+      get_replies(msg).first.text.
+        should include("You are already subscribed")
+    end
+
+    it 'should allow users to unsubscribe' do
+      get_replies(make_message(@bot, '!hangouts subscribe'))
+      msg = make_message(@bot, '!hangouts unsubscribe')
+      get_replies(msg).first.text.
+        should include("You are now unsubscribed")
+    end
+
+    it 'should inform users that they are not subscribed on an unsubscribe' do
+      msg = make_message(@bot, '!hangouts unsubscribe')
+      get_replies(msg).first.text.
+        should include("You are not subscribed.")
+    end
+
+    #it 'should notify users when a new hangout is linked' do
+    #  get_replies(make_message(@bot, '!hangouts subscribe'), { channel: '#foo', nick: 'joe' } )
+    #  msgs = get_replies(make_message(@bot, Hangout.url(random_hangout_id, false), { channel: '#foo', nick: 'josh' }))
+    #  msgs.first.should_not be_nil
+    #end
+
+    it 'should not notify users when an old hangout is relinked' do
+      get_replies(make_message(@bot, '!hangouts subscribe'), { :channel => '#foo' } )
+      get_replies(make_message(@bot, Hangout.url(random_hangout_id, false), { :channel => '#foo' }))
+      msg = make_message(@bot, Hangout.url(random_hangout_id, false), { :channel => '#foo' })
+      get_replies(msg).
+        should be_empty
+    end
+  end
+
+  def random_hangout_id
+    chars = %w{ a b c d e f 0 1 2 3 4 5 6 7 8 9 }
+    string = ''
+    40.times { string << chars[rand(chars.length)] } 
+    string
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'cinch-hangouts'
+require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-hangouts
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-04 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cinch
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch-storage
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch-toolbox
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -59,12 +59,76 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: cinch-storage
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: time-lord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
@@ -72,7 +136,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
 description: Cinch Plugin to track any Google Hangouts that are linked into the channel
@@ -83,14 +147,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cinch-hangouts.gemspec
 - lib/cinch-hangouts.rb
-- lib/cinch/plugins/hangouts/hangouts.rb
+- lib/cinch/plugins/hangouts.rb
+- lib/cinch/plugins/hangouts/hangout.rb
+- lib/cinch/plugins/hangouts/subscription.rb
 - lib/cinch/plugins/hangouts/version.rb
+- spec/cinch-hangouts_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-hangouts
 licenses: []
 post_install_message: 
@@ -111,8 +180,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Cinch Plugin for racking Google Hangouts
-test_files: []
+test_files:
+- spec/cinch-hangouts_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/lib/cinch/plugins/hangouts/hangouts.rb

@@ -1,101 +0,0 @@
-# -*- coding: utf-8 -*-
-module Cinch::Plugins
-  class Hangouts
-    include Cinch::Plugin
-
-    self.help = "Use .hangouts to see the info for any recent hangouts. You can also use .hangouts subscribe to sign up for notifications."
-
-    match /hangouts\z/,           method: :list_hangouts
-    match /hangouts subscribe/,   method: :subscribe
-    match /hangouts unsubscribe/, method: :unsubscribe
-
-    listen_to :channel
-
-    def initialize(*args)
-      super
-      @storage = CinchStorage.new(config[:filename] || 'yaml/hangouts.yml')
-      @storage.data[:hangouts] ||= {}
-      @storage.data[:subscriptions] ||= []
-      @expire_period = config[:expire_period] || 120
-    end
-
-    def listen(m)
-      # This is the regex that captures hangout links in the following format:
-      #
-      #   https://plus.google.com/hangouts/_/fbae432b70a47bdf7786e53a16f364895c09d9f8
-      #
-      # The regex will need to be updated if the url scheme changes in the future.
-      if m.message.match(/plus.google.com\/hangouts\//)
-        hangout_id = m.message[/[^\/?]{40}/, 0]
-        unless hangout_id.nil?
-          if @storage.data[:hangouts].key?(hangout_id)
-            @storage.data[:hangouts][hangout_id][:time] = Time.now
-          else
-            @storage.data[:hangouts][hangout_id] = {:user => m.user.nick, :time => Time.now}
-          end
-
-          synchronize(:hangout_save) do
-            @storage.save
-          end
-
-         @storage.data[:subscriptions].each do |user|
-            unless m.user.nick == user
-              Cinch::User.new(user, @bot).notice "#{m.user.nick} just linked a new hangout at #{hangout_url(hangout_id)}!"
-            end
-          end
-        end
-      end
-    end
-
-    private
-
-    def list_hangouts(m)
-      hangouts = sort_and_expire
-      if hangouts.empty?
-        m.user.notice "No hangouts have been linked recently!"
-      else
-        m.user.notice "These hangouts have been linked in the last #{@expire_period} minutes. They may or may not still be going."
-        hangouts.each do |hangout|
-          m.user.notice "#{hangout[:user]} started a hangout #{hangout[:time].ago.to_words} ago at #{hangout_url(hangout[:id])}"
-        end
-      end
-    end
-
-    def subscribe(m)
-      nick = m.user.nick
-      if @storage.data[:subscriptions].include?(nick)
-        m.user.notice "You are already subscribed, to unsubscribe use `.hangouts unsubscribe`"
-      else
-        @storage.data[:subscriptions] << nick
-        synchronize(:hangout_save) do
-          @storage.save
-        end
-        m.user.notice "You are now subscribed, and will receive a message when a *new* hangout is linked. To unsubscribe use `.hangouts unsubscribe`."
-      end
-    end
-
-    def unsubscribe(m)
-      nick = m.user.nick
-      if @storage.data[:subscriptions].include?(nick)
-        @storage.data[:subscriptions].delete(nick)
-        synchronize(:hangout_save) do
-          @storage.save
-        end
-        m.user.notice "You are now unsubscribed, and will no longer receive a messages. To resubscribe use `.hangouts subscribe`."
-      else
-        m.user.notice "You are not subscribed, to subscribe use `.hangouts subscribe`"
-      end
-    end
-
-    def sort_and_expire
-      hangouts = @storage.data[:hangouts].each_pair.map { |x,y| y[:id] = x;y }
-      hangouts.delete_if { |h| Time.now - h[:time] > @expire_period * 60 }
-      hangouts.sort! { |x,y| y[:time] <=> x[:time] }
-      return hangouts
-    end
-
-    def hangout_url(id)
-      return Cinch::Toolbox.shorten("https://plus.google.com/hangouts/_/#{id}")
-    end
-  end
-end