thimbl 0.1.2 → 0.2.0

data/Manifest

@@ -9,10 +9,13 @@ lib/thimbl/base.rb
 lib/thimbl/command.rb
 lib/thimbl/finger.rb
 lib/thimbl/utils.rb
-test/fixtures/cache.json
-test/fixtures/cache_error_nil.json
 test/fixtures/finger_dk_telekommunisten_org.txt
 test/fixtures/finger_dk_telekommunisten_org_two_break_lines.txt
+test/fixtures/messages_1.json
+test/fixtures/messages_2.json
+test/fixtures/messages_3.json
+test/fixtures/official_plan.json
+test/fixtures/print.txt
 test/test_helper.rb
 test/thimbl_base_test.rb
 test/thimbl_command_test.rb

data/README.md

@@ -6,15 +6,20 @@ I have follow the style of the [Thimbl Python client](https://github.com/blippy/
 
 ## Commands
 
-* follow
 * fetch
+* follow
 * post
-* print
 * push
 
+## Attributes
+
+* messages
+* following
+* properties
+
 ## Version
 
-This version is in development, not ready for any production environment.
+This version is in development, use it in production environment under your own responsability.
 
 ## Install
 
@@ -24,18 +29,20 @@ This version is in development, not ready for any production environment.
 
     require 'rubygems'
     require 'thimbl'
-    thimbl = 
+    thimbl =
       Thimbl::Base.new(
-        'bio'      => 'my bio',
-        'website'  => 'my website', 
-        'mobile'   => 'my mobile', 
-        'email'    => 'my email', 
-        'address'  => 'me@thimbl.net', 
-        'name'     => 'my name'
+        'user@thimbl.net',
+        {
+          :bio      => 'my bio',
+          :website  => 'my website', 
+          :mobile   => 'my mobile', 
+          :email    => 'my email', 
+          :name     => 'my name'
+        }
       )
     thimbl.follow 'dk', 'dk@telekommunisten.org'
     thimbl.fetch
-    thimbl.print
+    thimbl.messages
     thimbl.post 'My first post'
     thimbl.push 'password'
     
@@ -44,15 +51,11 @@ This version is in development, not ready for any production environment.
 The gem comes with a *shell command*, you can use it like this:
     
     thimblr setup 'user@thimblrserver.com'
-    thimblr follow 'dk' 'dk@telekommunisten.org'
-    thimblr fetch
+    thimblr follow 'dk' 'dk@telekommunisten.org' 'my password'
     thimblr print
-    thimblr post "My first message :)"
-    thimblr push <password>
+    thimblr post 'My first message :)' 'my password'
     
 ## TODO
 
 * 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
+* Reply to another message support

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'  
 require 'echoe'  
   
-Echoe.new('thimbl', '0.1.2') do |p|  
+Echoe.new('thimbl', '0.2.0') 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"

data/bin/thimblr

@@ -3,10 +3,8 @@
 # Use:
 #     thimblr setup 'user@thimblrserver.com'
 #     thimblr follow 'dk' 'dk@telekommunisten.org'
-#     thimblr fetch
 #     thimblr print
 #     thimblr post "My first message :)"
-#     thimblr push
 
 begin
   require 'thimbl'
@@ -16,18 +14,17 @@ rescue LoadError
 end
 
 if ARGV.empty?
-  puts "use: $ thimbl <command>"
+  puts "use: $ thimblr <command>"
   exit 1
 end
 
 begin
   case ARGV[0]
   when 'setup';   Thimbl::Command.setup( *ARGV[1..4] ); puts "setup completed"
+  when 'version'; puts Thimbl::Command.version
   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 ARGV[1]; puts "push completed"
-  when 'follow';  Thimbl::Command.follow( ARGV[1], ARGV[2] ); puts "follow completed"
+  when 'post';    Thimbl::Command.post( ARGV[1], ARGV[2] ); puts "post completed"
+  when 'follow';  Thimbl::Command.follow( ARGV[1], ARGV[2], ARGV[3] ); puts "follow completed"
   else
     puts "command not valid '#{ARGV[0]}'"
     exit 1

data/lib/thimbl.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'net/scp'
 require 'fileutils'
 require 'tempfile'
+require 'ostruct'
 require "#{File.dirname(__FILE__)}/thimbl/base"
 require "#{File.dirname(__FILE__)}/thimbl/command"
 require "#{File.dirname(__FILE__)}/thimbl/finger"

data/lib/thimbl/base.rb

@@ -1,78 +1,67 @@
 # Thimbl ruby client
 #
 # Author: fernandoguillen.info
-#
 # Code: https://github.com/fguillen/ThimblClient
-#
 # Use:
 #     require 'rubygems'
 #     require 'thimbl'
 #     thimbl =
 #       Thimbl::Base.new(
-#         'bio'      => 'my bio',
-#         'website'  => 'my website', 
-#         'mobile'   => 'my mobile', 
-#         'email'    => 'my email', 
-#         'address'  => 'username@thimbl.net', 
-#         'name'     => 'my name'
+#         'user@thimbl.net',
+#         {
+#           :bio      => 'my bio',
+#           :website  => 'my website', 
+#           :mobile   => 'my mobile', 
+#           :email    => 'my email', 
+#           :name     => 'my name'
+#         }
 #       )
 #     thimbl.follow 'dk', 'dk@telekommunisten.org'
 #     thimbl.fetch
-#     thimbl.print
+#     thimbl.messages
 #     thimbl.post 'My first post'
-#     thimbl.push <password>
+#     thimbl.push 'password'
 #
 module Thimbl
+  class NoPlanException < Exception; end
   class Base
-    attr_accessor :data
+    attr_accessor :data, :address
   
-    # Initialize a new configuration, the execution of this method
-    # will delete any thing in the `thimbl.plan_path` file and `thimbl.cache_path` file.
+    # Initialize a new configuration
     #
     # Use:
     #     thimbl =
     #       Thimbl::Base.new(
-    #        :bio      => 'bio',
-    #        :website  => 'website', 
-    #        :mobile   => 'mobile', 
-    #        :email    => 'email', 
-    #        :address  => 'address', 
-    #        :name     => 'name'
-    #     )
+    #         'user@thimbl.net', 
+    #         {  
+    #           :bio      => 'bio',
+    #           :website  => 'website', 
+    #           :mobile   => 'mobile', 
+    #           :email    => 'email', 
+    #           :name     => 'name'
+    #         }
+    #       )
     #
     # or just:
     #
-    #     thimbl = Thimbl::Base.new
-    def initialize( opts = {} )
-      opts = { 
-        'bio'      => 'bio',
-        'website'  => 'website', 
-        'mobile'   => 'mobile', 
-        'email'    => 'email', 
-        'address'  => 'address', 
-        'name'     => 'name'
-      }.merge( opts )
-    
+    #     thimbl = Thimbl::Base.new( 'user@thimbl.net' )
+    def initialize( address, opts = {} )
+      @address = address
       @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'    => {}
-          }
-        }
+        'name' => opts[:name],
+        'bio'  => opts[:bio],
+        'properties' => {
+          'email'   => opts[:email],
+          'mobile'  => opts[:mobile],
+          'website' => opts[:website]
+        },
+        'following'  => [],
+        'messages'   => [],
+        'replies'    => {}
       }
     end
   
