ruby_imaginary 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8383208cd621d1d6595a360286fdd417683f5b13f641ce5e423df7b495b5976d
+  data.tar.gz: 50d684c30c146702a9368dc1607eb296ca0c2d128ca218421b2fc7f924e1152e
+SHA512:
+  metadata.gz: 1eabcf57165061ec8266e71ad9e272d545cf69ad7408a6dcfd7827eeee945789013e1375ae88079bb0e36efb1dc4816bef1eb48a77dac9da42262200dec94067
+  data.tar.gz: 3a13cf8530e59b527bc54e9e67386300b6c7780f040cee38f9a8f062ec3424102b2fcf0bf5e2fcdbbe3593d03db47825d24318b2edd1a816c39c4fb6826c8355

data/README.md

@@ -0,0 +1,64 @@
+# Imaginary Ruby
+Minimalist ruby gem which is programmatic stream capable interface for [imaginary](https://github.com/h2non/imaginary) server.
+
+Supports multiple image operations such as resize, crop, zoom, watermark, rotate... and both local and remote URL based image source processing.
+
+## Installation
+
+`gem install ruby_imaginary`
+
+or add the line below to your Gemfile
+
+`gem 'ruby_imaginary'`
+
+## Configurations
+
+You need to set the imaginary server address like this.
+```
+Imaginary.configure do |config|
+  # You could set it directly or getting it from ENV variables
+  config.server = 'http://localhost:9000/'
+end
+```
+
+Also for rails application you could create an initializer at `config/initializers/imaginary.rb`
+
+## Operations
+
+- Resize
+- Enlarge
+- Crop
+- SmartCrop (based on libvips built-in algorithm)
+- Rotate (with auto-rotate based on EXIF orientation)
+- Flip (with auto-flip based on EXIF metadata)
+- Flop
+- Zoom
+- Thumbnail
+- Fit
+- Blur
+- Watermark (customizable by text)
+- WatermarkImage
+
+All the options are as same as the imaginary server documentation.
+
+## How to Use
+
+Each of the operation above has a class under `Imaginary` module which accepts a hash for initializing.
+
+```
+options = {
+  file: './images/1.jpg',
+  text: 'MyBrand',
+}
+operation = Imaginary::Watermark.new(options)
+
+result = operation.result
+
+File.write('result.jpg', result)
+```
+
+Also before running the operation you could user the `valid?` method to make sure all the options are correct for this operation and avoid any failures.
+
+```
+operation.valid?
+```

data/lib/imaginary.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'imaginary/validators/key_validator.rb'
+require_relative 'imaginary/validators/option.rb'
+require_relative 'imaginary/validators/key_presence_validator.rb'
+
+require_relative 'imaginary/configuration.rb'
+require_relative 'imaginary/request_handler.rb'
+require_relative 'imaginary/operation.rb'
+
+require_relative 'imaginary/operations/blur.rb'
+require_relative 'imaginary/operations/convert.rb'
+require_relative 'imaginary/operations/crop.rb'
+require_relative 'imaginary/operations/enlarge.rb'
+require_relative 'imaginary/operations/extract.rb'
+require_relative 'imaginary/operations/fit.rb'
+require_relative 'imaginary/operations/flip.rb'
+require_relative 'imaginary/operations/flop.rb'
+require_relative 'imaginary/operations/resize.rb'
+require_relative 'imaginary/operations/rotate.rb'
+require_relative 'imaginary/operations/smart_crop.rb'
+require_relative 'imaginary/operations/thumbnail.rb'
+require_relative 'imaginary/operations/zoom.rb'
+require_relative 'imaginary/operations/watermark.rb'
+require_relative 'imaginary/operations/watermark_image.rb'
+
+require_relative 'imaginary/hash.rb'
+
+require_relative 'imaginary/exceptions/invalid_option.rb'
+
+require 'rest-client'
+
+module Imaginary
+end

data/lib/imaginary/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Imaginary module
+module Imaginary
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # configure class
+  class Configuration
+    attr_accessor :server
+  end
+end

data/lib/imaginary/exceptions/invalid_option.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Imaginary
+  class InvalidOption < StandardError
+  end
+end

data/lib/imaginary/hash.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Hash
+  def to_query_params
+    map do |k, v|
+      "#{k}=#{v}"
+    end.join('&')
+  end
+end

data/lib/imaginary/operation.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Imaginary
+  class Operation
+    attr_accessor :options
+    attr_accessor :file_input_address
+
+    include Imaginary::RequestHandler
+    extend Imaginary::Validators::KeyPresenceValidator
+
+    def file_input?
+      !file_input_address.nil?
+    end
+
+    def initialize(options)
+      self.file_input_address = options[:file]
+      options.delete(:file)
+      self.options = options
+    end
+
+    def valid?
+      self.class.validators.each do |v|
+        return false unless v.valid?(options)
+      end
+
+      true
+    end
+
+    def remote_action
+      self.class.name.split('::').last.downcase
+    end
+
+    def url
+      [
+        Imaginary.configuration.server,
+        remote_action,
+        '?',
+        options.to_query_params
+      ].join
+    end
+  end
+end

data/lib/imaginary/operations/blur.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Convert < Operation
+    exists? :type
+  end
+end

data/lib/imaginary/operations/convert.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Blur < Operation
+    exists? :sigma
+  end
+end

data/lib/imaginary/operations/crop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Crop < Operation
+    exists? :wdith, or: :height
+  end
+end

data/lib/imaginary/operations/enlarge.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Enlarge < Operation
+    exists? :wdith, and: :height
+  end
+end

data/lib/imaginary/operations/extract.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Extract < Operation
+    exists? :top, and: :areawidth
+  end
+end

data/lib/imaginary/operations/fit.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Fit < Operation
+    exists? :width, and: :height
+  end
+end

data/lib/imaginary/operations/flip.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Flip < Operation
+  end
+end

data/lib/imaginary/operations/flop.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Flop < Operation
+  end
+end

data/lib/imaginary/operations/resize.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Resize < Operation
+    exists? :width, or: :height
+  end
+end

data/lib/imaginary/operations/rotate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Rotate < Operation
+    exists? :rotate
+  end
+end

data/lib/imaginary/operations/smart_crop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class SmartCrop < Operation
+    exists? :width, or: :height
+  end
+end

data/lib/imaginary/operations/thumbnail.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Thumbnail < Operation
+    exists? :width, and: :height
+  end
+end

data/lib/imaginary/operations/watermark.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Watermark < Operation
+    exists? :text
+  end
+end

data/lib/imaginary/operations/watermark_image.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class WatermarkImage < Operation
+    exists? :image
+  end
+end

data/lib/imaginary/operations/zoom.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Imaginary module extended for crop support
+module Imaginary
+  class Zoom < Operation
+    exists? :factor
+  end
+end

data/lib/imaginary/request_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Imaginary
+  module RequestHandler
+    def result
+      raise InvalidOption unless valid?
+      return execute_with_file if file_input?
+
+      execute_with_url
+    end
+
+    private
+
+    def execute_with_file
+      RestClient.post url, file: File.new(file_input_address, 'rb')
+    end
+
+    def execute_with_url
+      RestClient.get url
+    end
+  end
+end

data/lib/imaginary/validators/key_presence_validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Imaginary
+  module Validators
+    module KeyPresenceValidator
+      def exists?(key, options = {})
+        validator_options = []
+        options.keys.each do |type|
+          validator_options << Option.new(type, options[type])
+        end
+        validators << KeyValidator.new(key, validator_options)
+      end
+
+      def validators
+        @validators ||= []
+      end
+    end
+  end
+end

data/lib/imaginary/validators/key_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Imaginary
+  module Validators
+    class KeyValidator
+      attr_accessor :options
+      attr_accessor :key
+
+      def initialize(key, options)
+        self.key = key
+        self.options = options
+      end
+
+      def valid?(object)
+        validation_resut = object.include?(key)
+        options.each do |option|
+          validation_resut = option.append(validation_resut, object)
+        end
+
+        validation_resut
+      end
+    end
+  end
+end

data/lib/imaginary/validators/option.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Imaginary
+  module Validators
+    class Option
+      attr_accessor :type
+      attr_accessor :key
+
+      def initialize(type, key)
+        raise 'Invalid Validator Option Type' unless %i[and or].include? type
+
+        self.type = type
+        self.key = key
+      end
+
+      def append(result, object)
+        return (result && object.include?(key)) if type == :and
+
+        result || object.include?(key)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruby_imaginary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amirhosein Zolfaghari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: Ruby client for imaginary service
+email: amirhosein.zlf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/imaginary.rb
+- lib/imaginary/configuration.rb
+- lib/imaginary/exceptions/invalid_option.rb
+- lib/imaginary/hash.rb
+- lib/imaginary/operation.rb
+- lib/imaginary/operations/blur.rb
+- lib/imaginary/operations/convert.rb
+- lib/imaginary/operations/crop.rb
+- lib/imaginary/operations/enlarge.rb
+- lib/imaginary/operations/extract.rb
+- lib/imaginary/operations/fit.rb
+- lib/imaginary/operations/flip.rb
+- lib/imaginary/operations/flop.rb
+- lib/imaginary/operations/resize.rb
+- lib/imaginary/operations/rotate.rb
+- lib/imaginary/operations/smart_crop.rb
+- lib/imaginary/operations/thumbnail.rb
+- lib/imaginary/operations/watermark.rb
+- lib/imaginary/operations/watermark_image.rb
+- lib/imaginary/operations/zoom.rb
+- lib/imaginary/request_handler.rb
+- lib/imaginary/validators/key_presence_validator.rb
+- lib/imaginary/validators/key_validator.rb
+- lib/imaginary/validators/option.rb
+homepage: https://gitlab.com/amirhosein.zlf/ruby_imaginary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for imaginary service
+test_files: []