refile-gridfs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9862d00d38ad7c7573b9804bf098d894f71d2bce
+  data.tar.gz: 8d4eabaf55ecb9584321290728dd82aaa29ba63d
+SHA512:
+  metadata.gz: 63d87863155b3459ba59ebc9a4de8a894b6974043666104cda7a1acfc109b0281f1ae9057ab50f2476ab0d604fa9b990954dfd044d272053c29cec8e60acd11d
+  data.tar.gz: 0778c954358a2fd1da1211b5587226f52a7c2eab5454aee50938cde5f0c6f13a71060ad29cc81bf523bd45ef6a9847b9983c2aee595497f04197feee819d512a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in refile-gridfs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonas Nicklas
+
+MIT License
+
+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.md

@@ -0,0 +1,45 @@
+# Refile::Gridfs
+
+A Gridfs backend for [Refile](https://github.com/elabs/refile).
+
+## Why?
+
+* You want to store all your data in one place to simplify backups and replication
+
+## Take into account
+
+* Gem is developed and tested using Mongodb 3.0, Ruby 2.2 and Mongo 2.1. It might work with earlier versions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'refile-gridfs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install refile-gridfs
+
+## Usage with Rails
+
+Generate migration for table were to store list of attachments.
+
+    $ rails g refile:gridfs:migration
+
+Generate initializer and set Refile::Gridfs as `store` backend.
+
+    $ rails g refile:gridfs:initializer
+
+## Contributing
+
+1. Fork it ( https://github.com/Titinux/refile-gridfs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/generators/refile/gridfs/initializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates initializer and sets Gridfs as store backend
+
+Example:
+    rails generate initializer
+
+    This will create:
+        config/initializers/refile.rb

data/lib/generators/refile/gridfs/initializer/initializer_generator.rb

@@ -0,0 +1,6 @@
+class Refile::Gridfs::InitializerGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  def copy_initializer_file
+    copy_file "refile.rb", "config/initializers/refile.rb"
+  end
+end

data/lib/generators/refile/gridfs/initializer/templates/refile.rb

@@ -0,0 +1,5 @@
+require "refile"
+
+Refile.configure do |config|
+  config.store = Refile::Gridfs::Backend.new(proc { Mongo::Client.new('mongodb://127.0.0.1:27017/my_db') } )
+end

data/lib/refile/gridfs.rb

@@ -0,0 +1,8 @@
+require "refile"
+require "refile/gridfs/version"
+require "refile/gridfs/backend"
+
+module Refile
+  module Gridfs
+  end
+end

data/lib/refile/gridfs/backend.rb

@@ -0,0 +1,86 @@
+require "mongo"
+require "refile/backend_macros"
+
+module Refile
+  module Gridfs
+    class Backend
+      extend Refile::BackendMacros
+
+      DEFAULT_PREFIX = "fs"
+      INIT_CONNECTION_ARG_ERROR_MSG = "When initializing new Refile::Gridfs::Backend first argument should be an instance of Mongo::Client or a lambda/proc that returns it. When using Mongoid it is available as Mongoid.client(:default)"
+
+      attr_reader :max_size, :prefix, :hasher
+
+      def initialize(connection_or_proc, max_size: nil, prefix: DEFAULT_PREFIX, hasher: Refile::RandomHasher.new)
+        @connection_or_proc = connection_or_proc
+        @max_size   = max_size
+        @prefix     = prefix
+        @hasher     = hasher
+      end
+
+      verify_uploadable def upload(uploadable)
+        filename = @hasher.hash(uploadable)
+
+        file = Mongo::Grid::File.new(uploadable.read, filename: filename)
+        gridfs.insert_one(file)
+
+        Refile::File.new(self, filename)
+      end
+
+      verify_id def get(id)
+        Refile::File.new(self, id)
+      end
+
+      verify_id def delete(id)
+        file = gridfs.find_one(filename: id)
+        gridfs.delete_one(file) if file
+      end
+
+      verify_id def open(id)
+        StringIO.new(read(id))
+      end
+
+      verify_id def read(id)
+        if exists?(id)
+          gridfs.find_one(filename: id).data
+        else
+          nil
+        end
+      end
+
+      verify_id def size(id)
+        file = gridfs.find_one(filename: id)
+        file.data.length if file
+      end
+
+      verify_id def exists?(id)
+        !! gridfs.find_one(filename: id)
+      end
+
+      def clear!(confirm = nil)
+        raise Refile::Confirm unless confirm == :confirm
+
+        connection["#{@prefix}.files"].drop
+        connection["#{@prefix}.chunks"].drop
+      end
+
+    private
+
+      def obtain_new_connection
+        candidate = @connection_or_proc.is_a?(Proc) ? @connection_or_proc.call : @connection_or_proc
+        unless candidate.is_a?(Mongo::Client)
+          raise ArgumentError.new(INIT_CONNECTION_ARG_ERROR_MSG)
+        end
+        @connection = candidate
+      end
+
+      def connection
+        @connection || obtain_new_connection
+      end
+
+      def gridfs
+        connection.database.fs(fs_name: @prefix)
+      end
+    end
+  end
+end

data/lib/refile/gridfs/version.rb

@@ -0,0 +1,5 @@
+module Refile
+  module Gridfs
+    VERSION = "0.1.0"
+  end
+end

data/refile-gridfs.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'refile/gridfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "refile-gridfs"
+  spec.version       = Refile::Gridfs::VERSION
+  spec.authors       = ["Jérémie Horhant"]
+  spec.email         = ["jeremie.horhant@progralab.fr"]
+  spec.summary       = %q{Gridfs backend for Refile}
+  spec.homepage      = "https://github.com/Titinux/refile-gridfs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "refile", "~> 0.6.1"
+  spec.add_dependency "mongo", "~> 2.1"
+
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-stack_explorer"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/spec/refile/gridfs/backend_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+RSpec.describe Refile::Gridfs::Backend do
+  let(:connection_or_proc) { Mongo::Client.new('mongodb://127.0.0.1:27017/refile_test') }
+  let(:backend) { Refile::Gridfs::Backend.new(connection_or_proc, max_size: 100) }
+  it_behaves_like :backend
+
+  # context "Connection tests" do
+  #   def connection
+  #     PG.connect(dbname: 'refile_test')
+  #   end
+
+  #   context "when using proc" do
+  #     def connection_or_proc
+  #       proc { connection }
+  #     end
+
+  #     it "reuses the same PG::Connection if connection is ok" do
+  #       expect(backend.connection).to eq(backend.connection)
+  #     end
+
+  #     it "executes proc and obtains new connection if old one is closed" do
+  #       old = backend.connection
+  #       old.close
+  #       expect(backend.connection).not_to eq(old)
+  #       expect(backend.connection.finished?).to be_falsey
+  #     end
+  #   end
+
+  #   context "when not using procs and providing PG::Connection directly" do
+  #     def connection_or_proc
+  #       connection
+  #     end
+
+  #     it "reuses the same PG::Connection" do
+  #       expect(backend.connection).to eq(backend.connection)
+  #     end
+
+  #     it "continues to use old connection if the old one is closed" do
+  #       old = backend.connection
+  #       old.close
+  #       expect(backend.connection).to eq(old)
+  #       expect(backend.connection.finished?).to be_truthy
+  #     end
+  #   end
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+$LOAD_PATH.unshift(File.join(Gem::Specification.find_by_name("refile").gem_dir, "spec"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "refile/spec_helper"
+require "mongo"
+require "pry"
+require "refile/gridfs"
+
+WebMock.disable!(:except => [:codeclimate_test_reporter])
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: refile-gridfs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jérémie Horhant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jeremie.horhant@progralab.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/refile/gridfs/initializer/USAGE
+- lib/generators/refile/gridfs/initializer/initializer_generator.rb
+- lib/generators/refile/gridfs/initializer/templates/refile.rb
+- lib/refile/gridfs.rb
+- lib/refile/gridfs/backend.rb
+- lib/refile/gridfs/version.rb
+- refile-gridfs.gemspec
+- spec/refile/gridfs/backend_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Titinux/refile-gridfs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gridfs backend for Refile
+test_files:
+- spec/refile/gridfs/backend_spec.rb
+- spec/spec_helper.rb