twitter-bot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61933d001c493f9d222c14d77f7247891172d1d4
+  data.tar.gz: e65f894d371a3d2478019cd40266be41220a5c85
+SHA512:
+  metadata.gz: a0fbe99a8e26c3bd9d1d68650d0869df5b43d26cc2adc363e40d52542c0845ed2dfcee991c9e7554bf161dc0fd7f49435ba7005080602da7f8db213b654ec1ad
+  data.tar.gz: e03e98c9e315045d61ea6fb23ace503007bf71986adde7a36491b725dcc057998c4dedf31650efa6070a72570298cfbb232caa1480a2a833d10ed6a32cf388af

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Heather Rivers
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# twitter-bot
+
+Search Twitter for specific terms and automatically reply from your bot
+account.
+
+Please exercise reasonable benevolence with your new powers.
+
+![Stealth Mountain](http://i.imgur.com/hopMhyb.png "Stealth Mountain")
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'twitter-bot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twitter-bot
+
+## Usage
+
+### 1. Register a Twitter client application
+
+Using your Twitter bot account:
+
+1. Go to https://apps.twitter.com/app/new and create an app
+
+2. Go to the **Keys and Access Tokens** tab and click "Create my access token"
+   at the bottom.
+
+You will need to save the 2 keypairs on this page (consumer key/secret & token
+key/secret) to configure your bot.
+
+### 2. Create a bot
+
+```ruby
+bot = Twitter::Bot.new(
+  consumer_key:        'value',
+  consumer_secret:     'value',
+  access_token_key:    'value',
+  access_token_secret: 'value')
+
+bot.search('sneak peak') do |tweet|
+  'I think you mean "sneak peek"'
+end
+```
+
+#### Advanced configuration
+
+* `interval`: seconds to wait between polling requests (default: 5)
+* `user_agent`: custom user agent for Twitter API requests
+
+#### More examples
+
+```ruby
+bot.search('"how long is this tweet"') do |tweet|
+  "@#{tweet.user.screen_name} This is #{tweet.text.size} characters long"
+end
+```
+
+```ruby
+bot.search('from:nihilist_arbys "horsey saurce"') { |tweet| 'Yum!' }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/twitter/bot.rb

@@ -0,0 +1,99 @@
+require 'twitter/bot/configuration'
+require 'twitter/bot/version'
+require 'logger'
+
+module Twitter
+  class Bot
+    attr_writer :logger
+    attr_reader :options
+
+    # @param options [Hash] hash of configuration options
+    #
+    # @option options [String] :consumer_key
+    # @option options [String] :consumer_secret
+    # @option options [String] :access_token
+    # @option options [String] :access_token_secret
+    #
+    # @option options [String]  :user_agent
+    # @option options [Integer] :interval polling interval
+    #
+    def initialize(options)
+      @options = options
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def search(query, &block)
+      query = query.to_s
+
+      logger.info "Polling for #{query.inspect} every #{config.interval}s..."
+
+      cursor = nil
+
+      loop do
+        perform_search(query, cursor) do |tweet|
+          reply(tweet, block)
+
+          cursor = tweet.id if cursor.nil? || tweet.id > cursor
+        end
+      end
+    end
+
+    private
+
+    def perform_search(query, cursor)
+      options = { result_type: 'recent' }
+
+      options[:since_id] = cursor if cursor
+
+      logger.info "Searching for #{query}..."
+
+      begin
+        client.search(query, options).each { |tweet| yield tweet }
+      rescue Twitter::Error::TooManyRequests
+        logger.info 'Rate limit exceeded. Resuming in 30s...'
+
+        sleep 30
+      end
+
+      sleep config.interval
+    end
+
+    def reply(tweet, block)
+      *args = block.call(tweet)
+
+      text = args.shift
+      tweet_options = args.shift || {}
+
+      return unless text && text.size > 0
+
+      tweet_options[:in_reply_to_status] = tweet
+
+      logger.info "Tweet: #{tweet.full_text}"
+      logger.info "Autoreply: #{text}\n"
+
+      begin
+        client.update(text, tweet_options)
+      rescue Twitter::Error.errors.values => exception
+        logger.error "Autoreply failed: #{exception.class} #{exception.message}"
+      end
+    end
+
+    def config
+      @config ||= Configuration.new(options)
+    end
+
+    def client
+      @client ||= Twitter::REST::Client.new do |client|
+        client.consumer_key        = config.consumer_key
+        client.consumer_secret     = config.consumer_secret
+        client.access_token        = config.access_token
+        client.access_token_secret = config.access_token_secret
+
+        client.user_agent = config.user_agent
+      end
+    end
+  end
+end

data/lib/twitter/bot/configuration.rb

@@ -0,0 +1,54 @@
+module Twitter
+  class Bot
+    class Configuration
+      DEFAULT_INTERVAL = 5
+
+      DEFAULT_USER_AGENT =
+        'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 ' \
+        '(KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36'
+
+      CREDENTIALS = %w(
+        consumer_key
+        consumer_secret
+        access_token
+        access_token_secret
+      )
+
+      attr_reader :values
+
+      def initialize(values)
+        values.keys.each { |key| values[key.to_s] = values.delete(key) }
+
+        @values = values
+
+        validate!
+      end
+
+      CREDENTIALS.each do |name|
+        define_method(name) { values.fetch(name) }
+      end
+
+      def interval
+        values.fetch('interval', DEFAULT_INTERVAL)
+      end
+
+      def user_agent
+        values.fetch('user_agent', DEFAULT_USER_AGENT)
+      end
+
+      private
+
+      def validate!
+        CREDENTIALS.each do |name|
+          unless values.key?(name)
+            fail InvalidValue, "Missing required configuration key `#{name}`"
+          end
+        end
+
+        true
+      end
+
+      class InvalidValue < StandardError; end
+    end
+  end
+end

data/lib/twitter/bot/version.rb

@@ -0,0 +1,5 @@
+module Twitter
+  class Bot
+    VERSION = '0.0.1'
+  end
+end

data/twitter-bot.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter/bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twitter-bot'
+  spec.version       = Twitter::Bot::VERSION
+  spec.authors       = ['Heather Rivers']
+  spec.email         = ['git@heatherrivers.com']
+  spec.description   = 'Twitter autoreply bot'
+  spec.summary       = 'Search Twitter for specific terms and automatically ' \
+                       'reply from your bot account.'
+  spec.homepage      = 'https://github.com/rivers/twitter-bot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'twitter', '~> 5.14.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: twitter-bot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Heather Rivers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+- !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'
+description: Twitter autoreply bot
+email:
+- git@heatherrivers.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/twitter/bot.rb
+- lib/twitter/bot/configuration.rb
+- lib/twitter/bot/version.rb
+- misc/sneak_peek.png
+- twitter-bot.gemspec
+homepage: https://github.com/rivers/twitter-bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Search Twitter for specific terms and automatically reply from your bot account.
+test_files: []