middleman-image-uploader-tag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 362ef8e1b744f133c54355093a958ed4d1445ac1
+  data.tar.gz: a2a0114837e730164b9927b952907f6a88b8b734
+SHA512:
+  metadata.gz: bd13ca115c108becb86f3e6c71c8b55cd56b7089bd5f1caa76904778ad5675ea73d4805692fbd0435e4eb3837af2d8b9c9b4328ecc698b994707cc0f6b928ad1
+  data.tar.gz: 34c26fa912fc9bc2265e079c862fb6d1d52ec056930d41cbdadbf81b66ec793550483389103b1b7b9ed6aa2a9dab8af48a45f00d6386e1545b2f55b408bcb756

data/.gitignore

@@ -0,0 +1,8 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore temporary remote images folder
+test/fixtures/test/source/remote_images/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-image-uploader-tag.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+

data/README.md

@@ -0,0 +1,99 @@
+# Middleman Image Uploader Tag
+
+`middleman-image-uploader-tag` is an extension for the [Middleman] static site generator that adds special tag helpers with functionality of uploading images into a external services as CDN's and remote storages.
+
+## The Reason
+
+If you start a new blog generated by the Middleman and hosted at the GitHub static pages, soon you become realize that pushing big images into the repository has a few drawbacks:
+
+- the speed of deploy through the git is very low
+- it pollutes your repository with huge files (GitHub is definitely not Flckr)
+- it caches for 10 minutes only because of GitHub CDNs Cache-Control headers. So your readers would not be happy to redownload huge backgrounds or photos each time they visit your site..
+- ...
+
+## Concept
+
+During development phase nothing is changed. To prevent redundancy uploading into remote hosting (while you are looking for different pictures, changing their sizes and so on), local images used as ussually.
+
+But at the build time all images would be uploaded into remote hosting, and their relative paths replaced for appropriate absolute urls.
+That gives you a possibility to control caching time of images, as well as other options that your CDN may provides you, separately.
+
+## Important Note
+
+At the moment only the [Cloudinary] CDN is supported. But it is easy to add any new one.
+
+## Installation
+
+Nothing special:
+
+`gem install middleman-image-uploader-tag`
+
+Or just add the following line into your `Gemfile`:
+
+`gem 'middleman-image-uploader-tag'`
+
+ and after run `bundle install`.
+
+Also you can install the latest code directly from repository with:
+
+`gem 'middleman-image-uploader-tag', git: 'https://github.com/aliaksandrb/middleman-image-uploader-tag.git'`
+
+
+## Configuration
+
+Activate extension in your `config.rb`, providing credentials for remote provider:
+
+```ruby
+activate :image_uploader_tag do |e|
+  e.remote_images_dir = 'remote_images'
+  e.provider = :cloudinary
+  e.provider_config = {
+    cloud_name: ENV['CLOUDINARY_CLOUD_NAME'],
+    api_key: ENV['CLOUDINARY_API_KEY'],
+    api_secret: ENV['CLOUDINARY_API_SECRET'],
+    enhance_image_tag: false,
+    static_image_support: true,
+    secure: true
+  }
+end
+```
+
+Note: the `remote_images_dir` sets the only folder images being uploaded.
+
+It is optional and by default has the value `'remote_images'`. You can change it but be sure to place it NOT within the images directory of the Middleman, just somewhere in the application root folder.
+
+## Usage
+
+Now in your views you can use a few new helpers:
+
+Example for `.slim` or `.haml` templates
+
+```ruby
+= remote_image_tag 'test.png', alt: 'hello'
+
+= remote_image_tag 'backgrounds/test.png', alt: 'hello'
+```
+
+If you want to use it in your `.md` templates for posts content, you should rename them, adding additional proccessing level.
+
+For example you had an post `source/articles/2015-05-21-welcome.html.markdown` then you need to rename it to `source/articles/2015-05-21-welcome.html.markdown.erb` (note `.erb` at the end).
+
+After you can use a bit different helper:
+
+```ruby
+![MYIMAGE](<%= remote_image_tag_link 'test.png' %>)
+```
+
+or as simple as
+
+```ruby
+<%= remote_image_tag 'test.png' %>
+```
+
+The difference between `remote_image_tag` and `remote_image_tag_link` is that the first wraps link into `<img>` tag, but the other just produces the raw link as `https://cdn.blablabla.com/test.png`.
+
+[middleman]: http://middlemanapp.com/
+[cloudinary]: https://cloudinary.com/
+___
+
+Any feedback or issue report appreciated!

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake/clean'
+
+desc 'Run all tests available'
+task :test do
+  Dir.glob('./test/**/*_test.rb') { |file| require file }
+end
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-image-uploader-tag')

data/lib/middleman-image-uploader-tag.rb

@@ -0,0 +1,9 @@
+require 'middleman-core'
+require 'middleman/image-uploader-tag/exceptions'
+require 'middleman/image-uploader-tag/extension'
+require 'middleman/image-uploader-tag/cdns/base.rb'
+require 'middleman/image-uploader-tag/cdns/cloudinary.rb'
+
+::Middleman::Extensions.register(
+  :image_uploader_tag, ::Middleman::ImageUploaderTag::Extension
+)

data/lib/middleman/image-uploader-tag/cdns/base.rb

@@ -0,0 +1,9 @@
+module Middleman
+  module ImageUploaderTag
+
+    class BaseCDN
+      # all CDN share some functionality
+    end
+
+  end
+end

data/lib/middleman/image-uploader-tag/cdns/cloudinary.rb

@@ -0,0 +1,37 @@
+require 'cloudinary'
+
+module Middleman
+  module ImageUploaderTag
+
+    class CloudinaryCDN < BaseCDN
+      OBLIGATORY_OPTIONS = [:cloud_name, :api_secret, :api_key]
+
+      def initialize(config)
+        raise AuthorizationRequired if OBLIGATORY_OPTIONS.any? { |k| config[k].nil? }
+
+        Cloudinary.config do |c|
+          config.each { |key, value| c.public_send(:"#{key}=", value) unless value.nil? }
+        end
+      end
+
+      def get_remote_link(image_path)
+        raise NotFound if !image_path || !File.exist?(image_path.to_s)
+
+        upload_to_cloud(image_path)[:secure_url]
+      end
+
+      def upload_to_cloud(file, options = {})
+        # rescue Cloudinary exceptions? (timeouts, limits and so on..)
+        raise NotFound if !file || !File.exist?(file.to_s)
+
+        options.merge!({ use_filename: true, unique_filename: false })
+
+        Cloudinary::Uploader.upload(file, options).inject({}) do |memo, (k,v)|
+          memo[k.to_sym] = v
+          memo
+        end
+      end
+    end
+
+  end
+end

data/lib/middleman/image-uploader-tag/exceptions.rb

@@ -0,0 +1,24 @@
+module Middleman
+  module ImageUploaderTag
+
+    class ImageUploaderTagException < StandardError
+      def initialize(msg = nil)
+        @message = msg
+        super
+      end
+    end
+
+    class NotFound < ImageUploaderTagException
+      def to_s
+        "#{self.class}: #{@message || 'No such image file in the remote folder'}"
+      end
+    end
+
+    class AuthorizationRequired < ImageUploaderTagException
+      def to_s
+        "#{self.class}: #{@message || 'One or more obligatory options are missed'}"
+      end
+    end
+
+  end
+end

data/lib/middleman/image-uploader-tag/extension.rb

@@ -0,0 +1,84 @@
+require 'middleman-core'
+require 'middleman-core/extensions'
+
+module Middleman
+  module ImageUploaderTag
+
+    class Extension < ::Middleman::Extension
+      option :provider, nil, 'CDN provider name'
+      option :provider_config, nil, 'CDN provider config options'
+      option :remote_images_dir, nil, %q{
+        Folder where images are placed.
+        Must be outside the :images_dir of the Middleman'
+      }
+
+      def initialize(app, options_hash = {}, &block)
+        super
+
+        # Require libraries only when activated
+        # require 'necessary/library'
+
+        @@provider_options = options
+        @@app = app
+
+        self.class.create_images_dir!
+      end
+
+      helpers do
+        def remote_image_tag(image_name, params = {})
+          image_tag remote_image_tag_link(image_name), params
+        end
+
+        def remote_image_tag_link(image_name)
+          klass = ::Middleman::ImageUploaderTag::Extension
+
+          klass.get_remote_path image_name
+        end
+      end
+
+      def self.image_location(image_path)
+        File.join(app.root, 'source', remote_images_dir, image_path)
+      end
+
+      def self.provider
+        # need cache here i believe
+        # handle cases for snake_case_name
+        # handle unknown provider
+        Object.const_get(
+          "::Middleman::ImageUploaderTag::#{provider_options.provider.to_s.capitalize}CDN"
+        ).new(provider_options.provider_config)
+      end
+
+      def self.get_remote_path(image_name)
+        image_path = image_location(image_name)
+        raise NotFound unless File.exist?(image_path)
+
+        if app.config.environment == :build
+          provider.get_remote_link(image_path)
+        else
+          image_name
+        end
+      end
+
+      def self.provider_options
+        @@provider_options
+      end
+
+      def self.app
+        @@app
+      end
+
+      def self.remote_images_dir
+        @@remote_images_dir ||= provider_options.remote_images_dir || 'remote_images'
+      end
+
+      def self.create_images_dir!
+        img_dir = File.join(app.root, 'source', remote_images_dir)
+
+        Dir.mkdir(img_dir) unless Dir.exist?(img_dir)
+      end
+    end
+
+  end
+end
+

