net-fs-gmail 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 / 2007-09-04
+
+* First release of +Net::FS::Gmail+, a port of the Perl module of the same name.
+

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/gmailfs.rb
+lib/net/fs/gmail.rb

data/README.txt

@@ -0,0 +1,34 @@
+Net::FS::Gmail
+Blair Christensen <blair@devclue.com>
+http://code.google.com/p/blair/wiki/NetFsGmail
+
+== DESCRIPTION:
+
+Store and retrieve files on Gmail.  
+
+== FEATURES/PROBLEMS:
+
+This is a port of the Perl module of the same name.  Currently it tries to match the
+Perl module's feature set.  It allows you to treat a Gmail account as a simple filesystem
+where you may store files.  
+
+== SYNOPSIS:
+
+See the project home page or rdoc for more details.
+
+== REQUIREMENTS:
+
+* rubygems
+* gmailer
+
+== INSTALL:
+
+  $ sudo gem install net-fs-gmail
+
+== LICENSE:
+
+The Apache License, Version 2.0
+See +LICENSE.txt+
+
+Copyright (c) 2007 Blair Christensen
+

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/net/fs/gmail.rb'
+
+Hoe.new('net-fs-gmail', Net::FS::Gmail::VERSION) do |p|
+  p.rubyforge_name  = 'net-fs-gmail'
+  p.author          = 'blair christensen'
+  p.email           = 'blair@devclue.com'
+  p.summary         = 'Store files on Gmail'
+  p.description     = p.paragraphs_of('README.txt', 2..2).join("\n\n")
+  p.url             = p.paragraphs_of('README.txt', 0).first.split(/\n/)[2..-1]
+  p.changes         = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps      << [ 'gmailer', '>= 0.1.7' ]
+end
+
+# vim: syntax=Ruby

data/bin/gmailfs.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+#
+# = gmailfs.rb - Simple program to store and retrieve files on Gmail
+#
+# This is a port of Perl's {Net::FS::Gmail}[http://search.cpan.org/~simonw/Net-FS-Gmail/].  
+# File storage should be compatible with the original Perl version.
+#
+# == USAGE
+#
+#   gmailfs.rb <username> <password> [ COMMAND ]
+#
+# If no +COMMAND+ is specified the list of stored files will be retrieved.
+#
+# Commands and their supported arguments:
+# * +delete+ - Delete file(s)
+#   1. _file_ 
+#   2. _version_ (optional)
+# * +quota+ - Print quota information
+# * +remove+ - Move file(s) to trash
+#   1. _file_ 
+#   2. _version_ (optional)
+# * +retrieve+ - Get file from Gmail
+#   1. _file_ 
+#   2. _as_ (optional)
+#   3. _version_ (optional)
+# * +store+ - Store file at Gmail
+#   1. _file_ 
+#   2. _version_ (optional)
+# * +versions+ - Get version(s) of file stored at Gmail
+#   1. _file_ 
+#
+# == License
+# 
+# Net::FS::Gmail is released under the Apache License, Version 2.0
+#
+# == Author
+# 
+# Blair Christensen. <mailto:blair@devclue.com>
+#
+# == Copyright
+#
+# Copyright (C) 2007, Blair Christensen
+#
+
+require 'net/fs/gmail'
+
+user = ARGV.shift || raise('You must pass a user name')
+pass = ARGV.shift || raise('You must pass a password')
+
+fs = Net::FS::Gmail.new(user, pass)
+
+cmd = ARGV.shift
+if cmd.nil?
+  fs.files.each { |f| puts f }
+  exit
+end
+
+case cmd
+  when  'delete'
+    file = ARGV.shift || raise('You must pass a file name')
+    fs.delete(file, ARGV.shift)
+  when  'quota'
+    quota = fs.quota()
+    puts sprintf("%s MB (%s%%)", quota[0], quota[1])
+  when  'remove'
+    file = ARGV.shift || raise('You must pass a file name')
+    fs.remove(file, ARGV.shift)
+  when  'retrieve'
+    file = ARGV.shift || raise('You must pass a file name')
+    fs.retrieve(file, ARGV.shift, ARGV.shift)
+  when  'store'
+    file = ARGV.shift || raise('You must pass a file name')
+    fs.store(file, ARGV.shift)
+  when  'versions'
+    file = ARGV.shift || raise('You must pass a file name')
+    fs.versions(file).each_with_index do |v,idx|
+      puts sprintf("%-3d\t%-16s\t%-7s", idx + 1, v.id, v.date)
+    end
+  else 
+    raise("Uknown command '#{cmd}'")
+end
+
+exit
+

data/lib/net/fs/gmail.rb

@@ -0,0 +1,211 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem     'gmailer', '>= 0.1.7'
+require 'gmailer'
+
+module Net # :nodoc:
+  module FS # :nodoc:
+    #
+    # = Net::FS::Gmail - store and retrieve files on Gmail
+    #
+    # This is a port of Perl's {Net::FS::Gmail}[http://search.cpan.org/~simonw/Net-FS-Gmail/].  
+    # File storage should be compatible with the original Perl version.
+    # 
+    # == License
+    # 
+    # Net::FS::Gmail is released under the Apache License, Version 2.0
+    #
+    # == Author
+    # 
+    # Blair Christensen. <mailto:blair@devclue.com>
+    #
+    # == Copyright
+    #
+    # Copyright (C) 2007, Blair Christensen
+    #
+    class Gmail
+
+      # Prepend this string to message +Subject+ to mark Net::FS::Gmail files.
+      FILESTORE_PREFIX    = 'GmailStore v'
+      # Version of filestore.
+      FILESTORE_VERSION   = '0.1'
+      # Append this email domain to Gmail username if not present.
+      GMAIL_DOMAIN        = '@gmail.com'
+      # Gmail label where messages may be found.
+      GMAIL_LABEL         = 'Inbox'
+      # Files are versioned from newest-to-oldest, starting from this number.
+      MOST_RECENT_VERSION = 1
+      # Net::FS::Gmail version
+      VERSION             = '0.0.1'
+
+      #
+      # Create connection to Gmail.  Returns Net::FS::Gmail object.
+      #
+      # Example:
+      #   require 'net/fs/gmail'
+      #   fs = Net::FS::Gmail.new('your.gmail.account', 'your password')
+      #
+      def initialize(user, password)
+        @gmail  = GMailer.connect(user, password)
+        @user   = user
+      end # def initialize(user, password)
+
+      #
+      # Permanently delete +file+ from Gmail.
+      #
+      # If +version+ is specified only that version will be deleted.  Otherwise all
+      # versions will be deleted.
+      #
+      # Example:
+      #  fs.delete('example', 2)  # Delete version +2+ of file +example+
+      #  fs.delete('example')     # Delete all versions of file +example+
+      #
+      def delete(file, version = nil)
+        # TODO 20070901 DRY w/ "remove()"
+        versions = self.versions(file)
+        raise('No versions found') if versions.size < 1
+        if version.nil?
+          versions.each { |v| @gmail.delete_message(v.id) }
+        else
+          version = version.to_i
+          raise('Version must be positive integer') if version < 1
+          v = versions[version - 1]
+          @gmail.delete_message(v.id)
+        end
+      end # def delete(file, version)
+
+      #
+      # Get a list of all the file names stored on Gmail.
+      #
+      # Example:
+      #   fs.files().each { |name| puts name }
+      #
+      def files()
+        files = []
+        # TODO 20070831 create patch to add rdoc to all gmailer methods i call
+        # TODO 20070831 create otherblog posts for all gmailer methods i call
+        # TODO 20070831 create rdoc2gwiki tranlator?
+        # TODO 20070831 ml.each      - yields Gmailer::Box objects
+        # TODO 20070831 ml.each_msg  - yields Gmailer::Message objects and debug spew
+        @gmail.messages(:standard => GMAIL_LABEL).each do |box|
+          next unless box.subject =~ /^#{FILESTORE_PREFIX}[\d.]+ (.+)$/
+          files << $1
+        end
+        files.uniq # TODO 20070901 i think this deviates from the original Perl
+      end # def files()
+
+      #
+      # Returns two element array of current quota usage.
+      # 
+      # Elements:
+      # * [0] Usage (MB)
+      # * [1] Usage (Percentage)
+      #
+      # Example:
+      #  quota = fs.quota()
+      #  puts sprintf("%s MB (%s%%)", quota[0], quota[1])
+      #
+      def quota()
+        # TODO 20070901 why do i need to call this (or something like it) before getting a snapshot?
+        @gmail.fetch(:contact => "freq") 
+        snap = @gmail.snap(:standard)
+        # TODO 20070901 add support for quota size
+        [ snap.quota_mb, snap.quota_per ]
+      end # def quota()
+
+      #
+      # Move +file+ to Gmail trash.  
+      #
+      # If +version+ is specified only that version will be removed.  Otherwise all
+      # versions will be trashed.
+      #
+      # Example:
+      #  fs.remove('example', 2)  # Move version +2+ of file +example+ to trash
+      #  fs.remove('example')     # Move all versions of file +example+ to trash
+      #
+      def remove(file, version)
+        # TODO 20070901 DRY w/ "delete()"
+        versions = self.versions(file)
+        raise('No versions found') if versions.size < 1
+        if version.nil?
+          versions.each { |v| @gmail.trash(v.id) }
+        else
+          version = version.to_i
+        raise('Version must be positive integer') if version < 1
+          v = versions[version - 1]
+          @gmail.trash(v.id)
+        end
+      end # def remove(file, version)
+
+      #
+      # Retrieves +file+ from Gmail and writes to the local filesystem.  
+      #
+      # If +as+ is specified, that will be used as the name of the output file.  Otherwise +file+
+      # will be used.  If +version+ is not specified, the most recent version of +file+
+      # will be retrieved.
+      # 
+      # Example:
+      #  # Retrieve most recent version of +example+ and write to file +example+
+      #  fs.retrieve('example')
+      #
+      #  # Retrieve most recent version of +example+ and write to file +example.txt+
+      #  fs.retrieve('example', 'example.txt')
+      #
+      #  # Retrieve version +2+ of +example+ and write to file +/tmp/example-v2.txt+
+      #  fs.retrieve('example', '/tmp/example-v2.txt', 2)
+      #
+      def retrieve(file, as = nil, version = MOST_RECENT_VERSION)
+        as  = file if ( as.nil? || as.empty? )
+        v   = self.versions(file)[ version.to_i - 1 ]
+        att = v.attachment[0]
+        # TODO 20070901 why "0.1" as the attachment id?  and can i retrieve that via the api somehow?
+        @gmail.attachment("0.1", v.id, as, false) 
+      end # def retrieve(file, as, version)
+
+      #
+      # Store +file+ on Gmail.
+      #
+      # If +as+ is specified it will be used as the filename instead of +file+.  The name
+      # of +file+ will be expanded to the absolute path if +as+ is not specified.
+      #
+      # Example:
+      #   fs.store('example')                 # Store local file +example+ as +example+
+      #   fs.store('example.txt', 'example')  # Store local file +example.txt+ as +example+
+      #
+      def store(file, as)
+        File.exist?(file) || raise("No such file '#{file}'")
+        file  = File.expand_path(file) # TODO 20070901 to expand or not to expand?
+        as    = file if ( as.nil? || as.empty? )
+        user  = @user
+        user  =~ /#{GMAIL_DOMAIN}$/ || user += GMAIL_DOMAIN
+        @gmail.send(
+          :to       => "#{@user}@gmail.com",
+          :subject  => "#{FILESTORE_PREFIX}#{FILESTORE_VERSION} #{as}",
+          :files    => [ file ]
+        )
+      end # def store()
+
+      #
+      # Return array of all versions of +file+ stored on Gmail.
+      #
+      # Files are versioned from newest-to-oldest, beginning with +MOST_RECENT_VERSION+.
+      #
+      # Example:
+      #  fs.versions('example').each_with_index do |v,idx|
+      #    puts sprintf("%-3d\t%-16s\t%-7s", idx + 1, v.id, v.date)
+      #  end
+      #
+      def versions(file)
+        versions = []
+        @gmail.messages(:standard => GMAIL_LABEL).each do |box|
+          next unless box.subject =~ /^#{FILESTORE_PREFIX}[\d.]+ #{file}$/
+          versions << box
+        end
+        versions
+      end # def versions(file)
+
+    end # class Gmail
+  end # module FS
+end # module Net
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: net-fs-gmail
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-09-30 00:00:00 -05:00
+summary: Store files on Gmail
+require_paths: 
+- lib
+email: blair@devclue.com
+homepage: http://code.google.com/p/blair/wiki/NetFsGmail
+rubyforge_project: net-fs-gmail
+description: Store and retrieve files on Gmail.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- blair christensen
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/gmailfs.rb
+- lib/net/fs/gmail.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+executables: 
+- gmailfs.rb
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gmailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: