botolo 0.10.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3700d7909e38446f210f833a5056d4b16f9f84ae
-  data.tar.gz: 14ef0e0ee8af888d8c4c7f82bee3f6f266c3057f
+  metadata.gz: d26a145e0b3ac102c30cf98e2ce8a45b25775149
+  data.tar.gz: 9655334f33005b852effe442d23142da14883175
 SHA512:
-  metadata.gz: 347960ca6554b41963cd1075001df23de440e0483f8536052998bdf53460e744223f474ae7b4292831a12035fa2c506122d9204a5fc1fb352e7f30adcaeb8a35
-  data.tar.gz: 62bae3351919d3093e4dab14c4254cc3ed0ab6ec2f1177531859e1f947b3427170d0299f7581156bb5ad35c1ff8986c6b91077bc9463388d0f1219296e3b0b2a
+  metadata.gz: de587e1e239f1ab995b149936377168ffa13dd0ef3903df6c608bce8c119133902c6f351086518cd3b3fc4cf32f29c7a0e635b5a7dc4eba084049bec5b768e98
+  data.tar.gz: 071885a1b089208ef848deac5c487f02d6d26d36bcee5ffb7939abd68fc8320e9a6fa06357bb60feffd35e4f5cdf4fb4522db6925e5a6eafa44098705b33b23c

data/README.md

@@ -1,6 +1,8 @@
 # Botolo
 
-TODO: Write a gem description
+Botolo is an engine for bots written in ruby. With botolo you must take care
+only about writing actions your bot must implement and then the engine will
+execute them for you.
 
 ## Installation
 
@@ -18,7 +20,100 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+For creating a great bot you have to describe in a YAML configuration file the
+Bot behaviour and in a separate ruby class you must implement the methods your
+bot must carry on.
+
+Let's see how to create a very dummy bot saying _foo_ every 3 seconds and
+saying _hello_ every 5 seconds. 
+
+You have to write a config.yaml file containing the action schedule and some
+very basic information about your bot.
+
+``` 
+verbose: true
+
+bot:
+  name: dummy-bot
+  version: 1.0
+  email: paolo@codesake.com
+  # This overrides any behaviour file passed as argument
+  behaviour: dummy-bot.rb
+
+twitter:
+  enabled: no
+task:
+  - { schedule: every 5 s, action: say_hello }
+  - { schedule: every 3 s, action: say_foo }
+``` 
+
+Botolo expects to find in the current directory a file named dummy-bot.rb
+implementing the two methods (say\_hello and say\_foo) it has to run based upon
+this schedule. 
+There is a **big** constraint: your ruby file must be a Botolo::Bot::Behaviour
+class. It must also implement an initialize method with an Hash parameter
+engine will use to pass options to the bot.
+
+It will be used in the future to implement some form of communication between
+the main process and threads, useful to provide a centralized console about
+what's going on on your bot.
+
+Let's see our dummy bot behaviour:
+
+``` 
+module Botolo
+  module Bot
+    class Behaviour
+      def initialize(options={})
+      end
+
+      def say_hello
+        puts "hello"
+      end
+
+      def say_foo
+        puts "foo"
+      end
+    end
+  end
+end
+``` 
+
+It's easy, isn't it!?! 
+
+Now, all you have to do is running the botolo command specifying the config
+file as parameter. Remember to put the behaviour class in the same directory of
+your YAML file.
+
+``` 
+$ botolo config.yaml
+botolo:9: warning: already initialized constant OpenSSL::SSL::VERIFY_PEER 
+[*] dummy-bot v1.0 is starting up at 08:31:31
+08:31:31: 2 tasks loaded
+08:31:31: using ./dummy-bot.rb as bot behaviour
+08:31:31: dummy-bot is online
+08:31:31: entering main loop
+08:31:31: hello
+08:31:31: foo
+08:31:34: foo
+08:31:36: hello
+08:31:37: foo
+08:31:40: foo
+08:31:41: hello
+08:31:43: foo
+^C08:31:46: shutting down threads
+08:31:46: pid #<Thread:0x007fa731022e18> killed
+08:31:46: pid #<Thread:0x007fa731022cd8> killed
+[*] bot is shutting down at 08:31:46
+``` 
+
+Custom written behaviour can use the global variable $logger to use botolo logging
+facilities and having the stdout/stderr prints more consistent.
+
+## Missing features
+
+A back channels for threads to communicate with the engine about action
+status.
 
 ## Contributing
 

data/bin/botolo

