pione 0.2.1 → 0.2.2

data/lib/pione/location/data-location.rb

@@ -0,0 +1,328 @@
+module Pione
+  module Location
+    class DataLocation < BasicLocation
+      location_type :data
+
+      class << self
+        # @return [String]
+        #   location's scheme name
+        attr_reader :scheme
+
+        # Declare the name as location scheme.
+        #
+        # @param name [String]
+        #   scheme name
+        def set_scheme(name)
+          @scheme = name
+          SCHEMES[name] = self
+        end
+
+        def set_real_appendable(b)
+          @appendable = b
+        end
+
+        def real_appendable?
+          @appendable
+        end
+
+        def set_writable(b)
+          @writable = b
+        end
+
+        def writable?
+          @writable
+        end
+      end
+
+      forward! :class, :scheme, :real_appendable?, :writable?
+      forward :@uri, :host
+
+      # @return [URI]
+      #   URI of the location
+      attr_reader :uri
+
+      # @return [Pathname]
+      #   path of the location
+      attr_reader :path
+
+      # Create a location with the URI.
+      #
+      # @param uri [URI]
+      #   location URI
+      def initialize(uri)
+        @address = uri.to_s
+        @uri = uri.kind_of?(URI::Generic) ? uri : URI.parse(uri)
+        @path = Pathname.new(uri.path)
+        raise ArgumentError.new(uri) unless @uri.scheme = scheme
+      end
+
+      # Copy the content to temporary local location and return it. If the
+      # scheme is local, return itselft.
+      def local
+        if scheme == "local"
+          self
+        else
+          Location[Temppath.create].tap {|tmp| copy(tmp)}
+        end
+      end
+
+      # Create new location appended the name.
+      #
+      # @param name [String]
+      #   filename or directory name
+      # @return [BasicLocation]
+      #   new location
+      def +(name)
+        self.class.new(@uri.as_directory + name.to_s)
+      end
+
+      # Create new location that has URI as a directory.
+      #
+      # @return [BasicLocation]
+      #   new location
+      def as_directory
+        self.class.new(@uri.as_directory)
+      end
+
+      # Return the basename of the location.
+      #
+      # @param suffix [String]
+      #   suffix name
+      # @return [String]
+      #   basename
+      def basename(suffix="")
+        File.basename(@path, suffix)
+      end
+
+      # Return the extension name of location.
+      #
+      # @return
+      #    the extension name of location
+      def extname
+        File.extname(basename)
+      end
+
+      # Rebuild location with the path.
+      #
+      # @param path [Pathname]
+      #   new path
+      # @return [Location]
+      #   location with new path
+      def rebuild(path)
+        scheme = @uri.scheme
+        auth = "%s:%s@" % [@uri.user, @uri.password] if @uri.user and @uri.password
+        host = @uri.host
+        port = ":%i" % @uri.port
+        path = path.expand_path("/").to_s
+        Location["%s://%s%s%s%s" % [scheme, auth, host, port, path]]
+      end
+
+      # Return true if the location is cached.
+      #
+      # @return [Boolean]
+      #   true if the location is cached
+      def cached?
+        System::FileCache.cached?(self)
+      end
+
+      # Write a data into the location.
+      #
+      # @param data [String]
+      #   data content
+      # @return [void]
+      def write(data)
+        if exist?
+          update(data)
+        else
+          create(data)
+        end
+      end
+
+      # Creates a file at the location. If a file exists at the location aleady,
+      # it raises an exception.
+      #
+      # @param data [String]
+      #   data content
+      # @return [void]
+      def create(data)
+        raise NotImplementedError
+      end
+
+      # Append data to the location data.
+      #
+      # @param data [String]
+      #   data content
+      # @return [void]
+      def append(data)
+        raise NotImplmentedError
+      end
+
+      # Read location data.
+      #
+      # @return [String]
+      #   data content
+      def read
+        raise NotImplementedError
+      end
+
+      # Update with the data.
+      #
+      # @param data [String]
+      #   new data content
+      # @return [void]
+      def update(data)
+        raise NotImplementedError
+      end
+
+      # Delete data of the location.
+      #
+      # @return [void]
+      def delete
+        raise NotImplementedError
+      end
+
+      # Return last modification time of the location.
+      #
+      # @return [Time]
+      #   last modification time
+      def mtime
+        raise NotImplementedError
+      end
+
+      # Return byte size of data in the location.
+      #
+      # @return [Integer]
+      #   byte size of data
+      def size
+        raise NotImplementedError
+      end
+
+      # Return entries of the location.
+      #
+      # @return [Array<Location>]
+      #   entries of the location
+      def entries
+        raise NotImplementedError
+      end
+
+      # Return relative entries of the location.
+      #
+      # @return [Array<String>]
+      #   entries of the location
+      def rel_entries(option)
+        raise NotImplementedError
+      end
+
+      # Return file entries of the location.
+      #
+      # @return [Array<Location>]
+      #    file entries of the location
+      def file_entries
+        entries.select{|entry| entry.file?}
+      end
+
+      # Return directory entries of the location.
+      #
+      # @return [Array<Location>]
+      #    directory entries of the location
+      def directory_entries
+        entries.select do |entry|
+          entry.directory? and not(entry.path.basename == "." or entry.path.basename == "..")
+        end
+      end
+
+      # Return true if there is data in the location.
+      #
+      # @return [Boolean]
+      #   if there is data in the location
+      def exist?
+        raise NotImplementedError
+      end
+
+      # Return true if data in the location is a file.
+      #
+      # @return [Boolean]
+      #   true if data in the location is a file
+      def file?
+        raise NotImplementedError
+      end
+
+      # Return true if data in the location is a directory.
+      #
+      # @return [Boolean]
+      #   true if data in the location is a directory
+      def directory?
+        raise NotImplementedError
+      end
+
+      # Move to the destination.
+      #
+      # @param dest [BasicLocation]
+      #   destination
+      # @return [void]
+      def move(dest)
+        raise NotImplementedError
+      end
+
+      # Copy location's content to the destination.
+      #
+      # @param dest [BasicLocation]
+      #   destination
+      # @return [void]
+      def copy(dest)
+        raise NotImplementedError
+      end
+
+      # Link to the destination. If the location scheme is same to destination,
+      # create link by a symbolic link or lightweight copy method. If not, copy
+      # it simply.
+      #
+      # @param dest [BasicLocation]
+      #   destination
+      # @return [void]
+      def link(dest)
+        raise NotImplementedError
+      end
+
+      # Move data to the destination and link self to it.
+      #
+      # @param dest [BasicLocation]
+      #   destination
+      # @return [void]
+      def turn(dest)
+        raise NotImplementedError
+      end
+
+      # Return the digest string by SHA1.
+      #
+      # @return [String]
+      #   hex-string of the file
+      def sha1
+        if file?
+          Digest::SHA1.file(local.path)
+        else
+          raise InvalidFileOperation.new(self)
+        end
+      end
+
+      # @api private
+      def inspect
+        "#<%s %s:%s>" % [self.class, scheme, @path.to_s]
+      end
+      alias :to_s :inspect
+
+      # @api private
+      def ==(other)
+        return false unless other.kind_of?(self.class)
+        @uri == other.uri
+      end
+      alias :eql? :"=="
+
+      # @api private
+      def hash
+        @uri.hash
+      end
+    end
+  end
+end
+

