imagekitio 1.0.8 → 2.0.1

data/lib/imagekit/constants/errors.rb

@@ -1,77 +0,0 @@
-MANDATORY_INIT_MISSING = {
-  'message': "Missing public_key or private_key or url_endpoint during ImageKit initialization",
-  help: "",
-}
-INVALID_TRANSFORMATION_POS = {'message': "Invalid transformationPosition parameter",
-                              help: "",}
-INVALID_URL_GENERATION_PARAM = {'message': "Invalid url parameter", help: ""}
-INVALID_TRANSFORMATION_OPTIONS = {
-  'message': "Invalid transformation parameter options",
-  help: "",
-}
-CACHE_PURGE_URL_MISSING = {'message': "Missing URL parameter for this request",
-                           help: "",}
-CACHE_PURGE_STATUS_ID_MISSING = {'message': "Missing Request ID parameter for this request",
-                                 help: "",}
-FILE_ID_MISSING = {'message': "Missing File ID parameter for this request",
-                   help: "",}
-UPDATE_DATA_MISSING = {'message': "Missing file update data for this request",
-                       help: "",}
-
-UPDATE_DATA_TAGS_INVALID = {'message': "Invalid tags parameter for this request",
-                            help: "tags should be passed as null or an array like ['tag1', 'tag2']",}.freeze
-
-UPDATE_DATA_COORDS_INVALID =
-  {'message': "Invalid custom_coordinates parameter for this request",
-   help: "custom_coordinates should be passed as null or a string like 'x,y,width,height'",}
-
-LIST_FILES_INPUT_MISSING = {
-  'message': "Missing options for list files",
-  help: "If you do not want to pass any parameter for listing, pass an empty object",
-}
-MISSING_FILE_URL = {'message': "Missing file_url for purge_cache", help: ""}
-MISSING_UPLOAD_DATA = {'message': "Missing data for upload", help: ""}
-MISSING_UPLOAD_FILE_PARAMETER = {
-  'message': "Missing file parameter for upload",
-  help: "",
-}
-MISSING_UPLOAD_FILENAME_PARAM = {
-  'message': "Missing fileName parameter for upload",
-  help: "",
-}
-
-INVALID_PHASH_VALUE =
-  {
-    'message': "Invalid pHash value",
-    help: "Both pHash strings must be valid hexadecimal numbers",
-  }
-
-MISSING_PHASH_VALUE = {
-  'message': "Missing pHash value",
-  help: "Please pass two pHash values",
-}
-UNEQUAL_STRING_LENGTH = {
-  '': "Unequal pHash string length",
-  help: "For distance calculation, the two pHash strings must have equal length",
-}
-
-MISSING_UPLOAD_FILE_PARAMETER = {'message': "Missing file parameter for upload",
-                                 'help': "",}
-MISSING_UPLOAD_FILENAME_PARAM = {
-  'message': "Missing fileName parameter for upload",
-  'help': "",
-}
-
-INVALID_PHASH_VALUE = {'message': "Invalid pHash value",
-                       'help': "Both pHash strings must be valid hexadecimal numbers",}
-
-MISSING_PHASH_VALUE = {'message': "Missing pHash value",
-                       'help': "Please pass two pHash values",}
-UNEQUAL_STRING_LENGTH = {'message': "Unequal pHash string length",
-                         'help': "For distance calculation, the two pHash strings must have equal length",}
-
-MISSING_PRIVATE_KEY = "ImageKit private key missing"
-
-MISSING_PUBLIC_KEY = "ImageKit public key missing"
-
-MISSING_URL_ENDPOINT = "ImageKit URL Endpoint missing. Default URL Endpoint: https://ik.imagekit.io/<YOUR_IMAGEKIT_ID>/"

data/lib/imagekit/constants/file.rb

@@ -1,5 +0,0 @@
-VALID_FILE_OPTIONS = %w[path fileType tags includeFolder name limit skip]
-
-VALID_FILE_DETAIL_OPTIONS = ["fileID"]
-
-VALID_UPLOAD_OPTIONS = %w[file file_name use_unique_file_name tags folder is_private_file custom_coordinates response_fields]

data/lib/imagekit/constants/supported_transformation.rb

