shrine-sql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0be3b2fc90a4117a0f9ee77be1b735630c414d08
+  data.tar.gz: 9bc258b1ce55a676a83cbe4bd203b75e247ec02d
+SHA512:
+  metadata.gz: 3f45d5520f916b766c30d9eaf22078b8d6905cf9edafd0c1824b574cd57741177eb80a84ae0a061f6aa57784d1fca76b882ff38ef189a3ff2e965a7075abba18
+  data.tar.gz: c614f098019442f864d3317535a1a4d57236bb47047c309a4f4ce5c633abe7e1402f7cf7a8a27093d1c36a5ecf8050fa49a4eeaf0960417de64a2df41ec3c8d8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+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,72 @@
+# Shrine::Sql
+
+Provides a [Shrine] storage for storing files in any SQL database. It uses
+[Sequel] under the hood.
+
+## Installation
+
+```ruby
+gem "shrine-sql"
+```
+
+## Usage
+
+We first need to create the table for our files, with "id" and "content" columns:
+
+```rb
+create_table :files do
+  primary_key :id
+  column :content, :text
+end
+```
+
+We can now instantiate the storage with a `Sequel::Database` and the name of
+the table:
+
+```rb
+require "shrine/storage/sql"
+require "sequel"
+
+DB = Sequel.connect("postgres:///my-database")
+Shrine.storages[:store] = Shrine::Storage::Sql.new(database: DB, table: :files)
+```
+
+You can see [Connecting to a database] on how connect to any database with
+Sequel.
+
+### URL
+
+The shrine-sql storage itself doesn't provide any kind of URL, but you can load
+the `data_uri` plugin, which provides `UploadedFile#data_uri` which returns the
+data URI of the file, which you can display in the browser:
+
+```rb
+Shrine.plugin :data_uri
+```
+```rb
+user.avatar.data_uri #=> "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA"
+```
+
+Note that `UploadedFile#data_uri` is only available in Shrine >= 1.1.
+
+### Indices
+
+It is recommended that you add a unique index to the "id" column, for faster
+lookups. Depending on your needs, you can also make the primary key column a
+UUID type, if your database supports it.
+
+## Contributing
+
+You can run the tests with Rake:
+
+```sh
+$ bundle exec rake test
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+[Shrine]: https://github.com/janko-m/shrine
+[Sequel]: https://github.com/janko-m/shrine
+[Connecting to a database]: http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html

data/lib/shrine/storage/sql.rb

@@ -0,0 +1,62 @@
+require "sequel"
+require "stringio"
+
+class Shrine
+  module Storage
+    class Sql
+      attr_reader :database, :dataset
+
+      def initialize(database:, table:)
+        @database = database
+        @dataset = @database[table]
+      end
+
+      def upload(io, id, metadata = {})
+        generated_id = dataset.insert(content: io.read)
+        id.replace(generated_id.to_s)
+      end
+
+      def download(id)
+        tempfile = Tempfile.new("shrine", binmode: true)
+        File.write(tempfile.path, content(id))
+        tempfile
+      end
+
+      def open(id)
+        StringIO.new(content(id))
+      end
+
+      def read(id)
+        content(id)
+      end
+
+      def exists?(id)
+        this = dataset.where(id: id).limit(1)
+        !this.get(Sequel::SQL::AliasedExpression.new(1, :one)).nil?
+      end
+
+      def delete(id)
+        dataset.where(id: id).delete
+      end
+
+      def multi_delete(ids)
+        dataset.where(id: ids).delete
+      end
+
+      def url(id, options = {})
+      end
+
+      def clear!(confirm = nil)
+        raise Shrine::Confirm unless confirm == :confirm
+        dataset.delete
+      end
+
+      private
+
+      def content(id)
+        record = dataset.first!(id: id)
+        record[:content]
+      end
+    end
+  end
+end

data/shrine-sql.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |gem|
+  gem.name          = "shrine-sql"
+  gem.version       = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides SQL database storage for Shrine."
+  gem.homepage     = "https://github.com/janko-m/shrine-sql"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-sql.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_dependency "sequel"
+
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "shrine"
+  gem.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: shrine-sql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rake
+  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: shrine
+  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: minitest
+  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:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/storage/sql.rb
+- shrine-sql.gemspec
+homepage: https://github.com/janko-m/shrine-sql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides SQL database storage for Shrine.
+test_files: []
+has_rdoc: