tweetly 0.0.1 → 0.1.0

data/README.md

@@ -2,7 +2,9 @@
 
 Generate nifty word frequency distributions from your Twitter statuses.
 
-Written and tested in __Ruby 1.9.3__.
+Written and tested in __Ruby 1.9.3__
+
+Gem hosted on [RubyGems](https://rubygems.org/gems/tweetly), where you can find more documentation.
 
 ## Installation
 
@@ -35,11 +37,11 @@ user.print_word_freq(tweets: 20, count: 5)
 
 which prints:
 
-		for (5)
-		$10 (3)
-		@julioz2 (3)
-		my (3)
-		post: (2)
+	for (5)
+	$10 (3)
+	@julioz2 (3)
+	my (3)
+	post: (2)
 
 By default, Tweetly pulls the last 1000 tweets from the user's timeline and displays the entire list of words.
 
@@ -49,52 +51,53 @@ user.print_word_freq
 
 which prints:
 
-		the (262)
-		to (179)
-		a (165)
-		@Sualehh (161)
-		my (112)
-		RT (107)
-		I (105)
-		of (100)
-		# and so on...
+	the (262)
+	to (179)
+	a (165)
+	@Sualehh (161)
+	my (112)
+	RT (107)
+	I (105)
+	of (100)
+	# and so on...
 
 Well, that's not a very interesting list. Let's ignore retweets as well as a few common words. Additionally, let's constrain our list to words of at least length 5, only word characters (i.e. letters, digits, underscores), and case insensitive:
 
 ```ruby
-		options = {
-			include_rts: false, 
-			ignore: ['the', 'to', 'a', 'I'], 
-			min_length: 5, 
-			words_only: true, 
-			case_sensitive: false
-		}
-		user.print_word_freq(options)
+options = {
+	include_rts: false, 
+	ignore: ['the', 'to', 'a', 'I'], 
+	min_length: 5, 
+	words_only: true, 
+	case_sensitive: false
+}
+
+user.print_word_freq(options)
 ```
 
 The above prints out:
 
-		sualehh (206)
-		foursquare (31)
-		julioz2 (30)
-		mlacitation (24)
-		compywiz (24)
-		right (21)
-		think (20)
-		pretty (20)
+	sualehh (206)
+	foursquare (31)
+	julioz2 (30)
+	mlacitation (24)
+	compywiz (24)
+	right (21)
+	think (20)
+	pretty (20)
 
 Awesome! That's a great looking list.
 
 If you strictly want the words and not the frequency counts printed, you can pass in the option `print_count: false`. For the above, we would just have
 
-		sualehh
-		foursquare
-		julioz2
-		mlacitation
-		compywiz
-		right
-		think
-		pretty
+	sualehh
+	foursquare
+	julioz2
+	mlacitation
+	compywiz
+	right
+	think
+	pretty
 
 ## Contributing
 

data/lib/tweetly.rb

@@ -1,6 +1,7 @@
 require "tweetly/version"
 require "twitter"
 require "tweetly/user"
+require "tweetly/error"
 
 module Tweetly
   # Your code goes here...

data/lib/tweetly/error.rb

@@ -0,0 +1,15 @@
+module Tweetly
+  class Error < StandardError
+
+    # Initializes a new Error object
+    #
+    # @param [String] message the error message
+    # @return [Tweetly::Error]
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  class Error::Unauthorized < Tweetly::Error
+  end
+end

data/lib/tweetly/user.rb

@@ -5,12 +5,14 @@ module Tweetly
 
 		def initialize(name)
 			user = Twitter.user(name)
-			unless user.protected?
+			if !user.protected?
 				@name = user.name
 				@screen_name = user.screen_name
 				@protected = user.protected?
 				@statuses_count = user.statuses_count
 				@timeline = []
+			else
+				raise Tweetly::Error::Unauthorized, "User is protected", caller
 			end
 		end
 
@@ -40,26 +42,19 @@ module Tweetly
 			fetch_timeline(params[:tweets]) if @timeline.count < params[:tweets]
 
 			freqDist = {}
-
 			@timeline.each_with_index do |tweet, i|
 				# :include_rts option
 				next if !params[:include_rts] && tweet.retweeted_status
 
 				tweet.text.split.each do |word|
-					# :ignore option
+					# Adjust according to options
 					next if params[:ignore].include? word
-
-					# :case_sensitive option
 					word.downcase! if !params[:case_sensitive]
-
-					# :words_only option
 					if params[:words_only]
 						word = word.match(/\w+/)
 						next unless word
 						word = word[0]
 					end
-
-					# :min_length option
 					next if params[:min_length] && word.length < params[:min_length]
 
 					if freqDist.has_key? word

data/lib/tweetly/version.rb

@@ -1,3 +1,3 @@
 module Tweetly
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/user_spec.rb

@@ -11,6 +11,14 @@ describe Tweetly::User do
     end
 	end
 
+	context "Initializing a protected user" do
+		it "should raise an error" do
+			lambda { 
+				@user = Tweetly::User.new('lbpere') 
+			}.should raise_error(Tweetly::Error::Unauthorized)
+		end
+	end
+
 	context "Fetching a user timeline" do
 		before do
 			@user = Tweetly::User.new('jicooo')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweetly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70128994114340 !ruby/object:Gem::Requirement
+  requirement: &70228646582600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128994114340
+  version_requirements: *70228646582600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70128994113540 !ruby/object:Gem::Requirement
+  requirement: &70228646582020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70128994113540
+  version_requirements: *70228646582020
 - !ruby/object:Gem::Dependency
   name: twitter
-  requirement: &70128994113060 !ruby/object:Gem::Requirement
+  requirement: &70228646581420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70128994113060
+  version_requirements: *70228646581420
 description: Twitter user timeline stats.
 email:
 - jico@baligod.com
@@ -58,6 +58,7 @@ files:
 - README.md
 - Rakefile
 - lib/tweetly.rb
+- lib/tweetly/error.rb
 - lib/tweetly/user.rb
 - lib/tweetly/version.rb
 - spec/spec_helper.rb
@@ -77,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4256241259014341675
+      hash: 3708206646365248655
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4256241259014341675
+      hash: 3708206646365248655
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17