carrierwave-blitline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcdab1946c051e221bdf9f7327168fa69d69a0ef
-  data.tar.gz: d8a451c3dba65f7e20090e7aa1479404d521781f
+SHA256:
+  metadata.gz: 7321893581e7f320dd4f97a0b68d57d7e9047863887e6a1c91fae9159ba391f2
+  data.tar.gz: 68c2ea79350ed4d47e06a1477a1bd48b5d11123bb3eb3ff73b8866ccde94c359
 SHA512:
-  metadata.gz: 0f1ea11ece56e432a29ba8e2dac504453a23c8f24c2081d0e4be48d158166e984907dc3dfee535ca57c4a12ca1475a73179bc76476e341e0c3a9270778f7a979
-  data.tar.gz: e278d95e4367a0df37580083ec3a76d8534a55aa504ce3ed2a4af5d720e18c5ea7be28cb3af71bfab6c93fee566db54f47f7d46a5f0a9a517bf88fa63b315f49
+  metadata.gz: 9ed4f4c07b32a58f894fa5fc45cf4641ef6d15f00e3177e83936e2840283df57b82218690aff79206033d6329dd155c7514f67f1e0e06c83bcc08049d8b26917
+  data.tar.gz: db9adcef477a9711f7920d7003315c561803162a82284dc2f7b9a78126a5f3543e103b7b2c96c7246cf797aae625b30e8c2ed12acee74d84f01940de5dfe8cbd

data/.circleci/config.yml

@@ -0,0 +1,112 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    environment:
+      CC_TEST_REPORTER_ID: 6f037067f424fa130712bb6a48398f25de184f86997b11990abbde61f2b07d7a
+
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5
+
+    working_directory: ~/carrierwave-blitline
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run:
+          name: Download CodeClimate
+          command: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+
+      - run:
+          name: "Change Permissions on CodeClimate"
+          command: chmod +x ./cc-test-reporter
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: "Prepare CC test reporter"
+          command: ./cc-test-reporter before-build
+
+      # run tests!
+      - run:
+          name: Run Rspec
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      - run:
+          name: "Report CodeClimate"
+          command: ./cc-test-reporter after-build --exit-code 0
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  audit:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5
+
+    working_directory: ~/carrierwave-blitline
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bunder Audit
+          command: gem install bundle-audit && bundle-audit check --update
+
+      - run:
+          name: Code Style Check
+          command: rubocop lib --display-style-guide -c ./.rubocop.yml
+
+workflows:
+  version: 2
+  build_and_audit:
+    jobs:
+      - build
+      - audit

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,60 @@
+inherit_gem:
+
+AllCops:
+  UseCache: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  # Include:
+  Exclude:
+    - 'Gemfile'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - '**/Rakefile'
+    - '**/config.ru'
+
+StringLiterals:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Rails:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 90
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false

data/README.md

