list_cloud_files 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,11 @@
+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 "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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

@@ -0,0 +1,111 @@
+ListCloudFiles
+==============
+
+ListCloudFiles is a really simple gem to help you show the contents of an Amazon S3 bucket 
+in a view in your Rails app.  It uses a simple _metadata.txt file inside your bucket (that you create)
+to provide friendly descriptions for each of the files in your bucket.
+
+Configuration and usage is pretty simple.  See below for example usage and sample Haml/Sass code, too.
+
+
+Example Usage
+=============
+
+Instructions for using ListCloudFiles:
+
+0.  Set up a bucket on Amazon S3 to hold your files.  Make sure they're all publicly readable.
+    If you'd like to include description metadata for each of your files in the bucket, 
+    create a new file in the bucket called _metadata.txt.  Format _metadata.txt like this:
+
+    <code>
+      Some_file_name.txt|This is a description about some file.
+      Another_file.txt|Here's a description about another file.
+    </code>
+
+      Anything after the pipe character on this line counts as a description.  Anything before the pipe character is the file name key we'll use to look up this description based on a matching filename in the bucket, so make sure it matches.
+
+
+1.  Create config/initializers/list_cloud_files.rb with:
+    ListCloudFiles.aws_access_key_id = 'your_amazon_aws_access_key'
+    ListCloudFiles.aws_secret_access_key = 'your_amazon_aws_secret_access_key'
+
+    # this controls how often the cache of the s3 bucket's file contents will be cleared
+    ListCloudFiles.cache_expires_in = 1.day
+    
+
+2.  Call ListCloudFiles.get_files_for_bucket('your-bucket-name')  in your controller.
+    You'd probably do something like: 
+
+    <code>
+      @cloud_files = ListCloudFiles.get_files_for_bucket('my-bucket-name')
+    </code>
+
+    ListCloudFiles.get_files_for_bucket('your-bucket-name') returns a hash with:
+      :file_names    # an array of strings for each file in your bucket
+      :file_metadata # a hash of metadata keyed on each file_name from the file_names key above
+    
+    Each hash vlaue in the :file_metadata contains these keys:
+      :pretty_name  # the name of the file without the extension
+      :extension    # the file's extension
+      :description  # a description taken from parsing the _metadata.txt file (see below)
+      :public_url   # the public url for the file, assuming it has public read access
+
+
+3.  Use the result of ListCloudFiles.get_files_for_bucket in your view to show the data.
+    Assuming you set @cloud_files = ListCloudFiles.get_files_for_bucket('my-bucket-name'), 
+    and assuming you're using Haml, you'd probably do something like the following.
+
+    Note: this example code assumes that you have file images to match each file extension
+    in public/images/list_cloud_files/filetypes/<extension>.png
+
+    <code>
+      - @file_metadata = @cloud_files[:file_metadata]
+      %ul.cloud_files
+        - @cloud_files[:file_names].each do |file_name|
+          - file_metadata = @file_metadata[file_name]
+          %li.file{ :class => file_metadata[:extension] }
+            %a{:href => file_metadata[:public_url]}
+              %img.file_icon{:src => "/images/list_cloud_files/filetypes/#{file_metadata[:extension]}.png", :alt => @file_metadata[file_name][:extension]}
+            %span.file_name
+              %a{:href => file_metadata[:public_url]}
+                = file_metadata[:pretty_name]
+            %span.file_description
+              %a{:href => file_metadata[:public_url]}
+                = file_metadata[:description]
+    </code>
+
+
+4.  Stlye the HTML output so it doesn't look like total crap.  Here're some example Sass styles:
+
+    <code>
+      ul.cloud_files
+        :list-style-type none
+        :margin 0
+        :padding 0 
+        li.file
+          :padding 0 
+          :margin-bottom 20px
+          a
+            :color inherit
+            :text-decoration none
+          img.file_icon
+            :width 50px
+            :margin 0 10px 0 0 
+            :float left
+          span.file_name
+            :font-weight bold
+            :font-size 24px
+            :display block
+            :padding-top 24px
+            :font-weight bold
+            a
+              :text-decoration underline
+          span.file_description
+            :display block
+            :clear both
+            :font-weight normal
+    </code>
+
+
+
+Copyright (c) 2011 Gabe Hollombe, released under the MIT license

data/Rakefile

@@ -0,0 +1,46 @@
+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 = "list_cloud_files"
+  gem.homepage = "http://github.com/gabehollombe/list_cloud_files"
+  gem.license = "MIT"
+  gem.summary = %Q{Easily share the contents of a public Amazon S3 bucket in your Rails app}
+  gem.description = %Q{Easily share the contents of a public Amazon S3 bucket in your Rails app}
+  gem.email = "gabe@avantbard.com"
+  gem.authors = ["Gabe Hollombe"]
+  # 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 'fog', '>= 0.7.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "list_cloud_files #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/lib/list_cloud_files.rb

@@ -0,0 +1,44 @@
+# ListCloudFiles
+class ListCloudFiles
+  #everything here is at the class level
+  class << self
+    attr_accessor :aws_access_key_id, :aws_secret_access_key, :cache_expires_in
+
+    def get_files_for_bucket(bucket_name)
+      Rails.cache.fetch(bucket_name, :expires_in => (@cache_expires_in || 1.day)) do
+        storage = Fog::Storage.new(:provider => 'AWS', :aws_access_key_id => @aws_access_key_id, :aws_secret_access_key => @aws_secret_access_key)
+        directory = storage.directories.get(bucket_name)
+        files = directory.files
+
+        #read the metadata file and build a hash of info for each file
+        file_metadata = {}
+        if directory.files.get('_metadata.txt')
+          directory.files.get('_metadata.txt').body.split("\n").each do |line|
+            file_name, description = line.split('|')
+            file_metadata[file_name] = { :description => description }
+          end
+        end
+
+        file_names = []
+        files.reject{|f| f.key == '_metadata.txt'}.each do |file|
+          file_name = file.key
+          file_names << file_name
+          name, extension = file_name.rpartition('.')[0], file_name.rpartition('.')[2]
+          pretty_name = name.gsub('_', ' ')
+          file_metadata[file_name].merge!({
+            :pretty_name => pretty_name,
+            :extension => extension,
+            :public_url => file.public_url
+          })
+        end
+
+        #returning our hash of info
+        {:file_names => file_names, :file_metadata => file_metadata}
+      end
+    end
+
+    def get_html_for_files(cloud_files)
+      #must be passed a hash with :file_names => array of filenames, :file_metadata => hash of metadata keyed on filename
+    end
+  end
+end

data/list_cloud_files.gemspec

@@ -0,0 +1,55 @@
+# 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{list_cloud_files}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gabe Hollombe"]
+  s.date = %q{2011-04-01}
+  s.description = %q{Easily share the contents of a public Amazon S3 bucket in your Rails app}
+  s.email = %q{gabe@avantbard.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/list_cloud_files.rb",
+    "list_cloud_files.gemspec",
+    "rails/init.rb"
+  ]
+  s.homepage = %q{http://github.com/gabehollombe/list_cloud_files}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily share the contents of a public Amazon S3 bucket in your Rails app}
+
+  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<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<fog>, [">= 0.7.1"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<fog>, [">= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<fog>, [">= 0.7.1"])
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1 @@
+require 'list_cloud_files'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: list_cloud_files
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabe Hollombe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-01 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: fog
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  requirement: *id003
+description: Easily share the contents of a public Amazon S3 bucket in your Rails app
+email: gabe@avantbard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .document
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/list_cloud_files.rb
+- list_cloud_files.gemspec
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/gabehollombe/list_cloud_files
+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: Easily share the contents of a public Amazon S3 bucket in your Rails app
+test_files: []
+