active-storage-ftp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c28e1d6c737b6a82bada6c98144ce559eaf384f88b41a1a8e48fce12d831dd
-  data.tar.gz: 3d375e09b426060428eddb07968b00d8503774dbfaf3fb083e1ba9aa36b9c673
+  metadata.gz: 17d6911595715168ddebd3539f62b8e201d09d9acf98d9d6d30c19aff431149d
+  data.tar.gz: 4415e8df88899c04e4a78c45cb1117c7a6577c089c9cf4c81ed7731e70eadef1
 SHA512:
-  metadata.gz: eaecbd2f4c21dbdecfa2bfc22e0cab18e6da65bad1150f00f6df090bb01a3ea3036b02e823ff64f3b02b13fa4b310494fe7ceb21fb50c504a0d8684f3eac704f
-  data.tar.gz: ece1cd11ba4746a15cfc98ddc9f7b10f6cbb71728a1357badc05e9b77437dd56b1fcfc307b86a26ecbcfbf60749403c23f2beb3973f1d154a9392d2cb4d645a2
+  metadata.gz: e4ad459cc21fb0fa91a7a65142754565559d876e481fe65572f3e9893db659425a91256093fe18739d9332d8d552143483a699c53cda2c3cc6bfc7098bc543fa
+  data.tar.gz: a69367e3bada7f7c61eab4a9e3b018793b50aac3dde0477b8cf675346fb50adbbc82a5109e87aaa25440775c3ce6908d051314313512e02ca4cebf86e6c69f1d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    active-storage-ftp (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active-storage-ftp!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,46 @@
+# Activestorage::Ftp
+
+Active Storage FTP Service, This project only support FTP service not SSH
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actives-storage-ftp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active-storage-ftp
+
+## Usage
+
+```yml
+production:
+  service: FTP
+  host: <%= ENV["FTP_HOST"] %>
+  port: <%= ENV["FTP_PORT"] %>
+  username: <%= ENV["FTP_USERNAME"] %>
+  password: <%= ENV["FTP_PASSWORD"] %>
+  folder: <%= ENV["FTP_FOLDER"] %>
+  url: <%= ENV["FTP_URL"] %>
+  # optional
+  passive: true
+  ssl: false
+  debug_mode: false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iscreen/actives-torage-ftp.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_storage_ftp.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_storage_ftp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active-storage-ftp'
+  spec.version       = ActiveStorageFtp::VERSION
+  spec.authors       = ["Dean Lin"]
+  spec.email         = ["iscreen@gmail.com"]
+
+  spec.summary       = %q{Active Storage FTP Service.}
+  spec.description   = %q{Active Storage FTP Service.}
+  spec.homepage      = 'https://api.genbagames.com/doc/'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host"'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activestorage/ftp"
+
+# 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(__FILE__)

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/active-storage-ftp.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'rest-client'
+require File.dirname(__FILE__) + '/active_storage_ftp'

data/lib/active_storage/service/ftp_service.rb

@@ -0,0 +1,183 @@
+require 'net/ftp'
+
+module ActiveStorage
+  class Service::FTPService < Service
+    def initialize(**config)
+      @config = config
+    end
+
+    def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil)
+      instrument :upload, key: key, checksum: checksum do
+        connection do |ftp|
+          ftp.put(io, key)
+        end
+      end
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument :streaming_download, key: key do
+          stream(key, &block)
+        end
+      else
+        instrument :download, key: key do
+          stream(data) do |data|
+            result += data
+          end
+          result
+        rescue StandardError => _
+          raise ActiveStorage::FileNotFoundError
+        end
+      end
+    end
+
+    def update_metadata(key, content_type:, disposition: nil, filename: nil)
+      instrument :update_metadata, key: key, content_type: content_type, disposition: disposition do
+        # Nothing need to do
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        connection do |ftp|
+          offset = range.begin
+          ftp.retrbinary("RETR #{key}", range.begin) do |data|
+            yield data
+            offset += data
+          end
+        end
+      rescue StandardError => _
+        raise ActiveStorage::FileNotFoundError
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        connection do |ftp|
+          ftp.delete(key)
+        end
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        connection do |ftp|
+          files = ftp.list("#{prefix}*")
+          files.each { |f| f.delete(f) }
+        end
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        connection do |ftp|
+          data = ftp.retrbinary("RETR #{key}")
+          answer = !data.nil?
+          payload[:exist] = answer
+          answer
+        end
+      end
+    end
+
+    def url(key, expires_in:, filename:, content_type:, disposition:)
+      instrument :url, key: key do |payload|
+        generated_url = url_for(key)
+        payload[:url]
+        generated_url
+      end
+    end
+
+    def url_for_direct_upload(key, expires_in:, checksum:, **)
+      instrument :url, key: key do |payload|
+        raise 'not support direct upload'
+        # generated_url = bucket.signed_url key, method: "PUT", expires: expires_in, content_md5: checksum
+
+        # payload[:url] = generated_url
+
+        # generated_url
+      end
+    end
+
+    def headers_for_direct_upload(key, checksum:, **)
+      { 'Content-MD5' => checksum }
+    end
+
+    private
+
+    attr_reader :config
+
+    def connection
+      EnhanceFtp.open(
+        ftp_host,
+        username: ftp_username,
+        password: ftp_password,
+        port: ftp_port,
+        passive: ftp_passive,
+        ssl: ftp_ssl,
+        debug_mode: ftp_debug_mode
+      ) do |ftp|
+        begin
+          ftp.chdir(ftp_folder)
+        rescue StandardError => _
+          ftp.mkdir_p(ftp_folder)
+          ftp.chdir(ftp_folder)
+        end
+        yield ftp
+      end
+    end
+
+    def path_for(key) #:nodoc:
+      File.join(ftp_folder, key)
+    end
+
+    def url_for(key)
+      file_url = [ftp_url, ftp_folder, key].join('/')
+      file_url
+    end
+
+    # Reads the file for the given key in chunks, yielding each to the block.
+    def stream(key)
+      connection do |ftp|
+        ftp.retrbinary("RETR #{key}", 5.megabytes) do |data|
+          yield data
+        end
+      end
+    end
+
+    def ftp_host
+      config.fetch(:host)
+    end
+
+    def ftp_username
+      config.fetch(:username)
+    end
+
+    def ftp_password
+      config.fetch(:password)
+    end
+
+    def ftp_port
+      config.fetch(:port)
+    end
+
+    def ftp_folder
+      config.fetch(:folder)
+    end
+
+    def ftp_ssl
+      config.fetch(:ssl, false)
+    end
+
+    def ftp_passive
+      config.fetch(:passive, true)
+    end
+
+    def ftp_url
+      config.fetch(:url)
+    end
+
+    def ftp_debug_mode
+      config.fetch(:debug_mode, false)
+    end
+  end
+end

data/lib/active_storage_ftp/enhance_ftp.rb

@@ -0,0 +1,12 @@
+module ActiveStorageFtp
+  class EnhanceFtp < Net::Ftp
+    def mkdir_p(remove_path)
+      paths = remove_path.split('/')
+      full_path = paths.first == '~' ? '' : '/'
+      paths.each do |path|
+        full_path = File.join(full_path, path)
+        mkdir(full_path)
+      end
+    end
+  end
+end

data/lib/active_storage_ftp/version.rb

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

data/lib/active_storage_ftp.rb

@@ -0,0 +1,6 @@
+require 'net/ftp'
+require 'active_storage/service/ftp_service'
+require 'active-storage-ftp/enhance_ftp'
+
+module ActiveStorageFtp
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active-storage-ftp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dean Lin
@@ -58,7 +58,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active_storage_ftp.gemspec
+- bin/console
+- bin/setup
+- lib/active-storage-ftp.rb
+- lib/active_storage/service/ftp_service.rb
+- lib/active_storage_ftp.rb
+- lib/active_storage_ftp/enhance_ftp.rb
+- lib/active_storage_ftp/version.rb
 homepage: https://api.genbagames.com/doc/
 licenses: []
 metadata: