botolo 0.32.9 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbeb05fdb3cf739092a995a69966641a8f22e7b7
-  data.tar.gz: 34c717174161db5935f779b1052688f3e88cc811
+  metadata.gz: 5db849cbb8017808accaae72cc3f6b430fcf963f
+  data.tar.gz: f00801595c7363ad64c12ac6cf1311b0b42a846c
 SHA512:
-  metadata.gz: 08396913b0678a35bafaa2ab52c12721523c509289f93da373648a3f8522b2417757ef7b80b2770ad7644c8abab3f5f2f173cd38e39416f6a20833f2dfcd7c71
-  data.tar.gz: 02941872a2b6f03cbfa002877862e397a4004740030bcb95fbaf278733264776d5009e320603f2e5c45e451711f285d68a031c3f34f40e747b677a67eb21ad21
+  metadata.gz: f9a3246e555a4895cce738cc2260f68945f1f8c3579ad5eb88bdd972ff1672673222a57dab80001fdede898b9ed5be8990fa4ea0ec48b3a709b7f8aafdcbacb7
+  data.tar.gz: 45a383398b60148e2dcf444c94ed47fcae0acfcab719cb51550b37dd691ac8283fc71437b76e02d9a24383fc5cbe89f308974a794d5c61dd74083bb8319eb5d6

data/.ruby-gemset

@@ -0,0 +1 @@
+botolo

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.3

data/README.md

@@ -39,6 +39,7 @@ bot:
   email: paolo@codesake.com
   # This overrides any behaviour file passed as argument
   behaviour: dummy-bot.rb
+  logfile: dummy-bot.log
 
 twitter:
   enabled: no
@@ -110,10 +111,49 @@ botolo:9: warning: already initialized constant OpenSSL::SSL::VERIFY_PEER
 Custom written behaviour can use the global variable $logger to use botolo logging
 facilities and having the stdout/stderr prints more consistent.
 
+The same ruby class can have some social integration adding twitter support in
+its behaviour file.
+
+Since botolo version 0.50, more twitter accounts are supported and
+Botolo::API::Twitter are introduced to provide basic services to your bots.
+
+```
+verbose: true
+
+bot:
+  name: dummy-bot
+  version: 1.0
+  email: paolo@codesake.com
+  behaviour: dummy-bot.rb
+
+twitter:
+  enabled: yes
+  accounts:
+    - { name: first, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+    - { name: second, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+    - { name: third, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+
+task:
+  - { schedule: every 5 s, action: say_hello }
+  - { schedule: every 3 s, action: say_foo }
+  - { schedule: every 1 h, action: tweet_hello }
+```
+
+The tweet\_hello routine is very simple:
+
+```
+def tweet_hello
+  return "" if $twitter_api.nil?
+  $twitter_api.tweet("hello")
+end
+```
+
+The ```$twitter_api``` ojeect is something provided by the engine, so it's very
+easy for bot writers.
+
 ## Missing features
 
-A back channels for threads to communicate with the engine about action
-status.
+Other social network integration, mainly facebook.
 
 ## Contributing
 

data/bin/botolo

@@ -3,6 +3,13 @@
 require 'botolo'
 require 'openssl'
 require 'codesake-commons'
+require 'getoptlong'
+
+opts = GetoptLong.new(
+  [ "--debug",   "-D", GetoptLong::NO_ARGUMENT],
+  [ "--help",    "-h", GetoptLong::NO_ARGUMENT],
+  [ "--version", "-v", GetoptLong::NO_ARGUMENT ]
+)
 
 DEFAULT_BEHAVIOUR = "./lib/botolo/bot/behaviour.rb"
 BOTOLO_PID = File.join(".", "botolo.pid") 
@@ -10,8 +17,29 @@ BOTOLO_PID = File.join(".", "botolo.pid")
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
 $logger  = Codesake::Commons::Logging.instance