@@ -5,10 +5,11 @@ require 'openssl'
 require 'codesake_commons'
 
 DEFAULT_BEHAVIOUR = "./lib/botolo/bot/behaviour.rb"
+
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
 $logger  = Codesake::Commons::Logging.instance
-trap("INT")   { $logger.helo('bot is shutting down'); Kernel.exit(0) }
+trap("INT")   { @bot.stop; $logger.helo('bot is shutting down'); Kernel.exit(0) }
 
 behaviour_file = DEFAULT_BEHAVIOUR
 config_file = nil
@@ -16,10 +17,10 @@ config_file = ARGV[0] if ARGV.count == 1
 
 $logger.die "usage: botolo bot_configuration_file" if config_file.nil?
 
-bot = Botolo::Bot::Engine.new({:config=>config_file})
-$logger.log "#{bot.name} is online" if bot.online?
-$logger.log "#{bot.name} is offline" unless bot.online?
-bot.run if bot.online?
-
+@bot = Botolo::Bot::Engine.new({:config=>config_file})
+$logger.log "#{@bot.name} is online" if @bot.online?
+$logger.log "#{@bot.name} is offline" unless @bot.online?
+@bot.run if @bot.online?
+@bot.infinite_loop
 
 

data/botolo.gemspec

@@ -9,7 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Paolo Perego"]
   spec.email         = ["thesp0nge@gmail.com"]
   spec.description   = %q{botolo is a bot engine written in ruby}
-  spec.summary       = %q{botolo is a bot engine written in ruby}
+  spec.summary       = %q{botolo is a bot engine written in ruby. With botolo
+    you can focus on writing a set of actions your bot will execute every
+    amount of seconds, minutes or whatever and implement those actions. The
+    part of executing them and putting babies to sleep will be up to botolo.}
   spec.homepage      = "http://codesake.com"
   spec.license       = "MIT"
 

data/lib/botolo/bot/engine.rb

@@ -3,23 +3,23 @@ require 'yaml'
 
 module Botolo
   module Bot
-
-    # This is the main bot class, it is responsible of:
-    #   * reading configuration
-    #   * using Twitter APIs
-    #   * do something
     class Engine
 
       def initialize(options={})
         @start_time = Time.now
         @online = false
         @config = read_conf(options[:config])
-        authenticate
+        authenticate if @config['twitter']['enabled']
+
         @tasks = @config['task']
+        @task_pids = []
+
         behaviour = File.join(".", @config['bot']['behaviour']) unless @config['bot']['behaviour'].nil? 
 
         $logger.helo "#{name} v#{version} is starting up"
         
+        $logger.log "#{@tasks.size} tasks loaded"
+
         begin
           load behaviour
           $logger.log "using #{behaviour} as bot behaviour"
@@ -51,18 +51,45 @@ module Botolo
 
       def run
         $logger.log "entering main loop"
+        @tasks.each do |task|
+          @task_pids << Thread.start do
+            start_task(task['action'], task['schedule'])
+          end
+        end
+
+      end
+
+      def infinite_loop
         while true
-          @tasks.each do |task|
-            begin 
-            @behaviour.send(task["action"].to_sym) if @behaviour.respond_to? task["action"].to_sym
-            rescue => e
-              $logger.err "#{task["action"]} failed (#{e.message})"
-            end
-            sleep calc_sleep_time(task["schedule"])
+
+        end
+      end
+
+      def start_task(name, sleep)
+        while true
+          begin 
+            @behaviour.send(name.to_sym) if @behaviour.respond_to? name.to_sym
+          rescue => e
+            $logger.err "#{name} failed (#{e.message})"
           end
+          sleep calc_sleep_time(sleep)
         end
 
       end
+
+      def stop
+        $logger.log "shutting down threads"
+        @task_pids.each do |pid|
+          Thread.kill(pid)
+          sleep 0.05
+          $logger.log "pid #{pid} killed" if ! pid.alive? 
+          $logger.err "pid #{pid} not killed" if pid.alive? 
+        end
+
+        true
+      end
+
+      
       def authenticate
         begin
           Twitter.configure do |config|

data/lib/botolo/version.rb

@@ -1,3 +1,3 @@
 module Botolo
-  VERSION = "0.10.0"
+  VERSION = "0.20.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: botolo
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Paolo Perego
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,5 +108,8 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: botolo is a bot engine written in ruby
+summary: botolo is a bot engine written in ruby. With botolo you can focus on writing
+  a set of actions your bot will execute every amount of seconds, minutes or whatever
+  and implement those actions. The part of executing them and putting babies to sleep
+  will be up to botolo.
 test_files: []