retjilp 0.2 → 0.3

data/lib/retjilp/runner.rb

@@ -1,14 +1,51 @@
-require_relative 'options'
+require 'json/pure'
+require 'optparse'
+
+require_relative 'log'
 require_relative 'retweeter'
+require_relative 'twitter'
 
 module Retjilp
+	DATA_DIR = File.expand_path("~/.retjilp")
+
 	class Runner
 		def initialize(argv)
-			@options = Options.new(argv)
+			# Parse command-line options
+			OptionParser.new do |opts|
+				opts.banner = "Usage: retjilp [ --help ] [ --verbose | --debug ]"
+				opts.on("--verbose", "Run with verbose output") { Retjilp::log.level = Logger::INFO }
+				opts.on("--debug", "Run with debug output") { Retjilp::log.level = Logger::DEBUG }
+				opts.on_tail("-h", "--help", "Show this help") { puts opts ; exit }
+				begin
+					opts.parse!(argv)
+				rescue => e
+					fatal_error("Invalid option(s): #{e.message}\n" + opts.to_s)
+				end
+			end
+
+			# Parse config file
+			config_filename = File.join(DATA_DIR, "config")
+			begin
+				@options = File.open(config_filename) { |f| JSON.load(f) }
+			rescue => e
+				fatal_error("Error parsing configuration file #{config_filename}: #{e.message}")
+			end
+
+			# Convert keys to symbols
+			@options = @options.inject({}){|m,(k,v)| m[k.to_sym] = v; m}
 		end
 
 		def run
-			Retweeter.new(@options).run
+			consumer_key = (@options[:consumer_key] or fatal_error("Consumer key missing"))
+			consumer_secret = (@options[:consumer_secret] or fatal_error("Consumer secret missing"))
+			twitter = Twitter.new(@options[:consumer_key], @options[:consumer_secret])
+			Retweeter.new(twitter, @options).run
 		end
+
+		private
+			def fatal_error(msg)
+				STDERR.puts msg
+				exit(-1)
+			end
 	end
 end

data/lib/retjilp/twitter.rb

@@ -0,0 +1,118 @@
+require_relative 'log'
+
+module Retjilp
+	class Twitter
+		TWITTER_URI = "http://api.twitter.com"
+		API_VERSION = "1.1"
+		ACCESS_TOKEN_FILENAME = File.join(File.expand_path("~/.retjilp"), "access_token")
+
+		def initialize(consumer_key, consumer_secret)
+			@consumer_key = consumer_key
+			@consumer_secret = consumer_secret
+		end
+
+		def user_timeline
+			Retjilp::log.info("Fetching own tweets")
+			get "/statuses/user_timeline.json?trim_user=true&include_rts=true"
+		end
+
+		def list_statuses(list, options)
+			Retjilp::log.info("Fetching list tweets of #{list}")
+			since_id = options[:since_id] ? "&since_id=#{options[:since_id]}" : ""
+			get "/lists/statuses.json?slug=#{list}&owner_screen_name=#{@user_info['screen_name']}&include_rts=true" + since_id
+		end
+
+		def home_timeline(options)
+			since_id = options[:since_id] ? "&since_id=#{options[:since_id]}" : ""
+			get "/statuses/home_timeline.json?trim_user=true" + since_id
+		end
+
+		def retweet(id)
+			result = @access_token.post("/#{API_VERSION}/statuses/retweet/#{id}.json")
+			result.class == Net::HTTPOK or Retjilp::log.error("Error retweeting #{result.body}")
+		end
+
+		def login
+			# Request the token if the cached access token does not exist
+			@access_token, @user_info = cached_access_token
+			unless @access_token
+				STDIN.tty? or raise "This script must be run interactively the first time to be able to authenticate."
+				Retjilp::log.info("Requesting new access token")
+				consumer = OAuth::Consumer.new(
+					@consumer_key,
+					@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
+					raise "Invalid PIN verification!"
+				end
+				@user_info = verify_token(@access_token) or raise "Access token not authorized!"
+				cached_access_token = @access_token
+			end
+			Retjilp::log.info("Logged in as #{@user_info["screen_name"]}")
+		end
+
+		protected
+			def cached_access_token
+				access_token = nil
+				user_info = nil
+				if File.exist?(ACCESS_TOKEN_FILENAME)
+					Retjilp::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(@consumer_key, @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)
+								Retjilp::log.warn("Cached token not authorized")
+								access_token = nil
+							end
+						rescue JSON::ParserError 
+							Retjilp::log.warn("Cached token does not parse")
+						end
+					end 
+				end
+				[access_token, user_info]
+			end
+
+			def cached_access_token=(access_token)
+				Retjilp::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
+
+		private
+			# 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
+
+		private 
+			def get(url)
+				full_url = "/#{API_VERSION}#{url}"
+				Retjilp::log.debug("-> " + full_url)
+				result = JSON.parse(@access_token.get("/#{API_VERSION}/#{url}").body)
+				Retjilp::log.debug("<- " + JSON.pretty_generate(result))
+				raise "Error fetching result: #{result.to_s}" if result.include? "errors"
+				result
+			end
+	end
+end

data/retjilp.gemspec

@@ -5,18 +5,24 @@ Gem::Specification.new do |s|
 	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.version = '0.3'
 	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.files = Dir['{bin,lib,doc}/**/*'] + Dir['[A-Z]*'] + ['retjilp.gemspec']
 	s.executables = 'retjilp'
 	s.require_paths = ['lib']
 	s.has_rdoc = false
 	s.license = 'BSD'
+	s.test_files = Dir.glob("test/**/*.rb")
 
 	s.add_runtime_dependency('oauth')
 	s.add_runtime_dependency('json_pure')
+
+	s.add_development_dependency('rake')
+	s.add_development_dependency('rspec-core')
+	s.add_development_dependency('rspec-mocks')
+	s.add_development_dependency('rspec-expectations')
 end

data/test/spec/retweeter_spec.rb

@@ -0,0 +1,82 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+require 'retjilp/retweeter'
+require 'retjilp/twitter'
+
+module Retjilp 
+	describe Retweeter do
+		let(:twitter) { double(Twitter) }
+
+		before (:each) do
+			twitter.stub(:login)
+		end
+
+		context 'match keyword' do
+			let(:retweeter) { Retweeter.new(twitter, :match => ['MatchingKeyword']) }
+
+			context 'empty user timeline' do
+				before(:each) do
+					twitter.stub(:user_timeline) {[]}
+				end
+
+				it 'retweets new matching items' do
+					twitter.stub(:home_timeline) {[{'text' => 'MatchingKeyword', 'id' => 'id1'}]}
+					twitter.should_receive(:retweet).with('id1')
+					retweeter.run
+				end
+
+				it 'does not retweet non-matching items' do
+					twitter.stub(:home_timeline) {[{'text' => 'OtherKeyword', 'id' => 'id1'}]}
+					twitter.should_not_receive(:retweet)
+					retweeter.run
+				end
+
+				it 'retweets retweets with their id' do
+					twitter.stub(:home_timeline) {[{'text' => 'MatchingKeyword', 'id' => 'id1', 'retweeted_status' => {'id' => 'id2'}}]}
+					twitter.should_receive(:retweet).with('id2')
+					retweeter.run
+				end
+			end
+
+			context 'user timeline with already retweeted items' do
+				before(:each) do
+					twitter.stub(:user_timeline) {[{}, {'retweeted_status' => {'id' => 'id1'}}]}
+				end
+
+				it 'does not retweet already tweeted items' do
+					twitter.stub(:home_timeline) {[{'text' => 'MatchingKeyword', 'id' => 'id1'}]}
+					twitter.should_not_receive(:retweet)
+					Retweeter.new(twitter, :match => ['MatchingKeyword']).run
+				end
+			end
+		end
+
+		context 'match is empty' do
+			let(:retweeter) { Retweeter.new(twitter, :match => []) }
+
+			it 'retweets all items' do
+				twitter.stub(:user_timeline) {[]}
+				twitter.stub(:home_timeline) {[{'text' => 'OtherKeyword', 'id' => 'id1'}]}
+
+				twitter.should_receive(:retweet).with('id1')
+
+				retweeter.run
+			end
+		end
+
+		context 'retweet from list' do
+			let(:retweeter) { Retweeter.new(twitter, :retweet_from_list => 'MyList', :match => ['MatchingKeyword']) }
+
+			it 'retweets from the right list' do
+				twitter.stub(:user_timeline) {[]}
+				twitter.should_receive(:list_statuses).with('MyList', anything()).and_return([
+					{'text' => 'MatchingKeyword', 'id' => 'id1'},
+					{'text' => 'OtherKeyword', 'id' => 'id2'}
+				])
+				twitter.should_receive(:retweet).with('id1')
+				retweeter.run
+			end
+		end
+
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retjilp
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Remko Tronçon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -38,6 +38,62 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  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: 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).
@@ -47,15 +103,37 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- AUTHORS
 - bin/retjilp
-- config
-- COPYING
-- lib/retjilp/options.rb
+- lib/retjilp/log.rb
 - lib/retjilp/retweeter.rb
 - lib/retjilp/runner.rb
+- lib/retjilp/twitter.rb
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.AUTHORS.html
+- doc/file.COPYING.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/Retjilp/Options.html
+- doc/Retjilp/Retweeter.html
+- doc/Retjilp/Runner.html
+- doc/Retjilp.html
+- doc/top-level-namespace.html
+- AUTHORS
+- COPYING
+- Rakefile
 - README.markdown
 - retjilp.gemspec
+- test/spec/retweeter_spec.rb
 homepage: http://el-tramo.be/blog/retjilp
 licenses:
 - BSD
@@ -81,4 +159,5 @@ rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Automatically retweet tweets
-test_files: []
+test_files:
+- test/spec/retweeter_spec.rb

data/config

@@ -1,27 +0,0 @@
-/*
- * 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

@@ -1,24 +0,0 @@
-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