froala-editor-sdk 1.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c51a689daf99ec97c6ccebbb452f66e3c0c217b8
-  data.tar.gz: 4dc43249a447e483c3463103d4e8cebd755ff4a5
+SHA256:
+  metadata.gz: b9a480de43d7ab38e6c584f2619b9c616b3256885ce624b879efcee7f926ecd2
+  data.tar.gz: 4edd6556ad1a0049b1b7a8fda4ffc61293d76a5612f5ba70f7a95166d87ca59b
 SHA512:
-  metadata.gz: 642103cf3c5b322c4e7d9664c9619ef86503b720b9a1f3827a1bc94544862fce3cabd16cff1ca53045fe6145e3b60d3b0326337b109b10194daa8d7fba1c3e29
-  data.tar.gz: 5b429455276179d3a3dc96ef5f0158ce9b5ebc70afb606a8a47546f304f74f960b9c3f25819f55b8ed3d9cda5d4fdb1bd5f951bbcfb8ce71094d6ed852513b7e
+  metadata.gz: 6af3df5f2c0bedf6a15bdf8c5bb060e1032f535c74abfc99fdf5d98cff73522d4c66c1520796ebb5d822a6b8f99e37ba366e572c0f5ce681f6ae0199985e3352
+  data.tar.gz: a7645f764dcfc0b14679e32b8470e165b1e53616f37edb779de8c9725461f69b155b7d5d6c6e961dfd4ada294fe641ee6797966fec5e8f4adc2b3e3332aa2cd4

data/lib/froala-editor-sdk.rb

@@ -1,11 +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'
+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

@@ -1,109 +1,114 @@
-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 = {})
-
-      # Merge 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
-
-    class << self
-      attr_reader :var
-    end
-
-    def var
-      self.class.var
-    end
-  end
+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,
+        file_access_path: '/uploads/'
+    }
+
+    # 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 = {})
+
+      # Merge 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, options[:file_access_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, file_access_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 "#{file_access_path}#{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))
+      begin
+        if ::File.delete(file_path)
+          return true
+        else
+          return false
+        end
+      rescue => exception
+        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][:width]}x#{options[:resize][:height]}")
+    end
+
+    class << self
+      attr_reader :var
+    end
+
+    def var
+      self.class.var
+    end
+  end
 end

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

@@ -1,34 +1,38 @@
-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
+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,
+        file_access_path: '/uploads/'
+    }
+
+    # 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, options = {})
+
+      # Merge options.
+      options = @default_options.merge(options)
+
+      images = Dir["#{path}*"]
+      all_images = []
+
+      images.each do |img|
+        all_images.push({url: "#{options[:file_access_path]}#{Utils.get_file_name(img)}"})
+      end
+
+      return all_images.to_json
+    end
+  end
 end

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

@@ -1,61 +1,96 @@
-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'
-
-      {
-        :bucket => options[:bucket],           # Upload bucket
-        :region =>  options[:region] != 'us-east-1' ? "s3-#{options[:region]}" : 's3', # Upload region
-        :keyStart => options[:keyStart],       # Start key/folder
-        :params => {
-          :signature => self.signature(options), # Defined signature
-          :AWSAccessKeyId => options[:accessKey],     # Your Access key
-          :policy => self.policy(options),       # Defined policy
-          :acl => options[:acl]                 # ACL property 'public-read'
-        }
-      }
-    end
-  end
+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)
+      OpenSSL::HMAC.hexdigest(
+        "SHA256",
+        self.sign(
+          self.sign(
+            self.sign(
+              self.sign(
+                ("AWS4" + options[:secretKey]).force_encoding(Encoding::UTF_8),
+                options[:'date-string']
+              ),
+              options[:region]
+            ),
+            "s3"
+          ),
+          "aws4_request"
+        ), 
+        self.policy(options)
+      )
+    end
+
+    # Builds a HMAC-SHA256 digest using key and data
+    # Params:
+    # +key+:: Key to use for creating the digest
+    # +data+:: Data to be used for creating the digest
+    def self.sign(key, data)
+      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, data.force_encoding(Encoding::UTF_8))
+    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", "$Content-type", ""],         # Content type
+              {"x-requested-with": "xhr"},                  # Request type
+              {"x-amz-algorithm": options[:'x-amz-algorithm']}, # Encrytion Algorithm
+              {"x-amz-date": options[:'x-amz-date']},       # Current Date
+              {"x-amz-credential": options[:'x-amz-credential']}, # Encrypted Credentials
+              {bucket: options[:bucket]},                   # Bucket name
+              {acl: options[:acl]},                         # ACL property
+              {success_action_status: "201"}                # Response status 201 'file created'
+          ]
+      }
+    end
+
+    # Builds the amazon credential by appending access key, x-amz-date, region and 's3/aws4_request'
+    # Params:
+    # +options+:: Configuration params to generate the AWS response
+    def self.getXamzCredential(options = nil)
+      "#{options[:accessKey]}#{"/"}#{options[:'date-string']}#{"/"}#{options[:region]}#{"/"}#{"s3/aws4_request"}"
+    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'
+      options[:'date-string'] = Time.now.strftime("%Y%m%d")
+      options[:'x-amz-algorithm'] = "AWS4-HMAC-SHA256"
+      options[:'x-amz-credential'] = self.getXamzCredential(options)
+      options[:'x-amz-date'] = options[:'date-string'] + "T000000Z"
+
+      {
+        :bucket => options[:bucket],           # Upload bucket
+        :region =>  options[:region] != 'us-east-1' ? "s3-#{options[:region]}" : 's3', # Upload region
+        :keyStart => options[:keyStart],       # Start key/folder
+        :params => {
+          :acl => options[:acl],                 # ACL property 'public-read'
+          :policy => self.policy(options),       # Defined policy
+          :'x-amz-algorithm' => options[:'x-amz-algorithm'], # Encrytion Algorithm
+          :'x-amz-credential' => options[:'x-amz-credential'],     # Encrypted Credentials
+          :'x-amz-date' => options[:'x-amz-date'],  # Current Date
+          :'x-amz-signature' => self.signature(options), # Defined signature
+        }
+      }
+    end
+  end
 end

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

@@ -1,19 +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
+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

@@ -1,35 +1,35 @@
-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)
-
-      # Check if there is custom validation.
-      if options[:validation].class != Proc
-        ext(ext, options) && mime(mime, options)
-      else
-        options[:validation].call(file.path, mime)
-      end
-    end
-
-  end
+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)
+
+      # Check if there is custom validation.
+      if options[:validation].class != Proc
+        ext(ext, options) && mime(mime, options)
+      else
+        options[:validation].call(file.path, mime)
+      end
+    end
+
+  end
 end

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

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

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

@@ -1,19 +1,20 @@
-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
+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,
+        file_access_path: '/uploads/'
+    }
+
+    # Default upload path.
+    @default_upload_path = "public/uploads/videos"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: froala-editor-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Froala Labs
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -30,30 +30,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '4.5'
 description: Ruby SDK for Froala Editor
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -70,7 +70,7 @@ homepage: https://github.com/froala/wysiwyg-editor-ruby-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,9 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Ruby on Rails SDK for Froala WYSIWYG Editor.
 test_files: []