cws3chk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c5979e26ae5b8fdb283cb68dbd10e9270f5703c
+  data.tar.gz: 6781fede45e5a2864aa4d23782e85e23d6f451d9
+SHA512:
+  metadata.gz: 677899d7077e3e11fb1eba084a7d70dd0aee54bf6b4229d382353094020328c84bde651a6effb5ccb57cd618224d89c29fbdd326620d4d5ee430eea0618597b2
+  data.tar.gz: d164a44ae4a6f325bf23c0c90d34fe83581f37e7da373c4be5d0233c7b9d419e046c0ff173a1f21cd721bc722ce86356c4b1daf71e07fc7c3306bcb359a4446a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Cws3chk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Antoine Qu'hen
+
+MIT License
+
+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,40 @@
+# Cws3chk
+
+This gem checks the existance on S3 of the assets described by ActiveRecord
+and Carrierwave.
+
+* It loads the ids of the object with assets in a task and splits them into 
+  groups. Each group is going to be processed by a Resque Job.
+* It studies the groups of object by launching n threads. It checks for the
+  existence of the original file and the different versions.
+* It stores the result of the check in Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Cws3chk'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+    $ bundle exec rake Cws3chk:check
+or
+
+```ruby
+request = User.with_avatar
+Cws3chk::Checker.new(request, :avatar, 250).check
+```
+Then study your missig assets and fix them if needed:
+```ruby
+redis.smembers 'Cws3chk::missing'
+```
+You can also study the size of the resulting assets:
+```ruby
+redis.smembers 'Cws3chk::metadata'
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "Cws3chk/tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/cws3chk.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Cws3chk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cws3chk"
+  spec.version       = Cws3chk::VERSION
+  spec.authors       = ["Antoine Qu'hen"]
+  spec.email         = ["antoinequhen@gmail.com"]
+  spec.summary       = %q{Check assets are on S3 as Carrierwave says}
+  spec.description   = %q{This gem studies the existency of AR model assets, including their versions, on S3 via Resque jobs.}
+  spec.homepage      = "https://rubygems.org/gems/cws3chk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '>= 4.1.8'
+  spec.add_runtime_dependency 'aws', '>= 2.10.2'
+  spec.add_runtime_dependency 'resque', '>= 1.25.2'
+  spec.add_runtime_dependency 'retryable_block', '>= 0.0.1'
+  spec.add_runtime_dependency 'threadify_procs', '>= 0.0.5'
+  spec.add_runtime_dependency 'redis', '>= 3.1.0'
+  spec.add_runtime_dependency 'json', '>= 1.8.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mocha", ">= 1.1.0"
+end

data/lib/cws3chk/checker.rb

@@ -0,0 +1,53 @@
+require 'threadify_procs'
+require 'Cws3chk/s3'
+require 'Cws3chk/store'
+
+# This class is in charge of checking the existance on S3 of the assets
+# described by ActiveRecord + Carrierwave.
+# It checks for the existence of the original file an the different versions.
+# It stores the result of the check in Redis.
+#
+# After loading the data from the database, it performs the calls to S3 in
+# parallel via threads.
+class Cws3chk::Checker < Struct.new(:request, :mounted_column, :threads)
+  include ThreadifyProcs
+
+  def check
+    call_with_threads procs, number_of_threads: threads
+  end
+
+  private
+
+  def procs
+    [].tap do |_procs|
+      iterate_over_resources_and_versions do |resource, uploader, version|
+        _procs << Proc.new{ study resource, uploader, version }
+      end
+    end
+  end
+
+  def versions uploader
+    [nil] + uploader.versions.keys
+  end
+
+  def iterate_over_resources_and_versions
+    request.find_each do |resource|
+      next unless resource.public_send("#{mounted_column}?") # resource.image?
+      uploader = resource.public_send mounted_column # resource.image
+      versions(uploader).each do |version|
+        yield resource, uploader, version
+      end
+    end
+  end
+
+  def study resource, uploader, version
+    s3 = Cws3chk::S3.new uploader, version
+    store = Cws3chk::Store.new(
+      resource, mounted_column, version)
+    if s3.file_exists?
+      store.store_headers s3.headers
+    else
+      store.store_missing_asset
+    end
+  end
+end

data/lib/cws3chk/job.rb

@@ -0,0 +1,12 @@
+# This job takes an ActiveRecord model, a column and a bunch of ids, and runs
+# the check on all the versions of those objects. Including the original version.
+class Cws3chk::Job
+  # TODO config
+  @queue = :z_low
+
+  def self.perform klass_name, ids_json, threads, mounted_column
+    ids = JSON.load ids_json
+    request = klass_name.constantize.where id: ids
+    Cws3chk::Checker.new(request, mounted_column, threads).check
+  end
+end

data/lib/cws3chk/redis.rb

@@ -0,0 +1,7 @@
+module Cws3chk::Redis
+
+  # TODO config
+  def redis
+    @redis ||= ::RedisProxy
+  end
+end

data/lib/cws3chk/s3.rb

@@ -0,0 +1,43 @@
+require 'retryable_block'
+
+class Cws3chk::S3 < Struct.new(:uploader, :version)
+  include RetryableBlock
+
+  # TODO put 1.kilobyte in config
+  def file_exists?
+    headers.present? && headers['content-length'].to_i > 1.kilobyte
+  end
+
+  def headers
+    @headers ||= s3_key_headers
+  end
+
+  private
+
+  def s3_key_headers
+    s3_key.tap do |key|
+      begin
+        retryable{ key.head }
+        print '.'
+      rescue => e
+        Rails.logger.warn "Cws3chk::S3 #{e.message}"
+      end
+    end.headers # Headers is blank if the head request has failed.
+  end
+
+  def s3_key
+    Aws::S3::Key.create bucket, s3_key_path
+  end
+
+  def bucket
+    if defined?(S3::Helper) == 'constant' && S3::Helper.class == Class  
+      @bucket ||= S3::Helper.current_bucket
+    else
+      #TODO config
+    end
+  end
+
+  def s3_key_path
+    @s3_key_path ||= (version ? uploader.public_send(version) : uploader).path
+  end
+end

data/lib/cws3chk/store.rb

@@ -0,0 +1,24 @@
+require 'Cws3chk/redis'
+
+class Cws3chk::Store < Struct.new(:resource, :mounted_column, :version)
+  include Cws3chk::Redis
+
+  # TODO redis or stdout > config
+  def store_missing_asset
+    redis.sadd 'Cws3chk::missing', base.to_json
+  end
+  
+  def store_headers headers
+    redis.sadd 'Cws3chk::metadata',
+      (base + [headers['content-length']]).to_json
+  end
+  
+  private
+
+  def base
+    [resource.class.name,
+     resource.id,
+     mounted_column,
+     version]
+  end
+end

data/lib/cws3chk/tasks.rb

@@ -0,0 +1,29 @@
+# 2X dynos support no more than 512 Processes or Threads
+# An AWS connection needs its own thread.
+desc <<-DESC
+This task launchs Resque Jobs to study Carrierwave assets. The links to those
+assets are comming from the database through ActiveRecord.
+
+You need to provide the name of the ActiveRecord model, the mounted column, the
+number of available workers and the number of threads per worker.
+
+Default:
+* number of workers = 100
+* number of threads = 250
+
+Remember:
+* On Heroku a 2X dyno has a limit of 512 Processes or Threads.
+* An AWS connection needs its own thread with the aws gem.
+DESC
+task :collect_missing_assets, :model, :mounted_column, :workers, :threads do
+  raise('No Rails environment !') unless Rake::Task[:environment]
+  Rake::Task[:environment].invoke
+  klass = args.model.camelize.constantize
+  ids = klass.where.not(args.mounted_column => nil).pluck(:id)
+  workers = args.workers.present? ? args.workers.to_i : 100
+  threads = args.threads.present? ? args.threads.to_i : 250
+  ids.each_slice(workers) do |ids_group|
+    Resque.enqueue Cws3chk::Job, klass.name, ids_group.to_json, threads,
+      mounted_column
+  end
+end

data/lib/cws3chk/version.rb

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

data/lib/cws3chk.rb

@@ -0,0 +1,8 @@
+require 'Cws3chk/version'
+require 'Cws3chk/job'
+require 'Cws3chk/checker'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Cws3chk
+end

data/test/test_cws3chk.rb

@@ -0,0 +1,116 @@
+require 'minitest/autorun'
+require 'Cws3chk'
+require 'mocha/mini_test'
+require 'aws'
+
+class Cws3chkTest < Minitest::Test
+
+  class Subject
+    def image?
+      true
+    end
+
+    def image
+    end
+  end
+
+  class FakeRedis
+    attr_reader :sets
+    def initialize
+      @sets = {}
+    end
+
+    def sadd key, value
+      (@sets[key] ||= []) << value
+    end
+  end
+
+  def setup
+    Cws3chk::Store.any_instance.stubs(:redis).returns(fake_redis)
+  end
+
+  def test_check_one_present_asset
+    set_s3_headers_to headers_of_present_asset
+    Cws3chk::Checker.new(request, :image, 2).check
+    keys = fake_redis.sets["Cws3chk::metadata"]
+    assert_equal keys.size, 2
+    assert_equal keys.sort, [
+      "[\"Cws3chkTest::Subject\",1,\"image\",\"pdf\",1999]",
+      "[\"Cws3chkTest::Subject\",1,\"image\",null,1999]"
+    ]
+  end
+
+  def test_check_one_missing_asset
+    set_s3_headers_to headers_of_missing_asset
+    Cws3chk::Checker.new(request, :image, 2).check
+    keys = fake_redis.sets["Cws3chk::missing"]
+    assert_equal keys.size, 2
+    assert_equal keys.sort, [
+      "[\"Cws3chkTest::Subject\",1,\"image\",\"pdf\"]",
+      "[\"Cws3chkTest::Subject\",1,\"image\",null]"
+    ]
+  end
+
+  private
+
+  def set_s3_headers_to headers
+    @headers = headers
+    Aws::S3::Key.stubs(:create).returns(s3_key)
+  end
+
+  def headers_of_present_asset
+    {'content-length' => 1999}
+  end
+
+  def headers_of_missing_asset
+    nil
+  end
+
+  def s3_key
+    mock('s3_key').tap do |_mock|
+      _mock.stubs(:head).returns(true)
+      _mock.stubs(:headers).returns(@headers)
+    end
+  end
+
+  def request
+    mock().tap do |_mock|
+      _mock.stubs(:find_each).yields(subject)
+    end
+  end
+
+  def subject
+    mock().tap do |_mock|
+      _mock.stubs(:image).returns(uploader)
+      _mock.stubs(:image?).returns(true)
+      _mock.stubs(:class).returns(Subject)
+      _mock.stubs(:id).returns(1)
+    end
+  end
+
+  def uploader
+    mock().tap do |_mock|
+      _mock.stubs(:versions).returns(mock keys: [:pdf])
+      _mock.stubs(:pdf).returns(pdf_version)
+      _mock.stubs(:path).returns(path)
+    end
+  end
+
+  def path
+    'path_to_original'
+  end
+
+  def pdf_version
+    mock().tap do |_mock|
+      _mock.stubs(:path).returns(pdf_path)
+    end
+  end
+
+  def pdf_path
+    'path_to_pdf_version'
+  end
+
+  def fake_redis
+    @fake_redis ||= FakeRedis.new
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: cws3chk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antoine Qu'hen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.25.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.25.2
+- !ruby/object:Gem::Dependency
+  name: retryable_block
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: threadify_procs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: This gem studies the existency of AR model assets, including their versions,
+  on S3 via Resque jobs.
+email:
+- antoinequhen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cws3chk.gemspec
+- lib/cws3chk.rb
+- lib/cws3chk/checker.rb
+- lib/cws3chk/job.rb
+- lib/cws3chk/redis.rb
+- lib/cws3chk/s3.rb
+- lib/cws3chk/store.rb
+- lib/cws3chk/tasks.rb
+- lib/cws3chk/version.rb
+- test/test_cws3chk.rb
+homepage: https://rubygems.org/gems/cws3chk
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Check assets are on S3 as Carrierwave says
+test_files:
+- test/test_cws3chk.rb
+has_rdoc: