imw 0.2.18 → 0.3.0

data/lib/imw/schemes/http.rb

@@ -1,165 +0,0 @@
-module IMW
-  module Schemes
-
-    # Defines methods for accessing a resource over HTTP.  Uses
-    # RestClient to implement the basic HTTP verbs (GET, POST, PUT,
-    # DELETE, HEAD).
-    module HTTP
-
-      # Many websites have HTML content without an <tt>.html</tt>
-      # extension so automatically extend +obj+ with
-      # IMW::Resources::Formats::HTML in this case.
-      def self.extended obj
-        obj.extend(IMW::Formats::Html) if obj.extension.blank?
-      end
-
-      # Is this resource being accessed via HTTP?
-      #
-      # @return [true, false]
-      def via_http?
-        true
-      end
-
-      # Copy this resource to the +new_uri+.
-      #
-      # @param [String, IMW::Resource] new_uri
-      # @return [IMW::Resource] the new resource
-      def cp new_uri
-        IMW::Tools::Transferer.new(:cp, self, new_uri).transfer!
-      end
-      
-      # Return the basename of the URI or <tt>_index</tt> if it's
-      # blank, as in the case of <tt>http://www.google.com</tt>.
-      #
-      # @return [String]
-      def effective_basename
-        (basename.blank? || basename =~ %r{^/*$}) ? "_index" : basename
-      end
-      
-      # Send a GET request to this resource's URI.
-      #
-      # If the response doesn't have HTTP code 2xx, a RestClient
-      # error will be raised.
-      #
-      # If a block is given then the response will be passed to the
-      # block, even in case of a non-2xx code.
-      #
-      # See the documentation for
-      # RestClient[http://rdoc.info/projects/archiloque/rest-client]
-      # for more information.
-      #
-      # @param [Hash] headers the headers to include in the request
-      # @yield [RestClient::Response] the response from the server
-      # @return [RestClient::Response] the response from the server
-      # @raise [RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed] error from RestClient on non-2xx response codes
-      def get headers={}, &block
-        make_restclient_request do
-          RestClient.get(uri.to_s, headers, &block)
-        end
-      end
-
-      # Send a POST request to this resource's URI with data
-      # +payload+.
-      #
-      # If the response doesn't have HTTP code 2xx, a RestClient
-      # error will be raised.
-      #
-      # If a block is given then the response will be passed to the
-      # block, even in case of a non-2xx code.
-      #
-      # See the documentation for
-      # RestClient[http://rdoc.info/projects/archiloque/rest-client]
-      # for more information.
-      #
-      # @param [Hash, String] payload the data to send
-      # @param [Hash] headers the headers to include in the request
-      # @yield [RestClient::Response] the response from the server
-      # @return [RestClient::Response] the response from the server
-      # @raise [RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed] error from RestClient on non-2xx response codes
-      def post payload, headers={}, &block
-        make_restclient_request do
-          RestClient.post(uri.to_s, payload, headers, &block)
-        end
-      end
-
-      # Send a PUT request to this resource's URI with data
-      # +payload+.
-      #
-      # If the response doesn't have HTTP code 2xx, a RestClient
-      # error will be raised.
-      #
-      # If a block is given then the response will be passed to the
-      # block, even in case of a non-2xx code.
-      #
-      # See the documentation for
-      # RestClient[http://rdoc.info/projects/archiloque/rest-client]
-      # for more information.
-      #
-      # @param [Hash, String] payload the data to send
-      # @param [Hash] headers the headers to include in the request
-      # @yield [RestClient::Response] the response from the server
-      # @return [RestClient::Response] the response from the server
-      # @raise [RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed] error from RestClient on non-2xx response codes
-      def put payload, headers={}, &block
-        make_restclient_request do
-          RestClient.put(uri.to_s, payload, headers, &block)
-        end
-      end
-      
-      # Send a DELETE request to this resource's URI.
-      #
-      # If the response doesn't have HTTP code 2xx, a RestClient
-      # error will be raised.
-      #
-      # If a block is given then the response will be passed to the
-      # block, even in case of a non-2xx code.
-      #
-      # See the documentation for
-      # RestClient[http://rdoc.info/projects/archiloque/rest-client]
-      # for more information.
-      #
-      # @param [Hash] headers the headers to include in the request
-      # @yield [RestClient::Response] the response from the server
-      # @return [RestClient::Response] the response from the server
-      # @raise [RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed] error from RestClient on non-2xx response codes
-      def delete headers={}, &block
-        make_restclient_request do
-          RestClient.delete(uri.to_s, headers, &block)
-        end
-      end
-      
-      # Send a HEAD request to this resource's URI.
-      #
-      # If the response doesn't have HTTP code 2xx, a RestClient
-      # error will be raised.
-      #
-      # If a block is given then the response will be passed to the
-      # block, even in case of a non-2xx code.
-      #
-      # See the documentation for
-      # RestClient[http://rdoc.info/projects/archiloque/rest-client]
-      # for more information.
-      #
-      # @param [Hash] headers the headers to include in the request
-      # @yield [RestClient::Response] the response from the server
-      # @return [RestClient::Response] the response from the server
-      # @raise [RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed] error from RestClient on non-2xx response codes
-      def head headers={}, &block
-        make_restclient_request do
-          RestClient.head(uri.to_s, headers, &block)
-        end
-      end
-
-      protected
-      def make_restclient_request &block # :nodoc
-        require 'restclient'
-        begin
-          yield
-        rescue RestClient::NotModified, RestClient::Unauthorized, RestClient::ResourceNotFound, RestClient::RequestFailed => e
-          raise IMW::NetworkError.new("#{e.class} -- #{e.message}")
-        end
-      end
-    end
-  end
-end
-

data/lib/imw/schemes/local.rb

@@ -1,409 +0,0 @@
-module IMW
-  module Schemes
-    module Local
-
-      # Defines methods appropriate for any file (or directory) on the
-      # local machine.  Includes methods from the File class like
-      # File#exist?, File#size, &c.
-      #
-      # When extending with this module, it will automatically also
-      # extend with either IMW::Schemes::Local::LocalDirectory or
-      # IMW::Schemes::Local::LocalFile, as appropriate.
-      module Base
-
-        def self.extended obj
-          # also extend with file or directory as appropriate
-          if obj.directory?
-            obj.extend(LocalDirectory)
-          else
-            obj.extend(LocalFile)
-          end
-        end
-        
-        # Steal a bunch of class methods from File which only take a
-        # path as a first argument.
-        [:executable?, :executable_real?, :exist?, :file?, :directory?, :ftype, :owned?, :pipe?, :readable?, :readable_real?, :setgid?, :setuid?, :size, :size?, :socket?, :split, :stat, :sticky?, :writable?, :writable_real?, :zero?].each do |class_method|
-          define_method class_method do
-            File.send(class_method, path)
-          end
-        end
-        alias_method :exists?, :exist?
-
-        # Return the path to this local object.
-        #
-        # @return [String]
-        def path
-          @path ||= File.expand_path(@encoded_uri ? Addressable::URI.decode(uri.to_s) : uri.to_s)
-        end
-
-        # Is this file on the local machine?
-        #
-        # @return [true, false]
-        def is_local?
-          true
-        end
-
-        # Copy this resource to the +new_uri+.
-        #
-        # @param [String, IMW::Resource] new_uri
-        # @return [IMW::Resource] the new resource
-        def cp new_uri
-          IMW::Tools::Transferer.new(:cp, self, new_uri).transfer!
-        end
-
-        # Move this resource to the +new_uri+.
-        #
-        # @param [String, IMW::Resource] new_uri
-        # @return [IMW::Resource] the new resource
-        def mv new_uri
-          IMW::Tools::Transferer.new(:mv, self, new_uri).transfer!
-        end
-
-        # Return the directory of this resource.
-        #
-        # @return [IMW::Resource]
-        def dir
-          IMW.open(dirname)
-        end
-        
-      end
-
-      # Defines methods for appropriate for a local file.
-      module LocalFile
-
-        include IMW::Metadata::HasMetadata
-        
-        # Is this resource a regular file?
-        #
-        # @return [true, false]
-        def is_file?
-          true
-        end
-
-        # Delete this resource.
-        def rm
-          should_exist!("Cannot delete")
-          FileUtils.rm path
-          self
-        end
-        alias_method :rm!, :rm
-
-        # Return the IO object at this path.
-        #
-        # @return [File]
-        def io
-          @io ||= open(path, mode)
-        end
-
-        # Close this resource's file handle if it exists.
-        def close
-          # explicitly check the @io instance variable b/c self.io
-          # will open up a new handle by default
-          io.close if @io
-          super()
-        end
-
-        # Read from this file.
-        #
-        # @param [Fixnum] length bytes to read
-        # @return [String]
-        def read length=nil
-          io.read(length)
-        end
-
-        # Read a line from this file.
-        #
-        # @return [String]
-        def readline
-          io.readline
-        end
-
-        # Write to this file
-        #
-        # @param [String, #to_s] text text to write
-        # @return [Fixnum] bytes written
-        def write text
-          io.write text
-        end
-
-        # Write the text with a trailing newline to this resource.
-        #
-        # @param [String, #to_s] text
-        def << text
-          io.write text.to_s + "\n"
-        end
-
-        # Return the lines in this file.
-        #
-        # If passed a block, yield each line of the file to the block.
-        #
-        # @yield [String] each line of the file
-        # @return [Array] the lines in the file
-        def load &block
-          if block_given?
-            io.each do |line|
-              yield line
-            end
-          else
-            read.split("\n")
-          end
-        end
-
-        # Map over the lines in this file.
-        #
-        # @yield [String] each line of the file
-        def map &block
-          io.map(&block)
-        end
-
-        # Emit +data+ into this file.
-        #
-        # @param [String, Array, #each] data object to emit
-        def emit data, options={}
-          data.each do |element|  # works if data is an Array or a String
-            io << (element.to_s)
-          end
-        end
-
-        # Return a snippet of text from this resource.
-        #
-        # Will read the first 1024 bytes and strip non-ASCII
-        # characters from them.  For more control, redefine this
-        # method in another module.
-        #
-        # @return [String]
-        def snippet
-          [].tap do |snip|
-            (io.read(1024) || '').bytes.each do |byte|
-              # CR            LF          SPACE            ~
-              snip << byte.chr if byte == 13 || byte == 10 || byte >= 32 && byte <= 126
-            end
-          end.join
-        end
-
-        # Return the number of lines in this file.
-        #
-        # @return [Integer]
-        def num_lines
-          wc[0]
-        end
-
-        # Return the number of words in this file.
-        #
-        # @return [Integer]
-        def num_words
-          wc[1]
-        end
-
-        # Return the number of characters in this file.
-        #
-        # @return [Integer]
-        def num_chars
-          wc[2]
-        end
-
-        # Return a summary of properties of this local file.
-        #
-        # Returned properties include
-        # - basename
-        # - size
-        # - extension
-        # - num_lines
-        def external_summary
-          super().merge({
-                          :size      => size,
-                          :num_lines => num_lines
-                        })
-        end
-
-
-        
-
-        protected
-        
-        # Return a triple of line, word, and character counts for this
-        # resource.
-        #
-        # Relies on the Unix utility +wc+.
-        #
-        # @return [Array<Integer>]
-        def wc
-          @wc ||= begin
-                    `wc #{path}`.chomp.strip.split.map(&:to_i)
-                  rescue
-                    [nil,nil,nil] # FIXME
-                  end
-        end
-
-      end
-
-      # Defines methods for manipulating the contents of a local
-      # directory.
-      module LocalDirectory
-
-        # Lets local directories contain a special metadata file which
-        # describes their contents.
-        include IMW::Metadata::ContainsMetadata
-
-        # Is this resource a directory?
-        #
-        # @return [true, false]
-        def is_directory?
-          true
-        end
-
-        # Delete this directory.
-        #
-        # @return [IMW::Resource] the deleted directory
-        def rmdir
-          FileUtils.rmdir path
-          self
-        end
-        alias_method :rmdir!, :rmdir
-
-        # Delete this directory recursively.
-        #
-        # @return [IMW::Resource] the deleted directory
-        def rm_rf
-          FileUtils.rm_rf path
-          self
-        end
-        alias_method :rm_rf!, :rm_rf
-
-        # Return a list of paths relative to this directory which match
-        # the +selector+.  Works just like Dir[].
-        #
-        # @param [String] selector
-        # @return [Array] the matched paths
-        def [] selector='*'
-          Dir[File.join(path, selector)]
-        end
-
-        # Does this directory contain +obj+?
-        #
-        # @param [String, IMW::Resource] obj
-        # @return [true, false]
-        def contains? obj
-          obj = IMW.open(obj)
-          return false unless obj.is_local?
-          return true  if obj.path == path
-          return false unless obj.path.starts_with?(path)
-          return true  if self[obj.path[path.length..-1]].size > 0
-          false
-        end
-
-        # Return a list of all paths directly within this directory.
-        #
-        # @return [Array<String>]
-        def contents
-          self['*']
-        end
-
-        # Return all paths within this directory, recursively.
-        #
-        # @return [Array<String>]
-        def all_contents
-          self['**/*']
-        end
-
-        # Return all resources directly within this directory.
-        #
-        # @return [Array<IMW::Resource>]
-        def resources
-          contents.map { |path| IMW.open(path) }
-        end
-
-        # Return all resources within this directory, recursively.
-        #
-        # @return [Array<IMW::Resource>]
-        def all_resources
-          all_contents.map do |path|
-            IMW.open(path) unless File.directory?(path)
-          end.compact
-        end
-
-        # Package the contents of this directory to an archive at
-        # +package_path+.
-        #
-        # @param [String, IMW::Resource] package_path
-        # @return [IMW::Resource] the new package
-        def package package_path
-          temp_package = IMW.open(File.join(dirname, File.basename(package_path)))
-          FileUtils.cd(dirname) { temp_package.create(basename) }
-          temp_package.path == File.expand_path(package_path) ? temp_package : temp_package.mv(package_path)
-        end
-        alias_method :package!, :package
-
-        # Change the working directory to this local directory.
-        #
-        # If passed a black, execute the block in this directory and
-        # then change back to the initial directory.
-        #
-        # This method works the same as FileUtils.cd.
-        def cd &block
-          FileUtils.cd(path, &block)
-        end
-
-        # Create this directory.
-        #
-        # No error if the directory already exists.
-        #
-        # @return [IMW::Resource] this directory
-        def create
-          FileUtils.mkdir_p(path) unless exist?
-          self
-        end
-
-        # Return the resource at the base path of this resource joined
-        # to +path+.
-        #
-        #   IMW.open('/path/to/dir').join('subdir')
-        #   #=> IMW::Resource at '/path/to/dir/subdir'
-        #
-        # @param [Array<String>] paths
-        # @return [IMW::Resource]
-        def join *paths
-          IMW.open(File.join(stripped_uri.to_s, *paths))
-        end
-
-        # Open (and create if necessary) a subdirectory beneath this
-        # directory.
-        #
-        # @params [Array<String>] paths
-        # @return [IMW::Resource]
-        def subdir! *paths
-          IMW.dir!(File.join(stripped_uri.to_s, *paths))
-        end
-
-        # Recursively walk down this directory
-        def walk(options={}, &block)
-          require 'find'
-          Find.find(path) do |path|
-            if options[:only]
-              next if options[:only] == :files && !File.file?(path)
-              next if options[:only] == :directories && !File.directory?(path)
-              next if options[:only] == :symlinks && !File.symlink?(path)
-            end
-            yield path
-          end
-        end
-        
-        # The directory summary includes the following information
-        # - size
-        # - num_files
-        #
-        # @return [Hash]
-        def external_summary
-          super().merge({
-                          :size      => size,
-                          :num_files => contents.length,
-                        })
-        end
-
-      end
-    end
-  end
-end
-
-
-