twitter_topic_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b82cc1435918f3e1b0cb1ef84c332f14fa2ba17
+  data.tar.gz: f8a4e6862aa5cd85da511df4d2554dc0e2b1a7df
+SHA512:
+  metadata.gz: fa5e6ab98c56c1841a1d5cb5698514bfcdf7931da176f8f19be2888538fe461d380db8d991456bff66dca3fd14207b62f17ca6108a9e2ada22a9d304f8397102
+  data.tar.gz: 1d66820a52febe7a771e3d20fc4f9f9b6742768712ff44aa87d1e1d5d4f06fd9cd8539ff92b9bbe55a1102f0646055ef53bf421ffd7d3f8414e5d34baef9037b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at annekjohnson23@yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitter_topic_bot.gemspec
+gemspec

data/README.md

@@ -0,0 +1,74 @@
+# TwitterTopicBot
+
+Create a Twitter bot in 5 minutes that tweets and engages with the community on topics you're interested in!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitter_topic_bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twitter_topic_bot
+
+## Usage
+
+To let your bot know what to tweet about, you need to make an object that responds to the three methods in the code sample below. The topic below is art, but your topic can be about anything.
+
+```ruby
+class ArtContentPreparer
+  def topic_string
+    ['#painting', '#watercolor'].sample
+  end
+
+  def prepare_tweet
+    %q{If you hear a voice within you say 'you cannot paint,' then by all means paint, and that voice will be silenced. -Vincent Van Gogh}
+  end
+
+  def prepare_reply(tweet_to_reply_to, user_to_reply_to)
+    "@#{user_to_reply_to}, thank you for tweeting about art!"
+  end
+end
+
+content_preparer = ArtContentPreparer.new
+```
+
+Next, get your Twitter API credentials ready. Register an app on [Twitter](https://apps.twitter.com/) with read & write permissions. Once you have your API keys, prepare the following pieces of information:
+
+```ruby
+credentials = {
+  username: '<Your bot\'s username (without the @ sign)>',
+  consumer_key: '<Your consumer key>',
+  consumer_secret: '<Your consumer secret>',
+  access_token: '<Your access token>',
+  access_token_secret: '<Your access token secret>'
+}
+```
+
+Next, instantiate a `TwitterTopicBot`, and make it do things!
+
+```ruby
+bot = TwitterTopicBot.new(content_preparer, credentials)
+
+bot.tweet
+bot.retweet_someone
+bot.follow_someone
+bot.retweet_mentions
+bot.reply_to_someone
+bot.follow_followers
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/annejohnson/twitter_topic_bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'twitter_topic_bot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twitter_topic_bot/api_client.rb

@@ -0,0 +1,95 @@
+require 'twitter'
+require 'forwardable'
+
+class TwitterTopicBot
+  class ApiClient
+    extend Forwardable
+
+    MAX_TWEET_LENGTH = 140
+
+    def_delegators :twitter_client,
+                   :favorite,
+                   :following,
+                   :followers
+
+    def initialize(credentials)
+      @credentials = Hash[credentials.map { |k, v| [k.to_s, v] }]
+      @tweet_filterer = TwitterTopicBot::TweetFilterer.new
+      @max_num_tweets_per_query = 60
+    end
+
+    def max_tweet_length
+      MAX_TWEET_LENGTH
+    end
+
+    def tweet(str, options = {})
+      twitter_client.update(str, options)
+    end
+
+    def retweet(*tweets)
+      twitter_client.retweet(*tweets.map(&:id))
+    rescue Twitter::Error::Forbidden
+      false
+    end
+
+    def follow(*users)
+      twitter_client.follow(*users.map(&:id))
+    end
+
+    def search_recent_tweets(query_str)
+      filter_tweets(
+        twitter_client.search(
+          query_str,
+          result_type: 'recent'
+        ).take(max_num_tweets_per_query)
+      )
+    end
+
+    def mentions
+      filter_tweets(
+        twitter_client.mentions_timeline,
+        allow_links: false
+      )
+    end
+
+    def tweets
+      twitter_client.user_timeline(
+        username,
+        count: max_num_tweets_per_query
+      )
+    end
+
+    def replies
+      tweets.select do |tweet|
+        tweet.in_reply_to_status_id.to_s.match(/\d+/)
+      end
+    end
+
+    def username
+      credentials['username']
+    end
+
+    private
+
+    attr_reader :tweet_filterer,
+                :credentials,
+                :max_num_tweets_per_query
+
+    def filter_tweets(tweets, allow_links: true)
+      allowed_languages = ['en']
+      tweets.select do |tweet|
+        allowed_languages.include?(tweet.lang) &&
+          tweet_filterer.acceptable_tweet?(tweet.text, allow_links: allow_links)
+      end
+    end
+
+    def twitter_client
+      @twitter_client ||= Twitter::REST::Client.new do |config|
+        config.consumer_key = credentials['consumer_key']
+        config.consumer_secret = credentials['consumer_secret']
+        config.access_token = credentials['access_token']
+        config.access_token_secret = credentials['access_token_secret']
+      end
+    end
+  end
+end

data/lib/twitter_topic_bot/tweet_filterer.rb

@@ -0,0 +1,49 @@
+class TwitterTopicBot
+  class TweetFilterer
+    def initialize(options = {})
+      @max_num_mentions = options.fetch(:max_num_mentions, 1)
+      @max_num_hashtags = options.fetch(:max_num_hashtags, 3)
+    end
+
+    def acceptable_tweet?(tweet_str, allow_links: true)
+      return false if is_spammy_tweet?(tweet_str) ||
+                      is_sketchy_tweet?(tweet_str) ||
+                      has_too_many_mentions?(tweet_str) ||
+                      has_too_many_hashtags?(tweet_str)
+
+      allow_links || !contains_link?(tweet_str)
+    end
+
+    private
+
+    attr_reader :max_num_mentions,
+                :max_num_hashtags
+
+    def is_spammy_tweet?(tweet_str)
+      contains_link?(tweet_str) &&
+        tweet_str.match(/(buy)|(e-?book)|(order)|(press)/i)
+    end
+
+    def is_sketchy_tweet?(tweet_str)
+      tweet_str.match(/(fuck)|(fetish)|(ass)|(gamergate)|(shit)|(bitch)|(cunt)|(rape)/i)
+    end
+
+    def has_too_many_mentions?(tweet_str)
+      num_mentions = tweet_str.split.count do |word|
+        word.start_with?('@')
+      end
+      num_mentions > max_num_mentions
+    end
+
+    def has_too_many_hashtags?(tweet_str)
+      num_hashtags = tweet_str.split.count do |word|
+        word.start_with?('#')
+      end
+      num_hashtags > max_num_hashtags
+    end
+
+    def contains_link?(tweet_str)
+      tweet_str.match(/http:\/\//i)
+    end
+  end
+end

data/lib/twitter_topic_bot/version.rb

@@ -0,0 +1,3 @@
+class TwitterTopicBot
+  VERSION = '0.1.0'
+end

data/lib/twitter_topic_bot.rb

@@ -0,0 +1,75 @@
+require 'twitter'
+require 'twitter_topic_bot/version'
+require 'twitter_topic_bot/api_client'
+require 'twitter_topic_bot/tweet_filterer'
+
+class TwitterTopicBot
+  def initialize(content_preparer, credentials)
+    @content_preparer = content_preparer
+    @api_client = TwitterTopicBot::ApiClient.new(credentials)
+  end
+
+  def tweet
+    api_client.tweet(
+      content_preparer.prepare_tweet
+    )
+  end
+
+  def retweet_someone
+    api_client.retweet(tweet_to_retweet)
+  end
+
+  def follow_someone
+    api_client.follow(user_to_follow)
+  end
+
+  def retweet_mentions
+    # TODO: filter out already retweeted mentions
+    api_client.retweet *api_client.mentions
+  end
+
+  def reply_to_someone
+    tweet = tweet_to_reply_to
+    reply = content_preparer.prepare_reply(
+              tweet.text,
+              tweet.user.screen_name
+            )
+
+    api_client.tweet(
+      reply,
+      in_reply_to_status_id: tweet.id
+    )
+  end
+
+  def follow_followers
+    # TODO: it is too easy to hit the rate limit on this one
+    api_client.follow *api_client.followers
+  end
+
+  private
+
+  attr_reader :content_preparer,
+              :api_client
+
+  def tweet_to_retweet
+    get_topic_tweets.max_by(&:favorite_count)
+  end
+
+  def user_to_follow
+    get_topic_tweets.sample.user
+  end
+
+  def tweet_to_reply_to
+    tweet_ids_already_replied_to = api_client.replies.map(&:in_reply_to_status_id)
+
+    get_topic_tweets.reject do |tweet|
+      tweet.retweet? || tweet_ids_already_replied_to.include?(tweet.id)
+    end.sample
+  end
+
+  def get_topic_tweets
+    api_client.search_recent_tweets(
+      content_preparer.topic_string
+    )
+  end
+end

data/twitter_topic_bot.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter_topic_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twitter_topic_bot'
+  spec.version       = TwitterTopicBot::VERSION
+  spec.authors       = ['Anne Johnson']
+  spec.email         = ['annecodes@gmail.com']
+
+  spec.summary       = %q{A gem to create Twitter bots that tweet about topics of interest}
+  spec.homepage      = 'https://github.com/annejohnson/twitter_topic_bot'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'twitter', '~> 5.16.0'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: twitter_topic_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anne Johnson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.16.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- annecodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitter_topic_bot.rb
+- lib/twitter_topic_bot/api_client.rb
+- lib/twitter_topic_bot/tweet_filterer.rb
+- lib/twitter_topic_bot/version.rb
+- twitter_topic_bot.gemspec
+homepage: https://github.com/annejohnson/twitter_topic_bot
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.4
+signing_key: 
+specification_version: 4
+summary: A gem to create Twitter bots that tweet about topics of interest
+test_files: []