retjilp 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2abfa27b54c9c65411d42b2da87ef91861120ac1
+  data.tar.gz: 11990c7cbc4e08b08d845967a1677d8fab55ef0f
+SHA512:
+  metadata.gz: 66febc755793570d43e7f8a528d78c54915fe2f160ba1106b4e93b63c0d160f2daefdec204e8889e1db99ec0901ca8449869cc3d6b4e46455cb418fa50452069
+  data.tar.gz: 8159a921b9d8d4046308c00ac44b9cb6f6a16b1ef31deab3704495d082cd5c617aca8802b3ed7d9c843da89987fdf26540cd6555ed097f9dd4461403437f046b

data/AUTHORS

@@ -0,0 +1 @@
+Remko Tronçon (http://el-tramo.be)

data/COPYING

@@ -0,0 +1,25 @@
+Copyright (c) 2011-2012 Remko Tronçon (http://el-tramo.be)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.markdown

@@ -0,0 +1,25 @@
+Retjilp: Native Auto-retweet bot 
+--------------------------------
+<http://el-tramo.be/blog/retjilp>
+
+Retjilp logs into your account, scans all the tweets from your following
+list or another defined list for a set of matching words, and retweets 
+the ones that match (using the native retweet API).
+ 
+Prerequisites of this script are Ruby and the `oauth` and `json_pure` 
+ruby gems (`gem install <gem>`).
+
+To use this script, you will need to have registered an application with
+<http://twitter.com/apps> to get a consumer key and secret, and fill these 
+values in the `config` file. After having changed the `config` file, move it 
+to a dir `.retjilp` in your homedir (i.e. `~/.retjilp`).
+
+To start the script, run 
+
+    ./retjilp.rb
+    
+To get a list of command-line parameters, use the `--help` option.
+
+The first time the script is run, it will ask you to authorize the application
+in your twitter account. After this is done, the script will automatically log
+in the next time it is run.

data/bin/retjilp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+require 'retjilp/runner'
+
+Retjilp::Runner.new(ARGV).run

data/config

@@ -0,0 +1,27 @@
+/*
+ * Retjilp configuration file.
+ * 
+ * Change this to reflect your setup, and put it in ~/.retjilp
+ */
+{
+	/*
+	 * Consumer key and secret.
+	 * Get this by registering a new (desktop) application at 
+	 * http://twitter.com/apps
+	 */
+	"consumer_key": "abcdeFghIjklMnOpQrStUv",
+	"consumer_secret": "abcdefgh123456789abcdefgh123456789abcdefg",
+
+	/*
+	 * The strings that a tweet should be matched against.
+	 * These strings are matched in lower case.
+	 */
+	"match": ["#sometag", "#someothertag", "someword"]
+
+	/*
+	 * List name from which statuses are retweeted.
+	 * Set this config value if you want to retweet only from 
+	 * this list instead of your following list.
+	 */
+	/* "retweet_from_list": "auto-retweet" */
+}

data/lib/retjilp/options.rb

@@ -0,0 +1,24 @@
+require 'optparse'
+require 'logger'
+
+module Retjilp
+	class Options
+		attr_reader :log_level
+
+		def initialize(argv)
+			@log_level = Logger::WARN
+			OptionParser.new do |opts|
+				opts.banner = "Usage: retjilp [ --help ] [ --verbose | --debug ]"
+				opts.on("--verbose", "Run with verbose output") { @log_level = Logger::INFO }
+				opts.on("--debug", "Run with debug output") { @log_level = Logger::DEBUG }
+				opts.on_tail("-h", "--help", "Show this help") { puts opts ; exit }
+				begin
+					opts.parse!(argv)
+				rescue => e
+					STDERR.puts e.message, "\n", opts
+					exit(-1)
+				end
+			end.parse!(argv)
+		end
+	end
+end

data/lib/retjilp/retweeter.rb

@@ -0,0 +1,142 @@
+require 'rubygems'
+require 'oauth'
+require 'json/pure'
+require 'logger'
+
+require_relative 'options'
+
+module Retjilp
+	TWITTER_URI = "http://api.twitter.com"
+	API_VERSION = "1.1"
+
+	class Retweeter
+		def initialize(options)
+			@log = Logger.new(STDERR)
+			@log.formatter = proc { |severity, time, prog, msg| "#{severity}: #{msg}\n" }
+			@log.level = options.log_level
+		end
+
+		def run
+			# Initialize data dir
+			@log.info("Reading configuration file")
+			data_dir = File.expand_path("~/.retjilp")
+			config_filename = File.join(data_dir, "config")
+			access_token_filename = File.join(data_dir, "access_token")
+
+			# Read configuration file
+			begin
+				config = File.open(config_filename) { |f| JSON.load(f) }
+			rescue => e
+				fatal_exit("Error parsing configuration file #{config_filename}: #{e.message}")
+			end
+
+			# Initialize the access token
+			access_token = nil
+			user_info = nil
+			if File.exist?(access_token_filename)
+				# Try using the cached token
+				@log.info("Loading cached access token from #{access_token_filename}")
+				File.open(access_token_filename) do |f|  
+					begin 
+						access_token_data = JSON.load(f)
+						consumer = OAuth::Consumer.new(config["consumer_key"], config["consumer_secret"], { :site => TWITTER_URI })
+						access_token = OAuth::AccessToken.new(consumer, access_token_data["token"], access_token_data["secret"])
+						unless user_info = verify_token(access_token)
+							@log.warn("Cached token not authorized")
+							access_token = nil
+						end
+					rescue JSON::ParserError 
+						@log.warn("Cached token does not parse")
+					end
+				end 
+			end
+
+			# Request the token if the cached access token does not exist
+			unless access_token
+				STDIN.tty? or fatal_exit("This script must be run interactively the first time to be able to authenticate.")
+				@log.info("Requesting new access token")
+				consumer = OAuth::Consumer.new(
+					config["consumer_key"],
+					config["consumer_secret"],
+					:site => TWITTER_URI,
+					:scheme => :header,
+					:request_token_path => "/oauth/request_token",
+					:authorize_path => "/oauth/authorize",
+					:access_token_path => "/oauth/access_token",
+					:http_method => :post)
+				request_token = consumer.get_request_token(:oauth_callback => "oob")
+
+				puts "Please open #{request_token.authorize_url} in your browser, authorize Retjilp, and enter the PIN code below:"
+				verifier = STDIN.gets.chomp 
+
+				begin
+					access_token = request_token.get_access_token(:oauth_verifier => verifier)
+				rescue OAuth::Unauthorized
+					fatal_exit("Invalid PIN verification!")
+				end
+				user_info = verify_token(access_token) or fatal_exit("Access token not authorized!")
+				@log.info("Caching token in #{access_token_filename}")
+				File.open(access_token_filename, 'w+') do |f|  
+					access_token_data = { 
+							"token" => access_token.token, 
+							"secret" => access_token.secret 
+					}
+					JSON.dump(access_token_data, f)
+				end
+			end
+
+			@log.info("Logged in as #{user_info["screen_name"]}")
+
+			# Get a list of retweeted ids
+			@log.info("Fetching retweets")
+			retweets = JSON.parse(access_token.get("/#{API_VERSION}/statuses/user_timeline.json?trim_user=true&include_rts=true").body)
+			@log.debug(JSON.pretty_generate(retweets))
+			not retweets.include? "error" or fatal_exit("Error fetching retweets: #{retweets}")
+
+			retweeted_ids = retweets.map { |retweet| retweet["retweeted_status"]["id"] }.sort!
+
+			# Fetch the statuses
+			@log.info("Fetching friends statuses")
+			if config["retweet_from_list"]
+				status_uri = "/#{API_VERSION}/lists/statuses.json?slug=#{config["retweet_from_list"]}&owner_screen_name=#{user_info["screen_name"]}&include_rts=true"
+			else
+				status_uri = "/#{API_VERSION}/statuses/home_timeline.json?trim_user=true"
+			end
+			status_uri += "&since_id=#{retweeted_ids[0]}" unless retweeted_ids.empty?
+			statuses = JSON.parse(access_token.get(status_uri).body)
+			@log.debug(JSON.pretty_generate(statuses))
+			not statuses.include? "error" or fatal_exit("Error fetching statuses: #{statuses.to_s}")
+
+			# Retweet statuses
+			statuses.each do |status|
+				should_retweet = (config["match"].empty? or config["match"].any? { |match| 
+					status["text"].downcase.include? match.downcase 
+				})
+				if should_retweet
+					id_to_retweet = status.has_key?("retweeted_status") ? status["retweeted_status"]["id"] : status["id"]
+					if retweeted_ids.include? id_to_retweet
+						@log.debug("Already retweeted: #{status["text"]}")
+					else
+						@log.info("Retweeting: #{status["text"]}")
+						result = access_token.post("/#{API_VERSION}/statuses/retweet/#{id_to_retweet}.json")
+						result.class == Net::HTTPOK or @log.error("Error retweeting #{result.body}")
+					end
+				end
+			end
+		end
+
+		private
+			# Print a log message, and exit
+			def fatal_exit(msg)
+				@log.fatal(msg)
+				exit -1
+			end
+
+			# Helper method to verify the validity of an access token.
+			# Returns the user info if the token verified correctly.
+			def verify_token(token) 
+				response = token.get("/#{API_VERSION}/account/verify_credentials.json")
+				response.class == Net::HTTPOK ? JSON.parse(response.body) : nil
+			end
+	end
+end

data/lib/retjilp/runner.rb

@@ -0,0 +1,14 @@
+require_relative 'options'
+require_relative 'retweeter'
+
+module Retjilp
+	class Runner
+		def initialize(argv)
+			@options = Options.new(argv)
+		end
+
+		def run
+			Retweeter.new(@options).run
+		end
+	end
+end

data/retjilp.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+	s.name = 'retjilp'
+	s.summary = 'Automatically retweet tweets'
+	s.description = 'Retjilp logs into your account, scans all the tweets from your following list or another defined list for a set of matching words, and retweets the ones that match (using the native retweet API).'
+	s.requirements = ['']
+	s.version = '0.2'
+	s.author = 'Remko Tronçon'
+	s.email = 'remko@el-tramo.be'
+	s.homepage = 'http://el-tramo.be/blog/retjilp'
+	s.platform = Gem::Platform::RUBY
+	s.required_ruby_version = '>=1.8'
+	s.files = Dir['**/**']
+	s.executables = 'retjilp'
+	s.require_paths = ['lib']
+	s.has_rdoc = false
+	s.license = 'BSD'
+
+	s.add_runtime_dependency('oauth')
+	s.add_runtime_dependency('json_pure')
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: retjilp
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Remko Tronçon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retjilp logs into your account, scans all the tweets from your following
+  list or another defined list for a set of matching words, and retweets the ones
+  that match (using the native retweet API).
+email: remko@el-tramo.be
+executables:
+- retjilp
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- bin/retjilp
+- config
+- COPYING
+- lib/retjilp/options.rb
+- lib/retjilp/retweeter.rb
+- lib/retjilp/runner.rb
+- README.markdown
+- retjilp.gemspec
+homepage: http://el-tramo.be/blog/retjilp
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- ''
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Automatically retweet tweets
+test_files: []