jackfs 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.1.0. Released with tests passing.
+
+v0.0.1. Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jackfs.gemspec
+gemspec

data/Manifest

@@ -0,0 +1,16 @@
+CHANGELOG
+Manifest
+README.md
+Rakefile
+init.rb
+lib/jackfs/file_store.rb
+lib/jackfs/adapters/db_adapter.rb
+lib/jackfs/adapters/s3_adapter.rb
+lib/jackfs/adapters/file_adapter.rb
+spec/adapters/db_adapter_spec.rb
+spec/adapters/file_adapter_spec.rb
+spec/adapters/s3_adapter_spec.rb
+
+jackfs.gemspec
+spec/jackfs.rb
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,42 @@
+# Jackfs
+
+Is a rails 3 file store plugin, that allows you to create a simple file store system
+that can point to disk, s3, or database based on your configuration file.
+
+This allows you to implement the storage using a simple api.  The plugin is 
+adapter driven, so you can create additional adapters to use for this Jackfs
+system.
+
+## Install
+
+    rails plugin install git://github.com/jackhq/jackfs.git
+    
+## Configure
+
+* If File Adapter your config/filestore.yml would look like this
+
+    production:
+      location: tmp
+      adapter: file
+  
+  
+* If Db Adapter your config/filestore.yml would look like this
+
+    production:
+      connection: sqlite://production.db
+      adapter: db
+      table_name: jackfs
+    
+** It is important to note that it uses the sequel toolkit to connect to the database.  The connection setting must be a valid sequel toolkit connection string.
+
+* If S3 Adapter your config/filestore.yml would look like this
+
+    production:
+      adapter: s3
+      bucket: jackhq
+      access_key: ACCESS KEY
+      secret_key: SECRET KEY
+
+---
+
+# Report any problems to team@jackrussellsoftware.com

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/init.rb

@@ -0,0 +1,2 @@
+require 'jackfs'
+

data/jackfs.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jackfs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jackfs"
+  s.version     = Jackfs::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jack Russell Software"]
+  s.email       = ["team@jackrussellsoftware.com"]
+  s.homepage    = ""
+  s.summary     = 'This is a fs gem we use'
+  s.description = 'This is an description for the fs gem we use'
+
+  s.rubyforge_project = "jackfs"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'sequel'
+  s.add_runtime_dependency 'aws-s3'
+end

data/lib/jackfs/adapters/db_adapter.rb

@@ -0,0 +1,72 @@
+require 'base64'
+require 'fileutils'
+
+begin
+  require 'sequel'
+rescue LoadError
+  puts 'sequel gem is required to use file store'
+end
+
+
+module Jackfs
+  class DbAdapter
+    TEMP_PATH = File.join('tmp','fs_cache')
+
+    attr_accessor :connection, :table_name, :dbase, :app_root, :app_env
+
+    def initialize(app_root, app_env)
+      @app_root = app_root
+      @app_env = app_env
+
+      FileUtils.mkdir_p temp_file_path
+
+      yml = YAML.load_file(config_file)[@app_env.to_s]
+      @connection = yml["connection"]
+      @table_name = yml["table_name"]
+
+      # Clean up temp files
+      FileUtils.remove_file(File.join(temp_file_path,'/*'), true)
+    end
+
+    def store(f, name)
+      body = Base64.encode64(f.read)
+      data << { :name => name, :body => body, :created_at => Time.now, :updated_at => Time.now  }
+    end
+
+    def get(name)
+      record = data.where(:name => name).order(:name).first
+      unique_name = UUIDTools::UUID.random_create.to_s
+      # Write Body to generated tmp file
+      f = temp_file_path + unique_name
+      open(File.join(f), 'wb') { |file| file.write Base64.decode64(record[:body]) }
+      f
+    end
+
+    def data
+      db = Sequel.connect(@connection)
+      make_table(db) unless db.tables.include?(@table_name.to_sym)
+      db[@table_name.to_sym]
+    end
+
+    def make_table(db)
+      db.create_table @table_name do
+        primary_key :id
+        string :name
+        text :body
+        timestamp :created_at
+        timestamp :updated_at
+      end
+    rescue
+      # table exists
+    end
+
+    def temp_file_path
+      File.join(@app_root, TEMP_PATH)
+    end
+
+    def config_file
+      File.join(@app_root, Jackfs::FileStore::CONFIG_FILE)
+    end
+
+  end
+end