data/lib/pione/location/dropbox-location.rb

@@ -1,7 +1,7 @@
 module Pione
   module Location
     # DropboxLocation represents locations on Dropbox server.
-    class DropboxLocation < BasicLocation
+    class DropboxLocation < DataLocation
       set_scheme "dropbox"
 
       class << self
@@ -27,6 +27,10 @@ module Pione
           @session.set_access_token(access_token_key, access_token_secret)
         end
 
+        def rebuild(path)
+          Location["dropbox:%s" % path]
+        end
+
         # Share dropbox's access token with PIONE agents.
         #
         # @param tuple_space_server [TupleSpaceServer]
@@ -89,14 +93,23 @@ module Pione
         Time.parse(metadata["modified"])
       end
 
-      def entries
+      def entries(option={})
+        rel_entries(option).map {|entry| rebuild(@path + entry)}
+      end
+
+      def rel_entries(option={})
+        list = []
+        raise NotFound.new(self) if not(directory?)
         metadata = @client.metadata(@path)
-        if not(metadata["is_dir"]) or metadata["is_deleted"]
-          raise NotFound.new(self)
-        end
-        metadata["contents"].select{|entry| not(entry["is_dir"]) and not(entry["is_deleted"])}.map do |entry|
-          Location["dropbox:%s" % entry["path"]]
+        metadata["contents"].select{|entry| not(entry["is_deleted"])}.each do |entry|
+          list << entry["path"][0, @path.size]
+          entry_location = rebuild(@path + entry)
+          if option[:rec] and entry_location.directory?
+            _list = entry_location.rel_entries(option).map {|subentry| entry + subentry}
+            list = list + _list
+          end
         end