data/lib/middleman/image-uploader-tag/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module ImageUploaderTag
+    VERSION = '0.0.1'
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require_relative 'middleman-image-uploader-tag'

data/middleman-image-uploader-tag.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'middleman/image-uploader-tag/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-image-uploader-tag'
+  s.version     = Middleman::ImageUploaderTag::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Aliaksandr Buhayeu']
+  s.email       = ['aliaksandr.buhayeu@gmail.com']
+  s.homepage    = 'https://github.com/aliaksandrb/middleman-image-uploader-tag'
+  s.summary     = %q{Image tag helper with automatic upload to external services}
+  s.description = %q{
+    The remote_image_tag helper provide you automatic image upload to external
+    hosting services with public back-link mapping
+  }
+  s.license = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'middleman-core', ['>= 3.3.12']
+  s.add_runtime_dependency 'cloudinary', '~>1.1.0'
+
+  s.add_development_dependency 'minitest', '~> 5.6.1'
+  s.add_development_dependency 'fivemat', '~> 1.3.1'
+  s.add_development_dependency 'minitest-stub-const'
+end

data/test/fixtures/test/.gitignore

@@ -0,0 +1,18 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+# git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the build directory
+/build
+
+# Ignore cache
+/.sass-cache
+/.cache
+
+# Ignore .DS_store file
+.DS_Store

data/test/fixtures/test/Gemfile

@@ -0,0 +1,14 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+gem "middleman", "~>3.3.12"
+
+# Live-reloading plugin
+gem "middleman-livereload", "~> 3.1.0"
+
+# For faster file watcher updates on Windows:
+gem "wdm", "~> 0.1.0", :platforms => [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem "tzinfo-data", platforms: [:mswin, :mingw, :jruby]

data/test/fixtures/test/config.rb

@@ -0,0 +1,72 @@
+###
+# Compass
+###
+
+# Change Compass configuration
+# compass_config do |config|
+#   config.output_style = :compact
+# end
+
+###
+# Page options, layouts, aliases and proxies
+###
+
+# Per-page layout changes:
+#
+# With no layout
+# page "/path/to/file.html", :layout => false
+#
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+#
+# A path which all have the same layout
+# with_layout :admin do
+#   page "/admin/*"
+# end
+
+# Proxy pages (https://middlemanapp.com/advanced/dynamic_pages/)
+# proxy "/this-page-has-no-template.html", "/template-file.html", :locals => {
+#  :which_fake_page => "Rendering a fake page with a local variable" }
+
+###
+# Helpers
+###
+
+# Automatic image dimensions on image_tag helper
+# activate :automatic_image_sizes
+
+# Reload the browser automatically whenever files change
+# configure :development do
+#   activate :livereload
+# end
+
+# Methods defined in the helpers block are available in templates
+# helpers do
+#   def some_helper
+#     "Helping"
+#   end
+# end
+
+set :css_dir, 'stylesheets'
+
+set :js_dir, 'javascripts'
+
+set :images_dir, 'images'
+
+# Build-specific configuration
+configure :build do
+  # For example, change the Compass output style for deployment
+  # activate :minify_css
+
+  # Minify Javascript on build
+  # activate :minify_javascript
+
+  # Enable cache buster
+  # activate :asset_hash
+
+  # Use relative URLs
+  # activate :relative_assets
+
+  # Or use a different image path
+  # set :http_prefix, "/Content/images/"
+end