@@ -1,57 +0,0 @@
-SUPPORTED_TRANS = {
-  'height': "h",
-  'width': "w",
-  'aspect_ratio': "ar",
-  'quality': "q",
-  'crop': "c",
-  'crop_mode': "cm",
-  'x': "x",
-  'y': "y",
-  'focus': "fo",
-  'format': "f",
-  'radius': "r",
-  'background': "bg",
-  'border': "b",
-  'rotation': "rt",
-  'blur': "bl",
-  'named': "n",
-  'overlay_image': "oi",
-  'overlay_image_trim': "oit",
-  'overlay_image_cropping': "oic",
-  'overlay_image_quality': "oiq",
-  'overlay_image_DPR': "oidpr",
-  'overlay_image_border': "oib",
-  'overlay_image_background': "oibg",
-  'overlay_image_aspect_ratio': "oiar",
-  'overlay_x': "ox",
-  'overlay_y': "oy",
-  'overlay_focus': "ofo",
-  'overlay_height': "oh",
-  'overlay_width': "ow",
-  'overlay_text': "ot",
-  'overlay_text_font_size': "ots",
-  'overlay_text_font_family': "otf",
-  'overlay_text_encoded': "ote",
-  'overlay_text_color': "otc",
-  'overlay_text_width': "otw",
-  'overlay_text_background': "otbg",
-  'overlay_text_padding': "otp",
-  'overlay_text_inner_alignment': "otia",
-  'overlay_text_transparency': "oa",
-  'overlay_alpha': "oa",
-  'overlay_radius': "or",
-  'overlay_text_typography': "ott",
-  'overlay_background': "obg",
-  'progressive': "pr",
-  'lossless': "lo",
-  'trim': "t",
-  'metadata': "md",
-  'color_profile': "cp",
-  'default_image': "di",
-  'dpr': "dpr",
-  'effect_sharpen': "e-sharpen",
-  'effect_usm': "e-usm",
-  'effect_contrast': "e-contrast",
-  'effect_gray': "e-grayscale",
-  'original': "orig",
-}

data/lib/imagekit/constants/url.rb

@@ -1,9 +0,0 @@
-class URL
-  # Default URL Constants
-  BASE_URL = "https://api.imagekit.io/v1/files"
-  PURGE_CACHE = "/purge"
-  BULK_FILE_DELETE = "/batch/deleteByFileIds"
-  UPLOAD = "/upload"
-  REMOTE_METADATA_FULL_URL = "https://api.imagekit.io/v1/metadata"
-
-end

data/lib/imagekit/file.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./constants/errors"
-require_relative "./constants/file"
-require_relative "./constants/url"
-
-require_relative "./utils/formatter"
-
-class ImageKitFile
-  # This File class holds file related operations like
-  # upload, list etc
-  def initialize(req_obj)
-    @req_obj = req_obj
-  end
-
-  def upload(file, file_name, options)
-    # uploads files with required arguments
-    # supports bot url and binary
-    raise ArgumentError, MISSING_UPLOAD_FILE_PARAMETER unless file
-    raise ArgumentError, MISSING_UPLOAD_FILE_PARAMETER unless file_name
-    options = validate_upload_options(options || {})
-    if options.is_a?(FalseClass)
-      raise ArgumentError, "Invalid Upload option"
-    else
-      headers = @req_obj.create_headers
-      payload = {multipart: true, file: file, fileName: file_name}.merge(options)
-
-      url = "#{URL::BASE_URL}#{URL::UPLOAD}"
-      @req_obj.request("post", url, headers, payload)
-    end
-  end
-
-  def update_details(file_id, options)
-    # Update file detail by file_id and options
-
-    unless (options.key? :tags) || (options.key? :custom_coordinates)
-      raise ArgumentError, UPDATE_DATA_MISSING
-    end
-    unless options.fetch(:tags, []).is_a?(Array)
-      raise ArgumentError, UPDATE_DATA_TAGS_INVALID
-    end
-    unless options.fetch(:custom_coordinates, "").is_a?(String)
-      raise ArgumentError, UPDATE_DATA_COORDS_INVALID
-    end
-    url = "#{URL::BASE_URL}/#{file_id}/details/"
-    headers = @req_obj.create_headers
-    payload = request_formatter(options)
-    @req_obj.request("patch", url, headers, payload.to_json)
-  end
-
-  def list(options)
-    #  returns list of files on ImageKit Server
-    #  :options dictionary of options
-    formatted_options = request_formatter(options)
-    raise KeyError(LIST_FILES_INPUT_MISSING) unless formatted_options.is_a?(Hash)
-    url = URL::BASE_URL
-    headers = @req_obj.create_headers.update({params: options})
-    @req_obj.request("get", url, headers, options)
-  end
-
-  def details(file_identifier)
-    # Get detail of file by file_identifier
-    url = "#{URL::BASE_URL}/#{file_identifier}/details/"
-    headers = @req_obj.create_headers
-    @req_obj.request("get", url, headers)
-  end
-
-  def get_metadata(file_id)
-    # Get metadata of a file by file_id
-    url = "#{URL::BASE_URL}/#{file_id}/metadata"
-    @req_obj.request("get", url, @req_obj.create_headers)
-  end
-
-  def delete(file_id)
-    # Delete a file_id by file_id
-    url = "#{URL::BASE_URL}/#{file_id}"
-    headers = @req_obj.create_headers
-    @req_obj.request("delete", url, headers)
-  end
-
-  def batch_delete(file_ids)
-    url = "#{URL::BASE_URL}#{URL::BULK_FILE_DELETE}"
-    payload = {'fileIds': file_ids}
-    @req_obj.request("post", url, @req_obj.create_headers, payload.to_json)
-  end
-
-  def purge_cache(file_url)
-
-    # purges cache from server by file_url
-
-    url = "#{URL::BASE_URL}/purge"
-    payload = {'url': file_url}
-    @req_obj.request("post", url, @req_obj.create_headers, payload)
-  end
-
-  def purge_cache_status(request_id)
-    # This function is to get cache_status
-    url = "#{URL::BASE_URL}/purge/#{request_id}"
-    @req_obj.request("get", url, @req_obj.create_headers)
-  end
-
-  def get_metadata_from_remote_url(remote_file_url)
-    if remote_file_url == ""
-      raise ArgumentError, "remote_file_url is required"
-    end
-    url = "#{URL::REMOTE_METADATA_FULL_URL}?url=#{remote_file_url}"
-    @req_obj.request("get", url, @req_obj.create_headers)
-  end
-
-  def validate_upload_options(options)
-
-    #  Validates upload value, checks if params are valid,
-    #  changes snake to camel case which is supported by
-    #  ImageKit server
-
-
-    response_list = []
-    options.each do |key, val|
-      if VALID_UPLOAD_OPTIONS.include?(key.to_s)
-        if val.is_a?(Array)
-          val = val.join(",")
-        end
-        if val.is_a?(TrueClass) || val.is_a?(FalseClass)
-          val = val.to_s
-        end
-        options[key] = val
-      else
-        return false
-      end
-    end
-    request_formatter(options)
-  end
-end

