gilesbowkett-twitter 0.4.3

data/lib/twitter/cli.rb

@@ -0,0 +1,334 @@
+require 'rubygems'
+
+gem 'main', '>= 2.8.2'
+gem 'highline', '>= 1.4.0'
+gem 'activerecord', '= 2.2.2'
+gem 'sqlite3-ruby', '>= 1.2.1'
+
+require 'main'
+require 'highline/import'
+require 'activerecord'
+require 'sqlite3'
+
+HighLine.track_eof = false
+CLI_ROOT = File.expand_path(File.join(File.dirname(__FILE__), 'cli'))
+require CLI_ROOT + '/config'
+require CLI_ROOT + '/helpers'
+Dir[CLI_ROOT + '/models/*.rb'].each { |m| require m }
+
+include Twitter::CLI::Helpers
+
+Main {
+  def run
+    puts "twitter [command] --help for usage instructions."
+    puts "The available commands are: \n   install, uninstall, add, remove, list, change, post, befriend, defriend, follow, leave, d and timeline."
+  end
+  
+  mode 'install' do
+    description 'Creates the sqlite3 database and runs the migrations.'
+    def run
+      migrate
+      attempt_import
+      say 'Twitter installed.'
+    end
+  end
+  
+  mode 'uninstall' do
+    description 'Removes the sqlite3 database. There is no undo for this.'
+    def run
+      FileUtils.rm(Twitter::CLI::Config[:database]) if File.exists?(Twitter::CLI::Config[:database])
+      say 'Twitter gem uninstalled.'
+    end
+  end
+  
+  mode 'add' do
+    description 'Adds a new twitter account to the database. Prompts for username and password.'
+    argument('username', 'u') {
+      optional
+      description 'optional username'
+    }
+    argument('password', 'p') {
+      optional
+      description 'optional password'
+    }
+    
+    def run
+      account = Hash.new
+      say "Add New Account:"
+      
+      # allows optional username arg
+      if params['username'].given?
+        account[:username] = params['username'].value
+      else
+        account[:username] = ask('Username: ') do |q|
+          q.validate = /\S+/
+        end
+      end
+      
+      # allows optional password arg
+      if params['password'].given?
+        account[:password] = params['password'].value
+      else
+        account[:password] = ask("Password (won't be displayed): ") do |q|
+          q.echo = false
+          q.validate = /\S+/
+        end
+      end
+      
+      do_work do
+        base(account[:username], account[:password]).verify_credentials
+        Account.add(account)
+        say 'Account added.'
+      end
+    end
+  end
+  
+  mode 'remove' do
+    description 'Removes a twitter account from the database. If username provided it removes that username else it prompts with list and asks for which one you would like to remove.'
+    argument( 'username' ) { 
+      optional
+      description 'username of account you would like to remove' 
+    }
+    
+    def run
+      do_work do
+        if params['username'].given?
+          account = Account.find_by_username(params['username'].value)
+        else
+          Account.find(:all, :order => 'username').each do |a|
+            say "#{a.id}. #{a}"
+          end
+          account_id = ask 'Account to remove (enter number): ' do |q|
+            q.validate = /\d+/
+          end
+        end
+        
+        begin
+          account = account_id ? Account.find(account_id) : account
+          account_name = account.username
+          account.destroy
+          Account.set_current(Account.first) if Account.new_active_needed?
+          say "#{account_name} has been removed.\n"
+        rescue ActiveRecord::RecordNotFound
+          say "ERROR: Account could not be found. Try again. \n"
+        end
+      end
+    end
+  end
+  
+  mode 'list' do
+    description 'Lists all the accounts that have been added and puts a * by the current one that is used for posting, etc.'
+    def run
+      do_work do
+        if Account.count == 0
+          say 'No accounts have been added.' 
+        else
+          say 'Account List'
+          Account.find(:all, :order => 'username').each do |a|
+            say a 
+          end
+        end
+      end
+    end
+  end
+  
+  mode 'change' do
+    description 'Changes the current account being used for posting etc. to the username provided. If no username is provided, a list is presented and you can choose the account from there.'
+    argument( 'username' ) { 
+      optional
+      description 'username of account you would like to switched to' 
+    }
+    
+    def run
+      do_work do
+        if params['username'].given?
+          new_current = Account.find_by_username(params['username'].value)
+        else
+          Account.find(:all, :order => 'username').each do |a|
+            say "#{a.id}. #{a}"
+          end
+          new_current = ask 'Change current account to (enter number): ' do |q|
+            q.validate = /\d+/
+          end
+        end
+        
+        begin
+          current = Account.set_current(new_current)
+          say "#{current} is now the current account.\n"
+        rescue ActiveRecord::RecordNotFound
+          say "ERROR: Account could not be found. Try again. \n"
+        end
+      end
+    end
+  end
+  
+  mode 'post' do
+    description "Posts a message to twitter using the current account. The following are all valid examples from the command line:
+    $ twitter post 'my update'
+    $ twitter post my update with quotes
+    $ echo 'my update from stdin' | twitter post"
+    def run
+      do_work do
+        post = ARGV.size > 1 ? ARGV.join(" ") : ARGV.shift
+        say "Sending twitter update"
+        finished, status = false, nil
+        progress_thread = Thread.new { until finished; print "."; $stdout.flush; sleep 0.5; end; }
+        post_thread = Thread.new(binding()) do |b|
+          status = base.post(post, :source => Twitter::SourceName)
+          finished = true
+        end
+        post_thread.join
+        progress_thread.join
+        say "Got it! New tweet created at: #{status.created_at}\n"
+      end
+    end
+  end
+
+  mode 'befriend' do
+    description "Allows you to add a user as a friend"
+    argument('username') {
+      required
+      description 'username or id of twitterrer to befriend'
+    }
+
+    def run
+      do_work do
+        username = params['username'].value
+        base.create_friendship(username)
+        say "#{username} has been added as a friend. follow notifications with 'twitter follow #{username}'"
+      end
+    end
+  end
+
+  mode 'defriend' do
+    description "Allows you to remove a user from being a friend"
+    argument('username') {
+      required
+      description 'username or id of twitterrer to defriend'
+    }
+
+    def run
+      do_work do
+        username = params['username'].value
+        base.destroy_friendship(username)
+        say "#{username} has been removed from your friends"
+      end
+    end
+  end
+  
+  mode 'follow' do
+    description "Allows you to add notifications for a user (aka Follow Them)"
+    argument('username') {
+      required
+      description 'username or id of twitterrer to follow'
+    }
+    
+    def run
+      do_work do
+        username = params['username'].value
+        base.follow(username)
+        say "You are now following notifications from #{username}"
+      end
+    end
+  end
+  
+  mode 'leave' do
+    description "Allows you to turn off notifications for a user"
+    argument('username') {
+      required
+      description 'username or id of twitterrer to leave'
+    }
+    
+    def run
+      do_work do
+        username = params['username'].value
+        base.leave(username)
+        say "You are no longer following notifications from #{username}"
+      end
+    end
+  end
+  
+  mode 'd' do
+    description "Allows you to direct message a user. The following are all valid examples from the command line:
+    $ twitter d jnunemaker 'yo homeboy'
+    $ twitter d jnunemaker yo homeboy
+    $ echo 'yo homeboy' | twitter d jnunemaker"
+    argument('username') {
+      required
+      description 'username or id of twitterrer to direct message'
+    }
+    
+    def run
+      do_work do
+        username = params['username'].value
+        post = ARGV.size > 1 ? ARGV.join(" ") : ARGV.shift
+        base.d(username, post)
+        say "Direct message sent to #{username}"
+      end
+    end
+  end
+  
+  mode 'timeline' do
+    description "Allows you to view your timeline, your friends or the public one"
+    argument( 'timeline' ) {
+      description 'the timeline you wish to see (friends, public, me)'
+      default 'friends'
+    }
+    option('force', 'f') {
+      description "Ignore since_id and show first page of results even if there aren't new ones"
+    }
+    option('reverse', 'r') {
+      description 'Reverse the output so the oldest tweets are at the top'
+    }
+    
+    def run
+      do_work do
+        timeline = params['timeline'].value == 'me' ? 'user' : params['timeline'].value
+        options, since_id = {}, Configuration["#{timeline}_since_id"]
+        options[:since_id] = since_id if !since_id.nil? && !params['force'].given?
+        reverse = params['reverse'].given? ? true : false
+        cache = [:friends, :user].include?(timeline)
+        collection = base.timeline(timeline.to_sym, options)
+        output_tweets(collection, {:cache => cache, :since_prefix => timeline, :reverse => reverse})
+      end
+    end
+  end
+  
+  mode 'replies' do
+    description 'Allows you to view all @replies sent to you'
+    option('force', 'f') {
+      description "Ignore since_id and show first page of replies even if there aren't new ones"
+    }
+    
+    def run
+      do_work do
+        options, since_id = {}, Configuration["replies_since_id"]
+        options[:since_id] = since_id if !since_id.nil? && !params['force'].given?
+        collection = base.replies(options)
+        output_tweets(collection, {:since_prefix => 'replies'})
+      end
+    end
+  end
+  
+  mode 'clear_config' do
+    def run
+      do_work do
+        count = Configuration.count
+        Configuration.destroy_all
+        say("#{count} configuration entries cleared.")
+      end
+    end
+  end
+  
+  mode 'open' do
+    description 'Opens the given twitter user in a browser window'
+    argument('username') {
+      required
+      description "username or id of twitterrer who's page you would like to see"
+    }
+    
+    def run
+      `open http://twitter.com/#{params['username'].value}`
+    end
+  end
+}

data/lib/twitter/direct_message.rb

@@ -0,0 +1,30 @@
+module Twitter
+  class DirectMessage
+    include EasyClassMaker
+    
+    attributes :id,
+               :text,
+               :sender_id,
+               :recipient_id,
+               :created_at,
+               :sender_screen_name,
+               :recipient_screen_name,
+               :sender_profile_image_url
+    
+    class << self
+      # Creates a new status from a piece of xml
+      def new_from_xml(xml)
+        DirectMessage.new do |d|
+          d.id                    = (xml).at('id').innerHTML
+          d.text                  = (xml).get_elements_by_tag_name('text').innerHTML
+          d.sender_id             = (xml).at('sender_id').innerHTML
+          d.recipient_id          = (xml).at('recipient_id').innerHTML
+          d.created_at            = (xml).at('created_at').innerHTML
+          d.sender_screen_name    = (xml).at('sender_screen_name').innerHTML
+          d.recipient_screen_name = (xml).at('recipient_screen_name').innerHTML
+          d.sender_profile_image_url = (xml).at('sender').at('profile_image_url').innerHTML
+        end
+      end
+    end
+  end
+end

data/lib/twitter/easy_class_maker.rb

@@ -0,0 +1,43 @@
+# This is pretty much just a macro for creating a class that allows
+# using a block to initialize stuff and to define getters and setters
+# really quickly.
+module Twitter
+  module EasyClassMaker
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      # creates the attributes class variable and creates each attribute's accessor methods
+      def attributes(*attrs)
+        @@attributes = attrs
+        @@attributes.each { |a| attr_accessor a }
+      end
+      
+      # read method for attributes class variable
+      def self.attributes; @@attributes end
+    end
+    
+    # allows for any class that includes this to use a block to initialize
+    # variables instead of assigning each one seperately
+    # 
+    # Example: 
+    # 
+    # instead of...
+    # 
+    # s = Status.new
+    # s.foo = 'thing'
+    # s.bar = 'another thing'
+    #
+    # you can ...
+    # 
+    # Status.new do |s|
+    #   s.foo = 'thing'
+    #   s.bar = 'another thing'
+    # end
+    def initialize
+      yield self if block_given?
+    end
+  end
+end

data/lib/twitter/rate_limit_status.rb

@@ -0,0 +1,19 @@
+module Twitter
+  class RateLimitStatus
+    include EasyClassMaker
+    
+    attributes :reset_time_in_seconds, :reset_time, :remaining_hits, :hourly_limit
+    
+    class << self
+      # Creates a new rate limi status from a piece of xml
+      def new_from_xml(xml)
+        RateLimitStatus.new do |s|
+          s.reset_time_in_seconds = xml.at('reset-time-in-seconds').inner_html.to_i
+          s.reset_time            = Time.parse xml.at('reset-time').inner_html
+          s.remaining_hits        = xml.at('remaining-hits').inner_html.to_i
+          s.hourly_limit          = xml.at('hourly-limit').inner_html.to_i
+        end
+      end
+    end
+  end
+end

data/lib/twitter/search.rb

@@ -0,0 +1,101 @@
+gem 'httparty'
+require 'httparty'
+
+module Twitter
+  class Search
+    include HTTParty
+    include Enumerable
+    base_uri 'search.twitter.com'
+    
+    attr_reader :result, :query
+    
+    def initialize(q=nil)
+      clear
+      containing(q) if q && q.strip != ''
+    end
+    
+    def from(user)
+      @query[:q] << "from:#{user}"
+      self
+    end
+    
+    def to(user)
+      @query[:q] << "to:#{user}"
+      self
+    end
+    
+    def referencing(user)
+      @query[:q] << "@#{user}"
+      self
+    end
+    alias :references :referencing
+    alias :ref :referencing
+    
+    def containing(word)
+      @query[:q] << "#{word}"
+      self
+    end
+    alias :contains :containing
+    
+    # adds filtering based on hash tag ie: #twitter
+    def hashed(tag)
+      @query[:q] << "##{tag}"
+      self
+    end
+    
+    # lang must be ISO 639-1 code ie: en, fr, de, ja, etc.
+    #
+    # when I tried en it limited my results a lot and took 
+    # out several tweets that were english so i'd avoid 
+    # this unless you really want it
+    def lang(lang)
+      @query[:lang] = lang
+      self
+    end
+    
+    # Limits the number of results per page
+    def per_page(num)
+      @query[:rpp] = num
+      self
+    end
+    
+    # Which page of results to fetch
+    def page(num)
+      @query[:page] = num
+      self
+    end
+    
+    # Only searches tweets since a given id. 
+    # Recommended to use this when possible.
+    def since(since_id)
+      @query[:since_id] = since_id
+      self
+    end
+    
+    # Search tweets by longitude, latitude and a given range.
+    # Ranges like 25km and 50mi work.
+    def geocode(long, lat, range)
+      @query[:geocode] = [long, lat, range].join(',')
+      self
+    end
+    
+    # Clears all the query filters to make a new search
+    def clear
+      @query = {}
+      @query[:q] = []
+      self
+    end
+    
+    # If you want to get results do something other than iterate over them.
+    def fetch
+      @query[:q] = @query[:q].join(' ')
+      SearchResultInfo.new_from_hash(self.class.get('/search.json', {:query => @query}))
+    end
+    
+    def each
+      @result = fetch()
+      @result['results'].each { |r| yield r }
+    end
+  end
+end
+

data/lib/twitter/search_result.rb

@@ -0,0 +1,83 @@
+module Twitter
+  class SearchResult < Hash
+    
+    # Creates an easier to work with hash from
+    # one with string-based keys
+    def self.new_from_hash(hash)
+      new.merge!(hash)
+    end
+    
+    def created_at
+      self['created_at']
+    end
+    
+    def created_at=(val)
+      self['created_at'] = val
+    end
+    
+    def from_user
+      self['from_user']
+    end
+    
+    def from_user=(val)
+      self['from_user'] = val
+    end
+    
+    def from_user_id
+      self['from_user_id']
+    end
+    
+    def from_user_id=(val)
+      self['from_user_id'] = val
+    end
+    
+    def id
+      self['id']
+    end
+    
+    def id=(val)
+      self['id'] = val
+    end
+    
+    def iso_language_code
+      self['iso_language_code']
+    end
+    
+    def iso_language_code=(val)
+      self['iso_language_code'] = val
+    end
+    
+    def profile_image_url
+      self['profile_image_url']
+    end
+    
+    def profile_image_url=(val)
+      self['profile_image_url'] = val
+    end
+    
+    def text
+      self['text']
+    end
+    
+    def text=(val)
+      self['text'] = val
+    end
+    
+    def to_user
+      self['to_user']
+    end
+    
+    def to_user=(val)
+      self['to_user'] = val
+    end
+    
+    def to_user_id
+      self['to_user_id']
+    end
+    
+    def to_user_id=(val)
+      self['to_user_id'] = val
+    end
+    
+  end
+end

data/lib/twitter/search_result_info.rb

@@ -0,0 +1,82 @@
+module Twitter
+  class SearchResultInfo < Hash
+    
+    # Creates an easier to work with hash from
+    # one with string-based keys
+    def self.new_from_hash(hash)
+      i = new
+      i.merge!(hash)
+      search_results = []
+      i.results.each do |r|
+        search_results << SearchResult.new_from_hash(r)
+      end
+      i.results = search_results
+      i
+    end
+    
+    def completed_in
+      self['completed_in']
+    end
+    
+    def completed_in=(val)
+      self['completed_in'] = val
+    end
+    
+    def max_id
+      self['max_id']
+    end
+    
+    def max_id=(val)
+      self['max_id'] = val
+    end
+    
+    def next_page
+      self['next_page']
+    end
+    
+    def next_page=(val)
+      self['next_page'] = val
+    end
+    
+    def page
+      self['page']
+    end
+    
+    def page=(val)
+      self['page'] = val
+    end
+    
+    def refresh_url
+      self['refresh_url']
+    end
+    
+    def refresh_url=(val)
+      self['refresh_url'] = val
+    end
+    
+    def results_per_page
+      self['results_per_page']
+    end
+    
+    def results_per_page=(val)
+      self['results_per_page'] = val
+    end
+    
+    def since_id
+      self['since_id']
+    end
+    
+    def since_id=(val)
+      self['since_id'] = val
+    end
+    
+    def results
+      self['results']
+    end
+    
+    def results=(val)
+      self['results'] = val
+    end
+    
+  end
+end