scamp 1.2.0 → 2.0.0.pre

data/spec/spec_helper.rb

@@ -1,7 +1,29 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 require File.expand_path("../lib/scamp", File.dirname(__FILE__))
+require File.expand_path("../lib/scamp/adapter", File.dirname(__FILE__))
+require File.expand_path("../lib/scamp/message", File.dirname(__FILE__))
 
+require 'mocha'
 require 'webmock/rspec'
 
 RSpec.configure do |config|
   config.mock_framework = :mocha
-end
+end
+
+
+class RspecAdapter < Scamp::Adapter
+  class Context;end
+
+  def speak! msg
+    push [Context.new, Scamp::Message.new(self, :body => msg)]
+  end
+
+  def connect!
+    # noop!
+  end
+end

metadata

@@ -1,136 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: scamp
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.pre
 platform: ruby
 authors:
 - Will Jessop
+- Adam Holt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0.rc.4
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: em-http-request
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 description: Eventmachine based Campfire bot framework
 email:
 - will@willj.net
+- me@adamholt.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
-- examples/bot.rb
+- examples/v2.rb
 - lib/scamp.rb
-- lib/scamp/action.rb
-- lib/scamp/connection.rb
+- lib/scamp/adapter.rb
 - lib/scamp/matcher.rb
-- lib/scamp/messages.rb
-- lib/scamp/rooms.rb
-- lib/scamp/users.rb
+- lib/scamp/matches.rb
+- lib/scamp/message.rb
+- lib/scamp/plugin.rb
 - lib/scamp/version.rb
 - scamp.gemspec
+- spec/lib/adapter_spec.rb
+- spec/lib/matcher_spec.rb
+- spec/lib/matches_spec.rb
+- spec/lib/message_spec.rb
+- spec/lib/plugin_spec.rb
 - spec/lib/scamp_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/wjessop/Scamp
@@ -142,20 +134,25 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Eventmachine based Campfire bot framework
 test_files:
+- spec/lib/adapter_spec.rb
+- spec/lib/matcher_spec.rb
+- spec/lib/matches_spec.rb
+- spec/lib/message_spec.rb
+- spec/lib/plugin_spec.rb
 - spec/lib/scamp_spec.rb
 - spec/spec_helper.rb

data/examples/bot.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), '../lib')
-
-require 'scamp'
-
-scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "37s")
-
-scamp.behaviour do
-  # Match some regex limited to a room condition based on a room id
-  match /^room id (.+)$/, :conditions => {:room => 401839} do
-    # Reply in the current room
-    say "Match some regex limited to a room condition based on a room id"
-  end
-  
-  # Limit a match to a room condition based on a string
-  match "room name check", :conditions => {:room => "Monitoring"} do
-    say "Limit a match to a room condition based on a string"
-  end
-  
-  # Limit a match to a user condition based on a string
-  match /^user name (.+)$/, :conditions => {:user => "Will Jessop"} do
-    say "Limit a match to a user condition based on a string"
-  end
-  
-   # Limit a match to a user condition based on a string
-   match "user id check", :conditions => {:user => 774016} do
-     say "Limit a match to a user condition based on an ID"
-   end
-   
-   # Limit a match to a room & user condition combined
-   match /^something (.+)$/, :conditions => {:room => "Monitoring", :user => "Will Jessop"} do
-     # Reply in the current room
-     say "Limit a match to a room & user condition combined"
-   end
-     
-   # Match text with a regex, access the captures from the match object
-   match /^repeat (\w+), (\w+)$/ do
-     say "You said #{matches[0]} and #{matches[1]}"
-   end
-   
-   # Match text with a regex, access the named captures as a method
-   match /^say (?<yousaid>.+)$/ do
-     say "You said #{yousaid}"
-   end
-   
-   # Simple string match, interpolating the room and user in response.
-   match "something" do |data|
-     # Send the response to a different room
-     say "#{user} said something in room #{room}", "Robot Army"
-     
-     # Send the response to a different room, using the room ID
-     say "#{user} said something in room #{room}", 293788
-     
-     # Send the response to the originating room
-     say "#{user} said something in room #{room}"
-   end
-   
-   # Play some sounds
-   match "ohmy" do
-     play "yeah"
-     play "drama"
-   end
-   
-   match "multi-condition match", :conditions => {:room => [401839, "Monitoring"], :user => ["Will Jessop", "Noah Lorang"]} do
-     # Reply in the current room
-     say "multi-condition match"
-   end
-end
-
-# FIXME: this does if the room doesn't exist. Need a better error.
-scamp.connect!([293788, "Monitoring"])

data/lib/scamp/action.rb

