twittbot 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145bf3689fa42e0b74cb05aa13a33708fd23d3f9
-  data.tar.gz: edc22c44e18f9466a0903e8571d2ec87ef1a6f95
+  metadata.gz: 22b58f70f78a48918691c29b693ff73a2c5f3ba0
+  data.tar.gz: def4b5eac4b779e0d38743ebc7c9df5b77653ea0
 SHA512:
-  metadata.gz: c2c06111fea59970c01c4ba73064286375d32a61ddd8d2650e08f913b7c712a8b55a72e139bf7ebad6259751260fb62ac1b2335edbd572b90e3aa52e9497e254
-  data.tar.gz: 03f7cc0f9365cbe1888870bc36d39799403f6ae9d9a1655f09743ce5696e410d8a44ebc475deb4713bdda89f839499a2ad04288d4f9b5eae8d76eea5b2b7890d
+  metadata.gz: 50277aecaa7a5db1ac8eb02fcd777def98a37204ef367174d84f125bff11a4cc7b702133a7c5a9cadeb8de07fb2e938fe46e9c759973217a7542601470387297
+  data.tar.gz: 9482a62c929960385b853dd603a222c881ba6d7b7d41c84ca7fedc015bda6526361cc2f6aa83a8baacab7dc048efd8f15228bd543ba522cc4f7ffa61c7e5ebc8

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 0.4.0
+
+* Add `twittbot cron` for interacting with the bot outside from Twittbot processes, e.g. via cron
+* Modify `retweet-bot` template to ignore retweets from ourselves
+* Add new `big-ben-clock` template which demonstrates the usage of `twittbot cron`.
+
+## 0.3.0
+
+* Add `on :load` event.
+
+## 0.2.0
+
+* Bot callbacks are now stored in an array
+
+## 0.1.2
+
+* Automatically reconnect to user streams after 5 seconds
+
+## 0.1.1
+
+* Fix EOFError occurring when streams are open for a long time
+
+## 0.1.0
+
+* Add `add-admin` and `del-admin` commands
+* Add support for direct messages
+* Add new BotPart method for commands over direct messages
+* Add a basic direct message template
+* Add ability to save config for each BotPart
+* Add example direct message command to `random-tweet` template
+
+## 0.0.1
+
+* Initial release

data/lib/twittbot/bot.rb

@@ -24,7 +24,9 @@ module Twittbot
           config: Twittbot::DEFAULT_BOT_CONFIG.merge(
               YAML.load_file(File.expand_path("./#{Twittbot::CONFIG_FILE_NAME}", @options[:current_dir]))
           ),
-          periodic: []
+          periodic: [],
+          save_config: true,
+          tasks: {}
       }.merge!(options)
 
       load_bot_code
@@ -32,7 +34,7 @@ module Twittbot
       at_exit do
         save_config
         $bot[:botparts].each { |b| b.save_config }
-      end
+      end if $bot[:save_config]
     end
 
     # Authenticates an account with Twitter.
@@ -103,7 +105,7 @@ module Twittbot
       @periodic_thread ||= Thread.new do
         loop do
           begin
-            do_periodic
+            Thread.new { do_periodic }
           rescue => _
           end
           sleep 60
@@ -117,6 +119,20 @@ module Twittbot
       @periodic_thread.join
     end
 
+    # Runs the task `task_name`.
+    # @param task_name [Symbol] The name of the task to be run.
+    def cron(task_name)
+      task = $bot[:tasks][task_name]
+      unless task
+        say "Task \"#{task_name}\" does not exist.  Use \"twittbot cron list\" for a list of available tasks."
+        return
+      end
+
+      #check_config
+      init_clients
+      task[:block].call
+    end
+
     # @param screen_name [String] the user's screen name
     # @param action [Symbol] :add or :delete
     def modify_admin(screen_name, action = :add)
@@ -137,6 +153,7 @@ module Twittbot
     # Loads the bot's actual code which is stored in the bot's +lib+
     # subdirectory.
     def load_bot_code