data/lib/jackfs/adapters/file_adapter.rb

@@ -0,0 +1,25 @@
+module Jackfs
+  class FileAdapter
+    attr_accessor :location, :app_root, :app_env
+
+    def initialize(app_root, app_env)
+      @app_root = app_root
+      @app_env = app_env
+      begin
+        @location = YAML.load_file(File.join(@app_root, Jackfs::FileStore::CONFIG_FILE))[@app_env.to_s]["location"]
+      rescue
+        raise InvalidFileStore
+      end
+    end
+
+    def store(this_file, name)
+      File.open(File.join(@app_root, @location, name), 'w') { |file| file.write this_file.read }
+      name
+    end
+
+    def get(name)
+      File.open(File.join(app_root, @location, name), 'r')
+    end
+
+  end
+end

data/lib/jackfs/adapters/s3_adapter.rb

@@ -0,0 +1,72 @@
+require 'fileutils'
+
+begin
+  require 'aws/s3'
+rescue LoadError
+  puts 'aws-s3 gem is required to use file store'
+end
+
+module Jackfs
+  class S3Adapter
+
+    TEMP_PATH = File.join('tmp','fs_cache')
+
+    attr_accessor :access_key, :secret_key, :bucket, :app_root, :app_env
+
+    def initialize(app_root, app_env)
+      @app_root = app_root
+      @app_env = app_env
+
+      FileUtils.mkdir_p(full_temp_path)
+
+      yml = YAML.load_file(config_file)[@app_env.to_s]
+      @access_key = yml["access_key"]
+      @secret_key = yml["secret_key"]
+      @bucket = yml["bucket"]
+
+      # Clean up temp files
+      FileUtils.remove_file(File.join(full_temp_path,'/*'), true)
+
+    end
+
+    def store(f, name)
+      find_or_create_bucket
+      AWS::S3::S3Object.store(name, f, @bucket)
+      name
+    end
+
+    def get(name)
+      unique_name = UUIDTools::UUID.random_create.to_s
+      # Write Body to generated tmp file
+      open(File.join(full_temp_path, unique_name), 'wb') do |file| 
+        AWS::S3::S3Object.stream(name, @bucket) do |chunk|
+          file.write chunk
+        end
+      end
+      # Open and return Temp File
+      open(File.join(full_temp_path,unique_name), 'rb')
+    end
+
+    def establish_connection
+      AWS::S3::Base.establish_connection!(
+          :access_key_id     => @access_key,
+          :secret_access_key => @secret_key
+        )
+    end
+
+    def find_or_create_bucket
+      establish_connection
+      AWS::S3::Bucket.create(@bucket) unless bucket = AWS::S3::Bucket.find(@bucket)
+      true
+    end
+
+    def full_temp_path
+      File.join(@app_root, TEMP_PATH)
+    end
+
+    def config_file
+      File.join(@app_root, Jackfs::FileStore::CONFIG_FILE)
+    end
+
+  end
+end

data/lib/jackfs/errors.rb

@@ -0,0 +1,3 @@
+module Jackfs
+  class InvalidFileStore < RuntimeError; end
+end

data/lib/jackfs/file_store.rb

@@ -0,0 +1,49 @@
+begin
+  require 'uuidtools'
+rescue LoadError
+  puts 'gem uuidtools is required'
+end
+
+require File.dirname(__FILE__) + '/adapters/file_adapter'
+require File.dirname(__FILE__) + '/adapters/s3_adapter'
+require File.dirname(__FILE__) + '/adapters/db_adapter'
+
+module Jackfs
+  class FileStore
+    CONFIG_FILE = File.join('config','filestore.yml')
+
+    attr_accessor :file, :guid, :adapter, :app_root, :app_env
+
+    def initialize(app_root, app_env)
+      @app_root = app_root
+      @app_env = app_env
+      @adapter = load_adapter
+    end
+
+    def store(this_file)
+      @file = this_file
+      @guid = create_guid
+      # call adapter passing the file and guid as file identifier
+      @adapter.store(this_file, @guid)
+    end
+
+    def get(guid)
+      # Need call adapter passing the guid and returning the file
+      @adapter.get(guid)
+    end
+
+    def create_guid
+      UUIDTools::UUID.random_create.to_s
+    end
+
+    def load_adapter
+      adapter_type = YAML.load_file(File.join(@app_root,CONFIG_FILE))[@app_env.to_s]["adapter"].to_sym
+      case adapter_type
+        when :s3 then Jackfs::S3Adapter.new(@app_root, @app_env)
+        when :db then Jackfs::DbAdapter.new(@app_root, @app_env)
+        else Jackfs::FileAdapter.new(@app_root, @app_env)
+      end
+    end
+  end
+
+end

data/lib/jackfs/version.rb

@@ -0,0 +1,3 @@
+module Jackfs
+  VERSION = "0.0.1"
+end

data/lib/jackfs.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/jackfs/file_store'