-    # Post a new message in your time-line.
+    # Post a new message in user's time-line.
     # _This method doesn't push the modifications to de server._
     def post( text )
       message = {
@@ -80,99 +69,125 @@ module Thimbl
         'text' => text
       }
 
-      data['plans'][me]['messages'] << message
+      data['messages'] << message
     end
     
-    # Post a new message in your time-line and push the modifications to the server.
+    # Post a new message in user's time-line and push the modifications to the server.
     def post!( text, password )
       post text
       push password
     end
   
-    # Add a new user to your following
+    # Add a new user to user's following
     # _This method doesn't push the modifications to de server._
     def follow( follow_nick, follow_address )
-      return  if data['plans'][me]['following'].count { |e| e['address'] == follow_address } != 0
-      data['plans'][me]['following'] << { 'nick' => follow_nick, 'address' => follow_address }
+      return  if following.count { |e| e.address == follow_address } != 0
+      data['following'] << { 'nick' => follow_nick, 'address' => follow_address }
     end
     
-    # Add a new user to your following and push the modifications to the server.
+    # Add a new user to user's following and push the modifications to the server.
     def follow!( follow_nick, follow_address, password )
       follow follow_nick, follow_address
       push password
     end
   
-    # Fetch all the info and timelines of all the users you are following.
-    # Even you, so any not pushed modification will be overwritten
+    # Remove a user from the user's following
+    # _This method doesn't push the modifications to de server._
+    def unfollow( follow_address )
+      data['following'].delete_if { |e| e['address'] == follow_address }
+    end
+  
+    # Remove a new from user's following and push the modifications to the server.
+    def unfollow!( follow_address, password )
+      unfollow follow_address
+      push password
+    end
+  
+    # Updating cached .plan
+    # Any not pushed modification will be deleted
     def fetch
