paperweight 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8380f20790cf3d11b41e3da6274c68fc6c0ac692fcaeb2a5aa7c2c2641bebeff
-  data.tar.gz: 9d992fc125eefcf29f06cd590f4e742bda84e1fc2ab47d08e8b113ac2d77d1bc
+  metadata.gz: c257b89200e21b312d6e80618546a84263d2f4d87408d07e2ae1d9bb86b2935b
+  data.tar.gz: 30997e5c1c095e24ba48ee655c8ca7f487a741c0687858d9e991c75730c3cb90
 SHA512:
-  metadata.gz: ee438611f9a2788d970f41eb5c1cdf6c7b75ac47325a0aa603bb7a88e48a788fbbde058941cb14dcc22b1038a21c2dcc6c7151ea33498387d587c3f18eba2597
-  data.tar.gz: '0568df48aa2c36ef68f8b24a7e04f6ec41e8ead419ceb4a3524831742236af9c718b9414096eb93d0f99602fb51a3fa650192ebeca46003d385228aec3ed4a8c'
+  metadata.gz: 1e63cb06b6c8257719e098666b220f04499d119e0dfa016c9054e8802d742933053bc6935c5f2b19084b4e84d9d8973a1586e80070a5e794b446ef81f3dd8648
+  data.tar.gz: 50048131ed8ad3430c886e2fc633730b3351777131bcac59b9b78e5ebb16c5e96ffcda5e72f148d078140d9e5cefa0176963ecbe5a4fd58199ad04fef2d5d57d

data/.gitignore

@@ -5,5 +5,6 @@
 /doc/
 /log/
 /pkg/
+/public/
 /spec/reports/
 /tmp/

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    paperweight (0.0.5)
-      aws-sdk-s3 (~> 1.13)
+    paperweight (0.1.0)
       paperclip (~> 6.0)
       rails (~> 5.2)
 
@@ -52,21 +51,6 @@ GEM
       tzinfo (~> 1.1)
     arel (9.0.0)
     ast (2.4.0)
-    aws-eventstream (1.0.0)
-    aws-partitions (1.91.0)
-    aws-sdk-core (3.21.2)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
-      jmespath (~> 1.0)
-    aws-sdk-kms (1.5.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-s3 (1.14.0)
-      aws-sdk-core (~> 3, >= 3.21.2)
-      aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.2)
     builder (3.2.3)
     climate_control (0.2.0)
     concurrent-ruby (1.0.5)
