twittbot 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09e59460e2557a87718a9bad72b57d1b42c2a4c3
-  data.tar.gz: 179a82d6023f5b2900d54841538e1aeb1b673564
+  metadata.gz: c1ccc06698d66c5f816c4021a4f629b2bb7a388f
+  data.tar.gz: 809da09ae7ae3724f1c14080eef51dcdefe33c3c
 SHA512:
-  metadata.gz: ed8bedb456e2ff5d26857f0758797e20f9ece05bca381e8125381807c0b91168fb20b90263cd162cb2cb6ce0560169c234743d0e07ff38e846df1bf0aa64dc84
-  data.tar.gz: fe77b02ea6703e0b22e8cf8004e10a05a6cae7381fca8120b29a95392cca7934ae4603ea8ab0a23e37a61162534c7da05e957d0345f307b301fb3527a134ebb7
+  metadata.gz: 23668bb8a4caeb9d7bae00775498ff5fe4dc3a17893b5190a105683af2931cf624d36a2e6d2c989a7a51fe071e42f673ee1dbbaa76d8a843832bf3f0f75a6775
+  data.tar.gz: 8a9aef2318375d165b3af9eeeebfc219664998df13e4581fb3fdf24f836dc472cd8b4b275eb38932138bbb003e6cd2cfebd1973e02d1b757575d42e68ff4d1d5

data/README.md

@@ -1,4 +1,4 @@
-# Twittbot
+# Twittbot [![Gem Version](https://badge.fury.io/rb/twittbot.svg)](http://badge.fury.io/rb/twittbot) [![Inline docs](http://inch-ci.org/github/nilsding/twittbot.svg?branch=master)](http://inch-ci.org/github/nilsding/twittbot)
 
 Twittbot is the next generation of my old Twitter bot, `twittbot-nd`.
 
@@ -19,6 +19,10 @@ Authorize with Twitter:
 
     $ twittbot auth
 
+Add yourself as a botadmin:
+
+    $ twittbot add-admin nilsding
+
 Add a template, such as for a simple reply bot:
 
     $ twittbot generate random-reply

data/lib/twittbot/bot.rb

@@ -18,12 +18,21 @@ module Twittbot
       }
 
       $bot = {
+          botparts: [],
           callbacks: {},
-          config: YAML.load_file(File.expand_path("./#{Twittbot::CONFIG_FILE_NAME}", @options[:current_dir])),
+          commands: {},
+          config: Twittbot::DEFAULT_BOT_CONFIG.merge(
+              YAML.load_file(File.expand_path("./#{Twittbot::CONFIG_FILE_NAME}", @options[:current_dir]))
+          ),
           periodic: []
       }.merge!(options)
 
       load_bot_code
+
+      at_exit do
+        save_config
+        $bot[:botparts].each { |b| b.save_config }
+      end
     end
 
     # Authenticates an account with Twitter.
@@ -54,26 +63,12 @@ module Twittbot
       # get the bot's user name (screen_name) and print it to the console
       $bot[:config][:screen_name] = get_screen_name access_token
       puts "Hello, #{$bot[:config][:screen_name]}!"
-
-      save_config
     end
 
     # Starts the bot.
     def start
       check_config
-      $bot[:client] ||= Twitter::REST::Client.new do |cfg|
-        cfg.consumer_key        = $bot[:config][:consumer_key]
-        cfg.consumer_secret     = $bot[:config][:consumer_secret]
-        cfg.access_token        = $bot[:config][:access_token]
-        cfg.access_token_secret = $bot[:config][:access_token_secret]
-      end
-
-      @streamer ||= Twitter::Streaming::Client.new do |cfg|
-        cfg.consumer_key        = $bot[:config][:consumer_key]
-        cfg.consumer_secret     = $bot[:config][:consumer_secret]
-        cfg.access_token        = $bot[:config][:access_token]
-        cfg.access_token_secret = $bot[:config][:access_token_secret]
-      end
+      init_clients
 
       @userstream_thread ||= Thread.new do
         puts "connected to user stream"
