filestack 2.0.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec 'irb -r filestack/filestack -I ./lib'
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/bin/console

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

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+puts lib
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "filestack/ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "filestack"
+  spec.version       = Filestack::Ruby::VERSION
+  spec.authors       = ["Filestack"]
+  spec.email         = ["dev@filestack.com"]
+
+  spec.summary       = %q{Official Ruby SDK for the Filestack API}
+  spec.description   = %q{This is the official Ruby SDK for Filestack - API and content management system that makes it easy to add powerful file uploading and transformation capabilities to any web or mobile application.}
+  spec.homepage      = "https://github.com/filestack/filestack-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|test-files)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "unirest", "~> 1.1.2"
+  spec.add_dependency "parallel", "~> 1.11.2"
+  spec.add_dependency "mimemagic", "~> 0.3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+end

data/lib/filestack.rb

@@ -0,0 +1,5 @@
+require 'filestack/models/filelink'
+require 'filestack/models/filestack_client'
+require 'filestack/models/filestack_security'
+require 'filestack/utils/utils'
+require 'filestack/models/filestack_transform'

data/lib/filestack/config.rb

@@ -0,0 +1,36 @@
+require 'filestack/ruby/version'
+
+include Filestack
+
+class FilestackConfig
+  API_URL = 'https://www.filestackapi.com/api'.freeze
+  CDN_URL = 'https://cdn.filestackcontent.com'.freeze
+  PROCESS_URL = 'https://process.filestackapi.com'.freeze
+
+  MULTIPART_START_URL = 'https://upload.filestackapi.com/multipart/start'.freeze
+  MULTIPART_UPLOAD_URL = 'https://upload.filestackapi.com/multipart/upload'.freeze
+  MULTIPART_COMPLETE_URL = 'https://upload.filestackapi.com/multipart/complete'.freeze
+
+  MULTIPART_PARAMS = %w[
+    store_location store_region store_container
+    store_path store_access
+  ].freeze
+
+  DEFAULT_CHUNK_SIZE = 5 * 1024**2
+  VERSION = Filestack::Ruby::VERSION
+  HEADERS = {
+    'User-Agent' => "filestack-ruby #{VERSION}",
+    'Filestack-Source' => "Ruby-#{VERSION}"
+  }.freeze
+end
+
+class TransformConfig
+  TRANSFORMATIONS = %w[
+    resize crop rotate flip flop watermark detect_faces
+    crop_faces pixelate_faces round_corners vignette polaroid
+    torn_edges shadow circle border sharpen blur monochrome
+    blackwhite sepia pixelate oil_paint negative modulate
+    partial_pixelate partial_blur collage upscale enhance
+    redeye ascii filetype_conversion quality
+  ].freeze
+end

data/lib/filestack/mixins/filestack_common.rb

@@ -0,0 +1,93 @@
+require 'filestack/config'
+require 'filestack/utils/utils'
+require 'filestack/utils/multipart_upload_utils'
+require 'mimemagic'
+
+# Module is mixin for common functionalities that all Filestack
+# objects can call.
+module FilestackCommon
+  include UploadUtils
+  # Get the contents of a Filestack handle
+  #
+  # @param [String]             file_handle   The Filelink handle
+  # @param [FilestackSecurity]  security      Optional Filestack security object
+  #                                           if security is enabled
+  #
+  # @return [Bytes]
+  def send_get_content(url, parameters: nil)
+    UploadUtils.make_call(url, 'get', parameters: parameters)
+  end
+
+  # Get the content of a filehandle
+  #
+  # @param [String]             filepath      Local path of file to be written
+  #
+  # @return [Int]                             Size of file written
+  def send_download(filepath)
+    content = send_get_content(url)
+    File.write(filepath, content.body)
+  end
+
+  # Send the delete api request to delete a filelink
+  #
+  # @param [String]             url           The url of the Filehandle
+  #                                           to be deleted (includes security)
+  #
+  # @return [unirest::Response]
+  def send_delete(handle, apikey, security)
+    return 'Delete requires security' if security.nil?
+    signature = security.signature
+    policy = security.policy
+    base = "#{FilestackConfig::API_URL}/file"
+    UploadUtils.make_call(
+      "#{base}/#{handle}?key=#{apikey}&signature=#{signature}&policy=#{policy}",
+      'delete'
+    )
+  end
+
+  # Send the overwrite api request to update a filelink
+  #
+  # @param [String]             filepath      Filepath of file to upload
+  # @param [String]             handle        The Filelink handle
+  # @param [String]             apikey        Filestack API Key
+  # @param [FilestackSecurity]  security      Filestack security object
+  #
+  # @return [Typhoeus::Response]
+  def send_overwrite(filepath, handle, apikey, security)
+    return 'Overwrite requires security' if security.nil?
+
+    file = File.open(filepath, 'r')
+    mimetype = MimeMagic.by_magic(file)
+    content = file.read
+
+    signature = security.signature
+    policy = security.policy
+
+    headers = { 'Content-Type' => mimetype }
+    base = "#{FilestackConfig::API_URL}/file"
+
+    UploadUtils.make_call(
+      "#{base}/#{handle}?key=#{apikey}&signature=#{signature}&policy=#{policy}",
+      'put',
+      headers: headers,
+      parameters: content
+    )
+  end
+
+  # Get tags or sfw content from a filelink
+  #
+  # @param [String]              task         'tags' or 'sfw'
+  # @param [String]              handle       The filehandle
+  # @param [Filestack::Security] security     Security object
+  #
+  # @return [Hash]
+  def send_tags(task, handle, security)
+    raise 'You must use security for tags' if security.nil?
+
+    policy = security.policy
+    signature = security.signature
+    url = "#{FilestackConfig::CDN_URL}/#{task}/"\
+      "security=signature:#{signature},policy:#{policy}/#{handle}"
+    UploadUtils.make_call(url, 'get').body[task]
+  end
+end