-$logger.filename="./codesake-bot.log"
-trap("INT")   { @bot.stop; $logger.bye; Kernel.exit(0); }
+trap("INT")   { @bot.stop; $logger.bye; File.delete(BOTOLO_PID); Kernel.exit(0); }
+
+opts.quiet=true
+debug = false
+
+begin
+  opts.each do |opt, val|
+    case opt
+    when '--version'
+      puts "#{Botolo::VERSION}"
+      Kernel.exit(0)
+    when '--help'
+      puts "I'll put an help here... promise"
+      Kernel.exit(0)
+    when '--debug'
+      debug = true
+    end
+  end
+rescue GetoptLong::InvalidOption => e
+  $logger.helo "botolo", Botolo::VERSION, BOTOLO_PID
+  $logger.err e.message
+  Kernel.exit(-1)
+end
 
 behaviour_file = DEFAULT_BEHAVIOUR
 config_file = nil
@@ -22,10 +50,15 @@ $logger.die "usage: botolo bot_configuration_file" if config_file.nil?
 $logger.helo "botolo", Botolo::VERSION, BOTOLO_PID
 
 @bot = Botolo::Bot::Engine.new({:config=>config_file})
-$logger.log "#{@bot.name} is online" if @bot.online?
+$logger.log "#{@bot.name} is online"  if @bot.online?
 $logger.log "#{@bot.name} is offline" unless @bot.online?
-@bot.run if @bot.online?
-  # Process.daemon(true, true)
+
+if debug
+  $logger.debug "forcing #{@bot.name} run"
+  @bot.run
+else
+  @bot.run if @bot.online?
+end
 @bot.infinite_loop
 
 

data/botolo.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency "twitter"
-  spec.add_dependency "codesake-commons"
+  spec.add_dependency "twitter", "~> 5.11.0"
+  spec.add_dependency "codesake-commons", "~> 1.0.0"
 end

data/examples/config.yaml

@@ -0,0 +1,15 @@
+verbose: true
+
+bot:
+  name: dummy-bot
+  version: 1.0
+  email: paolo@codesake.com
+  logfile: dummy_log.log
+  behaviour: dummy_bot.rb
+
+twitter:
+  enabled: no
+
+task:
+  - { schedule: every 5 s, action: say_hello }
+  - { schedule: every 3 s, action: say_foo }

data/examples/dummy_bot.rb

@@ -0,0 +1,22 @@
+module Botolo
+  module Bot
+    class Behaviour
+      def initialize(options={})
+      end
+
+      def say_hello
+        puts "hello"
+      end
+
+      def say_foo
+        puts "foo"
+      end
+
+      def tweet_hello
+        return "" if $twitter_api.nil?
+        $twitter_api.tweet("hello")
+      end
+    end
+  end
+end
+

data/examples/dummy_multiple_twitters.yaml