+        return list
       end
 
       def exist?
@@ -106,6 +119,16 @@ module Pione
         return false
       end
 
+      def file?
+        metadata = @client.metadata(@path)
+        return (not(metadata["is_dir"]) and not(metadata["is_deleted"]))
+      end
+
+      def directory?
+        metadata = @client.metadata(@path)
+        return (metadata["is_dir"] and not(metadata["is_deleted"]))
+      end
+
       def move(dest)
         if dest.scheme == scheme
           @client.file_move(@path, dest.path)

data/lib/pione/location/exception.rb

@@ -0,0 +1,38 @@
+module Pione
+  module Location
+    # LocationError is raised when any resource errors happen.
+    class LocationError < StandardError
+      def initialize(location, option={})
+        @location = location
+        @option = option
+      end
+    end
+
+    # ExistAlready is raised when there is data on the location already.
+    class ExistAlready < LocationError
+      def message
+        "the location exists already: %s" % @location.inspect
+      end
+    end
+
+    # NotFound is raised when there isn't data on the location.
+    class NotFound < LocationError
+      def message
+        "%s not found" % @location.inspect
+      end
+    end
+
+    # InvalidFileOperation represents you do file operation to directory.
+    class InvalidFileOperation < LocationError
+      def message
+        "invalid file operation: %s" % @location.inspect
+      end
+    end
+
+    class GitError < LocationError
+      def message
+        "%s: %s" % [@option[:message], @location.address]
+      end
+    end
+  end
+end

data/lib/pione/location/ftp-location.rb

@@ -1,7 +1,7 @@
 module Pione
   module Location
     # FTPLocation represents locations on FTP server.
-    class FTPLocation < BasicLocation
+    class FTPLocation < DataLocation
       set_scheme "ftp"
       set_real_appendable false
 
@@ -44,15 +44,11 @@ module Pione
       end
 
       def read
-        begin
-          data = nil
-          file = Temppath.create
-          connect {|ftp| ftp.get(@path, file.to_s)}
-          data = File.read(file.to_s)
-          return data
-        rescue Net::FTPPermError
-          raise NotFound.new(@uri)
-        end
+        file = Temppath.create
+        connect {|ftp| ftp.get(@path, file.to_s)}
+        return File.read(file.to_s)
+      rescue Net::FTPPermError
+        raise NotFound.new(@uri)
       end
 
       def update(data)
@@ -71,6 +67,10 @@ module Pione
         connect {|ftp| ftp.delete(@path.to_s)} if exist?
       end
 
+      def mkdir
+        connect {|ftp| makedirs(ftp, @path)} unless exist?
+      end
+
       def mtime
         connect {|ftp| exist? ? ftp.mtime(@path.to_s) : (raise NotFound.new(self))}
       end
@@ -79,12 +79,23 @@ module Pione
         connect {|ftp| exist? ? ftp.size(@path.to_s) : (raise NotFound.new(self))}
       end
 
-      def entries
+      def entries(option={})
+        rel_entries(option).map {|entry| rebuild(@path + entry)}
+      end
+
+      def rel_entries(option={})
+        list = []
         connect do |ftp|
-          ftp.nlst(@path.to_s).map do |entry|
-            rebuild(@path + entry)
+          ftp.nlst(@path.to_s).each do |entry|
+            list << entry
+            entry_location = rebuild(@path + entry)
+            if option[:rec] and entry_location.directory?
+              _list = entry_location.rel_entries(option).map {|subentry| entry + subentry}
+              list = list + _list
+            end
           end
         end
+        return list
       end
 
       def exist?