paperweight 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eeef0e576fcbb817bc834920213d877082c62843f67ce5d506d4543faa818d0
-  data.tar.gz: 9c693fee6737870d4dddc4bfaf1623f00bf49dc69040974920f9772411224084
+  metadata.gz: c9e3211e8bbf5de4d55271d89815de2fb413b8a9702e7ff280771ef2e4dfe944
+  data.tar.gz: f643f81049c0b4accef26b1ba8fd7c26af8030c8315e5656f6039946e52c240b
 SHA512:
-  metadata.gz: 2d70e2977920dab169fbda44dccaa94e9434250438deced9c6c77564292cf7005c1e3fe6302724f7007c603e301c20711ca054e514915ca0e99e44df00f9cfce
-  data.tar.gz: e70e7bc7cc925360bf476bb24dc56feedd28ced08c348e5a0f123f185df33a5d50ef668f84a167418f2c3276676ac26de16f7dbe92edcfef9209eeefae28f194
+  metadata.gz: e4099be28ad137adc0307b4e507e25a20d0edfd83c86d13fb2d2b62d50882e0c390e797bc50fa878a9803cc7117c3f4614d01a2d4807d36bdd4a2c848839682c
+  data.tar.gz: ca6ed11cd8f2bd2ad78baec34a7a4aca11d7797dde33dac29dbfb11b88e3b713ed48b715d1579c712fed713e895ec885d6974a9d68cd5314550a538ec5356afa

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2018-08-15
+### Added
+- The ability to configure the `max_size` value (the maximum download size) using the `Paperweight.configure` method.
+
+[Unreleased]: https://github.com/CultureHQ/client/compare/v0.2.0...HEAD
+[v0.2.0]: https://github.com/CultureHQ/client/compare/v0.1.2...v0.2.0

data/Gemfile.lock

@@ -1,50 +1,50 @@
 PATH
   remote: .
   specs:
-    paperweight (0.1.2)
-      paperclip (~> 6.1)
-      rails (~> 5.2)
+    paperweight (0.2.0)
+      paperclip (>= 5)
+      rails (>= 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.0)
-      actionpack (= 5.2.0)
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.0)
-      activesupport (= 5.2.0)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
       arel (>= 9.0)
-    activestorage (5.2.0)
-      actionpack (= 5.2.0)
-      activerecord (= 5.2.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
       marcel (~> 0.3.1)
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -59,7 +59,7 @@ GEM
     erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)
@@ -94,30 +94,30 @@ GEM
     rack (2.0.5)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.0)
-      actioncable (= 5.2.0)
-      actionmailer (= 5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      activemodel (= 5.2.0)
-      activerecord (= 5.2.0)
-      activestorage (= 5.2.0)
-      activesupport (= 5.2.0)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
       bundler (>= 1.3.0)
-      railties (= 5.2.0)
+      railties (= 5.2.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (12.3.1)
     rubocop (0.58.2)
@@ -128,7 +128,7 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.10.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)

data/README.md

@@ -57,6 +57,20 @@ end
 
 From now on, updating this attribute will queue a job in the background to update the image later.
 
+### Configuration
+
+You can provide additional configuration options through the `Paperweight.configure` method, as in:
+
+```ruby
+Paperweight.configure do |config|
+  config.max_size = 20 * 1024 * 1024
+end
+```
+
+The current configuration options include:
+
+* `max_size` - defaults to 10 MB
+
 ## 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.rb

@@ -7,6 +7,7 @@ require 'rails'
 
 require 'active_job'
 
+require 'paperweight/configuration'
 require 'paperweight/download'
 require 'paperweight/hook'
 require 'paperweight/post_process_job'

data/lib/paperweight/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Handles `Paperclip` attachments on the backend in a delayed process.
+module Paperweight
+  # Allows configuring certain attributes about how to process attachments.
+  class Configuration
+    attr_accessor :max_size
+
+    def initialize
+      @max_size = 10 * 1024 * 1024
+    end
+  end
+
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/paperweight/download.rb

@@ -13,8 +13,6 @@ module Paperweight
       Error                 # our errors
     ].freeze
 
-    MAX_SIZE = 10 * 1024 * 1024
-
     def download(url)
       # Finally we download the file. Here we mustn't use simple #open that
       # open-uri overrides, because this is vulnerable to shell execution
@@ -52,6 +50,8 @@ module Paperweight
     end
 
     def open_options
+      max_size = Paperweight.config.max_size
+
       {}.tap do |options|
         # It was shown that in a random sample approximately 20% of websites
         # will simply refuse a request which doesn't have a valid User-Agent.
@@ -61,8 +61,8 @@ module Paperweight
         # will call this block as soon as it gets the "Content-Length" header,
         # which means that we can bail out before we download the file.
         options[:content_length_proc] = lambda { |size|
-          if size && size > MAX_SIZE
-            raise Error, "file is too big (max is #{MAX_SIZE})"
+          if size && size > max_size
+            raise Error, "file is too big (max is #{max_size})"
           end
         }
       end

data/lib/paperweight/version.rb

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

data/paperweight.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'paperclip', '~> 6.1'
-  spec.add_dependency 'rails', '~> 5.2'
+  spec.add_dependency 'paperclip', '>= 5'
+  spec.add_dependency 'rails', '>= 5'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.11'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: paperweight
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-28 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -140,6 +141,7 @@ files:
 - bin/console
 - bin/setup
 - lib/paperweight.rb
+- lib/paperweight/configuration.rb
 - lib/paperweight/download.rb
 - lib/paperweight/hook.rb
 - lib/paperweight/post_process_job.rb