chmeee-twitter-fusefs 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 chmeee
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,71 @@
+# twitter-fusefs
+
+twitter-fusefs is a program to mount your twitter account as a filesystem.
+
+## Directory structure
+When you run it it will generate the following directory structure:
+
+    direct_messages  followers/  friends/  README  replies  timeline  updates
+
+### Files
+* `direct_messages`: when 'read' will output your direct_messages
+* `README`: when 'read' will output some info about twitter-fusefs
+* `replies`: when 'read' will output your replies
+* `timeline`: when 'read' will output your timeline (with your friends)
+* `updates`: when 'read' will output your tweets, when 'written to` will create a new tweet with the msg
+
+### Directories
+* `followers/`: has a list of files, each with a follower's nick
+* `friends/`: has a list of files, each with a friend's nick
+
+When 'read' from users' files will output his/her timeline, when 'written to' users' files will update your timeline adding @user.
+
+## Install and Use
+
+Until there's a ruby gem you can do the following
+
+1. Install the twitter gem: `sudo gem install twitter`
+2. Install [Ruby FuseFS][1] (as far as I know, there's no ruby gem)
+3. Download twitter-fusefs, uncompress
+4. Create a directory ~/.twitter with
+
+    email: yourtwitteraccountmail
+    password: yourcomplexpassword
+
+5. `mkdir` a directory where you want to mount
+6. `./bin/twitter-fusefs yourdirectory`
+
+  [1]: http://rubyforge.org/projects/fusefs
+
+Please, note that this script does not require rubygems, as you may not be using it. If you do you'll have to tell ruby so. The best way I think is through
+
+   export RUBYOPT="rubygems"
+
+## TO-DO
+
+twitter-fusefs is still in design and development. I'm still thinking about some of the details, so here's a to-do list:
+
+* Use SSL
+* Access user status: /status for the mounting user and 'maybe' /(followers|friends)/user_status for the rest of users
+* Unfollow people with rm on /friends
+* Follow with touch on /friends
+* Block with rm on /followers
+* Reformat the output of tweets and add more information (like time, app, in respond to, etc.)
+* Access to Twitter trends (whatever that is)
+* Produce a ruby-gem
+* Make a github page for the project
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 chmeee. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "twitter-fusefs"
+    gem.summary = %Q{Access twitter as a filesystem}
+    gem.description = %Q{Mount your twitter account as a userspace filesystem, access your tweets as files, update echo'ing over files}
+    gem.email = "chmeee@gmail.com"
+    gem.homepage = "http://github.com/chmeee/twitter-fusefs"
+    gem.authors = ["chmeee"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.files =  FileList["[A-Z]*", "{bin,helpers,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+    gem.bindir = 'bin'
+    gem.executables = ['twitter-fusefs']
+    gem.add_dependency 'twitter'
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "twitter-fusefs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/twitter-fusefs

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter-fusefs')
+
+tfs = TwitterFuseFS.new
+FuseFS.set_root(tfs)
+FuseFS.mount_under ARGV[0] || "/home/jmpavon/Mount/twitter"
+FuseFS.run

data/helpers/config_store.rb

@@ -0,0 +1,40 @@
+# Created by John Nunemaker for ruby twitter gem: http://twitter.rubyforge.org/
+
+class ConfigStore
+  attr_reader :file
+  
+  def initialize(file)
+    @file = file
+  end
+  
+  def load
+    @config ||= YAML::load(open(file))
+    self
+  end
+  
+  def [](key)
+    load
+    @config[key]
+  end
+  
+  def []=(key, value)
+    @config[key] = value
+  end
+  
+  def delete(*keys)
+    keys.each { |key| @config.delete(key) }
+    save
+    self
+  end
+  
+  def update(c={})
+    @config.merge!(c)
+    save
+    self
+  end
+  
+  def save
+    File.open(file, 'w') { |f| f.write(YAML.dump(@config)) }
+    self
+  end
+end

data/lib/twitter-fusefs.rb

@@ -0,0 +1,74 @@
+require File.join(File.dirname(__FILE__), 'twitter_account.rb')
+require 'fusefs'
+include FuseFS
+require 'pp'
+
+class TwitterFuseFS < FuseFS::FuseDir
+  def initialize
+    @twitter_user = TwitterAccount.new
+    @files = %w{ direct_messages updates timeline replies README} 
+    @dirs = %w{ followers friends }
+  end
+
+  def contents(path)
+    case path
+    when "/"
+      @dirs + @files
+    when "/friends"
+      @twitter_user.friends
+    when "/followers"
+      @twitter_user.followers
+    end
+  end
+
+  def file?(path)
+    dir, base = scan_path(path)
+
+    root_cond = (@files.include? dir and base.nil?)
+    dirs_cond = (@dirs.include? dir and (@twitter_user.friends.include? base or @twitter_user.followers.include? base))
+
+    root_cond or dirs_cond
+  end
+
+  def directory?(path)
+    dir_items = scan_path(path)
+    @dirs.include?(dir_items.last)
+  end
+
+  def read_file(path)
+    case path
+    when "/timeline"
+      @twitter_user.friends_timeline
+    when "/direct_messages"
+      @twitter_user.direct_messages
+    when "/updates"
+      @twitter_user.updates
+    when "/replies"
+      @twitter_user.replies
+    when "/README"
+      "twitter-fusefs\n"
+    when /\/(followers|friends)\/(.*)/
+      @twitter_user.user_timeline($2)
+    end
+  end
+
+  def write_to(path, body)
+    if !body.empty? # don't know why it gets executed twice, first time without body
+      case path
+      when "/updates"
+        @twitter_user.update body
+      when /\/(followers|friends)\/(.*)$/
+        body = "@#{$2} #{body}"
+        @twitter_user.update body
+      end
+    end
+  end
+
+  def can_write?(path)
+    path == "/updates" or path =~ /\/(followers|friends)\/.*/
+  end
+
+  def can_delete?(path)
+    can_write?(path)
+  end
+end

data/lib/twitter_account.rb

@@ -0,0 +1,52 @@
+require 'twitter'
+require File.join(File.dirname(__FILE__), '..', 'helpers', 'config_store')
+
+class TwitterAccount
+  attr_reader :friends, :followers
+
+  def initialize
+    config = ConfigStore.new("#{ENV['HOME']}/.twitter")
+    httpauth = Twitter::HTTPAuth.new(config['email'], config['password'])
+    @account = Twitter::Base.new(httpauth)
+
+    @friends = @account.friends.map do |friend|
+      friend.screen_name
+    end
+
+    @followers = @account.followers.map do |follower|
+      follower.screen_name
+    end
+  end
+
+# wating for a better formating (see twitter gem bien)
+# this methods are looking for some factoring
+  def friends_timeline
+    texts = @account.friends_timeline.map {|t| "#{t.user.screen_name}> #{t.text}"}
+    texts.join("\n") + "\n"
+  end
+
+  def direct_messages
+    texts = @account.direct_messages.map {|t| "#{t.sender.screen_name}> #{t.text}"}
+    texts.join("\n") + "\n"
+  end
+
+  def updates
+    texts = @account.user_timeline.map {|t| "#{t.user.screen_name}> #{t.text}"}
+    texts.join("\n") + "\n"
+  end
+
+  def replies
+    texts = @account.replies.map {|t| "#{t.user.screen_name}> #{t.text}"}
+    texts.join("\n") + "\n"
+  end
+
+  def update(msg)
+    @account.update msg
+  end
+
+  def user_timeline(user)
+    texts = Twitter::Search.new(user).map {|t| "#{t.from_user}> #{t.text}"}
+    texts.join("\n") + "\n"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'twitter-fusefs'
+
+class Test::Unit::TestCase
+end

data/test/twitter-fusefs_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TwitterFusefsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: chmeee-twitter-fusefs
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- chmeee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 -07:00
+default_executable: twitter-fusefs
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Mount your twitter account as a userspace filesystem, access your tweets as files, update echo'ing over files
+email: chmeee@gmail.com
+executables: 
+- twitter-fusefs
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/twitter-fusefs
+- helpers/config_store.rb
+- lib/twitter-fusefs.rb
+- lib/twitter_account.rb
+- test/test_helper.rb
+- test/twitter-fusefs_test.rb
+has_rdoc: false
+homepage: http://github.com/chmeee/twitter-fusefs
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Access twitter as a filesystem
+test_files: 
+- test/test_helper.rb
+- test/twitter-fusefs_test.rb