tweetabout 0.0.1

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tweetabout.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dylan Jhaveri
+
+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,84 @@
+== Tweets About Gem
+
+This gem takes a twitter username and returns a list of words.
+
+The words are are ordered list of the most frequently tweeted words based on the users last 1,000 tweets.
+* Retweets are included 
+* The casing of words doesn't matter (the = The = THE).  Output is downcased.
+* URLs are removed, because that makes sense.
+
+
+== Installation
+
+`gem install tweetabout`
+
+Gemfile
+
+`gem 'tweetabout'`
+
+==Twitter API
+
+The Twitter API imposes a restriction on requests for users' timelines.  Each request can only receive a maximum of 200 tweets.  To get 1,000 tweets, that means we have to make 5 round trips to the api server.  Let's see how longs these requests take.  This is the measured response time of the GET request for 5 different twitter usernames:
+
+ex: GET `http://api.twitter.com/1/statuses/user_timeline.json?screen_name=#{user}&include_rts=true&count=200`
+(time in ms)
+                
+                trial1    trial2    trial3    trial4    trial5
+    request1    806.521   740.214   1363.33   490.090   331.253
+    request2    720.767   537.374   673.249   532.168   478.668
+    request3    492.608   733.955   560.918   547.887   380.81
+    request4    480.757   945.29    645.733   605.972   340.256
+    request5    575.621   469.731   707.737   826.423   169.244
+
+Based on this small test we can see that response times from the api vary from a few hundred milliseconds up to a full second.  Of course this is all influnced by time of day, network connection, and a variety of factors but it's good to know that if we have to make 5 trips in a row to the twitter api server we can't really count on it being very fast.  In fact, 5 requests could easily take 2.5 to 3 seconds to complete.  No doubt this is the slowest part of this app.
+
+==Speed
+All these measurments are for processing the maximum of 1,000 tweets.  If the user has less than 1,000 tweets, obviously these processes will be faster.
+
+To see speeds yourself, checkout the speed branch and watch the server output.
+
+===get_tweets method
+`application_controller.rb: 29`
+This method does 5 GET requests to the Twitter api and stores them all in `@responses` These are the different time measurements:
+
+    4985.406 ms
+    3566.376 
+    4071.794 
+    7759.329 
+    3656.680
+    4510.602
+
+===Processing responses
+`@responses.each do |tweet|` block in `application_controller.rb:11
+This method essentially takes the @responses variable, which is all the tweets, splits the words apart, removes punctuation and creates a hash of keys and values, keys are words, values are the number of times that word has shown up.  (the `bad_key` method below is part of this block.
+
+    107.844 ms
+    117.764
+    78.989
+    87.12
+    137.528
+    134.256    
+
+====bad_key method:
+
+    .006ms - .013ms each word
+
+====Sorting
+`application_controller.rb:21`
+    
+    4.245 ms
+    4.016
+    4.098
+    5.509
+    3.994
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/tweetabout/version.rb

@@ -0,0 +1,3 @@
+module Tweetabout
+  VERSION = "0.0.1"
+end

data/lib/tweetabout.rb

@@ -0,0 +1,67 @@
+require "tweetabout/version"
+
+module Tweetabout
+  def self.tweetabout(user)
+    get_tweets(user)
+
+    hash = {}
+    @responses.each do |tweet|
+      tweet.split(" ").each do |key|
+        key = key.gsub(/\W/, "").downcase
+        if hash.has_key?(key)
+          hash["#{key}"] += 1
+        else
+          hash.merge!({"#{key}" => 1}) unless bad_key(key)
+        end
+      end
+    end
+    @sorted_array = hash.sort_by { |keyword, frequency| frequency }.reverse
+    @sorted_array.map { |keyword| keyword[0] }
+  end
+
+  def self.bad_key(key)
+    return true if key.empty?
+    return true if key.start_with?('http')
+  end
+  
+  def self.get_tweets(user)
+    count = 200
+    base_url = "http://api.twitter.com/1/statuses/user_timeline.json?screen_name=#{user}&include_rts=true&count=#{count}"
+
+    @responses = []
+    response1 = HTTParty.get("#{base_url}")
+    return if response1.code == 404
+    start_at_1 = response1.last["id"]
+    response1.each do |object|
+      @responses << object["text"]
+    end
+
+    response2 = HTTParty.get("#{base_url}&max_id=#{start_at_1-1}")
+    return if response2.count == 0
+    start_at_2 = response2.last["id"]
+    response2.each do |object|
+      @responses << object["text"]
+    end
+    
+    response3 = HTTParty.get("#{base_url}&max_id=#{start_at_2-1}")
+    return if response3.count == 0
+    start_at_3 = response3.last["id"]
+    response3.each do |object|
+      @responses << object["text"]
+    end
+    
+    response4 = HTTParty.get("#{base_url}&max_id=#{start_at_3-1}")
+    return if response4.count == 0
+    start_at_4 = response4.last["id"]
+    response4.each do |object|
+      @responses << object["text"]
+    end
+
+    response5 = HTTParty.get("#{base_url}&max_id=#{start_at_4-1}")
+    return if response5.count == 0
+    start_at_5 = response4.last["id"]
+    response5.each do |object|
+      @responses << object["text"]
+    end
+  end
+end

data/tweetabout.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tweetabout/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dylan Jhaveri"]
+  gem.email         = ["dylanjhaveri@gmail.com"]
+  gem.description   = %q{Returns a list of frequently tweeted words}
+  gem.summary       = %q{Takes a twitter username and outputs the most frequently tweeted words in their last 1,000 tweets.  Includes Re-tweets and excludes links.}
+  gem.homepage      = ""
+
+  gem.add_dependency "httparty"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tweetabout"
+  gem.require_paths = ["lib"]
+  gem.version       = Tweetabout::VERSION
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: tweetabout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dylan Jhaveri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Returns a list of frequently tweeted words
+email:
+- dylanjhaveri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tweetabout.rb
+- lib/tweetabout/version.rb
+- tweetabout.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Takes a twitter username and outputs the most frequently tweeted words in
+  their last 1,000 tweets.  Includes Re-tweets and excludes links.
+test_files: []