@@ -0,0 +1,19 @@
+verbose: true
+
+bot:
+  name: dummy-bot
+  version: 1.0
+  email: paolo@codesake.com
+  behaviour: dummy_bot.rb
+
+twitter:
+  enabled: yes
+  accounts:
+    - {name: first, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+    - {name: second, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+    - {name: third, consumer_key: "AAAAAAAAAAAAAAAAAAAAAAAAA", consumer_secret: "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", oauth_token: "999999999-CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC", oauth_token_secret: "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"}
+
+task:
+  - { schedule: every 5 s, action: say_hello }
+  - { schedule: every 3 s, action: say_foo }
+  - { schedule: every 1 h, action: tweet_hello }

data/lib/botolo.rb

@@ -1,2 +1,4 @@
 require "botolo/version"
+require "botolo/api/blog"
+require "botolo/api/tweet"
 require "botolo/bot/engine"

data/lib/botolo/api/blog.rb

@@ -0,0 +1,57 @@
+require 'rss'
+
+module Botolo
+  module API
+    class Blog
+
+      def initialize(options={})
+        @url = options[:url]
+        @tweet = options[:tweet_api]
+      end
+
+      def refresh_rss
+        rss = nil
+
+        open("#{@url}/feed.xml") do |http|
+          response = http.read
+          rss = RSS::Parser.parse(response, false)
+        end
+        @feed = []
+        rss.items.each_with_index do |item, i|
+          @feed << {:title=>item.title.content, :link=>item.link.href}
+        end
+        $logger.log "#{@feed.size} elements loaded from feed"
+      end
+
+      def tweet_random_posts(limit = 3, hashtags="")
+        return nil if @feed.nil? || @feed.size == 0
+        (0..limit-1).each do |l|
+          post = @feed[SecureRandom.random_number(@feed.size)]
+          m = "\"#{post[:title]}\" (#{post[:link]}) #{hashtags}"
+          $logger.debug "#{m} - #{m.length}"
+          begin
+            @tweet.tweet(m)
+            $logger.debug "tweet sent!"
+          rescue => e
+            $logger.err("error tweeting #{m}: #{e.message}")
+          end
+          sleep(10)
+
+        end
+      end
+
+      def promote_latest(hashtags="")
+        return nil if @feed.nil? || @feed.size == 0
+        post = @feed[0]
+        m = "\"#{post[:title]}\" (#{post[:link]}) #blog #sicurezza #informatica."
+        $logger.debug "#{m} - #{m.length}"
+        begin
+          @tweet.tweet(m)
+        rescue => e
+          $logger.err("error tweeting #{m}: #{e.message}")
+        end
+      end
+
+    end
+  end
+end

data/lib/botolo/api/tweet.rb

@@ -0,0 +1,77 @@
+require 'twitter'
+require 'singleton'
+
+module Botolo
+  module API
+    class Tweet
+
+      # twitters is a twitter client array read from configuration file and
+      # used to access the social network for a given account.
+      attr_reader :twitters
+      include Singleton
+
+      def authenticate(config)
+        @twitters = []
+        config['accounts'].each do |account|
+          a=Hash.new
+          a[:name] = account['name']
+          begin
+            a[:client] = Twitter::REST::Client.new do |config|
+              config.consumer_key         = account['consumer_key']
+              config.consumer_secret      = account['consumer_secret']
+
+              config.access_token         = account['access_token']        unless account['access_token'].nil?
+              config.access_token_secret  = account['access_token_secret'] unless account['access_token_secret'].nil?
+            end
+          rescue Exception => e
+            $logger.err e.message
+          end
+
+        @twitters << a
+      end
+
+      @twitters
+    end
+
+    def tweet(name=nil, msg)
+      return nil if msg.empty?
+      @twitters.each do |t|
+        t[:client].update(msg) if (name.nil? or (!name.nil? and name == t[:name]))
+      end
+      return msg
+    end
+
+    def retweet(name=nil, msg)
+      return nil if msg.empty?
+      @twitters.each do |t|
+        t[:client].retweet(msg) if (name.nil? or (!name.nil? and name == t[:name]))
+      end
+      return msg
+    end
+
+    def find_and_retweet_topic(limit = 5, topic)
+      list = []
+      @twitters.each do |tt|
+        list << tt[:client].search("#appsec").to_a
+      end
+
+      unless list.nil?
+        (0..limit-1).each do |l|
+          t = list[SecureRandom.random_number(list.count)]
+          $logger.debug "retwitting #{t["from_user"]}: #{t["text"]}"
+          begin
+            @twitters.each do |t|
+              t[:client].retweet(msg) if (name.nil? or (!name.nil? and name == t[:name]))
+            end
+          rescue => e
+              $logger.err("error tweeting #{t["text"]}: #{e.message}")
+            end
+            sleep(15)
+          end
+        end
+      end
+
+
+    end
+  end
+end

data/lib/botolo/bot/engine.rb

@@ -1,4 +1,3 @@
-require 'twitter'
 require 'yaml'
 
 module Botolo
@@ -9,26 +8,36 @@ module Botolo
         @start_time = Time.now
         @online = false
         @config = read_conf(options[:config])
-        $twitter_client = nil
-        authenticate if @config['twitter']['enabled']
+        $twitter_api = nil
+
+        behaviour_path = File.dirname(options[:config])
+
+        if @config['twitter']['enabled']
+          $twitter_api = Botolo::API::Tweet.instance
+          $twitter_api.authenticate(@config['twitter']) 
+        end
 
         @tasks = @config['task']
         @task_pids = []
 
-        behaviour = File.join(".", @config['bot']['behaviour']) unless @config['bot']['behaviour'].nil?
+        behaviour = File.join(behaviour_path, @config['bot']['behaviour']) unless @config['bot']['behaviour'].nil?
 
         $logger.helo name, version
+        $logger.filename = File.join(".", logfile) unless logfile.nil?
+
         $logger.log "#{@tasks.size} tasks loaded"
 
         begin
           load behaviour
           $logger.log "using #{behaviour} as bot behaviour"
           @behaviour = Botolo::Bot::Behaviour.new(@config)
+          @start_time = Time.now
         rescue => e
           $logger.err(e.message)
           require 'botolo/bot/behaviour'
           $logger.log "reverting to default dummy behaviour"
           @behaviour = Botolo::Bot::Behaviour.new(@config)
+          @start_time = Time.now
         end
       end
 
@@ -57,11 +66,25 @@ module Botolo
 
       def infinite_loop
         loop do
-          sleep(3600) # => 1 d
-          $logger.log " --- mark --- "
+          sleep(3600) # => 1 h
+          $logger.log " --- mark --- (bot: #{@behaviour.name}, uptime: #{uptime})"
         end
       end
 
+      def uptime
+        seconds_diff = (Time.now - @start_time).to_i.abs
+
+        days = seconds_diff / 86400
+        seconds_diff -= days * 86400
+
+        hours = seconds_diff / 3600
+        seconds_diff -= hours * 3600
+
+        minutes = seconds_diff / 60
+
+        "#{days.to_s} days, #{hours.to_s.rjust(2, '0')}:#{minutes.to_s.rjust(2, '0')}"
+      end
+
       def start_task(name, sleep)
         while true
           begin 
@@ -86,24 +109,14 @@ module Botolo
         true
       end
 
-      def authenticate
-        begin
-          $twitter_client = Twitter::REST::Client.new do |config|
-            config.consumer_key = @config['twitter']['consumer_key']
-            config.consumer_secret = @config['twitter']['consumer_secret']
-            config.oauth_token = @config['twitter']['oauth_token']
-            config.oauth_token_secret = @config['twitter']['oauth_token_secret']
-          end
-          @online = true
-        rescue Exception => e
-          $logger.err e.message
-        end
-      end
-
       def online?
         @online
       end
 
+      def logfile
+        return @config['bot']['logfile']
+      end
+
       def name
         return @config['bot']['name']
       end

data/lib/botolo/version.rb

@@ -1,3 +1,3 @@
 module Botolo
-  VERSION = "0.32.9"
+  VERSION = "0.50.0"
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: botolo
 version: !ruby/object:Gem::Version
-  version: 0.32.9
+  version: 0.50.0
 platform: ruby
 authors:
 - Paolo Perego
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.11.0
 - !ruby/object:Gem::Dependency
   name: codesake-commons
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 description: botolo is a bot engine written in ruby
 email:
 - thesp0nge@gmail.com
@@ -74,14 +74,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/botolo
 - botolo.gemspec
+- examples/config.yaml
+- examples/dummy_bot.rb
+- examples/dummy_multiple_twitters.yaml
 - lib/botolo.rb
+- lib/botolo/api/blog.rb
+- lib/botolo/api/tweet.rb
 - lib/botolo/bot/behaviour.rb
 - lib/botolo/bot/engine.rb
 - lib/botolo/version.rb
@@ -95,17 +102,17 @@ 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'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: botolo is a bot engine written in ruby. With botolo you can focus on writing