asset_link 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b6b58526fe25fe9c9505b63a704dcd5289f1d1c
+  data.tar.gz: 7f9bcb6ea40828f4a84fc245c779d742260b7a89
+SHA512:
+  metadata.gz: ada813208b60e65201a1f35080d01467531be7c3c6ac9f88d883051b80f48b37efaa3737055ae7c5dcb7c562912e21fc312a02cbb4f9486f865653154524abfc
+  data.tar.gz: 306b2a4989281f7b0be50c0c698b39f9b0da97f829256470b7564625dd8179b3e608628bcf4877c8f0a9194f032d4357c531c6d6ef7cab490aeee7feea80125b

data/.gitignore

@@ -0,0 +1,11 @@
+.idea
+*.iml
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'test-unit'
+gem 'mocha'
+# Specify your gem's dependencies in asset_link.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Antonov
+
+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,79 @@
+# AssetLink
+
+This gem allows to replace any asset (image, CSS stylesheet, script, etc.) with a light-weight link to the same asset located at a remote storage (e.g. Amazon S3).
+The idea behind it is to reduce the size of the application deployment, especially when it is limited by a hosting service (e.g. max slug size at Heroku is 300MB).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asset_link'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asset_link
+
+## Usage
+
+### Upload
+
+To upload asset(s) to the remote storage run:
+
+    $ asset_link_upload [FILE_PATTERN]
+
+e.g. to upload all .jpg images from /app/assets folder run:
+
+    $ cd ./app
+    $ asset_link_upload ./assets/**/*.jpg
+
+As a result each image.jpg file would be uploaded to the remote storage and replaced by a text file image.jpg.link that contains a link to that remote file.
+
+### Download
+
+To download asset(s) from the remote storage run:
+
+    $ asset_link_download [FILE_PATTERN]
+
+e.g. to replace all .jpg.link images by originals in /app/assets folder run:
+
+    $ cd ./app
+    $ asset_link_upload ./assets/**/*.jpg.link
+
+As a result each image.jpg.link file would be replaced by the original image.jpg file from the remote storage.
+
+### Middleware
+
+In order to allow Rails server to respond with original asset content from .link file, install middleware:
+
+in config.ru add before ``run Rails.application``:
+
+```ruby
+use AssetLink::Middleware
+```
+
+in config/initializers/sprokets.rb:
+
+```ruby
+Sprockets.register_engine '.link', AssetLink::Processor.new, silence_deprecation: true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/doubleton/asset_link.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/asset_link.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asset_link/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asset_link"
+  spec.version       = AssetLink::VERSION
+  spec.authors       = ["Anton Antonov"]
+  spec.email         = ["anton.antonov@castle.co"]
+
+  spec.summary       = %q{Gem that allows to replace any asset with a light-weight link to a remote storage.}
+  spec.description   = %q{This gem allows to replace any asset (image, CSS stylesheet, script, etc.) with a light-weight link to the same asset located at a remote storage (e.g. Amazon S3). The idea behind it is to reduce the size of the application deployment, especially when it is limited by a hosting service (e.g. max slug size at Heroku is 300MB).}
+  spec.homepage      = "https://github.com/doubleton/asset_link"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["asset_link"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "mime-types", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "fog", '~> 1.20'
+end

data/bin/asset_link

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'asset_link'
+
+args = ARGV
+action = args.shift
+
+case action
+  when "-upload"
+    AssetLink::Loader.new.upload args
+  when "-download"
+    AssetLink::Loader.new.download args
+  else
+    puts "Usage: asset_link -upload [FILES] or asset_link -download [FILES]"
+end

data/lib/asset_link.rb

@@ -0,0 +1,8 @@
+require "asset_link/version"
+require "asset_link/middleware"
+require "asset_link/processor"
+
+require "asset_link/config"
+require "asset_link/storage"
+require "asset_link/multi_mime"
+require "asset_link/loader"

data/lib/asset_link/config.rb

@@ -0,0 +1,29 @@
+module AssetLink
+  class Config
+
+    # FOG configuration
+    attr_accessor :fog_provider, :fog_directory, :fog_region
+
+    # Amazon AWS
+    attr_accessor :aws_access_key_id, :aws_secret_access_key
+
+    def initialize
+      self.fog_provider = ENV.fetch('FOG_PROVIDER') { 'AWS' }
+      self.fog_directory = ENV['FOG_DIRECTORY'] || ENV['AWS_S3_BUCKET']
+      self.fog_region = ENV['FOG_REGION'] || ENV['AWS_REGION']
+      self.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+      self.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
+    def fog_options
+      options = {
+          provider: fog_provider,
+          aws_access_key_id: aws_access_key_id,
+          aws_secret_access_key: aws_secret_access_key
+      }
+      options.merge!({region: fog_region}) if fog_region
+      options
+    end
+
+  end
+end

data/lib/asset_link/loader.rb

@@ -0,0 +1,67 @@
+require 'open-uri'
+
+module AssetLink
+  class Loader
+
+    def upload(files)
+      files.each do |f|
+        next unless File.file?(f)
+        puts "Uploading: #{f}"
+        link = upload_file(f)
+        create_link_file(f, link)
+        File.delete(f)
+      end
+    end
+
+    def download(files)
+      files.each do |f|
+        next if !File.file?(f) || File.extname(f) != '.link'
+        puts "Downloading: #{f}"
+        link = read_file(f)
+        download_file(f, link)
+        File.delete(f)
+      end
+    end
+
+    private
+
+    def read_file(f)
+      File.read(f).strip
+    end
+
+    def upload_file(f)
+      ext = File.extname(f)[1..-1]
+      mime = MultiMime.lookup(ext)
+      file = {
+          :key => f,
+          :body => File.open(f),
+          :public => true,
+          :content_type => mime
+      }
+
+      storage.bucket.files.create(file).public_url
+    end
+
+    def download_file(f, link)
+      new_filename = f.gsub('.link', '')
+      open(new_filename, 'w') do |file|
+        file << open(link).read
+      end
+    end
+
+    def create_link_file(f, link)
+      File.open("#{f}.link", "w") do |file|
+        file.write(link)
+      end
+    end
+
+    def config
+      @config ||= AssetLink::Config.new
+    end
+
+    def storage
+      @storage ||= AssetLink::Storage.new(config)
+    end
+
+  end
+end

data/lib/asset_link/middleware.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+
+module AssetLink
+  class Middleware
+    def initialize(app)
+      @app = app
+      @manifest = load_manifest
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      code, headers, body = @app.call(env)
+
+      if URI.unescape(request.path).start_with?('/assets/') && code == 200
+        entry = body.respond_to?(:to_a) ? body.to_a.first : body
+
+        asset = case entry
+                  when Sprockets::Asset
+                    entry
+                  when Rack::File::Iterator
+                    find_asset(entry.path)
+                end
+
+        if asset && asset.filename.ends_with?('.link')
+          link = File.read(asset.filename).strip # the file contains a link to the actual asset
+
+          open(link) do |f|
+            headers = f.meta
+            body.close if body.respond_to?(:closed?) && !body.closed?
+            body = [f.read]
+          end
+        end
+      end
+      [code, headers, body]
+    end
+
+    private
+
+    def find_asset(path)
+      filename = URI.unescape(path).gsub(/.*\/assets\//, '')
+
+      if @manifest && @manifest['files'][filename]
+        manifest_file = @manifest['files'][filename]
+        assets_engine.find_asset(manifest_file['logical_path'])
+      elsif filename =~ %r{(.*)-[a-z0-9]+\.(.+)}
+        assets_engine.find_asset("#{$1}.#{$2}")
+      end
+    end
+
+    def assets_engine
+      @assets_engine ||= Sprockets::Environment.new(Rails.root).tap do |e|
+        Dir[Rails.root.join('app', 'assets', '*')].each { |p| e.append_path p }
+      end
+    end
+
+    def load_manifest
+      manifests = Dir[Rails.root.join('public', 'assets', '.sprockets-manifest-*.json')]
+      if manifests.first
+        file = File.read(manifests.first)
+        JSON.parse(file)
+      end
+    end
+  end
+end

data/lib/asset_link/multi_mime.rb

@@ -0,0 +1,20 @@
+require 'mime/types'
+
+module AssetLink
+  class MultiMime
+
+    def self.lookup(ext)
+
+      if defined?(Mime::Type)
+        Mime::Type.lookup_by_extension(ext)
+      elsif defined?(Rack::Mime)
+        ext_with_dot = ".#{ext}"
+        Rack::Mime.mime_type(ext_with_dot)
+      else
+        ::MIME::Types.type_for(ext).first
+      end
+
+    end
+
+  end
+end

data/lib/asset_link/processor.rb

@@ -0,0 +1,9 @@
+module AssetLink
+  class Processor
+
+    def call(*)
+      { data: '' }
+    end
+
+  end
+end

data/lib/asset_link/storage.rb

@@ -0,0 +1,27 @@
+require 'fog'
+
+module AssetLink
+  class Storage
+
+    class BucketNotFound < StandardError; end
+
+    attr_accessor :config
+
+    def initialize(cfg)
+      @config = cfg
+    end
+
+    def connection
+      @connection ||= Fog::Storage.new(config.fog_options)
+    end
+
+    def bucket
+      @bucket ||= begin
+        bucket = connection.directories.get(config.fog_directory)
+        bucket = connection.directories.create(key: config.fog_directory) unless bucket
+        bucket
+      end
+    end
+
+  end
+end

data/lib/asset_link/version.rb

@@ -0,0 +1,3 @@
+module AssetLink
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: asset_link
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Antonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: This gem allows to replace any asset (image, CSS stylesheet, script,
+  etc.) with a light-weight link to the same asset located at a remote storage (e.g.
+  Amazon S3). The idea behind it is to reduce the size of the application deployment,
+  especially when it is limited by a hosting service (e.g. max slug size at Heroku
+  is 300MB).
+email:
+- anton.antonov@castle.co
+executables:
+- asset_link
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asset_link.gemspec
+- bin/asset_link
+- lib/asset_link.rb
+- lib/asset_link/config.rb
+- lib/asset_link/loader.rb
+- lib/asset_link/middleware.rb
+- lib/asset_link/multi_mime.rb
+- lib/asset_link/processor.rb
+- lib/asset_link/storage.rb
+- lib/asset_link/version.rb
+homepage: https://github.com/doubleton/asset_link
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gem that allows to replace any asset with a light-weight link to a remote
+  storage.
+test_files: []