fspsocket 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 mokit
+
+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.rdoc

@@ -0,0 +1,21 @@
+= fspsocket
+
+* FSPSocket is a library for socket-based communication between client/server programs
+over a file synchronization service.
+* It is an acronym for "File Synchronization-based Pseudo Socket."
+
+== Contributing to fspsocket
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 mokit. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fspsocket"
+  gem.homepage = "http://github.com/mokitma/fspsocket"
+  gem.license = "MIT"
+  gem.summary = %Q{A pseudo socket library over a file synchronization service}
+  gem.description = %Q{FSPSocket is a module to enable socket-like communication over a file synchronization service, namely Dropbox}
+  gem.email = "mokitma@gmail.com"
+  gem.authors = ["mokit"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_runtime_dependency 'filemonitor', '> 0.0.4'
+  gem.add_runtime_dependency 'json', '> 1.5.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fspsocket #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/fspsocket.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fspsocket}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mokit"]
+  s.date = %q{2011-03-10}
+  s.description = %q{FSPSocket is a module to enable socket-like communication over a file synchronization service, namely Dropbox}
+  s.email = %q{mokitma@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fspsocket.gemspec",
+    "lib/fspsocket.rb",
+    "sample/echocli.rb",
+    "sample/echoserv.rb",
+    "spec/fspsocket_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mokitma/fspsocket}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A pseudo socket library over a file synchronization service}
+  s.test_files = [
+    "spec/fspsocket_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<filemonitor>, ["> 0.0.4"])
+      s.add_runtime_dependency(%q<json>, ["> 1.5.1"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<filemonitor>, ["> 0.0.4"])
+      s.add_dependency(%q<json>, ["> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<filemonitor>, ["> 0.0.4"])
+    s.add_dependency(%q<json>, ["> 1.5.1"])
+  end
+end
+

data/lib/fspsocket.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/env ruby
+#
+# = FSPSocket module
+# Author:: mokitma@gmail.com
+# Copyright:: Copyright 2011 mokitma
+#
+# Supports lazy socket communication over file synchronization services,
+# namely Dropbox
+#
+require 'rubygems'
+require 'fileutils'
+require 'socket'
+require 'singleton'
+require 'observer'
+require 'filemonitor'
+require 'uri'
+require 'json'
+require 'drb/drb'
+require 'logger'
+
+module FSPSocket
+  @@log = Logger.new(STDOUT)
+  @@log.level = Logger::WARN
+  @@base = [ENV['HOME'], "Dropbox", "socks"].join(File::SEPARATOR)
+
+  def FSPSocket.new
+    return PSocket.new
+  end
+
+  def FSPSocket.open(dst_id, &block)
+    return PSocket.open(dst_id, block)
+  end
+
+  class PSocket 
+    include FSPSocket
+    @@id_count = 0
+    attr_reader :id
+
+    def initialize(*args)
+      @host = Socket.gethostname
+      @pid = Process.pid
+      @id = [@host, @pid, @@id_count].join('_')
+      @@id_count += 1
+      if args.length == 1
+        @block = args[0]
+      end
+      @sock_buf = []
+      Manager.instance.add_observer self
+      init_channel
+    end
+
+    def init_channel
+      unless FileTest.exist? @@base
+        Dir::mkdir(@@base, 0777)
+      end
+
+      @path = [@@base, @id].join(File::SEPARATOR)
+      @cpath = [@path, :controls].join(File::SEPARATOR)
+      @dpath = [@path, :data].join(File::SEPARATOR)
+      @connected = [] # for cleanup 
+      unless FileTest.exist? @path
+        Dir::mkdir(@path, 0777)
+        Dir::mkdir(@cpath, 0777)
+        FileUtils.touch(@dpath)
+      end
+      Manager.instance.add_dir(@cpath)
+    end
+    private :init_channel
+  
+    # msg[0] => path, msg[1] => data in JSON delimited with '\n'  
+    def update(msg)
+      @@log.info "--- update #{msg}"
+      # msg[1]:data part can contain more than one line
+      msg[1].each_line do |item|
+        h = JSON.parse(item) 
+        d = h.fetch(:data.to_s) 
+        ud = URI.unescape(d)
+        ar = ud.split
+        if ar[0] == "HELLO"
+          @@log.info "---got HELLO: #{ar[1]}"
+          Manager.instance.add_file([@@base, ar[1], :data].join(File::SEPARATOR))
+          # XXX
+          mycpath = [@@base, ar[1], :controls, @id].join(File::SEPARATOR)
+          FileUtils.touch(mycpath)
+          sleep 1 # XXX for timing purpose
+          PSocket.write_to(mycpath, "OK #{@id}")
+        elsif ar[0] == "OK"
+          @@log.info "---got OK: #{ar[1]}"
+          Manager.instance.add_file([@@base, ar[1], :data].join(File::SEPARATOR))
+          @block.call(method(:received))    
+        elsif ar[0] == "BYE"
+          @@log.info "---got BYE: #{ar[1]}"
+          Manager.instance.remove_file([@@base, ar[1], :data].join(File::SEPARATOR))
+        else
+          @recv_block.call(msg[0], ud)
+        end    
+      end # each
+    end
+
+    def connect_channel(dst_fullpath)
+      # 1. create my controls channel in the other's controls dir 
+      #    /socks/dstid/controls/myid
+      mycpath = [dst_fullpath, :controls, @id].join(File::SEPARATOR)
+      @connected << mycpath
+      FileUtils.touch(mycpath)
+      sleep 1 # XXX for timing purpose
+      # 2. let the other know my path
+      PSocket.write_to(mycpath, "HELLO #{@id}")    
+    end
+
+    def delete_channel
+      @connected.each do |path|
+        if FileTest.exist? path
+          File::delete path
+        end
+      end
+
+      path = [@@base, @id].join(File::SEPARATOR)
+      if FileTest.exist? path
+        File::delete [path, :data].join(File::SEPARATOR)
+        FileUtils.rm_rf path
+      end    
+    end 
+
+    def PSocket.open(dst_id, block)
+      sock = PSocket.new(block)
+      if (dst_id.kind_of?(Enumerable))
+        dst_id.each do |item|
+          sock.connect_channel([@@base, item].join(File::SEPARATOR))
+        end
+      else
+        sock.connect_channel([@@base, dst_id].join(File::SEPARATOR))
+      end
+      return sock
+    end
+
+    # used to connect to multiple destinations
+    def connect(dst_id)
+      if (dst_id.kind_of?(Enumerable))
+        dst_id.each do |item|
+          connect_channel([@@base, item].join(File::SEPARATOR))
+        end
+      else
+        connect_channel([@@base, dst_id].join(File::SEPARATOR))
+      end
+    end
+
+    def close
+      delete_channel
+      PSocket.write_to(@dst_cpath, "BYE #{@id}") 
+    end
+
+    def received(&block)
+      @recv_block = block
+    end 
+
+    def puts(data)
+      #@@log.debug "XXX puts: #{@dpath} #{data}"
+      PSocket.write_to(@dpath, data)
+    end
+
+    def PSocket.write_to(path, data)
+      @@log.info "write_to #{path} #{data}"
+      File::open(path, "a+") do |f|
+        h = {:time=>Time.now, :data=>URI.encode(data)}
+        f.puts(h.to_json)
+      end    
+    end
+
+    alias_method :_puts, :puts 
+    private :_puts
+  end # class
+
+  class Manager
+    include FSPSocket
+    include Singleton
+    include Observable
+    attr_reader :m
+
+    def initialize
+      @paths = {}
+      @m = FileMonitor.new do |f|
+        @@log.info "Modified: #{f.path}"
+        file_modified(f.path)
+      end
+    end
+
+    def add_dir(path)
+      @@log.info "add_dir: #{path}"
+      @m.add(path) do |f|
+        @@log.info "dir modified #{f.path}"
+        @paths.store(f.path, [0, 0]) # dummy data
+        file_modified(f.path)
+      end
+    end 
+
+    def add_file(path)
+      @@log.info "add_file: #{path}"
+      st = File::stat(path)
+      @paths.store(path, [st.mtime, st.size])
+      @m << path
+    end
+ 
+    def remove_file(path)
+      @paths.delete(path)
+    end
+
+    def get_file
+      @paths.each_key
+    end
+
+    def file_modified(path)
+      @@log.info "file_modifled: #{path}" 
+      prev = @paths.fetch(path)
+      st = File::stat(path)
+      open(path, "r") do |f|
+        f.seek(prev[1], IO::SEEK_SET)
+        data = f.read(st.size - prev[1])      
+        @@log.info "data: #{data}"
+        begin
+          changed
+          idpart = path.sub(@@base, "").split(File::Separator)[1]
+          notify_observers [idpart, data] # XXX May contain multiple json entries
+        rescue
+          STDERR.puts $!
+        end
+      end # open
+      @paths.store(path, [st.mtime, st.size]) 
+    end  
+
+    def file_deleted(path)
+      @@log.info "file_deleted: #{path}" 
+      @paths.delete(path)
+    end
+  end # class 
+
+  Thread.new do # called when the module is loaded
+    Manager.instance.m.monitor
+  end
+end # module
+
+
+if __FILE__ == $0
+  # FSPSocket.new
+end

data/sample/echocli.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+#
+# Simple echo client
+#
+require 'rubygems'
+require 'fspsocket'
+
+trap('INT') {
+  $sock.close
+  exit 
+}
+
+def send_line
+  print "> "
+  STDOUT.flush
+  line = STDIN.gets
+  $sock.puts(line)
+end
+
+if ARGV.length == 0
+  puts "Usage: #{$0} server_id"
+  exit 1
+end
+
+$sock = FSPSocket.open(ARGV[0]){|rh| 
+  puts "sock: #{$sock.id}"
+  rh.call {|*data|
+    puts "#{data[1]}"
+    send_line
+  }
+  send_line
+}
+
+loop do
+  Thread.pass
+end
+$sock.close

data/sample/echoserv.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# Simple echo server
+#
+require 'rubygems'
+require 'fspsocket'
+
+trap('INT') {
+  $sock.close
+  exit 
+}  
+
+$sock = FSPSocket.new
+puts $sock.id
+$sock.received {|*data|
+  puts "\"#{data[1].strip!}\" from a client<#{data[0]}>"
+  $sock.puts("#{data[1]} from a server<#{$sock.id}>")
+}
+
+STDIN.gets
+$sock.close

data/spec/fspsocket_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Fspsocket" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fspsocket'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification 
+name: fspsocket
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- mokit
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-10 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  type: :runtime
+  name: filemonitor
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  name: json
+  prerelease: false
+  version_requirements: *id006
+description: FSPSocket is a module to enable socket-like communication over a file synchronization service, namely Dropbox
+email: mokitma@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fspsocket.gemspec
+- lib/fspsocket.rb
+- sample/echocli.rb
+- sample/echoserv.rb
+- spec/fspsocket_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mokitma/fspsocket
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A pseudo socket library over a file synchronization service
+test_files: 
+- spec/fspsocket_spec.rb
+- spec/spec_helper.rb