froala-editor-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f550a761087a01b88464ae9fb6ccc7109559837d
+  data.tar.gz: 9cf4bcc1e64c5c12c01fccdd7837714c616c5619
+SHA512:
+  metadata.gz: 8a0041c0af55b3acdc5fa220897232a66f55ad06b8ad061d1a84e796dfeb91f24cfbaa3a143f7c4bbe48193eac5f797e9761586b106fcd56bf1db753ed68cc6c
+  data.tar.gz: ff798b2be7f7ab315bb464b02984062f23bf2d420eea88e606ff6ee6dc59cfa7c575da7cab8d2987ad549ec415f9a5ee817d73d112c298b2e048040a7cccc1b7

data/lib/froala-editor-sdk.rb

@@ -0,0 +1,11 @@
+require 'mime-types'
+require 'mini_magick'
+require 'froala-editor-sdk/utils/validation'
+require 'froala-editor-sdk/utils/utils'
+
+
+require 'froala-editor-sdk/file'
+require 'froala-editor-sdk/image'
+require 'froala-editor-sdk/s3'
+require 'froala-editor-sdk/version'
+require 'froala-editor-sdk/video'

data/lib/froala-editor-sdk/file.rb

@@ -0,0 +1,101 @@
+module FroalaEditorSDK
+
+  require 'fileutils'
+
+  # File functionality.
+  class File
+
+    # Default options that are used if no options are passed to the upload function
+    @@default_options = {
+        fieldname: 'file',
+        validation: {
+            allowedExts: [".txt", ".pdf", ".doc", ".json", ".html"],
+            allowedMimeTypes: [ "text/plain", "application/msword", "application/x-pdf", "application/pdf", "application/json","text/html" ]
+        },
+        resize: nil
+    }
+
+    # Default upload path.
+    @@default_upload_path = "public/uploads/files"
+
+    # Uploads a file to the server.
+    # Params:
+    # +params+:: File upload parameter mostly is "file".
+    # +upload_path+:: Server upload path, a storage path where the file will be stored.
+    # +options+:: Hash object that contains configuration parameters for uploading a file.
+    # Returns json object
+    def self.upload(params, upload_path = @@default_upload_path, options = nil)
+
+      # Merge options.
+      options = (options || @@default_options).merge(options)
+
+      file = params[options[:fieldname]]
+
+      if file
+
+        # Validates the file extension and mime type.
+        validation = Validation.check(file, options)
+
+        # Uses the Utlis name function to generate a random name for the file.
+        file_name = Utils.name(file)
+        path = Rails.root.join(upload_path, file_name)
+
+        # Saves the file on the server and returns the path.
+        serve_url = save(file, path)
+
+        resize(options, path) if !options[:resize].nil?
+
+        return {:link => serve_url}.to_json
+      else
+        return nil
+      end
+    end
+
+    # Saves a file on the server.
+    # Params:
+    # +file+:: The uploaded file that will be saved on the server.
+    # +path+:: The path where the file will be saved.
+    def self.save (file, path)
+
+      # Create directory if it doesn't exist.
+      dirname = ::File.dirname(path)
+      unless ::File.directory?(dirname)
+        ::FileUtils.mkdir_p(dirname)
+      end
+
+      if ::File.open(path, "wb") {|f| f.write(file.read)}
+
+        # Returns a public accessible server path.
+        return "#{"/uploads/"}#{Utils.get_file_name(path)}"
+      else
+        return "error"
+      end
+    end
+
+    # Deletes a file found on the server.
+    # Params:
+    # +file+:: The file that will be deleted from the server.
+    # +path+:: The server path where the file resides.
+    # Returns true or false.
+    def self.delete(file = params[:file], path)
+
+      file_path = Rails.root.join(path, ::File.basename(file))
+      if ::File.delete(file_path)
+        return true
+      else
+        return false
+      end
+    end
+
+    # Resizes an image based on the options provided.
+    # The function resizes the original file,
+    # Params:
+    # +options+:: The options that contain the resize hash
+    # +path+:: The path where the image is stored
+    def self.resize (options, path)
+      image = MiniMagick::Image.new(path)
+      image.path
+      image.resize("#{options[:resize][:height]}x#{options[:resize][:width]}")
+    end
+  end
+end

data/lib/froala-editor-sdk/image.rb

@@ -0,0 +1,34 @@
+module FroalaEditorSDK
+  # Image functionality.
+  class Image < File
+
+    # Default options that are used if no options are passed to the upload function.
+    @@default_options = {
+        fieldname: 'file',
+        validation: {
+            allowedExts: [".gif", ".jpeg", ".jpg", ".png", ".svg", ".blob"],
+            allowedMimeTypes: [ "image/gif", "image/jpeg", "image/pjpeg", "image/x-png", "image/png", "image/svg+xml" ]
+        },
+        resize: nil
+    }
+
+    # Default upload path.
+    @@default_upload_path = "public/uploads/images"
+
+    # Loads the images from a specific path
+    # Params:
+    # +path+:: The server path where the images are saved
+    # Returns Json object
+    def self.load_images(path)
+
+      images = Dir["#{path}*"]
+      all_images = []
+
+      images.each do |img|
+        all_images.push({url: "#{"/uploads/"}#{Utils.get_file_name(img)}"})
+      end
+
+      return all_images.to_json
+    end
+  end
+end

data/lib/froala-editor-sdk/s3.rb