+      load_special_tasks
       files = Dir["#{File.expand_path('./lib', @options[:current_dir])}/**/*"]
       files.each do |file|
         require_relative file.sub(/\.rb$/, '') if file.end_with? '.rb'
@@ -176,7 +193,7 @@ module Twittbot
           is_mention = (object.user.screen_name != $bot[:config][:screen_name] and object.text.include?("@" + $bot[:config][:screen_name]) and not object.retweet?)
           do_callbacks :retweet, object, opts if object.retweet? and object.retweeted_tweet.user.screen_name == $bot[:config][:screen_name]
           do_callbacks :mention, object, opts if is_mention
-          do_callbacks :tweet, object, opts.merge({ mention: is_mention, retweet: object.retweet? })
+          do_callbacks :tweet, object, opts.merge({ mention: is_mention, retweet: object.retweet?, favorite: object.favorited? })
         when Twitter::Streaming::Event
           case object.name
             when :follow, :favorite
@@ -210,7 +227,7 @@ module Twittbot
 
     def do_periodic
       $bot[:periodic].each_with_index do |h, i|
-        h[:remaining] = if h[:remaining] == 0
+        h[:remaining] = if h[:remaining] - 1 <= 0
                           h[:block].call
                           h[:interval]
                         else
@@ -267,5 +284,28 @@ module Twittbot
       oauth_response = access_token.get('/1.1/account/verify_credentials.json?skip_status=true')
       oauth_response.body.match(/"screen_name"\s*:\s*"(.*?)"/).captures.first
     end
+
+    # Load special tasks (e.g. list)
+    def load_special_tasks
+      $bot[:tasks][:list] = {
+        block: -> do
+          list_tasks
+        end,
+        desc: 'List all available tasks'
+      }
+    end
+
+    # Lists all tasks
+    def list_tasks
+      tasks = $bot[:tasks].map do |name, value|
+        [name, value[:desc]]
+      end.to_h
+      longest_name = tasks.keys.map(&:to_s).max { |a, b| a.length <=> b.length }.length
+      tasks = tasks.map do |name, desc|
+        "twittbot cron %-*s # %s" % [longest_name + 2, name, desc]
+      end.sort
+
+      puts tasks
+    end
   end
 end

data/lib/twittbot/botpart.rb

@@ -90,6 +90,26 @@ module Twittbot
       }
     end
 
+    # Defines a new task to be run outside of a running Twittbot process.
+    # @param name [Symbol] The name of the task.
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :desc ("") Description of this task
+    def task(name, options = {}, &block)
+      name = name.to_s.downcase.to_sym
+      task_re = /\A[a-z0-9.:-_]+\z/
+      raise "Task already exists: #{name}" if $bot[:tasks].include?(name)
+      raise "Task name does not match regexp #{task_re.to_s}" unless name.to_s.match(task_re)
+
+      opts = {
+        desc: ''
+      }.merge(options)
+
+      $bot[:tasks][name] ||= {
+        block: block,
+        desc: opts[:desc]
+      }
+    end
+
     # Saves the botpart's configuration.  This is automatically called when
     # Twittbot exits.
     def save_config
@@ -102,4 +122,4 @@ module Twittbot
       end
     end
   end
-end
+end

data/lib/twittbot/cli.rb

@@ -26,6 +26,13 @@ module Twittbot
       bot.start
     end
 
+    desc 'cron TASK_NAME', 'Runs the task TASK_NAME, useful for calling from cron'
+    def cron(task_name)
+      require 'twittbot/bot'
+      bot = Twittbot::Bot.new(save_config: false)
+      bot.cron(task_name.downcase.to_sym)
+    end
+
     desc 'generate TEMPLATE_NAME', 'Installs a template'
     def generate(template_name)
       require 'twittbot/generators/templates/template_generator'

data/lib/twittbot/defaults.rb