@@ -78,7 +62,6 @@ GEM
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
-    jmespath (1.4.0)
     json (2.1.0)
     loofah (2.2.2)
       crass (~> 1.0.2)

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.com/CultureHQ/paperweight.svg?branch=master)](https://travis-ci.com/CultureHQ/paperweight)
 
-An opinionated Paperclip for a specific workflow. Only accepts image URLs instead of uploaded files. The image URLs are then queued for downloading, converting, and generating thumbnails in the background using `ActiveJob`.
+Handles `Paperclip` attachments on the backend in a delayed process.
 
 ## Installation
 
@@ -22,45 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-First, configure `paperweight` in an initializer, e.g., `config/initializers/paperweight.rb`:
-
-```ruby
-Paperweight.configure do |config|
-  # your asset server (preferably a CDN)
-  config.asset_server = 'https://uploads.culturehq.com'
-
-  # the S3 bucket to which to uploads images
-  config.bucket = 'culturehq-uploads'
-
-  # the AWS credentials used with permission to S3
-  config.credentials = {
-    access_key_id: Rails.application.credentials.aws_access_key_id,
-    secret_access_key: Rails.application.credentials.aws_secret_access_key,
-    region: 'us-west-2'
-  }
-end
-```
-
-Then, create and run a migration to add the `image_uuid` and `image_processing` columns to your model:
-
-```ruby
-class AddImageToPost < ActiveRecord::Migration[5.2]
-  def change
-    add_column :posts, :image_uuid, :string
-    add_column :posts, :image_processing, :boolean, default: false, null: false
-  end
-end
-```
-
-Next, add the class macro to the model:
-
-```ruby
-class Post < ApplicationRecord
-  has_image thumb: '100x100>'
-end
-```
-
-Finally, add the ability to update the `image_url` attribute from the controller:
+Configure `Paperclip` as you normally would, according to their docs. Then, add the ability to update the `*_url` attribute from the controller, where the `*` is the name of the attachment that you specified in your model's call to `has_attached_file`.
 
 ```ruby
 class PostsController < ApplicationController
@@ -83,6 +45,8 @@ class PostsController < ApplicationController
 end
 ```
 
+From now on, updating this attribute will queue a job in the background to update the image later.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/paperweight/download.rb

@@ -32,12 +32,6 @@ module Paperweight
       raise Error, "download failed (#{url}): #{message}"
     end
 
-    def self.download(url)
-      new.download(url)
-    rescue Error
-      nil
-    end
-
     private
 
     # open-uri will return a StringIO instead of a Tempfile if the filesize

data/lib/paperweight/hook.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Paperweight
+  # Overrides the `has_attached_file` method from `paperclip` so that
+  # `paperweight` can add extras when the macro is called.
+  module Hook
+    # Converts a parent name to its respective component child names.
+    class AttachmentName
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def processing
+        :"#{name}_processing"
+      end
+
+      def url
+        :"#{name}_url"
+      end
+
+      def url_eq
+        :"#{name}_url="
+      end
+
+      def url_attr
+        :"@#{name}_url"
+      end
+    end
+
+    def has_attached_file(name, *) # rubocop:disable Naming/PredicateName
+      super
+
+      name = AttachmentName.new(name)
+      attr_reader name.url
+
+      define_paperweight_setter_for(name)
+      define_paperweight_after_commit_for(name)
+    end
+
+    private
+
+    def define_paperweight_setter_for(name)
+      define_method(name.url_eq) do |value|
+        instance_variable_set(name.url_attr, value)
+        self[name.processing] = value ? true : false
+      end
+    end
+
+    def define_paperweight_after_commit_for(name)
+      after_commit if: name.url do
+        attachment_url = public_send(name.url)
+        PostProcessJob.perform_later(self, name.name.to_s, attachment_url)
+      end
+    end
+  end
+end

data/lib/paperweight/post_process_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Paperweight
+  # Queues post processing.
+  class PostProcessJob < ActiveJob::Base
+    queue_as :default
+
+    discard_on ActiveJob::DeserializationError
+
+    def perform(model, name, url)
+      model.update!(
+        name => Download.new.download(url),
+        :"#{name}_processing" => false
+      )
+    end
+  end
+end

data/lib/paperweight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperweight
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/paperweight.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'aws-sdk-s3'
 require 'open-uri'
 require 'net/http'
 require 'paperclip'
@@ -8,12 +7,9 @@ require 'rails'
 
 require 'active_job'
 
-require 'paperweight/config'
 require 'paperweight/download'
-require 'paperweight/image'
-require 'paperweight/location'
-require 'paperweight/purge_job'
-require 'paperweight/railtie'
-require 'paperweight/storage'
-require 'paperweight/thumbnails_job'
+require 'paperweight/hook'
+require 'paperweight/post_process_job'
 require 'paperweight/version'
+
+Paperclip::ClassMethods.prepend(Paperweight::Hook)

data/paperweight.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'aws-sdk-s3', '~> 1.13'
   spec.add_dependency 'paperclip', '~> 6.0'
   spec.add_dependency 'rails', '~> 5.2'
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: paperweight
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-s3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: paperclip
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +140,9 @@ files:
 - bin/console
 - bin/setup
 - lib/paperweight.rb
-- lib/paperweight/config.rb
 - lib/paperweight/download.rb
-- lib/paperweight/image.rb
-- lib/paperweight/location.rb
-- lib/paperweight/purge_job.rb
-- lib/paperweight/railtie.rb
-- lib/paperweight/storage.rb
-- lib/paperweight/thumbnails_job.rb
+- lib/paperweight/hook.rb
+- lib/paperweight/post_process_job.rb
 - lib/paperweight/version.rb
 - paperweight.gemspec
 homepage: https://github.com/CultureHQ/paperweight

data/lib/paperweight/config.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# An opinionated Paperclip
-module Paperweight
-  # Stores various metadata about the configuration of `paperweight`.
-  class Config
-    attr_accessor :asset_server, :bucket, :credentials
-
-    def initialize
-      @bucket = ''
-      @credentials = { region: 'us-east-1' }
-    end
-  end
-
-  class << self
-    def config
-      @config ||= Config.new
-    end
-
-    def configure
-      yield config
-    end
-  end
-end

data/lib/paperweight/image.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # The image object attached to the model.
-  class Image
-    attr_reader :model
-
-    def initialize(model)
-      @model = model
-    end
-
-    def as_json(*)
-      serialized_styles_for(model).merge!(
-        is_default: model.image? ? false : true,
-        processing: model.image_processing?
-      )
-    end
-
-    def update_file(file)
-      image_styles.each do |style, geometry|
-        options = { geometry: geometry, convert_options: '-strip' }
-        thumbnail = Paperclip::Thumbnail.new(file, options).make
-        Storage.adapter.put(thumbnail, Location.new(model, style).path)
-      end
-
-      model.clear_image_url
-      model.update!(image_processing: false)
-    end
-
-    def update_url(url)
-      update_file(Download.download(url))
-    end
-
-    def path(style = :original)
-      Location.new(model, style).path
-    end
-
-    def url(style = :original)
-      Location.new(model, style).url
-    end
-
-    private
-
-    def image_styles
-      model.class.image_styles
-    end
-
-    def serialized_styles_for(model)
-      url_method = url_method_for(model)
-
-      image_styles.each_key.each_with_object({}) do |style, serialized|
-        serialized[:"#{style}_url"] =
-          Location.new(model, style).public_send(url_method)
-      end
-    end
-
-    def url_method_for(model)
-      !model.image? || model.image_processing? ? :default_url : :url
-    end
-  end
-end

data/lib/paperweight/location.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # The location of the attachment in terms of paths are URLs.
-  class Location
-    attr_reader :model, :style
-
-    def initialize(model, style = :original)
-      @model = model
-      @style = style
-    end
-
-    def path
-      "#{table_name}/#{model.id}-#{style}-#{model.image_uuid}"
-    end
-
-    def url
-      "#{self.class.prefix}/#{path}"
-    end
-
-    def default_url
-      "#{self.class.prefix}/#{table_name}/#{style}.png"
-    end
-
-    def self.prefix
-      @prefix ||=
-        if Rails.env.production?
-          Paperweight.config.asset_server
-        else
-          'http://localhost:3000/paperweight'
-        end
-    end
-
-    private
-
-    def table_name
-      model.class.table_name
-    end
-  end
-end

data/lib/paperweight/purge_job.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # Removes all previous image files matching the given pattern.
-  class PurgeJob < ActiveJob::Base
-    PLACEHOLDER = ':style'
-
-    queue_as :default
-
-    def perform(pattern, styles)
-      styles.each do |style|
-        Storage.adapter.delete(pattern.gsub(PLACEHOLDER, style))
-      end
-    end
-
-    def self.perform_later_for(model, image_uuid = nil)
-      model.image_uuid = image_uuid if image_uuid
-
-      perform_later(
-        Location.new(model, PLACEHOLDER).path,
-        model.class.image_styles.keys.map(&:to_s)
-      )
-    end
-  end
-end

data/lib/paperweight/railtie.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # Adds the `paperweight` hook in ActiveRecord models.
-  class Railtie < Rails::Railtie
-    # Extensions that need be generated from input.
-    class DynamicExtension < Module
-      def initialize(styles)
-        define_method(:image_styles) { styles }
-      end
-    end
-
-    # Extensions that are the same for each kind of attachment.
-    module StaticExtension
-      def clear_image_url
-        @image_url = nil
-      end
-
-      def image
-        Image.new(self)
-      end
-
-      def image?
-        image_uuid
-      end
-
-      def image_url
-        @image_url
-      end
-
-      def image_url=(url)
-        assign_attributes(
-          image_processing: url ? true : false,
-          image_uuid: url ? SecureRandom.uuid : nil
-        )
-
-        @image_url = url
-      end
-
-      def self.included(base)
-        base.after_commit do
-          PurgeJob.perform_later_for(self, prev_image_uuid) if prev_image_uuid
-          ThumbnailsJob.perform_later(self, image_url) if image_url
-        end
-
-        base.before_destroy if: :image? do
-          PurgeJob.perform_later_for(self)
-        end
-      end
-
-      private
-
-      def prev_image_uuid
-        previous_changes.fetch('image_uuid', [])[0]
-      end
-    end
-
-    # Provides the `has_image` method to attach to models.
-    module Hook
-      def has_image(styles = {}) # rubocop:disable Naming/PredicateName
-        extend DynamicExtension.new({ original: '' }.merge!(styles))
-        include StaticExtension
-      end
-    end
-
-    initializer 'paperweight' do
-      ActiveSupport.on_load(:active_record) { extend Hook }
-    end
-  end
-end

data/lib/paperweight/storage.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # Handles putting and deleting files from different kinds of storage.
-  module Storage
-    # A storage adapter for Amazon AWS S3.
-    class Remote
-      attr_reader :client
-
-      def initialize
-        @client = ::Aws::S3::Client.new(Paperweight.config.credentials)
-      end
-
-      def delete(key)
-        client.delete_object(bucket: Paperweight.config.bucket, key: key)
-      end
-
-      def put(file, key)
-        client.put_object(
-          acl: 'public-read',
-          bucket: Paperweight.config.bucket,
-          key: key,
-          content_type: Paperclip::ContentTypeDetector.new(file.path).detect,
-          content_disposition: 'attachment',
-          body: file
-        )
-      end
-    end
-
-    # A storage adapter for a local filesystem.
-    class Local
-      attr_reader :root
-
-      def initialize(root)
-        @root = root
-      end
-
-      def delete(key)
-        FileUtils.rm(File.join(root, key))
-      end
-
-      def put(file, key)
-        filepath = File.join(root, key)
-        FileUtils.mkdir_p(File.dirname(filepath))
-        FileUtils.cp(file.path, filepath)
-      end
-    end
-
-    class << self
-      def adapter
-        @adapter ||=
-          case Rails.env
-          when 'production'  then Remote.new
-          when 'development' then local_for('public')
-          when 'test'        then local_for('tmp')
-          end
-      end
-
-      private
-
-      def local_for(directory)
-        Local.new(Rails.root.join(directory, 'paperweight').to_s.freeze)
-      end
-    end
-  end
-end

data/lib/paperweight/thumbnails_job.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # Queues thumbnails for processing.
-  class ThumbnailsJob < ActiveJob::Base
-    queue_as :default
-
-    discard_on ActiveJob::DeserializationError
-
-    def perform(model, url)
-      model.image.update_url(url)
-    end
-  end
-end