activestorage-ftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10f69e9a517b7eb01c78baf94a8cfbde39b60aecb34a2fdf70f6ce2bd862bdad
+  data.tar.gz: 22528e4214f7f111ff8291d3b5842bac210c347937531619c44f415df076630a
+SHA512:
+  metadata.gz: c71cfe3d8b2bab2cfce28991261b39a2b23fec07f4d77e390edbb5e7a5e7e2e7fa6da0a81e1ab3d51acad32b1329c42d922fb2bc7f3513637f829f9aca5b5157
+  data.tar.gz: 6e0fa031fcf8e636788e7fc79783b63a114f685dfb8c37c1d3f9106b034d02bb4ba504bacee83fb3647fee76bf0fefd25d05d46f350fee1bcb1e5ef292ebac00

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release.

data/README.md

@@ -0,0 +1,39 @@
+# ActiveStorage FTP Service
+
+FTP Active Storage service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-ftp'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+config/storage.yml
+
+```yml
+production:
+  service: Ftp
+  ftp_host: <%= ENV["FTP_HOST"] %>
+  ftp_port: <%= ENV["FTP_PORT"] %>
+  ftp_user: <%= ENV["FTP_USER"] %>
+  ftp_passwd: <%= ENV["FTP_PASSWD"] %>
+  ftp_folder: <%= ENV["FTP_FOLDER"] %>
+  ftp_url: <%= ENV["FTP_URL"] %>
+  # optional
+  ftp_passive: true
+  ftp_chmod: 0600
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_storage/service/ftp_service.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+require "active_storage_ftp/ex_ftp"
+require "active_storage_ftp/ex_ftptls"
+require "digest/md5"
+require "active_support/core_ext/numeric/bytes"
+
+module ActiveStorage
+
+  class Service::FtpService < Service
+
+    def initialize(**config)
+      @config = config
+    end
+
+    def upload(key, io, checksum: nil, **)
+      instrument :upload, key: key, checksum: checksum do
+        connection do |ftp|
+          path_for(key).tap do |path|
+            ftp.mkdir_p(::File.dirname path)
+            ftp.chdir(::File.dirname path)
+            ftp.storbinary("STOR #{File.basename(key)}", io, Net::FTP::DEFAULT_BLOCKSIZE)
+            if ftp_chmod
+              ftp.sendcmd("SITE CHMOD #{ftp_chmod.to_s(8)} #{path_for(key)}")
+            end
+          end
+        end
+        ensure_integrity_of(key, checksum) if checksum
+      end
+    end
+
+    def download(key)
+      if block_given?
+        instrument :streaming_download, key: key do
+          open(http_url_for(key)) do |file|
+            while data = file.read(64.kilobytes)
+              yield data
+            end
+          end
+        end
+      else
+        instrument :download, key: key do
+          open(http_url_for(key)) do |file|
+            file.read
+          end
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        open(http_url_for(key)) do |file|
+            file.seek range.begin
+            file.read range.size
+        end
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        begin
+          connection do |ftp|
+            ftp.chdir(::File.dirname path_for(key))
+            ftp.delete(::File.basename path_for(key))
+          end
+        rescue
+          # Ignore files already deleted
+        end
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        connection do |ftp|
+          ftp.chdir(path_for(prefix))
+          ftp.list.each do |file|
+            ftp.delete(file.split.last)
+          end
+        end
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        response = request_head(key)
+        answer = response.code.to_i == 200
+        payload[:exist] = answer
+        answer
+      end
+    end
+
+    def url(key, expires_in:, filename:, disposition:, content_type:)
+      instrument :url, key: key do |payload|
+        generated_url = http_url_for(key)
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+      instrument :url, key: key do |payload|
+        verified_token_with_expiration = ActiveStorage.verifier.generate(
+            {
+                key: key,
+                content_type: content_type,
+                content_length: content_length,
+                checksum: checksum
+            },
+            {expires_in: expires_in,
+             purpose: :blob_token}
+        )
+
+        generated_url = url_helpers.update_rails_disk_service_url(verified_token_with_expiration, host: current_host)
+        payload[:url] = generated_url
+        generated_url
+
+      end
+    end
+
+    def headers_for_direct_upload(key, content_type:, **)
+      {"Content-Type" => content_type}
+    end
+
+    def path_for(key) #:nodoc:
+      File.join ftp_folder, folder_for(key), key
+    end
+
+    private
+
+    attr_reader :config
+
+    def folder_for(key)
+      [key[0..1], key[2..3]].join("/")
+    end
+
+    def ensure_integrity_of(key, checksum)
+      response = request_head(key)
+      unless "#{response['Content-MD5']}==" == checksum
+        delete key
+        raise ActiveStorage::IntegrityError
+      end
+    end
+
+    def url_helpers
+      @url_helpers ||= Rails.application.routes.url_helpers
+    end
+
+    def current_host
+      ActiveStorage::Current.host
+    end
+
+    def request_head(key)
+      uri = URI(http_url_for(key))
+      request = Net::HTTP.new(uri.host, uri.port)
+      request.use_ssl = uri.scheme == 'https'
+      request.request_head(uri.path)
+    end
+
+    def http_url_for(key)
+      ([ftp_url, folder_for(key), key].join('/'))
+    end
+
+    def inferred_content_type
+      SanitizedFile.new(path).content_type
+    end
+
+    def ftp_host
+      config.fetch(:ftp_host)
+    end
+
+    def ftp_port
+      config.fetch(:ftp_port)
+    end
+
+    def ftp_user
+      config.fetch(:ftp_user)
+    end
+
+    def ftp_passwd
+      config.fetch(:ftp_passwd)
+    end
+
+    def ftp_folder
+      config.fetch(:ftp_folder)
+    end
+
+    def ftp_url
+      config.fetch(:ftp_url)
+    end
+
+    def ftp_passive
+      config.fetch(:ftp_passive)
+    end
+
+    def ftp_chmod
+      config.fetch(:ftp_chmod, 0600)
+    end
+
+    def connection
+      ftp = ExFTP.new
+      ftp.connect(ftp_host, ftp_port)
+      begin
+        ftp.passive = ftp_passive
+        ftp.login(ftp_user, ftp_passwd)
+        yield ftp
+      ensure
+        ftp.quit
+      end
+    end
+
+  end
+end

data/lib/active_storage_ftp/ex_ftp.rb

@@ -0,0 +1,25 @@
+require 'net/ftp'
+
+class ExFTP < Net::FTP
+  def mkdir_p(dir)
+    parts = dir.split("/")
+    if parts.first == "~"
+      growing_path = ""
+    else
+      growing_path = "/"
+    end
+    for part in parts
+      next if part == ""
+      if growing_path == ""
+        growing_path = part
+      else
+        growing_path = File.join(growing_path, part)
+      end
+      begin
+        mkdir(growing_path)
+        chdir(growing_path)
+      rescue Net::FTPPermError, Net::FTPTempError => e
+      end
+    end
+  end
+end

data/lib/active_storage_ftp/ex_ftptls.rb

@@ -0,0 +1,25 @@
+require 'double_bag_ftps'
+
+class ExFTPTLS < DoubleBagFTPS
+  def mkdir_p(dir)
+    parts = dir.split("/")
+    if parts.first == "~"
+      growing_path = ""
+    else
+      growing_path = "/"
+    end
+    for part in parts
+      next if part == ""
+      if growing_path == ""
+        growing_path = part
+      else
+        growing_path = File.join(growing_path, part)
+      end
+      begin
+        mkdir(growing_path)
+        chdir(growing_path)
+      rescue Net::FTPPermError, Net::FTPTempError => e
+      end
+    end
+  end
+end

data/lib/active_storage_ftp/railtie.rb

@@ -0,0 +1,4 @@
+module ActiveStorageFtp
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/active_storage_ftp/version.rb

@@ -0,0 +1,3 @@
+module ActiveStorageFtp
+  VERSION = '0.1.0'
+end

data/lib/activestorage-ftp.rb

@@ -0,0 +1,5 @@
+# require "active_storage_ftp/railtie"
+
+module ActiveStorageFtp
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-ftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Gordienko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: double-bag-ftps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: FTP Active Storage service.
+email: alx@anadyr.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/active_storage/service/ftp_service.rb
+- lib/active_storage_ftp/ex_ftp.rb
+- lib/active_storage_ftp/ex_ftptls.rb
+- lib/active_storage_ftp/railtie.rb
+- lib/active_storage_ftp/version.rb
+- lib/activestorage-ftp.rb
+homepage: https://github.com/gordienko/activestorage-ftp
+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.7.9
+signing_key: 
+specification_version: 4
+summary: FTP Active Storage service
+test_files: []