@@ -1,6 +1,6 @@
 module Twittbot
   # The version of Twittbot.
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 
   CONSUMER_KEY = 'FYRuQcDbPAXAyVjuPZMuw' # :nodoc:
   CONSUMER_SECRET = 'KiLCYTftPdxNebl5DNcj7Ey2Y8YVZu7hfqiFRYkcg' # :nodoc:
@@ -23,4 +23,4 @@ module Twittbot
 
   # How many seconds should be waited until the bot reconnects
   RECONNECT_WAIT_TIME = 5
-end
+end

data/lib/twittbot/gem_ext/twitter/tweet.rb

@@ -26,6 +26,19 @@ module Twitter
     rescue Twitter::Error => e
       puts "caught Twitter error while retweeting: #{e.message}"
     end
+    alias rt retweet
+
+    # Favourites a tweet
+    def favourite
+      return if $bot.nil? or $bot[:client].nil?
+      $bot[:client].favorite self.id
+    rescue Twitter::Error => e
+      puts "caught Twitter error while favouriting: #{e.message}"
+    end
+    alias fav favourite
+    alias fave favourite
+    # for the 'muricans
+    alias favorite favourite
 
     # Scans the tweet text for screen names.
     # @param reply_all [Boolean] Include all users in the reply.

data/lib/twittbot/generators/templates/big_ben_clock/big_ben_clock.rb

@@ -0,0 +1,22 @@
+<%
+  # This is the config for this botpart.
+  # It is a hash and will be serialized to YAML and saved to 'etc/template_name.yml'.
+  botpart_config = {
+    string_to_repeat: 'BONG'
+  }
+
+  # Display a message after installation template installation
+  post_install_message <<-MSG
+Note: You installed a botpart which contains a task.
+
+A task can only be called outside of a running Twittbot process, e.g. from an
+UNIX shell or cron.
+MSG
+%>
+Twittbot::BotPart.new :<%= @template_name %> do
+  task :bong, desc: 'Big Ben Clock bong!' do
+    repeats = Time.now.hour % 12
+    repeats = 12 if repeats == 0
+    bot.tweet "#{@config[:string_to_repeat]} " * repeats
+  end
+end

data/lib/twittbot/generators/templates/retweet_bot/retweet_bot.rb

@@ -20,6 +20,8 @@ MSG
 Twittbot::BotPart.new :<%= @template_name %> do
   # When there's a new tweet in the timeline...
   on :tweet do |tweet, opts|
+    # ... ignore this tweet if it is from ourselves ...
+    next if tweet.user.screen_name == @config[:screen_name]
     # ... check if the tweet text contains at least one of the tags defined in your config...
     @config[:tags].each do |tag|
       if tweet.text.downcase.include? tag.downcase
@@ -29,4 +31,4 @@ Twittbot::BotPart.new :<%= @template_name %> do
       end
     end
   end
-end
+end

data/twittbot.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor', '~> 0.19'
   spec.add_dependency 'erubis', '~> 2.7', '>= 2.7.0'
-  spec.add_dependency 'oauth', '~> 0.4'
-  spec.add_dependency 'twitter', '~> 5.14'
-  spec.add_development_dependency 'yard', '~> 0.8'
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'oauth', '~> 0.5'
+  spec.add_dependency 'twitter', '~> 5.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake', '~> 11.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twittbot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - nilsding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -50,54 +50,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
 description: Twittbot is an advanced Twitter bot.  See the README for more info.
 email:
 - nilsding@nilsding.org
@@ -124,6 +124,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,6 +141,7 @@ files:
 - lib/twittbot/gem_ext/twitter/tweet.rb
 - lib/twittbot/gem_ext/twitter/user.rb
 - lib/twittbot/generators/templates/basic_dm/basic_dm.rb
+- lib/twittbot/generators/templates/big_ben_clock/big_ben_clock.rb
 - lib/twittbot/generators/templates/followback/followback.rb
 - lib/twittbot/generators/templates/random_reply/random_reply.rb
 - lib/twittbot/generators/templates/random_tweet/random_tweet.rb
@@ -173,9 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An advanced Twitter bot.
 test_files: []
-has_rdoc: