thimbl 0.0.1 → 0.0.2

data/Gemfile

@@ -1,5 +1,11 @@
 source 'http://rubygems.org'
 
+gem 'json'
+gem 'net-scp'
+
 group :test do
+  gem 'echoe'
   gem 'mocha'
+  gem 'delorean'
+  gem 'ruby-debug'
 end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    chronic (0.3.0)
+    columnize (0.3.2)
+    delorean (0.2.1)
+      chronic
+    echoe (4.3.1)
+      gemcutter
+      rubyforge
+    fileutils (0.6)
+      rmagick (>= 2.13.1)
+    gemcutter (0.6.1)
+    json (1.5.1)
+    json_pure (1.5.1)
+    linecache (0.43)
+    mocha (0.9.11)
+      rake
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.1.0)
+    rake (0.8.7)
+    rmagick (2.13.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  delorean
+  echoe
+  fileutils
+  json
+  mocha
+  net-scp
+  ruby-debug

data/Manifest

@@ -1,9 +1,16 @@
 Gemfile
+Gemfile.lock
 Manifest
 README.md
 Rakefile
-lib/finger.rb
+bin/thimbl
 lib/thimbl.rb
+lib/thimbl/base.rb
+lib/thimbl/command.rb
+lib/thimbl/finger.rb
 test/fixtures/cache.json
-test/thimbl_test.rb
-thimbl.rb
+test/fixtures/finger_dk_telekommunisten_org.txt
+test/fixtures/finger_dk_telekommunisten_org_two_break_lines.txt
+test/test_helper.rb
+test/thimbl_base_test.rb
+test/thimbl_command_test.rb

data/README.md

@@ -1,6 +1,20 @@
 # Thimbl Client
 
-Is an small client for the distributed microbloging protocol: [thimbl](http://www.thimbl.net/)
+Is an small client for the distributed microbloging protocol: [thimbl](http://thimbl.net/)
+
+I have follow the style of the [Thimbl Python client](https://github.com/blippy/Thimbl-CLI) in many ways. 
+
+## Commands
+
+* setup
+* follow
+* fetch
+* post
+* print
+
+## Architecture
+
+This client is only manipulating json files, the one with your **personal plan** and the other with the **complete cache** of the timeline of the people you are following.
 
 ## Version
 
@@ -8,21 +22,40 @@ This version is in development, not ready for any production environment.
 
 ## Install
 
-   gem install thimbl
+    gem install thimbl
    
 ## Use
 
+    require 'rubygems'
     require 'thimbl'
-    thimbl = Thimbl.new( '/tmp/plan', '/tmp/thimbl_cache' )
+    thimbl = 
+      Thimbl.new( 
+        'plan_path'  => '/tmp/plan', 
+        'cache_path' => '/tmp/thimbl_cache',
+        'user'       => 'fguillen@thimblserver.com'
+        'password'   => 'my_thimblserver_password'
+      )
     thimbl.setup(
-      :bio      => 'my bio',
-      :website  => 'my website', 
-      :mobile   => 'my mobile', 
-      :email    => 'my email', 
-      :address  => 'my address', 
-      :name     => 'my name'
+      'bio'      => 'my bio',
+      'website'  => 'my website', 
+      'mobile'   => 'my mobile', 
+      'email'    => 'my email', 
+      'address'  => 'my address', 
+      'name'     => 'my name'
     )
     thimbl.follow 'dk', 'dk@telekommunisten.org'
     thimbl.fetch
     thimbl.print
-    thimbl.post 'My first post'
+    thimbl.post 'My first post'
+    thimbl.push
+    
+## TODO
+
+* Shell script /bin/thimbl
+* Thinking that the *plan_path* is not needed.
+* Not save thimbl password, request for it in any *thimbl.push*
+* Support *simbolize* hash keys
+* In the Thimbl::Command.setup ask for the rest of the configuration options *bio*, *mobile*, ...
+* thimbl.unfollow
+* ERROR: If finger respond empty Plan
+* ERROR: the message format is without *address* key.

data/Rakefile

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rake'  
 require 'echoe'  
   
-Echoe.new('thimbl', '0.0.1') do |p|  
+Echoe.new('thimbl', '0.0.2') do |p|  
   p.description     = "Small client for the distributed microbloging protocol: [thimbl](http://www.thimbl.net/)"  
   p.url             = "http://github.com/fguillen/ThimblClient"
   p.author          = "Fernando Guillen"
   p.email           = "fguillen.mail@gmail.com"  
   p.ignore_pattern  = ['etc/*']
-  p.development_dependencies = ['mocha', 'ruby-debug']
-  p.runtime_dependencies = []
+  p.development_dependencies = ['mocha', 'ruby-debug', 'delorean']
+  p.runtime_dependencies = ['json', 'net-scp', 'fileutils']
 end

data/bin/thimbl

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# Use:
+#     thimbl setup ~/thimbl_plan ~/thimbl_cache 'user@thimblserver.com', 'thimblpass'
+#     thimbl follow 'dk' 'dk@telekommunisten.org'
+#     thimbl fetch
+#     thimbl print
+#     thimbl post "My first message :)"
+#     thimbl push
+
+begin
+  require 'thimbl'
+rescue LoadError
+  require 'rubygems'
+  require 'thimbl'
+end
+
+if ARGV.empty?
+  puts "use: $ thimbl <command>"
+  exit 1
+end
+
+begin
+  case ARGV[0]
+  when 'setup';   Thimbl::Command.setup( *ARGV[1..4] ); puts "setup completed"
+  when 'print';   puts Thimbl::Command.print
+  when 'fetch';   Thimbl::Command.fetch; puts "fecth completed"
+  when 'post';    Thimbl::Command.post ARGV[1]; puts "post completed"
+  when 'push';    Thimbl::Command.push; puts "push completed"
+  when 'follow';  Thimbl::Command.follow( ARGV[1], ARGV[2] ); puts "follow completed"
+  else
+    puts "command not valid '#{ARGV[0]}'"
+  end
+rescue ArgumentError => e
+  puts e.message
+end

data/lib/thimbl.rb

@@ -1,125 +1,7 @@
 require 'rubygems'
 require 'json'
-require "#{File.dirname(__FILE__)}/finger"
-
-class Thimbl
-  attr_reader :plan_path, :cache_path, :data, :address
-  
-  def initialize( plan_path, cache_path )
-    @plan_path = plan_path
-    @cache_path = cache_path
-    @data = nil
-    @address = nil
-  end
-  
-  def setup( opts = {} )
-    opts = { 
-      :bio      => 'bio',
-      :website  => 'website', 
-      :mobile   => 'mobile', 
-      :email    => 'email', 
-      :address  => 'address', 
-      :name     => 'name'
-    }.merge( opts )
-    
-    @data = {
-      'me'    => opts[:address],
-      'plans' => {
-        opts[:address] => {
-          'name' => opts[:name],
-          'bio'  => opts[:bio],
-          'properties' => {
-            'email'   => opts[:email],
-            'mobile'  => opts[:mobile],
-            'website' => opts[:website]
-          },
-          'following'  => [],
-          'messages'   => [],
-          'replies'    => {}
-        }
-      }
-    }
-
-    @address = opts[:address]
-    
-    save_data
-    
-    return self
-  end
-  
-  def post( text )
-    load_data
-
-    message = {
-      :address => address,
-      :time => Time.now.strftime('%Y%m%d%H%M%S'),
-      :text => text
-    }
-          
-    data['plans'][address]['messages'] << message
-    save_data
-    
-    return self
-  end
-  
-  def follow( follow_nick, follow_address )
-    load_data
-    data['plans'][address]['following'] << { :nick => follow_nick, :address => follow_address }
-    save_data
-    
-    return self
-  end
-  
-  def fetch
-    load_data
-
-    following.map { |f| f['address'] }.each do |followed_address|
-      address_finger = Finger.run followed_address
-      address_plan = address_finger.match(/Plan:\s*(.*)/m)[1].gsub("\n",'')
-      data['plans'][followed_address] = JSON.load( address_plan )
-    end
-    
-    save_data
-    
-    return self
-  end
-  
-  def print
-    load_data
-    
-    result = ""
-    messages.each do |message|
-      result += Thimbl.parse_time( message['time'] ).strftime( '%Y-%m-%d %H:%M:%S' )
-      result += " #{message['address']}"
-      result += " > #{message['text']}"
-      result += "\n"
-    end
-    
-    return result
-  end
-  
-  def load_data
-    @data = JSON.load( File.read cache_path )
-    @address = data['me']
-  end
-  
-  def save_data
-    File.open( cache_path, 'w' ) { |f| f.write data.to_json }
-    File.open( plan_path, 'w' ) { |f| f.write data['plans'][address].to_json }
-  end
-  
-  def following
-    data['plans'][address]['following']
-  end
-  
-  def messages
-    _messages = data['plans'].values.map { |e| e['messages'] }.flatten
-    _messages = _messages.sort { |a,b| a['time'] <=> b['time'] }
-    
-    return _messages
-  end
-  
-  def self.parse_time( time )
-    Time.utc( time[0,4], time[4,2], time[6,2], time[8,2], time[10,2], time[12,2] )
-  end
-end
+require 'net/scp'
+require 'fileutils'
+require "#{File.dirname(__FILE__)}/thimbl/base"
+require "#{File.dirname(__FILE__)}/thimbl/command"
+require "#{File.dirname(__FILE__)}/thimbl/finger"

data/lib/thimbl/base.rb

@@ -0,0 +1,223 @@
+# Thimbl ruby client
+#
+# Author: fernandoguillen.info
+#
+# Code: https://github.com/fguillen/ThimblClient
+#
+# Use:
+#      require 'rubygems'
+#      require 'thimbl'
+#      thimbl = 
+#        Thimbl::Base.new( 
+#          :plan_path  => '/tmp/plan', 
+#          :cache_path => '/tmp/thimbl_cache',
+#          :user       => 'fguillen@thimblserver.com'
+#          :password   => 'my_thimblserver_password'
+#        )
+#      thimbl.setup(
+#        :bio      => 'my bio',
+#        :website  => 'my website', 
+#        :mobile   => 'my mobile', 
+#        :email    => 'my email', 
+#        :address  => 'my address', 
+#        :name     => 'my name'
+#      )
+#      thimbl.follow 'dk', 'dk@telekommunisten.org'
+#      thimbl.fetch
+#      thimbl.print
+#      thimbl.post 'My first post'
+#
+module Thimbl
+  class Base
+    attr_reader :plan_path, :cache_path, :data, :address, :user, :password
+  
+    # Initialize the thimbl client.
+    #
+    # Use:
+    #     Thimbl.new(
+    #       :plan_path  => <path to the plan file>,
+    #       :cache_path => <path to the cache file>
+    #       :user       => <the user@domain>,
+    #       :password   => <the user password>
+    #     )
+    #
+    def initialize( opts = {} )
+      @plan_path = opts['plan_path']
+      @cache_path = opts['cache_path']
+      @user = opts['user']
+      @password = opts['password']
+    
+      @data = nil
+      @address = nil
+    end
+  
+    # Setup a new configuration, the execution of this method
+    # will delete any thing in the `thimbl.plan_path` file and `thimbl.cache_path` file.
+    #
+    # Use:
+    #     thimbl.setup(
+    #        :bio      => 'bio',
+    #        :website  => 'website', 
+    #        :mobile   => 'mobile', 
+    #        :email    => 'email', 
+    #        :address  => 'address', 
+    #        :name     => 'name'
+    #     )
+    #
+    def setup( opts = {} )
+      opts = { 
+        'bio'      => 'bio',
+        'website'  => 'website', 
+        'mobile'   => 'mobile', 
+        'email'    => 'email', 
+        'address'  => 'address', 
+        'name'     => 'name'
+      }.merge( opts )
+    
+      @data = {
+        'me'    => opts['address'],
+        'plans' => {
+          opts['address'] => {
+            'name' => opts['name'],
+            'bio'  => opts['bio'],
+            'properties' => {
+              'email'   => opts['email'],
+              'mobile'  => opts['mobile'],
+              'website' => opts['website']
+            },
+            'following'  => [],
+            'messages'   => [],
+            'replies'    => {}
+          }
+        }
+      }
+
+      @address = opts['address']
+    
+      save_data
+    end
+  
+    # Post a new message in your time-line.
+    #
+    # Use:
+    #     thimbl.post <message>
+    #
+    # To publish your comment you have to call:
+    #     thimbl.push
+    #
+    def post( text )
+      message = {
+        'address' => address,
+        'time' => Time.now.strftime('%Y%m%d%H%M%S'),
+        'text' => text
+      }
+
+      data['plans'][address]['messages'] << message
+      save_data
+    end
+  
+    # Add a new user to follow
+    #
+    # Use:
+    #     thimbl.follow 'nick', 'address'
+    #
+    # To publish your following users you have to call:
+    #     thimbl.push
+    #
+    def follow( follow_nick, follow_address )
+      data['plans'][address]['following'] << { 'nick' => follow_nick, 'address' => follow_address }
+      save_data
+    end
+  
+    # Fetch all the info and timelines of all the users you are following.
+    #
+    # Use:
+    #     thimbl.fetch
+    #
+    def fetch
+      following.map { |f| f['address'] }.each do |followed_address|
+        address_finger = Thimbl::Finger.run followed_address
+        address_plan = address_finger.match(/Plan:\s*(.*)/m)[1].gsub("\\\n",'')
+        data['plans'][followed_address] = JSON.load( address_plan )
+      end
+    
+      save_data
+    end
+  
+    # Print every message of you and all the users you are following.
+    #
+    # Use:
+    #     thimbl.print
+    # The method doesn't print anything by it self. It just returns an string
+    # with all the comments.
+    #
+    def print
+      result = ""
+      messages.each do |message|
+        result += Thimbl::Base.parse_time( message['time'] ).strftime( '%Y-%m-%d %H:%M:%S' )
+        result += " #{message['address']}"
+        result += " > #{message['text']}"
+        result += "\n"
+      end
+    
+      return result
+    end
+  
+    # Send your actual `plan` file to your server
+    #
+    # Use:
+    #     thimbl.push
+    #
+    def push
+      Net::SCP.start( user.split('@')[1], user.split('@')[0], :password => password ) do |scp|
+        scp.upload!( plan_path, ".plan" )
+      end
+    end
+
+    # Charge into the `thimbl` object all the data into your `cache` file.
+    # Use:
+    #     thimbl.load_data
+    #
+    def load_data
+      @data = JSON.load( File.read cache_path )
+      @address = data['me']
+    end
+  
+    # Save all the data into the `thimbl` objecto into your `cache` file and
+    # `plan` file.
+    #
+    # Use:
+    #     thimbl.save_data
+    #
+    def save_data
+      File.open( cache_path, 'w' ) { |f| f.write data.to_json }
+      File.open( plan_path, 'w' ) { |f| f.write data['plans'][address].to_json }
+    end
+  
+    # Returns all the info about the users you are following.
+    #
+    # Use:
+    #     thimbl.following
+    #
+    def following
+      data['plans'][address]['following']
+    end
+  
+    # Returns all the messages of you and all the users you are following
+    # in a chronologic order into a json format.
+    #
+    # Use:
+    #     thimbl.messages
+    #
+    def messages
+      _messages = data['plans'].values.map { |e| e['messages'] }.flatten
+      _messages = _messages.sort { |a,b| a['time'] <=> b['time'] }
+    
+      return _messages
+    end
+  
+    def self.parse_time( time )
+      Time.utc( time[0,4], time[4,2], time[6,2], time[8,2], time[10,2], time[12,2] )
+    end
+  end
+end