shrine-scp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d218a5be95309cbb6cf56dc828aa398846fc1c6a
+  data.tar.gz: f77ec8bedb9ef89fd565e36a587b111a2ef31772
+SHA512:
+  metadata.gz: 5638954e75ee62d8a60e76c0bba774d040ec8ff52c70d5822072f7b3e7a93ff2b076a2a52f742daec3ea48faa9a4e0727515419885daf1f2495b9ecb6b16a031
+  data.tar.gz: 63c615b69f7fc458ad27d01d3745eede7619c3729cc5abd9795f314cabe45c4850d5cbe5a1893e5fa3e7e6b4febb0a40dbac3544f6807d0f3ff571414bd1f43d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,53 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  DisplayCopNames: true
+  DefaultFormatter: simple
+  Include:
+    - Rakefile
+  Exclude:
+    - test/test_helper.rb
+
+# Style
+Style/FileName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+
+# can't enforce style to require
+# the trailing underscore -- so disabling for now
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+# Metrics
+Metrics/LineLength:
+  Max: 90
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20
+
+# Performance
+Performance/RedundantBlockCall:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+shrine-scp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shrine-scp.gemspec
+gemspec
+
+gem "pry-byebug"
+gem "rubocop"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 jordanandree
+
+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,61 @@
+# Shrine::Scp
+
+Scp storage plugin for Shrine attachment and upload toolkit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shrine-scp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shrine-scp
+
+## Usage
+
+```ruby
+require "shrine/storage/scp"
+
+Shrine.storages[:store] = Shrine::Storage::Scp.new(
+	directory: "/path/to/uploads" # Required argument
+)
+```
+
+### Optional Configuration
+
+**ssh_host:**  
+optional `user@hostname` for remote scp transfers
+
+**host:**  
+URLs will by default be relative if `:prefix` is set, and you can use this option to set a CDN host (e.g. `//abc123.cloudfront.net`).
+
+**prefix:**  
+The directory relative to `directory` to which files will be stored, and it is included in the URL.
+
+**options:**  
+Additional arguments specific to scp. See: [https://linux.die.net/man/1/scp](https://linux.die.net/man/1/scp)
+
+**permissions:**  
+bit pattern for permissions to set on uploaded files. i.e. group read permissions: `0644`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jordanandree/shrine-scp.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shrine/storage/scp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/lint

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shrine/storage/linter"
+require "shrine/storage/scp"
+
+storage = Shrine::Storage::Scp.new(directory: "./tmp/lint")
+Shrine::Storage::Linter.new(storage).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shrine/storage/scp.rb

@@ -0,0 +1,135 @@
+require "shrine"
+
+require "fileutils"
+require "tempfile"
+
+class Shrine
+  module Storage
+    class Scp
+      attr_reader :directory, :ssh_host, :host, :prefix, :options, :permissions
+
+      def initialize(directory:, ssh_host: nil, host: nil, prefix: nil, options: %w[-q], permissions: 0600)
+        # Initializes a storage for uploading via scp.
+        #
+        # :directory
+        # :  the path where files will be transferred to
+        #
+        # :ssh_host
+        # :  optional user@hostname for remote scp transfers over ssh
+        #
+        # :host
+        # :  URLs will by default be relative if `:prefix` is set, and you
+        #    can use this option to set a CDN host (e.g. `//abc123.cloudfront.net`).
+        #
+        # :prefix
+        # :  The directory relative to `directory` to which files will be stored,
+        #    and it is included in the URL.
+        #
+        # :options
+        # :  Additional arguments specific to scp
+        #    https://linux.die.net/man/1/scp
+        #
+        # :permissions
+        # :  bit pattern for permissions to set on uploaded files
+        #
+        @directory   = directory.chomp(File::SEPARATOR)
+        @ssh_host    = ssh_host
+        @host        = host.chomp(File::SEPARATOR) if host
+        @prefix      = prefix.chomp(File::SEPARATOR) if prefix
+        @options     = options
+        @permissions = permissions
+      end
+
+      def upload(io, id, **)
+        file = write_io(io, id)
+        scp_up(id, file.path)
+        file
+      end
+
+      def download(id)
+        file = scp_down(id)
+        file
+      end
+
+      def open(id)
+        file = scp_down(id)
+        file.tap(&:open)
+      end
+
+      def exists?(id)
+        file_path = File.join(directory, id)
+        bash "ls -la #{file_path}"
+      end
+
+      def url(id, **_options)
+        File.join([host, prefix, id].compact)
+      end
+
+      def delete(id)
+        file_path = path(id)
+        bash "rm -rf #{file_path}"
+      end
+
+      def clear!
+        file_path = path("*")
+        bash "rm -rf #{file_path}"
+      end
+
+      private
+
+        def ssh?
+          ssh_host
+        end
+
+        def bash(sh)
+          command = "bash -c '#{sh}' > /dev/null 2>&1; echo $?"
+          command = "ssh #{ssh_host} \"#{command}\"" if ssh_host
+          `#{command}`.chomp == "0"
+        end
+
+        def scp_up(id, tmp_path)
+          FileUtils.chmod(permissions, tmp_path)
+          destination = path(id)
+          destination = "#{ssh_host}:#{destination}" if ssh_host
+          scp_transfer(source: tmp_path, destination: destination)
+        end
+
+        def scp_down(id)
+          source = path(id)
+          tmp = tempfile!(id)
+
+          tmp if scp_transfer(source: source, destination: tmp.path)
+        end
+
+        def scp_transfer(source:, destination:)
+          command = [scp_bin, scp_options, source, destination].join(" ")
+          system command
+        end
+
+        def scp_bin
+          scp_bin = `which scp`.chomp
+          raise "scp could not be found." if scp_bin.empty?
+          scp_bin
+        end
+
+        def scp_options
+          options.join(" ")
+        end
+
+        def path(id)
+          File.join([directory, prefix, id].compact)
+        end
+
+        def tempfile!(id)
+          Tempfile.new(["shrine-scp-", File.extname(id)], binmode: true)
+        end
+
+        def write_io(io, id)
+          tmp = tempfile!(id)
+          IO.copy_stream(io, tmp)
+          tmp.tap(&:open)
+          tmp
+        end
+    end
+  end
+end

data/shrine-scp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "shrine-scp"
+  spec.version       = "0.1.0"
+  spec.authors       = ["jordanandree"]
+  spec.email         = ["jordanandree@gmail.com"]
+
+  spec.summary       = %q{Scp storage for Shrine file attachment toolkit}
+  spec.homepage      = "https://github.com/jordanandree/shrine-scp"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shrine", "~> 2.0"
+
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: shrine-scp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jordanandree
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jordanandree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/lint
+- bin/setup
+- lib/shrine/storage/scp.rb
+- shrine-scp.gemspec
+- tmp/downloads/.keep
+- tmp/lint/.keep
+- tmp/uploads/.keep
+homepage: https://github.com/jordanandree/shrine-scp
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Scp storage for Shrine file attachment toolkit
+test_files: []