activestorage-imgur 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 388008cb63e4720d852bad54c1083ba4b096084a265942643e85ad1a03ec39ff
+  data.tar.gz: fc07d05be417ea7744ead43ffe2608dfde9026b2a78564836f718cf007c306a1
+SHA512:
+  metadata.gz: 391a41de76e910ea621ca9bdb47608205684c4788bc4aa6e40d635a4b80942b5dcd3782c4a44d5c00076f92875f0cbc00dce281fe966041f68acfe0bd2d122bb
+  data.tar.gz: 0bc9e954b2fb8dd534938b9b2307421743e100818091c0df1e70ad61e15703b3f0a4883a54940a9a31181c34809f8998e6e886b145e48420e8ea02f5e418b031

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Yi Feng
+
+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,90 @@
+# ActiveStorage::Imgur
+
+An ActiveStorage driver for storing `images` on [Imgur hosting](https://imgur.com/).
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-imgur'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Quick Start
+
+1. generate a migration that creates the dependent table:
+    ```
+    # if you never use activestorage, run rails active_storage:install first. 
+    
+    rails g active_storage_imgur:install
+    rails db:migrate
+    ```
+2. Set `config.active_storage.service` to `:imgur` in any of `config/environments/*.rb` files.
+3. Set the imgur config in your `config/storage.yml`: 
+    ```
+    imgur:
+      service: Imgur
+      client_id: <%= ENV['IMGUR_CLIENT_ID'] %>
+      client_secret: <%= ENV['IMGUR_CLIENT_SECRET'] %>
+      access_token: <%= ENV['IMGUR_ACCESS_TOKEN'] %>
+      refresh_token: <%= ENV['IMGUR_REFRESH_TOKEN'] %>
+    ```
+
+    for environment variables on the above, follow steps:
+    
+    1. sign an imgur account: [https://imgur.com/](https://imgur.com/)
+    2. to create an imgur application visit: [https://api.imgur.com/oauth2/addclient](https://api.imgur.com/oauth2/addclient)
+    3. you will get client_id and client_secret after creating an application.
+    4. run `rails imgur:authorize CLIENT_ID='CLIENT_ID' CLIENT_SECRET='CLIENT_SECRET'` to get `access_token` and `refresh_token`.
+ 
+3. Add attachment to your model just like explanation of [activestorage](http://edgeguides.rubyonrails.org/active_storage_overview.html):
+    
+    ```
+    class User
+      has_one_attached :avatar
+      has_many_attached :photos
+      ...
+    end
+    ```
+    
+    ```
+    <%= form_for @user do |form| %>
+      <% if @user.errors.any? %>
+        <ul>
+          <% @user.errors.full_messages.each do |msg| %>
+            <li><%= msg %></li>
+          <% end %>
+        </ul>
+      <% end %>
+      
+      Avatar: <%= form.file_field :avatar %>
+      Photo: <%= form.file_field :photos, multiple: true %>
+      <%= form.submit %>
+    <% end %>
+    ```
+    
+    ```
+    <%= image_tag user.avatar %>
+    <%= image_tag user.photos.first.variant(resize: "100x100") %>
+    ```
+    
+    for more detail usage like uploading, image displaying. see official documentations[activestorage](http://edgeguides.rubyonrails.org/active_storage_overview.html).
+
+
+## Be careful
+
+1. this gem has built-in validation to validate image file. 
+   attachment can be nil, if it presents, it only accept image type.
+   if your app only accept files with image types, it should be fine.
+2. though imgur is free, it still has rate limits, if your application hit the daily limit, uploading function will probably be terminated.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+

data/app/controllers/active_storage/imgur_controller.rb

@@ -0,0 +1,19 @@
+class ActiveStorage::ImgurController < ActiveStorage::DiskController
+  def update
+    if token = decode_verified_token
+      imgur_service.upload token[:key], request.body, checksum: token[:checksum]
+      head :no_content
+    else
+      head :not_found
+    end
+  rescue ActiveStorage::IntegrityError
+    head :unprocessable_entity
+  ensure
+    response.stream.close
+  end
+
+  private
+  def imgur_service
+    ActiveStorage::Blob.service
+  end
+end

data/app/models/active_storage/imgur_key_mapping.rb

@@ -0,0 +1,6 @@
+class ActiveStorage::ImgurKeyMapping < ActiveRecord::Base
+  validates :key, presence: true
+  validates :imgur_id, presence: true
+
+  scope :by_prefix_key, ->(prefix) { where("key like ?", "#{prefix}%") }
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  put "/rails/active_storage/imgur/:encoded_token" => "active_storage/imgur#update", as: :update_rails_imgur_service
+end

data/lib/active_storage/imgur/engine.rb

@@ -0,0 +1,27 @@
+require 'active_support/lazy_load_hooks'
+
+module ActiveStorage
+  module Imgur
+    class Engine < ::Rails::Engine
+      isolate_namespace ActiveStorage::Imgur
+
+      initializer 'include imgur validator' do
+        ActiveStorage::Attached::One.include ActiveStorage::Imgur::Validator
+        ActiveStorage::Attached::Many.include ActiveStorage::Imgur::Validator
+      end
+
+      initializer 'include model extension' do
+        ActiveRecord::Base.include ActiveStorage::Imgur::ModelExtension
+      end
+
+      initializer 'enhance Imgur::Communication' do
+        ::Imgurapi::Communication
+      end
+
+      rake_tasks do
+        load 'imgurapi/tasks/tasks.rake'
+      end
+    end
+  end
+end
+

data/lib/active_storage/imgur/model_extension.rb

@@ -0,0 +1,35 @@
+module ActiveStorage
+  module Imgur::ModelExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_one_attached(*arg)
+        super(*arg)
+        name = arg.first
+        validate_image(name)
+      end
+
+      def has_many_attached(*arg)
+        super(*arg)
+        name = arg.first
+        validate_image(name)
+      end
+
+      private
+      def validate_image(name)
+        validate "validate_imgur_#{name}".to_sym
+
+        generated_association_methods.class_eval <<-CODE
+          attr_accessor :invalid_#{name}
+
+          def validate_imgur_#{name}
+            if invalid_#{name}
+              errors.add(:#{name}, "is not an image")
+            end
+          end
+        CODE
+      end
+    end
+  end
+end
+

data/lib/active_storage/imgur/service.rb

@@ -0,0 +1,193 @@
+require 'open-uri'
+require 'down'
+
+module ActiveStorage
+  module Imgur
+    class Service < ActiveStorage::Service
+      class NotAnImage < StandardError; end
+
+      attr_reader :client
+
+      def initialize(client_id:, client_secret:, refresh_token:, access_token:)
+        @client = ::Imgurapi::Session.instance(
+          client_id: client_id, client_secret: client_secret,
+          refresh_token: refresh_token, access_token: access_token)
+      end
+
+      # Upload the +io+ to the +key+ specified. If a +checksum+ is provided, the service will
+      # ensure a match when the upload has completed or raise an ActiveStorage::IntegrityError.
+      def upload(key, io, checksum: nil)
+        instrument :upload, key: key, checksum: checksum do
+          if io.is_a?(StringIO)
+            io = string_io_to_file(key, io)
+          end
+
+          ensure_integrity_of(key, io, checksum) if checksum
+          image = client.image.image_upload(io)
+
+          ActiveStorage::ImgurKeyMapping.create(key: key, imgur_id: image.id)
+        end
+      rescue StandardError => e
+        if e.message.match(/must be an image/)
+          raise NotAnImage
+        else
+          raise e
+        end
+      end
+
+      # Return the content of the file at the +key+.
+      def download(key, &block)
+        if block_given?
+          instrument :streaming_download, key: key do
+            stream(key, &block)
+          end
+        else
+          instrument :download, key: key do
+            File.binread file_for(key)
+          end
+        end
+      end
+
+      # Return the partial content in the byte +range+ of the file at the +key+.
+      def download_chunk(key, range)
+        instrument :download_chunk, key: key, range: range do
+          file = file_for(key)
+          file.seek range.begin
+          file.read range.size
+        end
+      end
+
+      # Delete the file at the +key+.
+      def delete(key)
+        instrument :delete, key: key do
+          map = find_map_by_key(key)
+          if map
+            client.image.image_delete(map.imgur_id)
+            map.destroy!
+          end
+        end
+      end
+
+      # Delete files at keys starting with the +prefix+.
+      def delete_prefixed(prefix)
+        instrument :delete_prefixed, prefix: prefix do
+          maps = ActiveStorage::ImgurKeyMapping.by_prefix_key(prefix)
+          maps.each do |map|
+            client.image.image_delete(map.imgur_id)
+            map.destroy!
+          end
+        end
+      end
+
+      # Return +true+ if a file exists at the +key+.
+      def exist?(key)
+        instrument :exist, key: key do |payload|
+          id = map_key_to_id(key)
+          answer = id.present?
+
+          payload[:exist] = answer
+          answer
+        end
+      end
+
+      # Returns a signed, temporary URL for the file at the +key+. The URL will be valid for the amount
+      # of seconds specified in +expires_in+. You must also provide the +disposition+ (+:inline+ or +:attachment+),
+      # +filename+, and +content_type+ that you wish the file to be served with on request.
+      def url(key, expires_in:, disposition:, filename:, content_type:)
+        instrument :url, key: key do |payload|
+          image = image_for(key)
+
+          image.link.tap do |url|
+            payload[:url] = url
+          end
+        end
+      end
+
+      # Returns a signed, temporary URL that a direct upload file can be PUT to on the +key+.
+      # The URL will be valid for the amount of seconds specified in +expires_in+.
+      # You must also provide the +content_type+, +content_length+, and +checksum+ of the file
+      # that will be uploaded. All these attributes will be validated by the service upon upload.
+      def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+        instrument :url, key: key do |payload|
+          verified_token_with_expiration = ActiveStorage.verifier.generate(
+            {
+              key: key,
+              content_type: content_type,
+              content_length: content_length,
+              checksum: checksum
+            },
+            { expires_in: expires_in,
+              purpose: :blob_token }
+          )
+
+          generated_url = url_helpers.update_rails_imgur_service_url(verified_token_with_expiration, host: current_host)
+
+          payload[:url] = generated_url
+          generated_url
+        end
+      end
+
+      def headers_for_direct_upload(key, content_type:, checksum:, **)
+        { "Content-Type" => content_type, "Content-MD5" => checksum }
+      end
+
+      private
+      def ensure_integrity_of(key, file, checksum)
+        unless Digest::MD5.file(file).base64digest == checksum
+          delete key
+          raise ActiveStorage::IntegrityError
+        end
+      end
+
+      def find_map_by_key(key)
+        ActiveStorage::ImgurKeyMapping.find_by(key: key)
+      end
+
+      def map_key_to_id(key)
+        map = find_map_by_key(key)
+        if map
+          map.imgur_id
+        end
+      end
+
+      def image_for(key)
+        id = map_key_to_id(key)
+        client.image.image(id)
+      end
+
+      def file_for(key)
+        image = image_for(key)
+        Down.download(image.link)
+      end
+
+      def string_io_to_file(key, string_io)
+        ext = File.extname(key)
+        base = File.basename(key, ext)
+        Tempfile.new([base, ext]).tap do |file|
+          file.write string_io
+        end
+      end
+
+      def stream(key)
+        image = image_for(key)
+        remote_file = Down.open(image.link)
+
+        chunk_size = 128.kilobytes
+
+
+        while !remote_file.eof?
+          yield remote_file.read(chunk_size)
+        end
+      end
+
+      def url_helpers
+        @url_helpers ||= Rails.application.routes.url_helpers
+      end
+
+      def current_host
+        ActiveStorage::Current.host
+      end
+    end
+  end
+
+end

data/lib/active_storage/imgur/validator.rb

@@ -0,0 +1,17 @@
+module ActiveStorage
+  module Imgur::Validator
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :old_attach, :attach
+
+      def attach(*attachables)
+        record.public_send("invalid_#{name}=", false)
+        old_attach(*attachables)
+      rescue ActiveStorage::Imgur::Service::NotAnImage
+        record.public_send("invalid_#{name}=", true)
+      end
+    end
+  end
+end
+

data/lib/active_storage/imgur/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module Imgur
+    VERSION = '1.0.0'
+  end
+end

data/lib/active_storage/service/imgur_service.rb

@@ -0,0 +1,3 @@
+module ActiveStorage
+  Service::ImgurService = Imgur::Service
+end

data/lib/activestorage-imgur.rb

@@ -0,0 +1,10 @@
+require "active_storage/imgur/engine"
+require "active_storage/imgur/validator"
+require "active_storage/imgur/service"
+require "active_storage/imgur/model_extension"
+require "imgurapi"
+
+module ActiveStorage
+  module Imgur
+  end
+end

data/lib/generators/active_storage_imgur/install_generator.rb

@@ -0,0 +1,17 @@
+module ActiveStorageImgur
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Add the migrations for DoubleDouble"
+
+    def self.next_migration_number(path)
+      next_migration_number = current_migration_number(path) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    def copy_migrations
+      migration_template "create_active_storage_imgur_key_mappings.rb",
+                         "db/migrate/create_active_storage_imgur_key_mappings.rb"
+    end
+  end
+end

data/lib/generators/active_storage_imgur/templates/create_active_storage_imgur_key_mappings.rb

@@ -0,0 +1,9 @@
+class CreateActiveStorageImgurKeyMappings < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_imgur_key_mappings do |t|
+      t.string   :key,        null: false
+      t.string   :imgur_id,   null: false
+      t.index [ :key ], unique: true
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-imgur
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yi Feng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: imgurapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email:
+- yfxie@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/active_storage/imgur_controller.rb
+- app/models/active_storage/imgur_key_mapping.rb
+- config/routes.rb
+- lib/active_storage/imgur/engine.rb
+- lib/active_storage/imgur/model_extension.rb
+- lib/active_storage/imgur/service.rb
+- lib/active_storage/imgur/validator.rb
+- lib/active_storage/imgur/version.rb
+- lib/active_storage/service/imgur_service.rb
+- lib/activestorage-imgur.rb
+- lib/generators/active_storage_imgur/install_generator.rb
+- lib/generators/active_storage_imgur/templates/create_active_storage_imgur_key_mappings.rb
+homepage: https://github.com/yfxie/activestorage-imgur
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An ActiveStorage driver for storing images on Imgur hosting.
+test_files: []