el_finder_s3 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da39c62708b7a593b641c04c5faf89b538a5c3d0
+  data.tar.gz: 064b8666cefc4d58d674d6686f550673dc777718
+SHA512:
+  metadata.gz: fefb3d47003af89571909ff973534f80a0016c517c534a1a5a81624ce62fc2af24af8ed0a981e4526fb9d688ed799c24327209db8e019835a5c78dde0cc91fde
+  data.tar.gz: 27aa78745a92d4e40251a26e18b5999b023c58d639a59cd51636e9d23c9e6ca58f4fbda7976d3cd7a969a10673c0c5a6d25a5b9cdc32f5bdc4015c8ac65b3298

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+/Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Raúl Morales
+
+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,37 @@
+# el_finder_s3
+Ruby gem to provide server side connector to elFinder using AWS S3 like a container
+
+## Description
+
+This is based on cdmicacc's Ruby library to provide server side ftp functionality over elFinder ruby gem of Phallstrom.
+
+- cdmicacc project: https://github.com/cdmicacc/el_finder_ftp
+- phallstrom project: https://github.com/phallstrom/el_finder
+
+
+## Rails 4
+
+```ruby
+  include ElFinderS3::Action
+  
+  def elfinder
+    ElFinderS3::Connector.new(
+      :mime_handler => ElFinderS3::MimeType,
+      :root => '/',
+      :url => 'CDN_BASE_PATH'
+      :thumbs => true,
+      :thumbs_size => 100,
+      :thumbs_directory => 'thumbs',
+      :home => t('admin.media.home'),
+      :original_filename_method => lambda { |file| "#{File.basename(file.original_filename, File.extname(file.original_filename)).parameterize}#{File.extname(file.original_filename)}" },
+      :default_perms => {:read => true, :write => true, :rm => true, :hidden => false},
+      :server => {
+        :bucket_name => 'BUCKET_NAME',
+        :region => 'AWS_REGION',
+        :access_key_id => 'ACCESS_KEY_ID',
+        :secret_access_key => 'SECRET_ACCESS_KEY',
+        :cdn_base_path => 'CDN_BASE_PATH'
+      }
+    ).run(params)
+  end
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'el_finder_s3'
+
+# 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/setup

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

data/el_finder_s3.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'el_finder_s3/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'el_finder_s3'
+  spec.version = ElFinderS3::VERSION
+  spec.authors = ['Raúl Anatol']
+  spec.email = ['raul@natol.es']
+
+  spec.summary = %q{elFinder server side connector for Ruby, with an S3 aws service.}
+  spec.description = %q{Ruby gem to provide server side connector to elFinder using AWS S3 like a container}
+  spec.homepage = 'https://github.com/raulanatol/el_finder_s3'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('aws-sdk', '~> 2')
+  #FIXME remove after testing
+  spec.add_dependency('net-ftp-list', '~> 3.2')
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/el_finder_s3.rb

@@ -0,0 +1,14 @@
+# require 'fileutils'
+# require 'net/ftp'
+
+require 'el_finder_s3/cache_connector'
+require 'el_finder_s3/adapter'
+require 'el_finder_s3/railties'
+require 'el_finder_s3/base64'
+require 'el_finder_s3/s3_connector'
+require 'el_finder_s3/s3_pathname'
+require 'el_finder_s3/pathname'
+require 'el_finder_s3/mime_type'
+require 'el_finder_s3/image'
+require 'el_finder_s3/connector'
+require 'el_finder_s3/action'

data/lib/el_finder_s3/action.rb

@@ -0,0 +1,32 @@
+module ElFinderS3
+  module Action
+    class << self
+      def included(klass)
+        klass.send(:extend, ElFinderS3::ActionClass)
+      end
+    end
+  end
+
+  module ActionClass
+    def el_finder_ftp(name = :elfinder, &block)
+      self.send(:define_method, name) do
+        h, r = ElFinderS3::Connector.new(instance_eval(&block)).run(params)
+        headers.merge!(h)
+        if r.include?(:file_data)
+          send_data r[:file_data], type: r[:mime_type], disposition: r[:disposition], filename: r[:filename]
+        else
+          if browser.ie8? || browser.ie9?
+            # IE 8 and IE 9 don't accept application/json as a response to a POST in some cases:
+            # http://blog.degree.no/2012/09/jquery-json-ie8ie9-treats-response-as-downloadable-file/
+            # so we send text/html instead
+            response = (r.empty? ? {:nothing => true} : {:text => r.to_json})
+          else
+            response = (r.empty? ? {:nothing => true} : {:json => r})
+          end
+
+          render response, :layout => false
+        end
+      end
+    end
+  end
+end

data/lib/el_finder_s3/adapter.rb

@@ -0,0 +1,222 @@
+module ElFinderS3
+  class Adapter
+    attr_reader :connection, :server, :s3_connector
+
+    def initialize(server)
+      @server = {
+        response_cache_expiry_seconds: 3000
+      }
+      @cached_responses = {}
+      @s3_connector = ElFinderS3::S3Connector.new server
+    end
+
+    def connect
+      @connection
+    end
+
+    def close
+      true
+    end
+
+    def children(pathname, with_directory)
+      cached :children, pathname do
+        @s3_connector.ls_la(pathname, with_directory)
+      end
+    end
+
+    def touch(pathname, options={})
+      @s3_connector.touch(pathname.to_file_prefix_s)
+    end
+
+    def exist?(pathname)
+      cached :exist?, pathname do
+        @s3_connector.exist? pathname
+      end
+    end
+
+    # @param [ElFinderS3::Pathname] pathname
+    def path_type(pathname)
+      cached :path_type, pathname do
+        result = :directory
+        begin
+          if pathname.to_s == '/'
+            result = :directory
+          end
+        rescue
+          result = pathname[:type]
+        end
+        return result
+      end
+    end
+
+    def size(pathname)
+      #FIXME
+      # cached :size, pathname do
+      #   ftp_context do
+      #     ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Getting size of #{pathname}"
+      #     begin
+      #       size(pathname.to_s)
+      #     rescue Net::FTPPermError => e
+      #       nil
+      #     rescue Net::FTPReplyError => e
+      #       nil
+      #     end
+      #   end
+      # end
+    end
+
+    #FIXME
+    def mtime(pathname)
+      cached :mtime, pathname do
+        # ftp_context do
+        #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Getting modified time of #{pathname}"
+        #   begin
+        #     mtime(pathname.to_s)
+        #   rescue Net::FTPPermError => e
+        # This command doesn't work on directories
+        0
+        # end
+        # end
+      end
+    end
+
+    #FIXME
+    def rename(pathname, new_name)
+      # ftp_context do
+      #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Renaming #{pathname} to #{new_name}"
+      #   rename(pathname.to_s, new_name.to_s)
+      # end
+      # clear_cache(pathname)
+    end
+
+    ##
+    # Both rename and move perform an FTP RNFR/RNTO (rename).  Move differs because
+    # it first changes to the parent of the source pathname and uses a relative path for
+    # the RNFR.  This seems to allow the (Microsoft) FTP server to rename a directory
+    # into another directory (e.g. /subdir/target -> /target )
+    def move(pathname, new_name)
+      #FIXME
+      # ftp_context(pathname.dirname) do
+      #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Moving #{pathname} to #{new_name}"
+      #   rename(pathname.basename.to_s, new_name.to_s)
+      # end
+      # clear_cache(pathname)
+      # clear_cache(new_name)
+    end
+
+    def mkdir(pathname)
+      if @s3_connector.mkdir(pathname.to_prefix_s)
+        #FIXME review cache clear
+        # clear_cache(pathname)
+        true
+      else
+        false
+      end
+    end
+
+    def rmdir(pathname)
+      #FIXME
+      # ftp_context do
+      #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Removing directory #{pathname}"
+      #   rmdir(pathname.to_s)
+      # end
+      # clear_cache(pathname)
+    end
+
+    def delete(pathname)
+      #FIXME
+      # ftp_context do
+      #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Deleting #{pathname}"
+      #   if pathname.directory?
+      #     rmdir(pathname.to_s)
+      #   else
+      #     delete(pathname.to_s)
+      #   end
+      # end
+      # clear_cache(pathname)
+    end
+
+    def retrieve(pathname)
+      #FIXME
+      # ftp_context do
+      #   ElFinderS3::Connector.logger.debug "  \e[1;32mFTP:\e[0m    Retrieving #{pathname}"
+      #   content = StringIO.new()
+      #   begin
+      #     retrbinary("RETR #{pathname}", 10240) do |block|
+      #       content << block
+      #     end
+      #     content.string
+      #   ensure
+      #     content.close
+      #   end
+      # end
+    end
+
+    def store(pathname, content)
+      @s3_connector.store(pathname.to_file_prefix_s, content)
+      #TODO clear_cache(pathname)
+    end
+
+    private
+
+    ##
+    # Remove all entries for the given pathname (and its parent folder)
+    # from the FTP cache
+    def clear_cache(pathname)
+      @cached_responses.delete(pathname.to_s)
+
+      if pathname.to_s != '/' && pathname.to_s != '.'
+        # Clear parent of this entry, too
+        @cached_responses.delete(pathname.dirname.to_s)
+      end
+    end
+
+    ##
+    # Looks in the cache for an entry for the given pathname and operation,
+    # returning the cached result if one is found.  If one is not found, the given
+    # block is invoked and its result is stored in the cache and returned
+    #
+    # The FTP cache is used to prevent redundant FTP queries for information such as a
+    # file's size, or a directory's contents, during a *single* FTP session.
+    def cached(operation, pathname)
+      response = cache_get(operation, pathname)
+      unless response.nil?
+        return response
+      end
+
+      response = yield
+      cache_put operation, pathname, response
+
+      response
+    end
+
+    ##
+    # Store an FTP response in the cache
+    def cache_put(operation, pathname, response)
+      @cached_responses[pathname.to_s] = {} unless @cached_responses.include?(pathname.to_s)
+
+      @cached_responses[pathname.to_s][operation] = {
+        timestamp: Time.now,
+        response: response
+      }
+    end
+
+    ##
+    # Fetch an FTP response from the cache
+    def cache_get(operation, pathname)
+      if @cached_responses.include?(pathname.to_s) && @cached_responses[pathname.to_s].include?(operation)
+        response = @cached_responses[pathname.to_s][operation]
+
+        #FIXME cache timeout
+        # max_staleness = Time.now - @server[:response_cache_expiry_seconds]
+
+        # if response[:timestamp] < max_staleness
+        #   @cached_responses[pathname.to_s].delete(operation)
+        #   nil
+        # else
+        response[:response]
+        # end
+      end
+    end
+  end
+end