snapimage 0.1.1 → 0.2.0

data/lib/snapimage/server_actions/server_actions.authorize.rb

@@ -1,69 +0,0 @@
-module SnapImage
-  module ServerActions
-    module Authorize
-      def get_token(role)
-        @request.json["#{role}_security_token"]
-      end
-
-      # Arguments:
-      # * role:: Can be either :client or :server
-      def token_available?(role)
-        !!get_token(role)
-      end
-
-      # A string is generated using
-      # * role:: "client" or "server"
-      # * date:: Date in the format "YYYY-MM-DD"
-      # * salt:: A shared salt
-      # * resource_id:: The resource's identifier
-      # and concatenated as "role:date:salt:resource_id".
-      #
-      # A SHA1 digest is generated off of the string to create a token.
-      #
-      # 3 tokens are generated: [yesterday, today, tomorrow].
-      def generate_tokens(role)
-        salt = @config["security_salt"]
-        now = Time.now
-        yesterday = (now - 24*60*60).strftime("%Y-%m-%d")
-        today = now.strftime("%Y-%m-%d")
-        tomorrow = (now + 24*60*60).strftime("%Y-%m-%d")
-        resource_id = @request.json["resource_identifier"]
-        [
-          Digest::SHA1.hexdigest("#{role}:#{yesterday}:#{salt}:#{resource_id}"),
-          Digest::SHA1.hexdigest("#{role}:#{today}:#{salt}:#{resource_id}"),
-          Digest::SHA1.hexdigest("#{role}:#{tomorrow}:#{salt}:#{resource_id}")
-        ]
-      end
-
-      # If "security_salt" is set in the config, authorization is performed.
-      #
-      # A string is generated using
-      # * role:: "client" or "server"
-      # * date:: Date in the format "YYYY-MM-DD"
-      # * salt:: A shared salt
-      # * resource_id:: The resource's identifier
-      # and concatenated as "role:date:salt:resource_id".
-      #
-      # A SHA1 digest is generated off of the string to create a token. A token
-      # for yesterday, today, and tomorrow are generated and used to compare
-      # with the security token.
-      #
-      # When authorization fails, an error is raised. Authorization can fail in
-      # 2 ways.
-      # * AuthorizationRequired:: The role's security token is missing
-      # * AuthorizationFailed:: The security token did not match the generated token
-      #
-      # If authorization is successful, true is returned.
-      #
-      # Arguments:
-      # * role:: Can be either :client or :server
-      def authorize(role)
-        if @config["security_salt"]
-          raise SnapImage::AuthorizationRequired unless token_available?(role)
-          raise SnapImage::AuthorizationFailed unless generate_tokens(role).include?(get_token(role))
-        end
-        return true
-      end
-    end
-  end
-end

data/lib/snapimage/server_actions/server_actions.delete_resource_images.rb

@@ -1,23 +0,0 @@
-module SnapImage
-  module ServerActions
-    class DeleteResourceImages
-      include SnapImage::ServerActions::Authorize
-
-      def initialize(config, request, response)
-        @config = config
-        @storage = config.storage
-        @request = request
-        @response = response
-      end
-
-      def call
-        authorize(:server)
-        @response.set_success(
-          message: "Delete Resource Images Successful",
-          deleted_image_urls: @storage.delete_resource_images(@request.json["resource_identifier"])
-        )
-        @response
-      end
-    end
-  end
-end

data/lib/snapimage/server_actions/server_actions.generate_image.rb

@@ -1,169 +0,0 @@
-module SnapImage
-  module ServerActions
-    class GenerateImage
-      include SnapImage::ServerActions::Authorize
-
-      def initialize(config, request, response)
-        @config = config
-        @storage = config.storage
-        @request = request
-        @response = response
-      end
-
-      def call
-        authorize(:client)
-        if request_valid?
-          image = get_image_for_modification
-          parts = SnapImage::ImageNameUtils.get_image_name_parts(image.public_url)
-          result = modify_image(image)
-          modified_image = result[:image]
-          modified_image_name = result[:name]
-          stored_image = @storage.add_image(modified_image, modified_image_name, @request.json["resource_identifier"])
-          @response.set_success(
-            message: "Get Modified Image Successful",
-            image_url: stored_image.public_url,
-            image_width: stored_image.width,
-            image_height: stored_image.height
-          )
-          # Release memory.
-          GC.start
-        else
-          @response.set_bad_request
-        end
-        @response
-      end
-
-      private
-
-      # Returns true if the request is valid. False otherwise.
-      def request_valid?
-        source_image_defined?
-      end
-
-      # Returns true if either "file" or JSON "url" is defined.
-      def source_image_defined?
-        !!(@request.file || @request.json["url"])
-      end
-
-      # Returns true if the image is being uploaded. False otherwise.
-      def upload?
-        @request.file || !@storage.local?(@request.json["url"])
-      end
-
-      # Returns true if cropping is required. False otherwise.
-      def crop?
-        @request.json["crop_x"] || @request.json["crop_y"] || @request.json["crop_width"] || @request.json["crop_height"]
-      end
-
-      # Returns true if all the cropping values are defined. False otherwise.
-      def crop_valid?
-        @request.json["crop_x"] && @request.json["crop_y"] && @request.json["crop_width"] && @request.json["crop_height"]
-      end
-
-      # Returns true if resizing is required. False otherwise.
-      def resize?
-        @request.json["width"] || @request.json["height"]
-      end
-
-      # Returns true if the image is too large and needs to be resized to fit.
-      # False otherwise.
-      def resize_to_fit?(image)
-        image.width > get_max_width || image.height > get_max_height
-      end
-
-      # Returns true if sharpening is required. False otherwise
-      def sharpen?
-        @request.json["sharpen"]
-      end
-
-      # Gets the max width. Takes the lesser of the JSON "max_width" or the
-      # server max width.
-      def get_max_width
-        server_max_width = @config["max_width"]
-        [(@request.json["max_width"] && @request.json["max_width"].to_i || server_max_width), server_max_width].min
-      end
-
-      # Gets the max height. Takes the lesser of the JSON "max_height" or the
-      # server max height.
-      def get_max_height
-        server_max_height = @config["max_height"]
-        [(@request.json["max_height"] && @request.json["max_height"].to_i || server_max_height), server_max_height].min
-      end
-
-      def get_image_for_modification
-        if upload?
-          # Add the image to the storage.
-          if @request.file
-            image = @storage.add_upload(@request.file, @request.json["resource_identifier"])
-          else
-            image = @storage.add_url(@request.json["url"], @request.json["resource_identifier"])
-          end
-        else
-          # Get the base image.
-          raise SnapImage::InvalidImageIdentifier unless SnapImage::ImageNameUtils.valid?(@request.json["url"])
-          image = @storage.get(SnapImage::ImageNameUtils.get_base_image_path(@request.json["url"]))
-        end
-        image
-      end
-
-      # Arguments:
-      # * image:: SnapImage::Image object that represents the base image
-      def modify_image(image)
-        parts = SnapImage::ImageNameUtils.get_image_name_parts(image.public_url)
-
-        # Crop.
-        cropped = crop?
-        crop = nil
-        if cropped
-          raise SnapImage::BadRequest, "Missing crop values." unless crop_valid?
-          crop = {
-            x: @request.json["crop_x"],
-            y: @request.json["crop_y"],
-            width: @request.json["crop_width"],
-            height: @request.json["crop_height"]
-          }
-          image.crop(crop[:x], crop[:y], crop[:width], crop[:height])
-        end
-
-        # Resize.
-        resized = resize?
-        if resized
-          width = @request.json["width"] && @request.json["width"].to_i
-          height = @request.json["height"] && @request.json["height"].to_i
-          if width && height
-            # When both width and height are specified, resize without
-            # maintaining the aspect ratio.
-            image.resize(width, height, false)
-          else
-            # When only one of width/height is specified, set the other to the
-            # max and maintain the aspect ratio.
-            image.resize(width || @config["max_width"], height || @config["max_height"])
-          end
-        end
-
-        # Resize to fit.
-        resized_to_fit = resize_to_fit?(image)
-        image.resize(get_max_width, get_max_height) if resized_to_fit
-
-        # Sharpen.
-        sharpened = sharpen?
-        image.sharpen if sharpened
-
-        # Get the dimensions at the end.
-        if cropped || resized || resized_to_fit || sharpened
-          modifications = {
-            crop: crop || { x: 0, y: 0, width: parts[:original_dimensions][0], height: parts[:original_dimensions][1] },
-            width: image.width,
-            height: image.height,
-            sharpen: sharpened
-          }
-          name = SnapImage::ImageNameUtils.generate_image_name(parts[:original_dimensions][0], parts[:original_dimensions][1], parts[:extname], {basename: parts[:basename]}.merge(modifications))
-        else
-          name = parts[:filename]
-        end
-
-        { image: image, name: name }
-      end
-    end
-  end
-end

data/lib/snapimage/server_actions/server_actions.list_resource_images.rb

@@ -1,23 +0,0 @@
-module SnapImage
-  module ServerActions
-    class ListResourceImages
-      include SnapImage::ServerActions::Authorize
-
-      def initialize(config, request, response)
-        @config = config
-        @storage = config.storage
-        @request = request
-        @response = response
-      end
-
-      def call
-        authorize(:server)
-        @response.set_success(
-          message: "List Resource Images Successful",
-          image_urls: @storage.get_resource_urls(@request.json["resource_identifier"])
-        )
-        @response
-      end
-    end
-  end
-end

data/lib/snapimage/server_actions/server_actions.sync_resource.rb

@@ -1,78 +0,0 @@
-module SnapImage
-  module ServerActions
-    class SyncResource
-      include SnapImage::ServerActions::Authorize
-
-      def initialize(config, request, response)
-        @config = config
-        @storage = config.storage
-        @request = request
-        @response = response
-      end
-
-      def call
-        authorize(:server)
-        if request_valid?
-          @response.set_success(
-            message: "Image Sync Successful",
-            deleted_image_urls: sync
-          )
-        else
-          @response.set_bad_request
-        end
-        @response
-      end
-
-      private
-
-      # Returns true if the request is valid. False otherwise.
-      def request_valid?
-        !!(content_valid? && @request.json["sync_date_time"])
-      end
-
-      # Returns true if "content" in the request is valid. False otherwise.
-      def content_valid?
-        content = @request.json["content"]
-        !!(content && content.is_a?(Hash) && !content.empty?)
-      end
-
-      # Concatenates all the content and returns it.
-      def get_content
-        @request.json["content"].values.inject("") { |result, element| result + element }
-      end
-
-      def urls_to_keep
-        content = get_content
-        keep = {}
-        @storage.url_regexps.each do |regexp|
-          # We use #scan instead of #match because #match returns only the
-          # first match. #scan will return all matches that don't overlap.
-          # However, #scan does not behave like #match. If the regexp contains
-          # groupings, #scan returns only the matched groups. Otherwise, it
-          # returns the entire match.
-          # To normalize, we take the given regexp and always wrap it in a
-          # group to ensure that the regexp always has a group and we always
-          # get back the entire match.
-          content.scan(Regexp.new("(#{regexp.source})", regexp.options)).each do |match|
-            keep[match[0]] = true
-            # If the image is modified, make sure to keep the base image too.
-            if !SnapImage::ImageNameUtils.base_image?(match[0])
-              keep[SnapImage::ImageNameUtils.get_base_image_path(match[0])] = true
-            end
-          end
-        end
-        keep.keys
-      end
-
-      def sync
-        urls_to_delete = @storage.get_resource_urls(
-          @request.json["resource_identifier"],
-          # DateTime only deals with years and days. We need to convert to a
-          # Time first to handle seconds, then convert back to a DateTime.
-          (DateTime.parse(@request.json["sync_date_time"]).to_time - 3).to_datetime
-        ) - urls_to_keep
-        urls_to_delete.each { |url| @storage.delete(url) }
-      end
-    end
-  end
-end

data/lib/snapimage/storage/storage.rb

@@ -1,120 +0,0 @@
-module SnapImage
-  class Storage
-    TYPES = %w{LOCAL}
-    FILE_TYPES = %w{png jpg gif}
-
-
-    def initialize(server_configs, primary_server_name, max_width, max_height)
-      @server_configs = server_configs
-      # TODO: Remove this once we figure out how to handle multiple servers.
-      raise SnapImage::InvalidConfig, "Only one storage server can be specified at the moment" unless @server_configs.size == 1
-      @primary_server_name = primary_server_name
-      @max_width = max_width
-      @max_height = max_height
-    end
-
-    # Returns an array of all the url regexps that are handled by the storage.
-    def url_regexps
-      @url_regexps ||= servers.values.map { |s| s.url_regexp }
-    end
-
-    # Returns true if the url is local to the storage. False otherwise.
-    def local?(url)
-      !!get_server_by_url(url)
-    end
-
-    # Adds the image to the storage and returns the public url to the file.
-    # Arguments:
-    # * file:: SnapImage::RequestFile
-    # * resource_id:: Resource identifier
-    def add_upload(file, resource_id)
-      raise UnknownFileType, "Unknown file type for upload: #{file.type}" unless FILE_TYPES.include?(file.type)
-      primary_server.store_file(file.file, file.type, resource_id)
-    end
-
-    # Adds the image to the storage from the url.
-    # If the image is from a storage server, nothing happens.
-    # If the image is from another place, the image is downloaded and added to
-    # the primary storage server.
-    # The image is returned.
-    # Arguments:
-    # * url:: A full url to the image
-    # * resource_id:: Resource identifier
-    def add_url(url, resource_id)
-      # If the url is local, then the image should already be in the storage.
-      return get(url) if get_server_by_url(url)
-      type = ImageNameUtils.get_image_type(url)
-      raise UnknownFileType, "Unknown file type for upload: #{type}" unless FILE_TYPES.include?(type)
-      primary_server.store_url(url, type, resource_id)
-    end
-
-    # Adds the image to the storage.
-    # Arguments:
-    # * image:: SnapImage::Image object
-    # * name:: Name of the image
-    # * resource_id:: Resource identifier
-    def add_image(image, name, resource_id)
-      primary_server.store_image(image, name, resource_id)
-    end
-
-    # Returns a SnapImage::Image using the url.
-    def get(url)
-      get_server_by_url(url).get(url)
-    end
-
-    # Returns all the image urls for the given resource in the storage.
-    # Arguments:
-    # * resource_id:: Filter by resource identifier
-    # * timestamp:: Only images that were updated before the DateTime
-    def get_resource_urls(resource_id, timestamp = nil)
-      servers.values.inject([]) { |urls, server| urls + server.get_resource_urls(resource_id, timestamp) }
-    end
-
-    # Deletes the given url from the storage.
-    # Arguments:
-    # * url:: URL to delete
-    def delete(url)
-      get_server_by_url(url).delete(url)
-    end
-
-    # Deletes all the image related to the resource.
-    # Arugments:
-    # * resource_id:: Resource identifier
-    def delete_resource_images(resource_id)
-      deleted_urls = []
-      servers.each do |name, server|
-        deleted_urls += server.delete_resource_images(resource_id)
-      end
-      deleted_urls
-    end
-
-    private
-
-    def servers
-      return @servers if @servers
-      @servers = {}
-      @server_configs.each do |config|
-        type = config["type"]
-        @servers[config["name"]] = get_server_class(type).new(config.merge("max_width" => @max_width, "max_height" => @max_height))
-      end
-      @servers
-    end
-
-    def primary_server
-      servers[@primary_server_name]
-    end
-
-    def get_server_class(type)
-      raise SnapImage::InvalidStorageConfig, "Storage server type not supported: #{type}" unless TYPES.include?(type)
-      klassname = type.downcase.split("_").map { |t| t.capitalize }.join("")
-      SnapImage::StorageServer.const_get(klassname)
-    end
-
-    def get_server_by_url(url)
-      servers.each do |name, server|
-        return server if server.local?(url)
-      end
-      return nil
-    end
-  end
-end