Sign inSign up

sinenomine/earthquake-s390x

By sinenomine

Updated about 9 years ago

Terminal-based Twitter Client with Streaming API support

Image
0

9.3K

sinenomine/earthquake-s390x repository overview

Earthquake

Derived from the "port" by Adam Miller [email protected] from https://github.com/fedora-cloud/Fedora-Dockerfiles Originally written for Fedora-Dockerfiles by Stephen Tweedie [email protected]

dockerfiles-clefos-earthquake

ClefOS 7 container for earthquake (terminal-based Twitter client: https://github.com/jugyo/earthquake)

Demo: http://www.youtube.com/watch?v=S2KtBGrIe5c
Slide: http://www.slideshare.net/jugyo/earthquakegem

Features


  • Use Twitter entirely in your Terminal.
  • Receive data in real time with Streaming API.
  • Easily extend using Ruby.
Quick-installation using Docker (http://docker.io)

Just clone the repo and:

$ sudo docker build -t earthquake .
$ sudo docker run --rm -i -name earthquake -t earthquake
Command-Line Usage

Launch
$ earthquake
Help
⚡ :help
Tweet
⚡ Hello World!
Show
⚡ $xx

$xx is the alias of tweet id.

Reply
⚡ $xx hi!
Delete
⚡ :delete $xx
Retweet
⚡ :retweet $xx
Timeline
⚡ :recent
⚡ :recent jugyo
Lists
⚡ :recent yugui/ruby-committers
⚡ :search #ruby
Eval
⚡ :eval Time.now
Exit
⚡ :exit
Reconnect
⚡ :reconnect
Restart
⚡ :restart
Threads
⚡ :thread $xx
Install Plugins
⚡ :plugin_install https://gist.github.com/899506
Alias
⚡ :alias :rt :retweet
Tweet Ascii Art
⚡ :update[ENTER]
[input EOF (e.g. Ctrl+D) at the last]
    ⚡
   ⚡
    ⚡
   ⚡
^D
View Ascii Art
# permanently
⚡ :eval config[:raw_text] = true

# temporarily(with :status, :recent or :thread etc...)
⚡ :aa :status $aa
Stream Filter Tracking
# keywords
⚡ :filter keyword earthquakegem twitter

# users
⚡ :filter user jugyo matsuu

# return to normal user stream
⚡ :filter off
Show config
# All config
⚡ :config

# config for :key
⚡ :config key
Set config
# set config for :key to (evaluated) value
⚡ :config key 1 + 1
{
    :key => 2
}
⚡ :config key {foo: 1, bar: 2}
{
    :key => {
        :foo => 1,
        :bar => 2
    }
}
# merge new config if both are Hash
⚡ :config key {bar: 3}
{
    :key => {
        :foo => 1,
        :bar => 3
    }
}

And more!

Configuration

The default earthquake directory is ~/.earthquake.

The config file is ~/.earthquake/config.

Changing the earthquake directory

You can change the directory at launch by entering a directory as an argument. For example:

$ earthquake ~/.earthquake_foo
Changing the colors for user name
# ~/.earthquake/config
# For example, to exclude blue:
Earthquake.config[:colors] = (31..36).to_a - [34]
Changing the color scheme
# ~/.earthquake/config
Earthquake.config[:color] = {
  :info => 34,
  :notice => 41,
  :event  => 46,
  :url => [4, 34]
}
Tracking specified keywords
# ~/.earthquake/config
Earthquake.config[:api] = {
  :method => 'POST',
  :host => 'stream.twitter.com',
  :path => '/1/statuses/filter.json',
  :ssl => true,
  :filters => %w(Twitter Earthquake)
}
Tracking specified users
# ~/.earthquake/config
Earthquake.config[:api] = {
  :method => 'POST',
  :host => 'stream.twitter.com',
  :path => '/1/statuses/filter.json',
  :ssl => true,
  :params => {
    :follow => '6253282,183709371' # @twitterapi @sitestreams
  }
}
Defining aliases
# ~/.earthquake/config
Earthquake.alias_command :rt, :retweet
Default confirmation type
# ~/.earthquake/config
Earthquake.config[:confirm_type] = :n
HTTP proxy support

Please set environment variable http_proxy if you want earthquake to use an http proxy.

Desktop Notifications

To enable desktop notifications, install one of the following:

Call Earthquake.notify for desktop notification. You can try it by using the :eval command:

⚡ :eval notify 'Hello World!'
Plugins

See https://github.com/jugyo/earthquake/wiki

Making Plugins

~/.earthquake/plugin is the directory for plugins. At launch, Earthquake tries to load files under this directory. The block that is specified for Earthquake.init will be reloaded at any command line input.

Defining your commands
A command named 'foo':
Earthquake.init do
  command :foo do
    puts "foo!"
  end
end
Handling the command args:
Earthquake.init do
  command :hi do |m|
    puts "Hi #{m[1]}!"
  end
end

'm' is a http://www.ruby-doc.org/core/classes/MatchData.html object.

Using regexp:
Earthquake.init do
  # Usage: :add 10 20
  command %r|^:add (\d+)\s+(\d+)|, :as => :add do |m|
    puts m[1].to_i + m[2].to_i
  end
end
Handling outputs
Keyword notifier:
Earthquake.init do
  output do |item|
    next unless item["_stream"]
    if item["text"] =~ /ruby/i
      notify "#{item["user"]["screen_name"]}: #{item["text"]}"
    end
  end
end
Favorite notifier:
Earthquake.init do
  output do |item|
    case item["event"]
    when "favorite"
      notify "[favorite] #{item["source"]["screen_name"]} => #{item["target"]["screen_name"]} : #{item["target_object"]["text"]}"
    end
  end
end
Defining filters for output
Filtering by keywords
Earthquake.init do
  output_filter do |item|
    if item["_stream"] && item["text"]
      item["text"] =~ /ruby/i
    else
      true
    end
  end
end
Replacing the output for tweets
Earthquake.init do
  output :tweet do |item|
    next unless item["text"]
    name = item["user"]["screen_name"]
    puts "#{name.c(color_of(name))}: foo"
  end
end
Defining completion
Earthquake.init do
  completion do |text|
    ['jugyo', 'earthquake', '#eqrb'].grep(/^#{Regexp.quote(text)}/)
  end
end

TODO

  • mark my tweet
  • Earthquake should parse ARGV
  • ruby1.9nize
  • guideline for plugin
  • deal proxy
  • spec

Copyright (c) 2011 jugyo. See LICENSE.txt for further details.

Tag summary

Content type

Image

Digest

Size

148.5 MB

Last updated

about 9 years ago

docker pull sinenomine/earthquake-s390x