@@ -103,6 +98,23 @@ module Twittbot
       @periodic_thread.join
     end
 
+    # @param screen_name [String] the user's screen name
+    # @param action [Symbol] :add or :delete
+    def modify_admin(screen_name, action = :add)
+      init_clients
+      user = $bot[:client].user screen_name
+      case action
+        when :add
+          $bot[:config][:admins] << user.id unless $bot[:config][:admins].include? user.id
+        when :del, :delete
+          $bot[:config][:admins].delete user.id if $bot[:config][:admins].include? user.id
+        else
+          say "Unknown action " + action.to_s, :red
+      end
+    rescue Twitter::Error::NotFound
+      say "User not found.", :red
+    end
+
     # Loads the bot's actual code which is stored in the bot's +lib+
     # subdirectory.
     def load_bot_code
@@ -158,6 +170,8 @@ module Twittbot
               pp object
               do_callbacks object.name, object, opts
           end
+        when Twitter::DirectMessage
+          do_direct_message object, opts
         else
           puts "no handler for #{object.class.to_s}\n  -- object data:"
           require 'pp'
@@ -184,6 +198,26 @@ module Twittbot
       end
     end
 
+    # Processes a direct message.
+    # @param dm [Twitter::DirectMessage] received direct message
+    def do_direct_message(dm, opts = {})
+      return if dm.sender.screen_name == $bot[:config][:screen_name]
+      return do_callbacks(:direct_message, dm, opts) unless dm.text.start_with? $bot[:config][:dm_command_prefix]
+      dm_text = dm.text.sub($bot[:config][:dm_command_prefix], '').strip
+      return if dm_text.empty?
+
+      return unless /(?<command>[A-Za-z0-9]+)(?:\s*)(?<args>.*)/m =~ dm_text
+      command = Regexp.last_match(:command).to_sym
+      args = Regexp.last_match :args
+
+      cmd = $bot[:commands][command]
+      return say_status :dm, "#{dm.sender.screen_name} tried to issue non-existent command :#{command}, ignoring", :cyan if cmd.nil?
+      return say_status :dm, "#{dm.sender.screen_name} tried to issue admin command :#{command}, ignoring", :cyan if cmd[:admin] and !dm.sender.admin?
+
+      say_status :dm, "#{dm.sender.screen_name} issued command :#{command}", :cyan
+      cmd[:block].call(args, dm.sender)
+    end
+
     # @return [Boolean] whether the bot is already authenticated or not.
     def already_authed?
       !($bot[:config][:access_token].empty? or $bot[:config][:access_token_secret].empty?)
@@ -191,6 +225,22 @@ module Twittbot
 
     private
 
+    def init_clients
+      $bot[:client] ||= Twitter::REST::Client.new do |cfg|
+        cfg.consumer_key        = $bot[:config][:consumer_key]
+        cfg.consumer_secret     = $bot[:config][:consumer_secret]
+        cfg.access_token        = $bot[:config][:access_token]
+        cfg.access_token_secret = $bot[:config][:access_token_secret]
+      end
+
+      @streamer ||= Twitter::Streaming::Client.new do |cfg|
+        cfg.consumer_key        = $bot[:config][:consumer_key]
+        cfg.consumer_secret     = $bot[:config][:consumer_secret]
+        cfg.access_token        = $bot[:config][:access_token]
+        cfg.access_token_secret = $bot[:config][:access_token_secret]
+      end
+    end
+
     def get_screen_name(access_token)
       oauth_response = access_token.get('/1.1/account/verify_credentials.json?skip_status=true')
       oauth_response.body.match(/"screen_name"\s*:\s*"(.*?)"/).captures.first

data/lib/twittbot/botpart.rb

@@ -5,13 +5,14 @@ module Twittbot
   class BotPart
     # @param name [Symbol] The name of the botpart.  Should be the same as the file name without the extension.
     def initialize(name, &block)
-      botpart_config_path = File.expand_path("./etc/#{name}.yml")
-      @config = $bot[:config].merge(if File.exist? botpart_config_path
-                                      YAML.load_file botpart_config_path
+      @botpart_config_path = File.expand_path("./etc/#{name}.yml")
+      @config = $bot[:config].merge(if File.exist? @botpart_config_path
+                                      YAML.load_file @botpart_config_path
                                     else
                                       {}
                                     end)
       instance_eval &block
+      $bot[:botparts] << self
     end
 
     # Adds a new callback to +name+.
@@ -23,6 +24,7 @@ module Twittbot
     #   * :retweet
     #   * :favorite
     #   * :friend_list
+    #   * :direct_message (i.e. not command DMs, see {cmd} for that)
     def on(name, *args, &block)
       $bot[:callbacks][name] ||= {
           args: args,
@@ -66,5 +68,36 @@ module Twittbot
       $bot[:client]
     end
     alias bot client
+
+    # Defines a new direct message command.
+    # @param name [Symbol] The name of the command.  Can only contain alphanumerical characters.
+    #   The recommended maximum length is 4 characters.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Boolean] :admin (true) Require admin status for this command.
+    def cmd(name, options = {}, &block)
+      raise "Command already exists: #{name}" if $bot[:commands].include? name
+      raise "Command name does not contain only alphanumerical characters" unless name.to_s.match /\A[A-Za-z0-9]+\z/
+
+      opts = {
+          admin: true
+      }.merge(options)
+
+      $bot[:commands][name] ||= {
+          admin: opts[:admin],
+          block: block
+      }
+    end
+
+    # Saves the botpart's configuration.  This is automatically called when
+    # Twittbot exits.
+    def save_config
+      botpart_config = Hash[@config.to_a - $bot[:config].to_a]
+
+      unless botpart_config.empty?
+        File.open @botpart_config_path, 'w' do |f|
+          f.write botpart_config.to_yaml
+        end
+      end
+    end
   end
 end

data/lib/twittbot/cli.rb

@@ -39,5 +39,19 @@ module Twittbot
       lister = Twittbot::TemplateLister.new options
       lister.list
     end
+
+    desc 'add-admin USER_NAME', 'Adds an user to the botadmin list'
+    def add_admin(user_name)
+      require 'twittbot/bot'
+      bot = Twittbot::Bot.new
+      bot.modify_admin(user_name, :add)
+    end
+
+    desc 'del-admin USER_NAME', 'Removes an user from the botadmin list'
+    def del_admin(user_name)
+      require 'twittbot/bot'
+      bot = Twittbot::Bot.new
+      bot.modify_admin(user_name, :delete)
+    end
   end
 end

data/lib/twittbot/defaults.rb

@@ -1,6 +1,6 @@
 module Twittbot
   # The version of Twittbot.
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 
   CONSUMER_KEY = 'FYRuQcDbPAXAyVjuPZMuw' # :nodoc:
   CONSUMER_SECRET = 'KiLCYTftPdxNebl5DNcj7Ey2Y8YVZu7hfqiFRYkcg' # :nodoc:
@@ -16,6 +16,8 @@ module Twittbot
     consumer_secret: Twittbot::CONSUMER_SECRET,
     access_token: '',
     access_token_secret: '',
-    track: []
+    track: [],
+    admins: [],
+    dm_command_prefix: '!'
   }
 end

data/lib/twittbot/gem_ext/twitter.rb

@@ -1,2 +1,4 @@
+require 'twittbot/gem_ext/twitter/user'
 require 'twittbot/gem_ext/twitter/tweet'
+require 'twittbot/gem_ext/twitter/direct_message'
 require 'twittbot/gem_ext/twitter/rest/tweets'

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

@@ -0,0 +1,13 @@
+module Twitter
+  class DirectMessage
+    # Replies to this direct message.
+    # @param direct_message_text [:String] direct message text
+    def reply(direct_message_text)
+      return if $bot.nil? or $bot[:client].nil?
+
+      $bot[:client].create_direct_message self.sender.id, direct_message_text
+    rescue Twitter::Error => e
+      puts "caught Twitter error while replying via DM: #{e.message}"
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module Twitter
 
       $bot[:client].update result, in_reply_to_status_id: self.id
     rescue Twitter::Error => e
-      puts "caught Twitter error while retweeting: #{e.message}"
+      puts "caught Twitter error while replying: #{e.message}"
     end
 
     # Retweets this tweet.

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

@@ -0,0 +1,9 @@
+module Twitter
+  class User
+    # @return [Boolean] whether the current user is a botadmin
+    def admin?
+      return false if $bot.nil? or $bot[:config].nil?
+      $bot[:config][:admins].include? self.id
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+<%
+  # 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 = {
+    magic_word: "Supercalifragilisticexpialidocious" # (I'll buy you a beer if you can spell this correctly while drunk)
+  }
+
+  # Display a message after installation template installation
+  post_install_message <<-MSG
+In order to make some commands work, you need to be a BotAdmin.  You can add
+yourself to the BotAdmin list by starting
+
+    twittbot add-admin your_user_name
+MSG
+%>
+Twittbot::BotPart.new :<%= @template_name %> do
+  # This command gives a BotAdmin the ability to tweet via the bot.
+  #
+  # Example usage (via direct message):
+  # !twet This is a tweet
+  cmd :twet do |args, _user|
+    bot.tweet args
+  end
+
+  # This command gives anyone who is followed by the bot the ability to echo
+  # back their direct message.
+  #
+  # Example usage:
+  # !echo Hello, world!
+  cmd :echo, admin: false do |args, user|
+    bot.dm user, args
+  end
+
+  ## Uncomment this if you want to remotely stop the bot.
+  ##
+  ## Example usage:
+  ## !stop Supercalifragilisticexpialidocious
+  #cmd :stop do |args, user|
+  #  exit 0 if args.downcase == @config[:magic_word].downcase
+  #end
+
+  # Of course, there's a :direct_message callback too.  This applies to
+  # everything that is not a command.
+  on :direct_message do |dm|
+    if dm.sender.admin?  # You can check if an user is an admin by using the .admin? method.
+      dm.reply "You're an admin!  You can use !twet to tweet nice things."
+    else
+      dm.reply "You're an ordinary user!  Try using !echo on me."
+    end
+  end
+end

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

@@ -17,4 +17,20 @@ Twittbot::BotPart.new :<%= @template_name %> do
     # ... tweet a random entry of the :tweets list that you configured
     bot.tweet @config[:tweets].sample
   end
+
+  ## Uncomment the next few lines if you want to add new tweets to the tweet
+  ## list on the fly using direct messages.
+  ##
+  ## Example usage:
+  ## !atwt Tweet text
+  #cmd :atwt do |args|
+  #  # adds args (usually the tweet text) to the list of random tweets unless
+  #  # args already is in the list
+  #  @config[:tweets] << args unless @config[:tweets].include? args
+  #end
+  #
+  ## Auto-save!  \o/
+  #every 1, :hour do
+  #  save_config
+  #end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twittbot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - nilsding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -135,8 +135,11 @@ files:
 - lib/twittbot/cli.rb
 - lib/twittbot/defaults.rb
 - lib/twittbot/gem_ext/twitter.rb
+- lib/twittbot/gem_ext/twitter/direct_message.rb
 - lib/twittbot/gem_ext/twitter/rest/tweets.rb
 - 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/followback/followback.rb
 - lib/twittbot/generators/templates/random_reply/random_reply.rb
 - lib/twittbot/generators/templates/random_tweet/random_tweet.rb