@@ -1,3 +1,12 @@
+[![Latest Version](https://img.shields.io/gem/v/carrierwave-blitline.svg)](https://rubygems.org/gems/carrierwave-blitline)
+[![CircleCI](https://circleci.com/gh/KatanaCode/carrierwave-blitline.svg?style=svg)](https://circleci.com/gh/KatanaCode/carrierwave-blitline)
+[![Downloads](https://img.shields.io/github/downloads/katanacode/carrierwave-blitline/total.svg)](https://img.shields.io/github/downloads/katanacode/carrierwave-blitline/total.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fdd8cffc25d6002a68df/maintainability)](https://codeclimate.com/github/KatanaCode/carrierwave-blitline/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fdd8cffc25d6002a68df/test_coverage)](https://codeclimate.com/github/KatanaCode/carrierwave-blitline/test_coverage)
+
+
+---
+
 # Carrierwave::Blitline
 
 This gem is still under construction but it basically works in its current form.

data/carrierwave-blitline.gemspec

@@ -5,7 +5,7 @@ require 'carrierwave/blitline/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "carrierwave-blitline"
-  spec.version       = Carrierwave::Blitline::VERSION
+  spec.version       = CarrierWave::Blitline::VERSION
   spec.authors       = ["Bodacious"]
   spec.email         = ["team@katanacode.com"]
 
@@ -20,7 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "blitline", "~> 2.8"
-
+  spec.add_dependency "activesupport", ">= 3.0.0", "<6.0.0"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rubocop"
 end

data/lib/carrierwave/blitline.rb

@@ -1,11 +1,13 @@
-# From the Blitline gem
 module CarrierWave
+  # Extend the behaviour of CarrierWave to support Blitline services
   module Blitline
+    # frozen_string_literal: true
 
+    # From the Blitline gem
     require "blitline"
-
+    require "active_support/core_ext/module/delegation"
+    require "active_support/concern"
     require "carrierwave/blitline/version"
-    require "carrierwave/blitline/class_methods"
     require "carrierwave/blitline/image_version"
     require "carrierwave/blitline/function"
     require "carrierwave/blitline/image_version_function_presenter"
@@ -19,6 +21,9 @@ module CarrierWave
     # Blitline API version
     BLITLINE_VERSION = 1.21
 
+    ##
+    #
+    UNIQUE_IDENTIFIER_TEMPLATE = "%<app_name>_%<rails_env>_%<token>".freeze
 
     # Extends the including class with ClassMethods, add an after_store callback
     # and includes ImageMagick if required.
@@ -49,15 +54,16 @@ module CarrierWave
     #   Blitline gem.
     #
     #  file - not used within the method, but required for the callback to function
-    def rip_process_images(file)
+    def rip_process_images(_file)
       return unless rip_can_begin_processing?
       Rails.logger.tagged("Blitline") { |l| l.debug(job_hash.to_json) }
       blitline_service.add_job_via_hash(job_hash)
       begin
         blitline_service.post_jobs
-      rescue => e
+      rescue StandardError => e
         Rails.logger.tagged("Blitline") do |logger|
-          logger.error "ERROR: Blitline processing error for #{model.class.name}"
+          logger.error format("ERROR: Blitline processing error for %<class>\n%<message>",
+                              class: model.class.name, message: e.message)
         end
       end
     end
@@ -74,9 +80,9 @@ module CarrierWave
 
     # Returns a Hash for each function included in the Blitline API post
     def functions
-      blitline_image_versions.map { |version|
+      blitline_image_versions.map do |version|
         ImageVersionFunctionPresenter.new(version, self).to_hash
-      }
+      end
     end
 
     # sends a request to Blitline to re-process themain image and all versions
@@ -92,17 +98,19 @@ module CarrierWave
     #
     # Returns a boolean
     def rip_can_begin_processing?
-      process_via_blitline? and not self.class.name.include? "::"
+      process_via_blitline? && (!self.class.name.include? "::")
     end
 
     def filename
-      if file
-        "#{model.class.to_s.underscore}.#{file.extension}"
-      end
+      "#{model.class.to_s.underscore}.#{file.extension}" if file
     end
 
     def unique_identifier
-      @unique_identifier ||= "#{Rails.application.class.name}_#{Rails.env}_#{SecureRandom.base64(10)}"
+      @unique_identifier ||= begin
+        format(UNIQUE_IDENTIFIER_TEMPLATE, app_name: Rails.application.class.name,
+                                           rails_env: Rails.env,
+                                           token: SecureRandom.base64(10))
+      end
     end
 
     def file_name_for_version(version)
@@ -117,18 +125,18 @@ module CarrierWave
       send("params_for_#{function_name}", *args)
     end
 
-    def params_for_no_op(*args)
-      return {}
+    def params_for_no_op(*_args)
+      {}
     end
 
     def params_for_resize_to_fill(*args)
       args.flatten!
-      return { width: args.first, height: args.last }
+      { width: args.first, height: args.last }
     end
 
     def params_for_resize_to_fit(*args)
       args.flatten!
-      return { width: args.first, height: args.last }
+      { width: args.first, height: args.last }
     end
 
 
@@ -139,5 +147,30 @@ module CarrierWave
       @blitline_service ||= ::Blitline.new
     end
 
+    # Class methods to extend your Uploader classes
+    module ClassMethods
+      def version(name, &block)
+        blitline_image_versions << ImageVersion.new(name, &block)
+        # If process_via_blitline? is true, we still want to register the version with
+        #  the Uploader, but we don't want to define the conversions.
+        if process_via_blitline?
+          super(name) {}
+        else
+          super(name, &block)
+        end
+      end
+
+      def blitline_image_versions
+        @blitline_image_versions ||= [ImageVersion.new(nil)]
+      end
+
+      def process_via_blitline(value = true)
+        @process_via_blitline = value
+      end
+
+      def process_via_blitline?
+        defined?(@process_via_blitline) && @process_via_blitline == true
+      end
+    end
   end
 end

data/lib/carrierwave/blitline/function.rb

@@ -1,10 +1,7 @@
 module CarrierWave
   module Blitline
-
     # A Struct class for storing name and params for each function parameter.
     #   See also: ImageVersionFunctionPresenter
-    class Function < Struct.new(:name, :params)
-    end
-
+    Function = Struct.new(:name, :params)
   end
-end
+end

data/lib/carrierwave/blitline/image_version.rb

@@ -1,6 +1,5 @@
 module CarrierWave
   module Blitline
-
     # An instance of an ImageVersion for Blitline API.
     #
     #   When the process() version is called in an Uploader class, we store the version
@@ -48,7 +47,7 @@ module CarrierWave
         if primary_function.nil?
           self.primary_function    = function
         else
-          self.secondary_functions << function
+          secondary_functions << function
         end
       end
 
@@ -65,7 +64,5 @@ module CarrierWave
       end
 
     end
-
   end
-
 end

data/lib/carrierwave/blitline/image_version_function_presenter.rb

@@ -1,6 +1,5 @@
 module CarrierWave
   module Blitline
-
     # A presenter class for converting an image version to a JSON param for the Blitline
     #   API.
     class ImageVersionFunctionPresenter
@@ -51,32 +50,38 @@ module CarrierWave
             "s3_destination": {
               "bucket": {
                 "name":     ENV["S3_BUCKET_NAME"],
-                "location": ENV["S3_BUCKET_REGION"],
+                "location": ENV["S3_BUCKET_REGION"]
               },
               "key": file_name_for_version(version)
             }
           },
-          "functions": secondary_functions.map { |function|
-            {
-              "name": function.name,
-              "params": params_for_function(function.name,function.params),
-              "save": {
-                "image_identifier": unique_identifier,
-                "s3_destination": {
-                  "bucket": {
-                    "name":     ENV["S3_BUCKET_NAME"],
-                    "location": ENV["S3_BUCKET_REGION"],
-                  },
-                  "key": file_name_for_version(version)
-                }
+          "functions": functions_hashes
+        }
+      end
+
+
+      private
+
+
+      def functions_hashes
+        secondary_functions.map do |function|
+          {
+            "name": function.name,
+            "params": params_for_function(function.name, function.params),
+            "save": {
+              "image_identifier": unique_identifier,
+              "s3_destination": {
+                "bucket": {
+                  "name":     ENV["S3_BUCKET_NAME"],
+                  "location": ENV["S3_BUCKET_REGION"]
+                },
+                "key": file_name_for_version(version)
               }
             }
           }
-        }
+        end
       end
 
     end
-
   end
-
 end

data/lib/carrierwave/blitline/version.rb

@@ -1,5 +1,5 @@
-module Carrierwave
+module CarrierWave
   module Blitline
-    VERSION = "0.1.0"
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-blitline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bodacious
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-27 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blitline
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +72,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Integrates the carrierwave gem with Blitline image API. (Still under
   development)
 email:
@@ -60,7 +136,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,7 +148,6 @@ files:
 - bin/setup
 - carrierwave-blitline.gemspec
 - lib/carrierwave/blitline.rb
-- lib/carrierwave/blitline/class_methods.rb
 - lib/carrierwave/blitline/function.rb
 - lib/carrierwave/blitline/image_version.rb
 - lib/carrierwave/blitline/image_version_function_presenter.rb
@@ -94,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Integrates Blitline image processing with Carrierwave

data/lib/carrierwave/blitline/class_methods.rb

@@ -1,33 +0,0 @@
-# Class methods to be included in Blitline module
-module CarrierWave
-  module Blitline
-
-    module ClassMethods
-
-      def version(name, &block)
-        blitline_image_versions << ImageVersion.new(name, &block)
-        # If process_via_blitline? is true, we still want to register the version with
-        #  the Uploader, but we don't want to define the conversions.
-        if process_via_blitline?
-          super(name) {}
-        else
-          super(name, &block)
-        end
-      end
-
-      def blitline_image_versions
-        @blitline_versions ||= [ImageVersion.new(nil)]
-      end
-
-      def process_via_blitline(value = true)
-        @@process_via_blitline = value
-      end
-
-      def process_via_blitline?
-        defined?(@@process_via_blitline) && @@process_via_blitline == true
-      end
-
-    end
-  end
-
-end