@@ -1,70 +0,0 @@
-#
-# Actions are run in the context of a Scamp::Action.
-# This allows us to make room, user etc. methods
-# available on a per-message basis
-#
-
-# {:room_id=>401839, :created_at=>"2011/09/10 00:23:19 +0000", :body=>"something", :id=>408089344, :user_id=>774016, :type=>"TextMessage"}
-
-class Scamp
-  class Action
-    
-    attr_accessor :matches, :bot
-    
-    def initialize(bot, action, message)
-      @bot = bot
-      @action = action
-      @message = message
-    end
-    
-    def matches=(match)
-      @matches = match[1..-1]
-      match.names.each do |name|
-        name_s = name.to_sym
-        self.class.send :define_method, name_s do
-          match[name_s]
-        end
-      end if match.respond_to?(:names) # 1.8 doesn't support named captures
-    end
-    
-    def room_id
-      @message[:room_id]
-    end
-    
-    def room
-      bot.room_name_for @message[:room_id]
-    end
-    
-    def user
-      bot.username_for(@message[:user_id])
-    end
-    
-    def user_id
-      @message[:user_id]
-    end
-    
-    def message
-      @message[:body]
-    end
-    
-    def run
-      self.instance_eval &@action
-    end
-    
-    def command_list
-      bot.command_list
-    end
-    
-    def say(msg, room_id_or_name = room_id)
-      bot.say(msg, room_id_or_name)
-    end
-
-    def paste(msg, room_id_or_name = room_id)
-      bot.paste(msg, room_id_or_name)
-    end
-
-    def play(sound, room_id_or_name = room_id)
-      bot.play(sound, room_id_or_name)
-    end
-  end
-end

data/lib/scamp/connection.rb

@@ -1,32 +0,0 @@
-class Scamp
-  module Connection
-    private
-    
-    def connect(api_key, room_list, &blk)
-      EventMachine.run do
-        
-        # Check for rooms to join, and join them
-        EventMachine::add_periodic_timer(5) do
-          while id = @rooms_to_join.pop
-            join_and_stream(id)
-          end
-        end
-        
-        populate_room_list do
-          logger.debug "Adding #{room_list.join ', '} to list of rooms to join"
-          @rooms_to_join = room_list.map{|c| room_id(c) }
-
-          # Call a post connection block
-          if block_given?
-            yield
-          end
-        end
-        
-        # populate bot data separately, in case we are ignoring ourselves
-        fetch_data_for('me')
-        
-      end
-    end
-      
-  end
-end

data/lib/scamp/messages.rb

@@ -1,35 +0,0 @@
-class Scamp
-  module Messages
-    
-    def say(message, room_id_or_name)
-      send_message(room_id_or_name, message, "Textmessage")
-    end
-
-    def paste(message, room_id_or_name)
-      send_message(room_id_or_name, message, "PasteMessage")
-    end
-
-    def play(sound, room_id_or_name)
-      send_message(room_id_or_name, sound, "SoundMessage")
-    end
-    
-    private
-    
-    #  curl -vvv -H 'Content-Type: application/json' -d '{"message":{"body":"Yeeeeeaaaaaahh", "type":"Textmessage"}}' -u API_KEY:X https://37s.campfirenow.com/room/293788/speak.json
-    def send_message(room_id_or_name, payload, type)
-      # post 'speak', :body => {:message => {:body => message, :type => type}}.to_json
-      room_id = room_id(room_id_or_name)
-      url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/speak.json"
-      http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}, :body => Yajl::Encoder.encode({:message => {:body => payload, :type => type}})
-      http.errback { logger.error "Couldn't connect to #{url} to post message \"#{payload}\" to room #{room_id}" }
-      http.callback {
-        if [200,201].include? http.response_header.status
-          logger.debug "Posted message \"#{payload}\" to room #{room_id}"
-        else
-          logger.error "Couldn't post message \"#{payload}\" to room #{room_id} using url #{url}, http response from the API was #{http.response_header.status}"
-        end
-      }
-    end
-      
-  end
-end

data/lib/scamp/rooms.rb