data/lib/imagekit/imagekit.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-$VERBOSE = nil
-
-require_relative "./resource"
-require_relative "./file"
-require_relative "./url"
-require_relative "./utils/calculation"
-
-module ImageKit
-  class Error < StandardError
-  end
-
-  # ImageKit class holds each method will be used by user
-  class ImageKitClient
-    attr_reader :file
-
-    def initialize(private_key, public_key, url_endpoint, transformation_pos = nil, options = nil)
-
-      unless(private_key.is_a?(String) && private_key.to_s.strip.length != 0)
-        raise ArgumentError, MISSING_PRIVATE_KEY
-      end
-      unless(public_key.is_a?(String) && public_key.to_s.strip.length != 0)
-        raise ArgumentError, MISSING_PUBLIC_KEY
-      end
-      unless(url_endpoint.is_a?(String) && url_endpoint.to_s.strip.length != 0)
-        raise ArgumentError, MISSING_URL_ENDPOINT
-      end
-
-      @private_key = private_key
-      @public_key = public_key
-      @url_endpoint = url_endpoint
-      @transformation_position = transformation_pos
-      @options = options
-
-      @ik_req = ImageKitRequest.new(private_key, public_key, url_endpoint)
-      @file = ImageKitFile.new(@ik_req)
-      @url_obj = Url.new(@ik_req)
-
-    end
-
-    def set_ik_request(ik_req)
-      # setter for imagekit request mainly will be used for
-      # test
-      @ik_req = ik_req
-    end
-
-    def url(options)
-      @url_obj.generate_url(options)
-    end
-
-    def upload_file(file = nil, file_name = nil, options = nil)
-      # upload file to imagekit server
-      @file.upload(file, file_name, options)
-    end
-
-    def list_files(options)
-      # list all files
-      @file.list(options)
-    end
-
-    def get_file_details(file_identifier)
-      # Get file detail by file-id or file_url
-      @file.details(file_identifier)
-    end
-
-    def update_file_details(file_id, options)
-      # update file details by file id and other options payload
-      @file.update_details(file_id, options)
-    end
-
-    def delete_file(file_id)
-      # Delete a file by file-id
-      @file.delete(file_id)
-    end
-
-    def bulk_file_delete(file_ids)
-      # Delete file in bulks by list of file id
-      @file.batch_delete(file_ids)
-    end
-
-    def get_file_metadata(file_id)
-      # Get metadata of a file by file-id
-      @file.get_metadata(file_id)
-    end
-
-    def purge_file_cache(file_url)
-      # Purge cache from ImageKit server by file_url
-      @file.purge_cache(file_url)
-    end
-
-    def purge_file_cache_status(request_id)
-      @file.purge_cache_status(request_id.to_s)
-    end
-
-    def get_remote_file_url_metadata(remote_file_url = "")
-      @file.get_metadata_from_remote_url(remote_file_url)
-    end
-
-    # Get metadata from remote_file_url
-    # param remote_file_url: url string of remote file
-
-    def phash_distance(first, second)
-      # Get hamming distance between two phash(image hash) to check
-      # similarity between images
-      if first.to_s.strip == "" || second.to_s.strip == ""
-        raise ArgumentError, Error::MISSING_PHASH_VALUE
-      end
-      hamming_distance(first, second)
-    end
-
-    def get_authentication_parameters(token = nil, expire = nil)
-      # Get Authentication params
-      get_authenticated_params(token, expire, @ik_req.private_key)
-    end
-  end
-end

data/lib/imagekit/resource.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "base64"
-require "rest-client"
-require "json"
-require_relative "./constants/defaults"
-
-# ImageKitRequest requests and sends data from server
-class ImageKitRequest
-  attr_reader :private_key, :public_key, :url_endpoint, :transformation_position, :options
-
-  def initialize(private_key, public_key, url_endpoint, transformation_position = nil, options = nil)
-    @private_key = private_key
-    @public_key = public_key
-    @url_endpoint = url_endpoint
-    @transformation_position = transformation_position || Default::TRANSFORMATION_POSITION
-    @options = options || {}
-  end
-
-  # creates required headers
-  def create_headers
-    headers = {'Accept-Encoding': "application/json", 'Content-Type': "application/json"}
-    headers.update(auth_headers)
-  end
-
-  def auth_headers
-    encoded_private_key = Base64.strict_encode64(@private_key+":")
-    {Authorization: "Basic #{encoded_private_key}"}
-  end
-
-  # request method communicates with server
-  def request(method, url, headers = nil, payload = nil)
-    headers ||= create_headers
-    response = {response: nil, error: nil}
-    begin
-      resp = RestClient::Request.new(method: method,
-                                     url: url,
-                                     headers: headers,
-                                     payload: payload).execute
-
-      if (resp.code >= 200) && (resp.code < 204)
-        if (resp.headers[:content_type].include? "application/json")
-          response[:response] = JSON.parse(resp.body.to_s)
-        else
-          raise =RestClient::ExceptionWithResponse
-        end
-      elsif resp.code == 204
-        response[:response] = {'success': true}
-      end
-
-    rescue RestClient::ExceptionWithResponse => err
-      err.http_code == 404 ? response[:error] = {'message': err.response.to_s} : JSON.parse(err.response)
-    end
-    response
-  end
-end

data/lib/imagekit/sdk/version.rb

@@ -1,5 +0,0 @@
-module Imagekit
-  module Sdk
-    VERSION = '1.0.8'
-  end
-end