@@ -0,0 +1,59 @@
+module FroalaEditorSDK
+
+  # Uploads files to S3/AWS
+  class S3
+
+    # Builds a signature based on  the options.
+    # Params:
+    # +options+:: The configuration params that are needed to compute the signature.
+    def self.signature (options = nil)
+      Base64.encode64(
+          OpenSSL::HMAC.digest(
+              OpenSSL::Digest.new('sha1'),
+              options[:secretKey], self.policy(options)
+          )
+      ).gsub("\n", "")
+    end
+
+    # Encodes to Base64 the policy data and replaces new lines chars.
+    # Params:
+    # +options+:: The configuration params that are needed to compute the signature.
+    def self.policy (options = nil)
+      Base64.encode64(self.policy_data(options).to_json).gsub("\n", "")
+    end
+
+    # Sets policy params, bucket that will be used max file size and other params.
+    # Params:
+    # +options+:: Configuration params that are needed to set the policy
+    def self.policy_data (options = nil)
+      {
+          expiration: 10.hours.from_now.utc.iso8601,
+          conditions: [
+              ["starts-with", "$key", options[:keyStart]],       # Start key/folder
+              ["starts-with", "$x-requested-with", "xhr"],  # Request type
+              ["starts-with", "$content-type", ""],         # Content type
+              {bucket: options[:bucket]},                   # Bucket name
+              {acl: options[:acl]},                         # ACL property
+              {success_action_status: "201"}                # Response status 201 'file created'
+          ]
+      }
+    end
+
+    # Makes all the request in order and returns AWS hash response
+    # Params:
+    # +options+:: Configuration params to generate the AWS response.
+    def self.data_hash (options = nil)
+      options[:region] = 'us-east-1' if options[:region].nil? ||  options[:region] == 's3'
+
+      {
+          :signature => self.signature(options), # Defined signature
+          :policy => self.policy(options),       # Defined policy
+          :bucket => options[:bucket],           # Upload bucket
+          :acl => options[:acl],                 # ACL property 'public-read'
+          :keyStart => options[:keyStart],       # Start key/folder
+          :accessKey => options[:accessKey],     # Your Access key
+          :region =>  options[:region] != 'us-east-1' ? "s3-#{options[:region]}" : 's3' # Upload region
+      }
+    end
+  end
+end

data/lib/froala-editor-sdk/utils/utils.rb

@@ -0,0 +1,19 @@
+module FroalaEditorSDK
+
+  # Basic utility functionality.
+  class Utils
+
+    # Generates a random name that will be used as name for files.
+    def self.name (file)
+      name = SecureRandom.urlsafe_base64
+      ext = ::File.extname(file.original_filename)
+
+      return "#{name}#{ext}"
+    end
+
+    # Returns file name from an file path
+    def self.get_file_name(path)
+      return ::File.basename(path)
+    end
+  end
+end

data/lib/froala-editor-sdk/utils/validation.rb

@@ -0,0 +1,30 @@
+module FroalaEditorSDK
+
+  # Image Validation class.
+  # Checks if image is matching the allowed extensions and mime types.
+  class Validation
+    require "mime-types"
+
+    def self.ext(ext, options)
+      raise "Not allowed" unless options[:validation][:allowedExts].include?(ext)
+    end
+
+    def self.mime(mime, options)
+      raise "Invalid mime type" unless options[:validation][:allowedMimeTypes].include?(mime)
+    end
+
+    # Checks an image with the options.
+    # Params:
+    # +file+:: The image that will be validated.
+    # +options+:: The image options that contain allowed extensions and mime types.
+    # Raises exception if the image has not passed the validation
+    def self.check(file, options = nil)
+
+      mime = file.content_type
+      ext = ::File.extname(file.original_filename)
+      if ext(ext, options) && mime(mime, options)
+      end
+    end
+
+  end
+end

data/lib/froala-editor-sdk/version.rb

@@ -0,0 +1,9 @@
+module FroalaEditorSDK
+  module Version
+    Major = 1
+    Minor = 0
+    Tiny = 0
+
+    String = "#{Major}.#{Minor}.#{Tiny}"
+  end
+end

data/lib/froala-editor-sdk/video.rb

@@ -0,0 +1,19 @@
+module FroalaEditorSDK
+
+  # Video functionality.
+  class Video < File
+
+    # Default options that are used if no options are passed to the upload function
+    @@default_options = {
+        fieldname: 'file',
+        validation: {
+            allowedExts: [".mp4", ".webm", ".ogg"],
+            allowedMimeTypes: [ "video/mp4", "video/webm", "video/ogg" ]
+        },
+        resize: nil
+    }
+
+    # Default upload path.
+    @@default_upload_path = "public/uploads/videos"
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: froala-editor-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Froala Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: wysiwyg-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+description: Ruby SDK for Froala Editor
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/froala-editor-sdk.rb
+- lib/froala-editor-sdk/file.rb
+- lib/froala-editor-sdk/image.rb
+- lib/froala-editor-sdk/s3.rb
+- lib/froala-editor-sdk/utils/utils.rb
+- lib/froala-editor-sdk/utils/validation.rb
+- lib/froala-editor-sdk/version.rb
+- lib/froala-editor-sdk/video.rb
+homepage: https://github.com/froala/wysiwyg-rails
+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.10
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails SDK for Froala WYSIWYG Editor.
+test_files: []