-      following_and_me = following.map { |f| f['address'] } << me
-      following_and_me.uniq.each do |address|
-        address_finger = Thimbl::Finger.run address
-        next  if address_finger.nil? || address_finger.match(/Plan:\s*(.*)/m).nil?
-        address_plan = address_finger.match(/Plan:\s*(.*)/m)[1].gsub("\\\n",'')
-        data['plans'][address] = JSON.load( address_plan )
-      end
+      @data = JSON.load( fetch_plan )
     end
     
-    # Send your actual `plan` file to your server
-    # It requires the password of your thimbl user
+    # Send user's cached .plan to user's server
+    # It requires the password of user's thimbl user
     def push( password )
-      tmp_path = Thimbl::Utils.to_file plan.to_json
-      Net::SCP.start( me.split('@')[1], me.split('@')[0], :password => password ) do |scp|
+      tmp_path = Thimbl::Utils.to_file( data.to_json )
+      Net::SCP.start( address.split('@')[1], address.split('@')[0], :password => password ) do |scp|
         scp.upload!( tmp_path, ".plan" )
       end
     end
   
-    # Print every message of you and all the users you are following.
-    #
-    # 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 += message['time'].strftime( '%Y-%m-%d %H:%M:%S' )
-        result += " #{message['address']}"
-        result += " > #{message['text']}"
-        result += "\n"
+    # Returns all this user's messages 
+    # in a chronologic order.
+    def messages
+      return []  if data['messages'].nil?
+      
+      result = []
+      
+      data['messages'].each do |message|
+        result << OpenStruct.new({
+          :address => address,
+          :time    => Thimbl::Utils.parse_time( message['time'] ),
+          :text    => message['text']
+        })
       end
+      
+      result = result.sort { |a,b| a.time <=> b.time }
     
       return result
     end
-  
-    # Returns all the messages of you and all the users you are following
-    # in a chronologic order into a json format.
-    def messages
+    
+    # Returns all the info about the users this user is following.
+    def following
+      return []  if data['following'].nil?
+      
       result = []
       
-      data['plans'].each_pair do |address, plan|
-        next  if plan['messages'].nil?
-        plan['messages'].each do |message|
-          result << {
-            'address' => address,
-            'time'    => Thimbl::Utils.parse_time( message['time'] ),
-            'text'    => message['text']
-          }
-        end
+      data['following'].each do |chased|
+        result << OpenStruct.new({
+          :nick    => chased['nick'],
+          :address => chased['address']
+        })
       end
       
-      result = result.sort { |a,b| a['time'] <=> b['time'] }
-    
       return result
     end
-
-    # Returns the actual thimbl user account
-    def me
-      data['me']
-    end
     
-    # Returns all the info about the users you are following.
-    def following
-      data['plans'][me]['following']
+    # Returns all the user properties
+    def properties
+      OpenStruct.new({
+        :bio      => data['bio'],
+        :name     => data['name'],
+        :email    => data['properties']['email'],
+        :mobile   => data['properties']['mobile'],
+        :website  => data['properties']['website']
+      })
     end
     
-    # Returns the actual plan
-    def plan
-      data['plans'][me]
+    # Update all the user properties
+    # _This method doesn't push the modifications to de server._
+    def properties=( opts = {} )
+      data['bio']                   = opts[:bio]      unless opts[:bio].nil?
+      data['name']                  = opts[:name]     unless opts[:name].nil?
+      data['properties']['email']   = opts[:email]    unless opts[:email].nil?
+      data['properties']['mobile']  = opts[:mobile]   unless opts[:mobile].nil?
+      data['properties']['website'] = opts[:website]  unless opts[:website].nil?
     end
+    
+    private
+    
+      def fetch_plan
+        finger_response = Thimbl::Finger.run address
+      
+        if( finger_response.nil? || finger_response.match(/Plan:\s*(.*)/m).nil? )
+          raise NoPlanException, "Not Thimbl Plan in this address: '#{address}'"
+        end
+      
+        finger_plan = finger_response.match(/Plan:\s*(.*)/m)[1].gsub("\\\n",'')
+      
+        return finger_plan
+      end
+      
   end
 end

data/lib/thimbl/command.rb

@@ -1,76 +1,91 @@
 module Thimbl
   class Command 
-    CACHE_PATH = File.expand_path( "~#{ENV['USER']}/.thimbl/cache.json" )
+    THIMBL_FOLDER = File.expand_path( "~#{ENV['USER']}/.thimbl" )
     
-    def self.setup( *args )
-      if( args.size != 1 )
-        raise ArgumentError, "use: $ thimbl setup <thimbl_user>"
-      end
-    
-      thimbl = Thimbl::Base.new( 'address' => args[0] )
-      save_cache thimbl.data
+    def self.version
+      "0.2.0"
     end
     
-    def self.save_cache data
-      if !File.exists? File.dirname( cache_path )
-        FileUtils.mkdir_p File.dirname( cache_path )
+    def self.setup( *args )
+      if( args.size != 1 )
+        raise ArgumentError, "use: $ thimblr setup <thimbl_user>"
       end
-
-      File.open( cache_path, 'w' ) do |f|
-        f.write( data.to_json )
+      
+      if !File.exists? File.dirname( thimbl_folder )
+        FileUtils.mkdir_p File.dirname( thimbl_folder )
       end
+    
+      save_actual args[0]
     end
 
     def self.print
-      thimbl = Thimbl::Command.load
-      return thimbl.print
-    end
-  
-    def self.fetch
-      thimbl = Thimbl::Command.load
+      thimbl = get_actual
       thimbl.fetch
-      save_cache thimbl.data
-    end
-  
-    def self.post( text )
-      if( text.nil? || text.empty? )
-        raise ArgumentError, "use: $ thimbl post <message>"
+      
+      # user's messages
+      messages = thimbl.messages
+      
+      # user's following's messages
+      thimbl.following.each do |followed|
+        thimbl = Thimbl::Base.new followed.address
+        begin
+          thimbl.fetch
+          messages += thimbl.messages
+        rescue Thimbl::NoPlanException
+          puts "Error fetching #{followed.address} messages"
+        end
       end
-      thimbl = Thimbl::Command.load
-      thimbl.post text
-      save_cache thimbl.data
-    end
-    
-    def self.push( password )
-      if( password.nil? || password.empty? )
-        raise ArgumentError, "use: $ thimbl push <password>"
+      
+      messages = messages.sort { |a,b| a.time <=> b.time }
+      
+      result = ""
+      messages.each do |message|
+        result += message.time.strftime( '%Y-%m-%d %H:%M:%S' )
+        result += " #{message.address}"
+        result += " > #{message.text}"
+        result += "\n"
       end
-      thimbl = Thimbl::Command.load
-      thimbl.push password
+    
+      return result
     end
   
-    def self.follow( nick, address )
-      if( nick.nil? || nick.empty? || address.nil? || address.empty? )
-        raise ArgumentError, "use: $ thimbl follow <nick> <address>"
+    def self.post( text = nil, password = nil)
+      if( text.nil? || text.empty? || password.nil? )
+        raise ArgumentError, "use: $ thimblr post <message> <password>"
       end
-      thimbl = Thimbl::Command.load
-      thimbl.follow nick, address
-      save_cache thimbl.data
+      
+      thimbl = get_actual
+      thimbl.post! text, password
     end
   
-    def self.load
-      if( !File.exists? cache_path )
-        raise ArgumentError, "Thimbl need to setup, use: $ thimbl setup <thimbl_user>"
+    def self.follow( nick = nil, address = nil, password = nil )
+      if( nick.nil? || nick.empty? || address.nil? || address.empty? || password.nil? )
+        raise ArgumentError, "use: $ thimblr follow <nick> <address> <password>"
       end
-    
-      thimbl = Thimbl::Base.new 
-      thimbl.data = JSON.load File.read cache_path
-
-      return thimbl
+      
+      thimbl = get_actual
+      thimbl.follow! nick, address, password
     end
     
-    def self.cache_path
-      CACHE_PATH
-    end
+    private
+   
+      def self.save_actual( address )
+        File.open( "#{thimbl_folder}/actual", 'w' ) { |f| f.write address }
+      end
+    
+      def self.get_actual
+        if( !File.exists? "#{thimbl_folder}/actual" )
+          raise ArgumentError, "Thimbl need to setup, use: $ thimblr setup <thimbl_user>"
+        end
+      
+        thimbl = Thimbl::Base.new File.read( "#{thimbl_folder}/actual" )
+        thimbl.fetch
+      
+        return thimbl
+      end
+    
+      def self.thimbl_folder
+        THIMBL_FOLDER
+      end
   end
 end