data/spec/adapters/db_adapter_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+
+describe "Jackfs Db Adapter" do
+  before(:each) do
+    File.delete("test.db") if File.exists?("test.db")
+    YAML.should_receive(:load_file).and_return("test" => {
+      "adapter" => "db",
+      "connection" => 'sqlite://test.db',
+      "table_name" => 'jackfs'
+    })
+    
+    root = File.dirname(__FILE__) + '/..'
+    @dba = Jackfs::DbAdapter.new(root, :test)
+  end
+
+  
+  it "should save a file to a configured database name" do
+    @dba.connection.should == 'sqlite://test.db'
+  end
+
+
+  it "should save a file to a configured table name" do
+    @dba.table_name.should == 'jackfs'
+  end
+
+  it "should save the file in db using the given name" do
+    @dba.store(File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r'),"COOLBEANS").should == true
+  end
+
+  # it "should get a file from a configured from db" do
+  #   f = File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r')
+  #   @dba.store(f, "COOLBEANS")
+  #   orig = File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r')
+  #   
+  #   @dba.get("COOLBEANS").read.length.should == orig.read.length    
+  # end
+  
+  
+end

data/spec/adapters/file_adapter_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+
+describe "Jackfs File Adapter" do
+  before(:each) do
+    YAML.should_receive(:load_file).and_return("test" => {
+      "adapter" => "file",
+      "location" => 'tmp'
+    })
+    root = File.dirname(__FILE__) + '/..'
+    
+    @fa = Jackfs::FileAdapter.new(root, :test)
+  end
+  
+  it "should save a file to a configured location" do
+    Jackfs::FileAdapter.should be_true
+    @fa.location.should == "tmp"
+  end
+  
+  it "should save the file in the location using the given name" do
+    @fa.store(File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r'),"COOLBEANS").should == true
+  end
+
+  it "should get a file from a configured location" do
+    f = File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r')
+    @fa.store(File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r'),"COOLBEANS").should == true 
+    orig = File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r')
+    @fa.get("COOLBEANS").read.length.should == orig.read.length
+  end
+end

data/spec/adapters/s3_adapter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
+
+
+describe "JackFS S3 Adapter" do
+  before(:each) do
+    root = File.dirname(__FILE__) + '/..'
+    YAML.should_receive(:load_file).and_return("test" => {
+      "adapter" => "s3",
+      "bucket" => 'jackhq',
+      "access_key" => ENV['AMAZON_ACCESS_KEY_ID'],
+      "secret_key" => ENV['AMAZON_SECRET_ACCESS_KEY']
+    })
+    
+    @s3a = Jackfs::S3Adapter.new(root, :test)
+  
+  end
+  
+  it "should save a file to a configured access key" do
+    @s3a.access_key.should == ENV['AMAZON_ACCESS_KEY_ID']
+  end
+  
+  it "should save a file to a configured secret key" do
+    @s3a.secret_key.should == ENV['AMAZON_SECRET_ACCESS_KEY']
+  end
+
+  it "should save a file to a configured secret key" do
+    @s3a.bucket.should == "jackhq"
+  end
+
+  it "should establish a connection to s3" do
+    AWS::S3::Base.stub!(:establish_connection!).and_return(true)
+    @s3a.establish_connection.should == true
+  end
+
+  it "should create a bucket if a bucket does not exist" do
+    AWS::S3::Bucket.should_receive(:find).and_return(false)
+    AWS::S3::Bucket.should_receive(:create).and_return(true)
+    @s3a.find_or_create_bucket.should be_true
+    
+  end
+
+  it "should find a bucket if a bucket does exist" do
+    AWS::S3::Bucket.should_receive(:find).and_return(true)
+    @s3a.find_or_create_bucket.should be_true
+  end
+
+  it "should save the file in s3 using the given name" do
+    @s3a.should_receive(:find_or_create_bucket).and_return(true)
+    AWS::S3::S3Object.should_receive(:store).and_return(true)
+    @s3a.store(File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r'),"COOLBEANS").should == true
+  end
+
+  it "should get a file from a configured from s3" do
+    f = File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r')
+    #AWS::S3::S3Object.should_receive(:stream).and_return(f)
+    @s3a.store(File.open(File.dirname(__FILE__) + '/../fixtures/test.pdf', 'r'),"COOLBEANS").should == true
+    @s3a.get("COOLBEANS").read.length.should == f.read.length
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rspec'
+require 'fileutils'
+require 'yaml'
+
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require File.join(File.dirname(__FILE__), '..', 'init')
+
+
+#TEST_DATABASE_FILE = File.join(File.dirname(__FILE__), 'test.sqlite3')
+
+# Spec::Runner.configure do |config|
+#   
+# end
+
+# def setup_database
+#   File.unlink(TEST_DATABASE_FILE) if File.exist?(TEST_DATABASE_FILE)
+#   ActiveRecord::Base.establish_connection(
+#     "adapter" => "sqlite3", "timeout" => 5000, "database" => TEST_DATABASE_FILE
+#   )
+#   create_tables
+# end
+# 
+# def create_tables
+#   c = ActiveRecord::Base.connection
+#   
+#   c.create_table :sponsors, :force => true do |t|
+#     t.string :name
+#     t.string :address
+#     t.string :city
+#     t.string :state
+#     t.string :zip
+#     t.string :phone
+#     t.string :fax
+#     
+#     t.timestamps
+#   end
+# end
+# 
+# setup_database
+# 
+# require File.join(File.dirname(__FILE__), 'models')

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: jackfs
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jack Russell Software
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: This is an description for the fs gem we use
+email: 
+- team@jackrussellsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- Manifest
+- README.md
+- Rakefile
+- init.rb
+- jackfs.gemspec
+- lib/jackfs.rb
+- lib/jackfs/adapters/db_adapter.rb
+- lib/jackfs/adapters/file_adapter.rb
+- lib/jackfs/adapters/s3_adapter.rb
+- lib/jackfs/errors.rb
+- lib/jackfs/file_store.rb
+- lib/jackfs/version.rb
+- spec/adapters/db_adapter_spec.rb
+- spec/adapters/file_adapter_spec.rb
+- spec/adapters/s3_adapter_spec.rb
+- spec/fixtures/test.pdf
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+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: jackfs
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This is a fs gem we use
+test_files: 
+- spec/adapters/db_adapter_spec.rb
+- spec/adapters/file_adapter_spec.rb
+- spec/adapters/s3_adapter_spec.rb
+- spec/fixtures/test.pdf
+- spec/spec_helper.rb