alchemy_cloudinary 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6013eec238f7a1c44af91041e61a1f4c3f1ee8491f8a5aff6b70f67a3f9af8f
+  data.tar.gz: bb3387d30961d38a25be56fbce96d22c842c660821f853cd58a2e67d71f5e1de
+SHA512:
+  metadata.gz: 886357acc1f48531e783aa4db24ec103a32ab0328f696fe7c25b4a4fd75d78042b18fce61fce0e7a05f89789eadaf1808ea65bdb26f64840004e279f9e403869
+  data.tar.gz: 3f3cd82adf0f391be4f0c88477de99fdf72d7d587c47767a03bcd9d58162c66eabc5e9411874a6a63d7242a22a8f151e5d9f7239ade753694425c96701485373

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Thomas von Deyen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# AlchemyCMS Cloudinary Integration
+
+Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.
+
+* Easily upload images to the cloud.
+* Automatically perform smart image resizing, cropping and conversion without installing any complex software.
+* Images are seamlessly delivered through a fast CDN, and much much more.
+
+## Usage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy_cloudinary', github: 'AlchemyCMS/alchemy_cloudinary'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install alchemy_cloudinary
+```
+
+## Configuration
+
+To use the Cloudinary Ruby on Rails library, you have to configure at least:
+
+* `cloud_name`
+* `api_key`
+* `api_secret`
+
+Setting the configuration parameters can be done by:
+
+* programmatically in each call to a Cloudinary method
+* globally using config/cloudinary.yml configuration file
+
+  > **Warning**: In this case you must **exclude it** from version control system (git, etc). In `.gitignore` you can add `config/cloudinary.yml`
+
+* use a Rails initializer file.
+
+  You can place a file named `cloudinary.rb` in the `config/initializers` folder of your Rails project.
+
+  Here's some sample initializer code:
+
+  ```ruby
+  # config/initializer/cloudinary.rb
+  Cloudinary.config do |config|
+    config.cloud_name = 'sample'
+    config.api_key = '874837483274837'
+    config.api_secret = 'a676b67565c6767a6767d6767f676fe1'
+    config.secure = true
+    config.cdn_subdomain = true
+  end
+  ```
+
+* dynamically configure the `cloud_name`, `api_key`, and `api_secret` by defining the `CLOUDINARY_URL` environment variable.
+
+  The **configuration URL** is available in the Management Console's dashboard of your account.
+  When using Cloudinary through a PaaS add-on (e.g., **Heroku**), this environment variable is
+  **automatically** defined in your deployment environment.
+
+  Here's a sample value:
+
+  `CLOUDINARY_URL=cloudinary://874837483274837:a676b67565c6767a6767d6767f676fe1@sample`
+
+  > **Note**: If you use more than one configuration option, the order of precedence is:
+  `CLOUDINARY_URL` -> `cloud_name` -> `cloudinary.yml`
+
+## Resources
+
+* https://cloudinary.com/documentation/rails_integration
+* Sample projects - https://github.com/cloudinary/cloudinary_gem/tree/master/samples
+  * Basic Ruby sample.
+    Uploading local and remote images to Cloudinary and generating various transformation URLs.
+  * Basic Rails sample.
+    Uploading local and remote images in a Rails project while embedding various transformed images in a Rails web view.
+  * Rails Photo Album.
+   A fully working web application.
+   It uses CarrierWave to manage images of an album model (database).
+   Performs image uploading both from the server side and directly from the browser using a jQuery plugin.
+* https://rubygems.org/gems/cloudinary
+* https://github.com/cloudinary/cloudinary_gem
+* https://cloudinary.com/documentation/rails_image_and_video_upload
+* https://cloudinary.com/documentation/rails_image_manipulation
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/alchemy/picture/cloudinary_url.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Picture::CloudinaryUrl
+    def url(options = {})
+      @options = options
+      image_file.remote_url(transformation: transformations, secure: !!options[:secure])
+    end
+
+    private
+
+    def transformations
+      [crop_transformation, resize_transformation].compact
+    end
+
+    def crop_transformation
+      if @options[:crop] && @options[:crop_from].present?
+        {
+          crop: 'crop',
+          gravity: 'xy_center',
+          x: crop_coordinates[:x],
+          y: crop_coordinates[:y],
+          size: @options[:crop_size]
+        }
+      end
+    end
+
+    def resize_transformation
+      crop_mode = @options[:crop] ? 'fill' : @options[:upsample] ? 'fit' : 'limit'
+      if @options[:size]
+        {
+          crop: crop_mode,
+          size: @options[:size]
+        }
+      end
+    end
+
+    def crop_coordinates
+      x, y = @options[:crop_from].to_s.split('x')
+      size_x, size_y = @options[:crop_size].to_s.split('x')
+      {
+        x: (x.to_i + size_x.to_f / 2).round,
+        y: (y.to_i + size_y.to_f / 2).round
+      }
+    end
+  end
+end

data/lib/alchemy_cloudinary.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'alchemy_cloudinary/engine'

data/lib/alchemy_cloudinary/dragonfly_data_store.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'cloudinary'
+
+module AlchemyCloudinary
+  class DragonflyDataStore
+    def write(content, opts = {})
+      result = Cloudinary::Uploader.upload(content.file, {
+        public_id: name(content.name)
+      }.merge(opts))
+      "#{result['public_id']}.#{result['format']}"
+    end
+
+    def read(uid)
+      url = Cloudinary::Utils.cloudinary_url(public_id(uid), format: ext(uid) || 'jpg')
+      [Cloudinary::Downloader.download(url), {'name' => name(uid)}]
+    end
+
+    def destroy(uid)
+      Cloudinary::Uploader.destroy public_id(uid)
+    end
+
+    def url_for(uid, options = {})
+      options = {format: ext(uid)}.merge(options)
+      Cloudinary::Utils.cloudinary_url(public_id(uid), options)
+    end
+
+    private
+
+    def public_id(uid)
+      File.basename(uid, ext(uid, true))
+    end
+
+    def name(uid)
+      pid = public_id(uid)
+      if pid.include?('_')
+        public_id(uid).split('_')[0..-1].join
+      else
+        pid
+      end
+    end
+
+    def ext(uid, with_dot = false)
+      ext = File.extname(uid)
+      ext[0] = '' if ext && !with_dot
+      ext
+    end
+  end
+end

data/lib/alchemy_cloudinary/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module AlchemyCloudinary
+  class Engine < ::Rails::Engine
+    config.before_initialize do
+      require 'dragonfly'
+      require 'alchemy_cloudinary/dragonfly_data_store'
+
+      Dragonfly::App.register_datastore(:alchemy_cloudinary) do
+        AlchemyCloudinary::DragonflyDataStore
+      end
+    end
+
+    config.to_prepare do
+      file = 'alchemy/picture/cloudinary_url'
+      Rails.configuration.cache_classes ? require(file) : load(file)
+      Alchemy::Picture.prepend(Alchemy::Picture::CloudinaryUrl)
+    end
+  end
+end

data/lib/alchemy_cloudinary/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AlchemyCloudinary
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: alchemy_cloudinary
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0.beta
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0.beta
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: cloudinary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: AlchemyCMS Cloudinary Integration.
+email:
+- thomas@vondeyen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/alchemy/picture/cloudinary_url.rb
+- lib/alchemy_cloudinary.rb
+- lib/alchemy_cloudinary/dragonfly_data_store.rb
+- lib/alchemy_cloudinary/engine.rb
+- lib/alchemy_cloudinary/version.rb
+homepage: https://alchemy-cms.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: AlchemyCMS Cloudinary Integration.
+test_files: []