data/lib/filestack/models/filelink.rb

@@ -0,0 +1,89 @@
+require 'filestack/ruby/version'
+require 'filestack/config'
+require 'filestack/utils/utils'
+require 'filestack/models/filestack_transform'
+require 'filestack/mixins/filestack_common'
+
+# This class represents a file stored on your Filestack
+# storage.  Once initialized, you may perform transformations, conversions,
+# get metadata, update, or delete it.
+class Filelink
+  include FilestackCommon
+  include UploadUtils
+  attr_reader :handle, :apikey, :security
+
+  # Initialize Filelink
+  #
+  # @param [String]             file_handle   The Filelink handle
+  # @param [String]             apikey        Your Filestack API Key (optional)
+  # @param [FilestackSecurity]  security      Filestack security object, if
+  #                                           security is enabled.
+  def initialize(handle, apikey: nil, security: nil)
+    @handle = handle
+    @apikey = apikey
+    @security = security
+  end
+
+  # Get content of filelink
+  #
+  # @return [Bytes]
+  def get_content
+    send_get_content(url)
+  end
+
+  # Download Filelink
+  #
+  # @param [String]              filepath     The local destination of the
+  #                                           downloaded filelink
+  # @return [Unirest::Response]
+  def download(filepath)
+    send_download(filepath)
+  end
+
+  # Delete filelink
+  #
+  # @return [Unirest::Response]
+  def delete
+    send_delete(handle, apikey, security)
+  end
+
+  # Ovewrite filelink by uploading local file
+  #
+  # @param [String]             filepath      filepath of file to upload
+  #
+  # @return [Unirest::Response]
+  def overwrite(filepath)
+    send_overwrite(filepath, handle, apikey, security)
+  end
+
+  # Turn the filelink into a transform object to perform
+  # transform operations
+  #
+  # @return [Filestack::Transform]
+  def transform
+    Transform.new(handle: @handle, apikey: @apikey, security: @security)
+  end
+
+  # Return auto and user tags for the filelink
+  #
+  # @return [Hash]
+  def tags
+    send_tags('tags', @handle, @security)
+  end
+
+  # Return true (SFW) or false (NSFW)
+  #
+  # @return [Bool]
+  def sfw 
+    send_tags('sfw', @handle, @security)
+  end
+
+  # Get the URL of the Filelink
+  #
+  # @return [String]
+  def url
+    UploadUtils.get_url(
+      FilestackConfig::CDN_URL, handle: handle, security: security
+    )
+  end
+end

data/lib/filestack/models/filestack_av.rb

@@ -0,0 +1,32 @@
+require 'filestack/models/filelink'
+require 'filestack/utils/utils'
+
+# Class for AV objects -- allows to check status
+# and upgrade to filelink once completed
+class AV
+  include UploadUtils
+  attr_reader :apikey, :security
+
+  def initialize(url, apikey: nil, security: nil)
+    @url = url
+    @apikey = apikey
+    @security = security
+  end
+
+  # Turns AV into filelink if video conversion is complete
+  #
+  # @return [Filestack::Filelink]
+  def to_filelink
+    return 'Video conversion incomplete' unless status == 'completed'
+    response = UploadUtils.make_call(@url, 'get').body
+    handle = response['data']['url'].split('/').last
+    Filelink.new(handle, apikey: @apikey, security: @security)
+  end
+
+  # Checks the status of the video conversion
+  #
+  # @return [String]
+  def status
+    UploadUtils.make_call(@url, 'get').body['status']
+  end
+end

data/lib/filestack/models/filestack_client.rb

@@ -0,0 +1,55 @@
+require 'filestack/utils/multipart_upload_utils'
+require 'filestack/models/filestack_transform'
+require 'filestack/utils/utils'
+require './lib/filestack/'
+
+# The Filestack Client class acts as a hub for all
+# Filestack actions that do not require a file handle, including
+# uploading files (both local and external), initiating an external
+# transformation, and other tasks
+class Client
+  include MultipartUploadUtils
+  include UploadUtils
+  attr_reader :apikey, :security
+
+  # Initialize Client
+  #
+  # @param [String]               apikey        Your Filestack API key
+  # @param [FilestackSecurity]    security      A Filestack security object,
+  #                                             if security is enabled
+  def initialize(apikey, security: nil)
+    @apikey = apikey
+    @security = security
+  end
+
+  # Upload a local file or external url
+  # @param [String]               filepath         The path of a local file
+  # @param [String]               external_url     An external URL
+  # @param [Bool]                 multipart        Switch for miltipart
+  #                                                    (Default: true)
+  # @param [Hash]                 options          User-supplied upload options
+  #
+  # return [Filestack::Filelink]
+  def upload(filepath: nil, external_url: nil, multipart: true, options: nil, storage: 's3')
+    if filepath && external_url
+      return 'You cannot upload a URL and file at the same time'
+    end
+    response = if filepath && multipart
+                 multipart_upload(@apikey, filepath, @security, options)
+               else
+                 send_upload(
+                   @apikey,
+                   filepath: filepath,
+                   external_url: external_url,
+                   options: options,
+                   security: @security,
+                   storage: storage
+                 )
+               end
+    Filelink.new(response['handle'], security: @security, apikey: @apikey)
+  end
+
+  def transform_external(external_url)
+    Transform.new(external_url: external_url, security: @security, apikey: @apikey)
+  end
+end

data/lib/filestack/models/filestack_security.rb

@@ -0,0 +1,82 @@
+require 'base64'
+require 'json'
+require 'openssl'
+
+#
+# This class represents a Filestack Security object that you must passed
+# in with your calls if your account has security enabled.  You can manage
+# your Filestack app's security and secret by logging into the Filestack
+# Dev portal.
+#
+class FilestackSecurity
+  DEFAULT_EXPIRY = 3600
+
+  attr_accessor :policy, :signature
+
+  # Initialize FilestackSecurity object
+  #
+  # @param [String]   secret    Your filestack security secret
+  # @param [Hash]     options   Hash of options:
+  #                               call: The calls that you allow this policy to
+  #                                 make, e.g convert, exif, pick, read, remove,
+  #                                 stat, store, write, writeUrl
+  #                               container: (regex) store must match container
+  #                                 that the files will be stored under
+  #                               expiry: (timestamp) epoch_timestamp expire,
+  #                                 defaults to 1hr
+  #                               handle: specific file this policy can access
+  #                               maxSize: (number) maximum file size in bytes
+  #                                 that can be stored by requests with policy
+  #                               minSize: (number) minimum file size in bytes
+  #                                  that can be stored by requests with policy
+  #                               path: (regex) store must match the path that
+  #                                  the files will be stored under.
+  #                               url: (regex) subset of external URL domains
+  #                                  that are allowed to be image/document
+  #                                  sources for processing
+  def initialize(secret, options: {})
+    generate(secret, options)
+  end
+
+  # Generate the security policy and signature given a string and options
+  #
+  # @param [String]   secret    Your filestack security secret
+  # @param [Hash]     options   Hash of options - see constructor
+  def generate(secret, options)
+    policy_json = create_policy_string(options)
+    @policy = Base64.urlsafe_encode64(policy_json)
+    @signature = OpenSSL::HMAC.hexdigest('sha256', secret, policy)
+  end
+
+  # Sign the URL by appending policy and signature URL parameters
+  #
+  # @param [String]   url    The URL to sign
+  #
+  # @return [String]
+  def sign_url(url)
+    format('%s&policy=%s&signature=%s', url, policy, signature)
+  end
+
+  private
+
+  #
+  # Manage options and convert hash to json string
+  #
+  def create_policy_string(options)
+    options[:expiry] = expiry_timestamp(options)
+    options.to_json
+  end
+
+  #
+  # Get expiration timestamp by adding seconds in option or using default
+  #
+  def expiry_timestamp(options)
+    expiry_time = if options.key?(:expiry)
+                    options[:expiry]
+                  else
+                    FilestackSecurity::DEFAULT_EXPIRY
+                  end
+
+    Time.now.to_i + expiry_time
+  end
+end