dis 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 341dc80b5a083c46a37da69c79e4ba9dd6061039
-  data.tar.gz: 08b2b167f82bcc09f66c5c6424afd64f659a1aa8
+SHA256:
+  metadata.gz: 5cb8a9f8a44513293da86ca083dd5d21387f2369517da289682e0195f1ec2ad7
+  data.tar.gz: fd15cbc2724c0125dc90070d90b4c25097e801e73224e446eeece2f07593c46e
 SHA512:
-  metadata.gz: 382d0edf787592cbfe10e080173ab5018d8f7cef98e3bf8747cd4405de646edb1a8f0801aab19cc3e5c46d6706b69c56faf8dc16bfbaf69417f5bf342fa72cf4
-  data.tar.gz: fc2749ccc2ad04800bf415a6b320ece8419b2d1f7ed04fdaeac8e6d3073f515d635fbfc0aa37396aa7bfb482f83fa387cb49fd4507aad0f4c6aea26ba3ce4630
+  metadata.gz: f07494205851ecaa4c0a9217c6721f42d04d4df8441da20bf3582f9f107dc35e5bd1b80220536147088e0387ccc265780a8ade62dbee42aad33c87d2d5d3e8e7
+  data.tar.gz: e06b2a61f8c282c34540f47d5aeaa2ce04293994aa19b0263940b40cfb203316a6d61d8a888faf246b3859c1f9257239273c1e65d34a8a567077e6d23048f7d5

data/README.md

@@ -1,29 +1,45 @@
-# Dis [![Build Status](https://travis-ci.org/elektronaut/dis.svg?branch=master)](https://travis-ci.org/elektronaut/dis) [![Code Climate](https://codeclimate.com/github/elektronaut/dis/badges/gpa.svg)](https://codeclimate.com/github/elektronaut/dis) [![Code Climate](https://codeclimate.com/github/elektronaut/dis/badges/coverage.svg)](https://codeclimate.com/github/elektronaut/dis) [![Dependency Status](https://gemnasium.com/elektronaut/dis.svg)](https://gemnasium.com/elektronaut/dis)
+[![Version](https://img.shields.io/gem/v/dis.svg?style=flat)](https://rubygems.org/gems/dis)
+[![Build Status](https://travis-ci.org/elektronaut/dis.svg?branch=master)](https://travis-ci.org/elektronaut/dis)
+[![Code Climate](https://codeclimate.com/github/elektronaut/dis/badges/gpa.svg)](https://codeclimate.com/github/elektronaut/dis)
+[![Code Climate](https://codeclimate.com/github/elektronaut/dis/badges/coverage.svg)](https://codeclimate.com/github/elektronaut/dis)
+[![Inline docs](http://inch-ci.org/github/elektronaut/dis.svg)](http://inch-ci.org/github/elektronaut/dis)
+[![Security](https://hakiri.io/github/elektronaut/dis/master.svg)](https://hakiri.io/github/elektronaut/dis/master)
 
-Dis handles file uploads for your Rails app.
-It's similar to [Paperclip](https://github.com/thoughtbot/paperclip)
-and [Carrierwave](https://github.com/carrierwaveuploader/carrierwave),
-but different in a few ways. Chiefly, it's much, much simpler.
+# Dis
 
-Your files are stored in one or more layers, either on disk or in
-a cloud somewhere. [Fog](http://fog.io) and
-[Active Job](https://github.com/rails/activejob) does most of the
-heavy lifting.
+Dis is a content-adressable store for file uploads in your Rails app.
 
-Files are indexed by the SHA1 hash of their contents. This means you get
-deduplication for free. This also means you run the (very slight) risk of
-hash collisions. There is no concept of updates in the data store,
-a file with changed content is by definition a different file.
+Data can be stored either on disk or in the cloud - anywhere that
+[Fog](http://fog.io) knows how to talk to.
 
-It does not do any processing. The idea is to provide a simple foundation
-other gems can build on. If you are looking to handle uploaded images,
-check out [DynamicImage](https://github.com/elektronaut/dynamic_image).
+It doesn't do any processing, but it's a simple foundation to roll
+your own on. If you're looking to handle image uploads, check out
+[DynamicImage](https://github.com/elektronaut/dynamic_image). It's
+built on top of Dis and handles resizing, cropping and more on demand.
 
-Requires Rails 4.2+ and Ruby 1.9.3+.
+Requires Rails 4.2+.
 
-## Documentation
+## Layers
 
-[Documentation on RubyDoc.info](http://rdoc.info/gems/dis)
+The underlaying storage consists of one or more layers. A layer is a
+unit of storage location, which can either be a local path, or a cloud
+provider like Amazon S3 or Google Cloud Storage.
+
+There are two types of layers, immediate and delayed. Files are
+written to immediate layers and then replicated to the rest in the
+background using ActiveJob.
+
+Reads are performed from the first available layer. In case of a read
+miss, the file is backfilled from the next layer.
+
+An example configuration could be to have a local layer first, and
+then for example an Amazon S3 bucket. This provides you with an
+on-disk cache backed by cloud storage. You can also add additional
+layers if you want fault tolerance across regions or even providers.
+
+Layers can be configured as read-only. This can be useful if you want
+to read from your staging or production environment while developing
+locally, or if you're transitioning away from a provider.
 
 ## Installation
 
@@ -39,6 +55,15 @@ Now, run the generator to install the initializer:
 bin/rails generate dis:install
 ```
 
+By default, files will be stored in `db/dis`. You can edit
+`config/initializers/dis.rb` if you want to change the path or add
+additional layers. Note that you also need the corresponding
+[Fog gem](https://github.com/fog) if you want to use cloud storage:
+
+```ruby
+gem "fog-aws"
+```
+
 ## Usage
 
 Run the generator to create your model.
@@ -50,7 +75,7 @@ bin/rails generate dis:model Document
 This will create a model along with a migration.
 
 Here's what your model might look like. Note that Dis does not
-validate any data by default, you are expected to use the Rails validators.
+validate any data by default, but you can use the standard Rails validators.
 A validator for validating presence of data is provided.
 
 ```ruby
@@ -70,81 +95,46 @@ document_params = params.require(:document).permit(:file)
 @document = Document.create(document_params)
 ```
 
-You can also assign the data directly.
+You can also pass a file directly:
 
 ```ruby
-Document.create(
-  data:         File.open('document.pdf'),
-  content_type: 'application/pdf',
-  filename:     'document.pdf'
-)
+Document.create(data: File.open('document.pdf'),
+                content_type: 'application/pdf',
+                filename: 'document.pdf')
 ```
 
-## Defining layers
-
-The install generator will set you up with a local storage layer on disk,
-but this is configurable in `config/initializers/dis.rb`.
-
-You can have as many layers as you want, any storage provider
-[supported by Fog](http://fog.io/storage/) should work in theory. Only the
-local storage is loaded by default, you'll have to manually require your provider.
+..or even a string:
 
 ```ruby
-require 'fog/aws/storage'
+Document.create(data: 'foo', content_type: 'text/plain', filename: 'foo.txt')
 ```
 
-Having a local layer first is a good idea, this will provide you
-with a cache on disk. Any misses will be filled from the next layer.
-
-```ruby
-Dis::Storage.layers << Dis::Layer.new(
-  Fog::Storage.new({provider: 'Local', local_root: Rails.root.join('db', 'binaries')}),
-  path: Rails.env
-)
-```
-
-Delayed layers will be processed out of the request cycle using
-whatever adapter you've configured
-[Active Job](https://github.com/rails/activejob) to use.
-Note: You must have at least one non-delayed layer.
-
-```ruby
-if Rails.env.production?
-  Dis::Storage.layers << Dis::Layer.new(
-    Fog::Storage.new({
-      provider:              'AWS',
-      aws_access_key_id:     YOUR_AWS_ACCESS_KEY_ID,
-      aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
-    }),
-    path: "my_bucket",
-    delayed: true
-  )
-end
-```
-
-You can also set layers to be read only. This is handy if you want to
-access production data from your development environment, or if you
-are in the process of migration from one provider to another.
-
-```ruby
-if Rails.env.development?
-  Dis::Storage.layers << Dis::Layer.new(
-    Fog::Storage.new(...),
-    readonly: true
-  )
+Getting your file back out is straightforward:
+
+``` ruby
+class DocumentsController < ApplicationController
+  def show
+    @document = Document.find(params[:id])
+    if stale?(@document)
+      send_data(@document.data,
+                filename: @document.filename,
+                type: @document.content_type,
+                disposition: "attachment)
+    end
+  end
 end
 ```
 
-## Interacting with the store
+## Behind the scenes
 
 You can interact directly with the store if you want.
 
 ```ruby
 file = File.open("foo.txt")
-hash = Dis::Storage.store("stuff", file) # => "8843d7f92416211de9ebb963ff4ce28125932878"
-Dis::Storage.exists?("stuff", hash)      # => true
-Dis::Storage.get("stuff", hash).body     # => "foobar"
-Dis::Storage.delete("stuff", hash)       # => true
+hash = Dis::Storage.store("documents", file) # => "8843d7f92416211de9ebb963ff4ce28125932878"
+Dis::Storage.exists?("documents", hash)      # => true
+Dis::Storage.get("documents", hash).body     # => "foobar"
+Dis::Storage.delete("documents", hash)       # => true
 ```
 
 ## License

data/lib/dis/jobs.rb

@@ -2,3 +2,4 @@
 
 require 'dis/jobs/delete'
 require 'dis/jobs/store'
+require 'dis/jobs/change_type'

data/lib/dis/jobs/change_type.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Dis
+  module Jobs
+    # = Dis ChangeType Job
+    #
+    # Handles delayed object type change.
+    #
+    #   Dis::Jobs::ChangeType.perform_later("old_things", "new_things", hash)
+    class ChangeType < ActiveJob::Base
+      queue_as :dis
+
+      def perform(prev_type, new_type, hash)
+        Dis::Storage.delayed_store(new_type, hash)
+        Dis::Storage.delayed_delete(prev_type, hash)
+      end
+    end
+  end
+end

data/lib/dis/storage.rb

@@ -38,6 +38,23 @@ module Dis
         @layers ||= Dis::Layers.new
       end
 
+      # Changes the type of an object. Kicks off a
+      # <tt>Dis::Jobs::ChangeType</tt> job if any delayed layers are defined.
+      #
+      #   Dis::Storage.change_type("old_things", "new_things", hash)
+      def change_type(prev_type, new_type, hash)
+        require_writeable_layers!
+        file = get(prev_type, hash)
+        store_immediately!(new_type, file)
+        layers.immediate.writeable.each do |layer|
+          layer.delete(prev_type, hash)
+        end
+        if layers.delayed.writeable.any?
+          Dis::Jobs::ChangeType.perform_later(prev_type, new_type, hash)
+        end
+        hash
+      end
+
       # Stores a file and returns a digest. Kicks off a
       # <tt>Dis::Jobs::Store</tt> job if any delayed layers are defined.
       #

data/lib/dis/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Dis
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/lib/rails/generators/dis/install/templates/initializer.rb

@@ -17,5 +17,6 @@ Dis::Storage.layers << Dis::Layer.new(
 #     aws_secret_access_key: AWS_SECRET_ACCESS_KEY
 #   }),
 #   path: "my_bucket",
-#   delayed: true
+#   delayed: true,
+#   readonly: false
 # )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dis
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Inge Jørgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: '3.5'
 description: Dis is a Rails plugin that stores your file uploads and other binary
   blobs.
 email:
@@ -102,12 +102,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - lib/dis.rb
 - lib/dis/engine.rb
 - lib/dis/errors.rb
 - lib/dis/jobs.rb
+- lib/dis/jobs/change_type.rb
 - lib/dis/jobs/delete.rb
 - lib/dis/jobs/store.rb
 - lib/dis/layer.rb
@@ -142,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A file store for your Rails app

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2014 Inge Jørgensen
-
-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.