twat 0.4.15 → 0.5.0

data/TODO

@@ -29,3 +29,22 @@ PENDING
 Add some commands to retweet/favourite etc
 
 Consider allowing to -f multiple accounts at once
+
+Refactor the calls to Twitter to hook my own object, which in turn hooks
+the current_account to work out which service it uses.
+
+(Bonus points for adding a hook which can also use an arbitrary user
+specified url)
+
+Allow -f #hashtag to follow that hashtag instead of your newsfeed
+
+Seriously consider moving to subcommands
+
+MOAR BACKENDS
+=============
+
+Abstract all the logic for the various operations (add, follow, post,
+etc etc)
+
+into a wrapper for each service so that twat can natively support
+facebook, g+ etc etc as I get around to writing the new modules.

data/lib/twat.rb

@@ -6,7 +6,7 @@ require 'yaml'
 require 'optparse'
 require 'oauth'
 
-%w[config exceptions argparse actions migration options].each do |filename|
+%w[config exceptions argparse actions migration options endpoint].each do |filename|
   require "twat/#{filename}"
 end
 
@@ -44,8 +44,8 @@ end
 
 module Twat
   VERSION_MAJOR = 0
-  VERSION_MINOR = 4
-  VERSION_PATCH = 15
+  VERSION_MINOR = 5
+  VERSION_PATCH = 0
 
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
   class Twat
@@ -56,6 +56,11 @@ module Twat
       # FIXME Handing in the opts like this feels dirty
       with_handled_exceptions(ArgParse.new) do |opts|
         actor = Actions.new
+
+        if opts[:account] && opts[:action] != :add
+          config.account = opts[:account]
+        end
+
         actor.config = config
         actor.opts = opts
         actor.send(opts.options[:action])

data/lib/twat/actions.rb

@@ -1,6 +1,7 @@
 module Twat
   OAUTH_TOKENS = [ :oauth_token, :oauth_token_secret ]
   CONSUMER_TOKENS = [ :consumer_key, :consumer_secret ]
+
   class Actions
 
     attr_accessor :config, :opts, :failcount
@@ -14,23 +15,30 @@ module Twat
       #puts opts.msg
     end
 
+    # Add is somewhat of a special case, everything else hangs off config for
+    # it's magic, However we're forced to do it manually here- config doesn't
+    # know anything about it yet
     def add
-      v = Config.consumer_info.map do |key, value|
+      endpoint = Endpoint.new(opts[:endpoint])
+      v = endpoint.consumer_info.map do |key, value|
         value
       end
-      # FIXME probably allow something other than 
-      # twitter
-      oauth = OAuth::Consumer.new( v[0], v[1],
-              { site: "http://twitter.com" })
+
+      oauth_options = { :site => endpoint.url }
+      oauth_options.merge!(endpoint.oauth_options)
+
+      oauth = OAuth::Consumer.new( v[0], v[1], oauth_options )
       token_request = oauth.get_request_token()
       puts "Please authenticate the application at #{token_request.authorize_url}, then enter pin"
-      pin = gets.chomp
+      pin = STDIN.gets.chomp
       begin
         access_token = token_request.get_access_token(oauth_verifier: pin)
-        config.accounts[opts[:account]] = {
+        account_settings = {
           oauth_token: access_token.token,
-          oauth_token_secret: access_token.secret
+          oauth_token_secret: access_token.secret,
+          endpoint: opts[:endpoint]
         }
+        config.accounts[opts[:account]] = account_settings
         config.save!
       rescue OAuth::Unauthorized
         puts "Couldn't authenticate you, did you enter the pin correctly?"
@@ -61,7 +69,7 @@ module Twat
 
     def show
       twitter_auth
-      Twitter.home_timeline(:count => opts[:count]).each do |tweet|
+      Twitter.home_timeline(:count => opts[:count]).reverse.each do |tweet|
         format(tweet)
       end
     end
@@ -72,7 +80,7 @@ module Twat
     def process_followed(tweets)
       last_id = nil
       tweets.reverse.each do |tweet|
-        beep if config.beep? && tweet.text.mentions?(account_name)
+        beep if config.beep? && tweet.text.mentions?(config.account_name)
         format(tweet)
         last_id = tweet.id
       end
@@ -136,9 +144,9 @@ module Twat
     def format(twt)
       text = deentitize(twt.text)
       if config.colors?
-        if twt.user.screen_name == account_name.to_s
+        if twt.user.screen_name == config.account_name.to_s
           puts "#{twt.user.screen_name.bold.blue}: #{text}"
-        elsif text.mentions?(account_name)
+        elsif text.mentions?(config.account_name)
           puts "#{twt.user.screen_name.bold.red}: #{text}"
         else
           puts "#{twt.user.screen_name.bold.cyan}: #{text}"
@@ -157,12 +165,13 @@ module Twat
 
     def twitter_auth
       Twitter.configure do |twit|
-        account.each do |key, value|
+        config.account.each do |key, value|
           twit.send("#{key}=", value)
         end
-        Config.consumer_info.each do |key, value|
+        config.endpoint.consumer_info.each do |key, value|
           twit.send("#{key}=", value)
         end
+        twit.endpoint = config.endpoint.url
       end
     end
 
@@ -184,15 +193,6 @@ module Twat
       end
     end
 
-    def account_name
-      @account_name ||=
-        if opts.include?(:account)
-          opts[:account]
-        else
-          config.default_account
-        end
-    end
-
     def beep
       print "\a"
     end

data/lib/twat/argparse.rb

@@ -25,6 +25,9 @@ module Twat
           options[:account] = acct.to_sym
           options[:action] = :add
         end #}}}
+        opts.on('--endpoint ENDPOINT', 'Specify a different endpoint for use with --add') do |endpoint| #{{{ --add ACCOUNT
+          options[:endpoint] = endpoint.to_sym
+        end #}}}
         opts.on('-d', '--delete ACCOUNT', 'Delete ACCOUNT') do |acct| #{{{ --delete ACCOUNT
           options[:account] = acct.to_sym
           options[:action] = :delete
@@ -56,13 +59,26 @@ module Twat
         end #}}}
       end
       @optparser.parse!
+      # {{{ Validation ---
+      # Default action is to send a tweet
       options[:action] ||= :tweet
+
+      # Only specify an endpoint when adding accounts
+      if options[:endpoint]
+        usage unless options[:action] == :add
+      end
+      # Similarly, default endpoint to twitter when we do add
+      if options[:action] == :add
+        options[:endpoint] ||= :twitter
+      end
+
       REQUIRED.each do |req|
         usage unless options[req]
       end
       if MSG_REQUIRED.include?(options[:action])
         options[:msg] = msg
       end
+      # }}} Validation End ---
       options
     end
 

data/lib/twat/config.rb

@@ -62,18 +62,6 @@ module Twat
       config[:polling_interval] || 60
     end
 
-    def default_account
-      raise NoDefaultAccount unless config.include?(:default)
-      return config[:default].to_sym
-    end
-
-    def self.consumer_info
-      {
-        consumer_key: "jtI2q3Z4NIJAehBG4ntPIQ",
-        consumer_secret: "H6vQOGGn9qVJJa9lWyTd2s8ZZRXG4kh3SMfvZ2uxOXE"
-      }
-    end
-
     def []=(k, v)
       config[k] = v
     end
@@ -86,5 +74,40 @@ module Twat
       Migrate.new.migrate!(config_path)
     end
 
+    # I don't know how rubyists feel about method returning something vastly
+    # different to what method= accepts, but I think the api makes sense
+    def account=(acct)
+      if accounts.include?(acct)
+        @account = acct
+      else
+        raise NoSuchAccount
+      end
+    end
+
+    def account_set?
+      !!@account
+    end
+
+    def account_name
+      if account_set?
+        @account
+      else
+        raise NoDefaultAccount unless config.include?(:default)
+        return config[:default].to_sym
+      end
+    end
+
+    def account
+      accounts[account_name]
+    end
+
+    def endpoint_name
+      account[:endpoint] || :twitter
+    end
+
+    def endpoint
+      @endpoint ||= Endpoint.new(endpoint_name)
+    end
+
   end
 end

data/lib/twat/endpoint.rb

@@ -0,0 +1,16 @@
+module Twat
+
+  %w[twitter identica].each do |filename|
+    require File.join(File.expand_path("../endpoints", __FILE__), filename)
+  end
+
+  # Proxies to the actual endpoint classes
+  class Endpoint
+    def self.new(endpoint)
+      @implementation = {
+        :twitter => Endpoints::Twitter,
+        :"identi.ca" => Endpoints::Identica
+      }[endpoint].new
+    end
+  end
+end

data/lib/twat/endpoints/identica.rb

@@ -0,0 +1,39 @@
+module Twat::Endpoints
+  class Identica
+
+    def initialize
+      ::Twitter::Request.module_eval do
+        alias :_request :request
+        def request(method, path, params, options)
+          path.gsub!(%r|^1/|, '')
+          _request(method, path, params, options)
+        end
+      end
+    end
+
+    # this bails with /home/richo/code/ext/twat/lib/twat/endpoints/identica.rb:6:in `block in initialize': uninitialized constant Twat::Endpoints::Identica::Request (NameError)
+    # So I figured it's still relative to This module, so I tried
+    #
+    # ::Twitter.module_eval...
+
+    def url
+      "https://identi.ca/api"
+    end
+
+    def consumer_info
+      {
+        consumer_key: "0af040d41599f5d07b738fc90a487af7",
+        consumer_secret: "b6bb7284eaf975ab65a2dd3eb53fbf3d"
+      }
+    end
+
+    def oauth_options
+      {
+        request_token_url: "https://identi.ca/api/oauth/request_token",
+        access_token_url: "https://identi.ca/api/oauth/access_token",
+        authorize_url: "https://identi.ca/api/oauth/authorize"
+      }
+    end
+
+  end
+end

data/lib/twat/endpoints/twitter.rb

@@ -0,0 +1,22 @@
+module Twat::Endpoints
+  class Twitter
+
+    def url
+      "https://api.twitter.com/"
+    end
+
+    def consumer_info
+      {
+        consumer_key: "jtI2q3Z4NIJAehBG4ntPIQ",
+        consumer_secret: "H6vQOGGn9qVJJa9lWyTd2s8ZZRXG4kh3SMfvZ2uxOXE"
+      }
+    end
+
+    def oauth_options
+      {}
+    end
+
+  end
+end
+
+

data/man/twat.1

@@ -1,4 +1,4 @@
-.TH twat 1 "September 2011" "" ""
+.TH twat 1 "October 2011" "Rich Healey" ""
 .SH NAME
 twat \- a cli/ruby interface to twitter.
 .SH SYNOPSIS
@@ -18,6 +18,9 @@ config for an account named default.
 .IP -a
 Tell twat to execute the routines for authenticating itself with OAuth for your
 account.
+.IP --endpoint
+With -a to add an account specify a different endpoint than the twitter default.
+At present, twitter and identi.ca are supported.
 .IP -d
 Delete speficied account.
 .IP -h
@@ -28,6 +31,13 @@ Watch your newsfeed in a similar manner to tail -f, updating as your feed does
 .IP -u USER
 Retrieve a list of USER's recent tweets. Note this will retrieve all of their
 tweets as opposed to just what would have appeared in your feed.
+.SH OTHER ENDPOINTS
+As of twat 0.5.0 endpoints other than twitter are supported. At present,
+twitter and identi.ca are supported, you may specify which one you intend to
+use at account creation time like
+.B twat -a accountname --endpoint identi.ca
+Other endpoints will be added in due course, as well as support for HTTP basic
+authentication.
 .SH CONFIGURATION
 Options are configured with --set OPTION=VALUE.
 Options include

data/twat

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'twat'
+
+inst = Twat::Twat.new
+inst.cli_run

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twat
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
+date: 2011-10-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
-  requirement: &17618920 !ruby/object:Gem::Requirement
+  requirement: &18544900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17618920
+  version_requirements: *18544900
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &17618180 !ruby/object:Gem::Requirement
+  requirement: &18544400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17618180
+  version_requirements: *18544400
 description: Command line tool for tweeting and whatnot
 email:
 - richo@psych0tik.net
@@ -52,10 +52,14 @@ files:
 - lib/twat/actions.rb
 - lib/twat/argparse.rb
 - lib/twat/config.rb
+- lib/twat/endpoint.rb
+- lib/twat/endpoints/identica.rb
+- lib/twat/endpoints/twitter.rb
 - lib/twat/exceptions.rb
 - lib/twat/migration.rb
 - lib/twat/options.rb
 - man/twat.1
+- twat
 - twat.gemspec
 homepage: http://github.com/richoH/twat
 licenses: []