@@ -1,116 +0,0 @@
-class Scamp
-  module Rooms
-    # TextMessage (regular chat message),
-    # PasteMessage (pre-formatted message, rendered in a fixed-width font),
-    # SoundMessage (plays a sound as determined by the message, which can be either “rimshot”, “crickets”, or “trombone”),
-    # TweetMessage (a Twitter status URL to be fetched and inserted into the chat)
-
-    def upload
-    end
-    
-    def join(room_id)
-      logger.info "Joining room #{room_id}"
-      url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/join.json"
-      http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}
-      
-      http.errback { logger.error "Error joining room: #{room_id}" }
-      http.callback {
-        yield if block_given?
-      }
-    end
-
-    def room_id(room_id_or_name)
-      if room_id_or_name.is_a? Integer
-        return room_id_or_name
-      else
-        return room_id_from_room_name(room_id_or_name)
-      end
-    end
-    
-    def room_name_for(room_id)
-      data = room_cache_data(room_id)
-      return data["name"] if data
-      room_id.to_s
-    end
-    
-    private
-    
-    def room_cache_data(room_id)
-      return room_cache[room_id] if room_cache.has_key? room_id
-      fetch_room_data(room_id)
-      return false
-    end
-    
-    def populate_room_list
-      url = "https://#{subdomain}.campfirenow.com/rooms.json"
-      http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { logger.error "Couldn't connect to url #{url} to fetch room list" }
-      http.callback {
-        if http.response_header.status == 200
-          logger.debug "Fetched room list"
-          new_rooms = {}
-          Yajl::Parser.parse(http.response)['rooms'].each do |c|
-            new_rooms[c["name"]] = c
-          end
-          # No idea why using the "rooms" accessor here doesn't
-          # work but accessing the ivar directly does. There's
-          # Probably a bug.
-          @rooms = new_rooms # replace existing room list
-          yield if block_given?
-        else
-          logger.error "Couldn't fetch room list with url #{url}, http response from API was #{http.response_header.status}"
-        end
-      }
-    end
-
-    def fetch_room_data(room_id)
-      url = "https://#{subdomain}.campfirenow.com/room/#{room_id}.json"
-      http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { logger.error "Couldn't connect to #{url} to fetch room data for room #{room_id}" }
-      http.callback {
-        if http.response_header.status == 200
-          logger.debug "Fetched room data for #{room_id}"
-          room = Yajl::Parser.parse(http.response)['room']
-          room_cache[room["id"]] = room
-
-          room['users'].each do |u|
-            update_user_cache_with(u["id"], u)
-          end
-        else
-          logger.error "Couldn't fetch room data for room #{room_id} with url #{url}, http response from API was #{http.response_header.status}"
-        end
-      }
-    end
-    
-    def join_and_stream(id)
-      join(id) do
-        logger.info "Joined room #{id} successfully"
-        fetch_room_data(id)
-        stream(id)
-      end
-    end
-    
-    def stream(room_id)
-      json_parser = Yajl::Parser.new :symbolize_keys => true
-      json_parser.on_parse_complete = method(:process_message)
-      
-      url = "https://streaming.campfirenow.com/room/#{room_id}/live.json"
-      # Timeout per https://github.com/igrigorik/em-http-request/wiki/Redirects-and-Timeouts
-      http = EventMachine::HttpRequest.new(url, :connect_timeout => 20, :inactivity_timeout => 0).get :head => {'authorization' => [api_key, 'X']}
-      http.errback { logger.error "Couldn't stream room #{room_id} at url #{url}" }
-      http.callback { logger.info "Disconnected from #{url}"; rooms_to_join << room_id}
-      http.stream do |chunk| 
-        begin
-          json_parser << chunk  
-        rescue Yajl::ParseError => e
-          logger.error "Couldn't parse room data for room #{room_id} with url #{url}, http response data was #{chunk[0..50]}..."
-        end
-      end
-    end
-
-    def room_id_from_room_name(room_name)
-      logger.debug "Looking for room id for #{room_name}"
-      rooms[room_name]["id"]
-    end
-  end
-end

data/lib/scamp/users.rb

@@ -1,51 +0,0 @@
-class Scamp
-  module Users
-    # Return the user_id if we haven't got the real name and
-    # kick off a user data fetch
-    def username_for(user_id)
-      if cached_user?(user_id)
-        user_cache[user_id]["name"]
-      else
-        fetch_data_for(user_id)
-        user_id.to_s
-      end
-    end
-
-    def is_me?(user_id)
-      if user_cache['me']
-        user_cache['me']['id'] == user_id
-      else
-        fetch_data_for('me')
-        false
-      end
-    end
-
-    def cached_user? user_id
-      user_cache[user_id] != nil
-    end
-
-  private
-
-    def fetch_data_for(user_id)
-      return unless user_id
-      url = "https://#{subdomain}.campfirenow.com/users/#{user_id}.json"
-      http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json"})
-      http.callback do
-        if http.response_header.status == 200
-          logger.debug "Got the data for #{user_id}"
-          update_user_cache_with(user_id, Yajl::Parser.parse(http.response)['user'])
-        else
-          logger.error "Couldn't fetch user data for user #{user_id} with url #{url}, http response from API was #{http.response_header.status}"
-        end
-      end
-      http.errback do
-        logger.error "Couldn't connect to #{url} to fetch user data for user #{user_id}"
-      end
-    end
-    
-    def update_user_cache_with(user_id, data)
-      logger.debug "Updated user cache for #{data['name']}"
-      user_cache[user_id] = data
-    end
-  end
-end