shrine-lambda 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb563c825e410212d1c72e8b6c6204cc9bffffc2
-  data.tar.gz: eb4cdd5915f16353b01e003e54eff043cbaa8d5b
+SHA256:
+  metadata.gz: de0b2ec23b85a7b74eab35936b6f031abc89251d1bfa487de9b6d3b8890f1ac1
+  data.tar.gz: 89969c5aa88c8793c24dec44f2434acf604b6e0fda20688c1e01e96e1b4a8d23
 SHA512:
-  metadata.gz: a5ccc3f20d9fad0c75a57e37b5efa3e307ff1fce909945828167a21048ba246562239b99ff056ad7d8d48247b7f4fe8d575aab0353274cda4b95458aeb72f46a
-  data.tar.gz: 378d0031a0472f926c9887a85690816179d0fb7285ef204250d74b13c752d7707f34200d2c86da0fd68365d1fe4070303aa9f288aedc3276208e6f6f25dd00b4
+  metadata.gz: 96593e09066a0600ef0669d6be98a040764f646899ffac2c2f18a72491b39bcd9ebd5b47c930f8454d9ab99f4779263dd48d8cd2b26410ba84fb1211ea9b087e
+  data.tar.gz: 47d53b565d9dcf0783630e42674e24761c9311a7f59048794aea7f7ab46e48f25e5ef7a98f39ad377874ae4f0370a5341c778dedd84561a10f5916dd1585286e

data/CHANGELOG.md

@@ -1,8 +1,21 @@
-# Change Log
+# Changelog
+
+## [0.1.0](https://github.com/texpert/shrine-lambda/tree/0.1.0) (2020-05-25)
+
+[Full Changelog](https://github.com/texpert/shrine-lambda/compare/v0.0.1...0.1.0)
+
+**Breaking changes:**
+
+- BREAKING CHANGE: Uploader's `:lambda\_process` method renamed to `:lambda\_process\_versions` [\#14](https://github.com/texpert/shrine-lambda/pull/14) ([texpert](https://github.com/texpert))
+
+**Implemented enhancements:**
+
+- Rubocop tuning and offences fixing [\#12](https://github.com/texpert/shrine-lambda/pull/12) ([texpert](https://github.com/texpert))
 
-## [0.0.1](https://github.com/texpert/shrine-lambda/tree/0.0.1) (2018-02-12)
 **Merged pull requests:**
 
+- Added github\_changelog\_generator as a development dependency [\#15](https://github.com/texpert/shrine-lambda/pull/15) ([texpert](https://github.com/texpert))
+- Release v. 0.0.1 [\#11](https://github.com/texpert/shrine-lambda/pull/11) ([texpert](https://github.com/texpert))
 - Prepairing for release. [\#10](https://github.com/texpert/shrine-lambda/pull/10) ([texpert](https://github.com/texpert))
 - Plugin documentation. [\#9](https://github.com/texpert/shrine-lambda/pull/9) ([texpert](https://github.com/texpert))
 - Comply with Shrine's `upload\_options` plugin to be able to set ACL's … [\#8](https://github.com/texpert/shrine-lambda/pull/8) ([texpert](https://github.com/texpert))
@@ -14,6 +27,10 @@
 - Fix of `:configure` and implementation of client and  `:lambda\_function\_list` methods. [\#2](https://github.com/texpert/shrine-lambda/pull/2) ([texpert](https://github.com/texpert))
 - Initial gem and plugin config [\#1](https://github.com/texpert/shrine-lambda/pull/1) ([texpert](https://github.com/texpert))
 
+## [v0.0.1](https://github.com/texpert/shrine-lambda/tree/v0.0.1) (2018-02-12)
+
+[Full Changelog](https://github.com/texpert/shrine-lambda/compare/803b40a03817943e5032c653742f90d811cdaff8...v0.0.1)
+
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -171,7 +171,7 @@ the Lambda function's `:access_key_id` received in the request authorization hea
 
 #### Usage
 
-Shrine-Lambda assemblies are built inside the `#lambda_process` method in the `LambdaUploader` class:
+Shrine-Lambda assemblies are built inside the `#lambda_process_versions` method in the `LambdaUploader` class:
 
 ```
 # app/uploaders/lambda_uploader.rb:
@@ -191,7 +191,7 @@ class LambdaUploader < Uploader
 
   plugin :versions
 
-  def lambda_process(io, context)
+  def lambda_process_versions(io, context)
     assembly = { function: 'ImageResizeOnDemand' } # Here the AWS Lambda function name is specified
 
     # Check if the original file format is a image format supported by the Sharp.js library

data/lib/shrine/plugins/shrine-lambda.rb

@@ -5,35 +5,45 @@ require 'aws-sdk-lambda'
 class Shrine
   module Plugins
     module Lambda
-      SETTINGS = { access_key_id: :optional,
-                   callback_url: :required,
-                   convert_params: :optional,
-                   endpoint: :optional,
-                   log_formatter: :optional,
-                   log_level: :optional,
-                   logger: :optional,
-                   profile: :optional,
-                   region: :optional,
-                   retry_limit: :optional,
+      SETTINGS = { access_key_id:     :optional,
+                   callback_url:      :required,
+                   convert_params:    :optional,
+                   endpoint:          :optional,
+                   log_formatter:     :optional,
+                   log_level:         :optional,
+                   logger:            :optional,
+                   profile:           :optional,
+                   region:            :optional,
+                   retry_limit:       :optional,
                    secret_access_key: :optional,
-                   session_token: :optional,
-                   stub_responses: :optional,
-                   validate_params: :optional }.freeze
+                   session_token:     :optional,
+                   stub_responses:    :optional,
+                   validate_params:   :optional }.freeze
 
       Error = Class.new(Shrine::Error)
 
       # If promoting was not yet overridden, it is set to automatically trigger
       # Lambda processing defined in `Shrine#lambda_process`.
       def self.configure(uploader, settings = {})
-        settings.each do |key, value|
-          raise Error, "The :#{key} is not supported by the Lambda plugin" unless SETTINGS[key]
-          uploader.opts[key] = value || uploader.opts[key]
-          if SETTINGS[key] == :required && uploader.opts[key].nil?
-            raise Error, "The :#{key} is required for Lambda plugin"
-          end
+        SETTINGS.each do |key, value|
+          raise Error, "The :#{key} option is required for Lambda plugin" if value == :required && settings[key].nil?
+
+          uploader.opts[key] = settings.delete(key) if settings[key]
         end
 
-        uploader.opts[:backgrounding_promote] ||= proc { lambda_process }
+        @logger = if Shrine.respond_to?(:logger)
+                    Shrine.logger
+                  elsif uploader.respond_to?(:logger)
+                    uploader.logger
+                  end
+
+        uploader.opts[:backgrounding_promote] = proc { lambda_process }
+
+        return unless @logger
+
+        settings.each do |key, _value|
+          @logger.info "The :#{key} option is not supported by the Lambda plugin"
+        end
       end
 
       # It loads the backgrounding plugin, so that it can override promoting.
@@ -56,26 +66,35 @@ class Shrine
         # received from Lambda request. Then it compares the calculated and received signatures, returning an error if
         # the signatures mismatch.
         #
-        # If the signatures are equal, it returns the attacher and the hash of the parsed result from Lambda.
+        # If the signatures are equal, it returns the attacher and the hash of the parsed result from Lambda, else -
+        # it returns false.
         # @param [Hash] headers from the Lambda request
+        # @option headers [String] 'User-Agent' The AWS Lambda function user agent
+        # @option headers [String] 'Content-Type' 'application/json'
+        # @option headers [String] 'Host'
+        # @option headers [String] 'X-Amz-Date' The AWS Lambda function user agent
+        # @option headers [String] 'Authorization' The AWS authorization string
         # @param [String] body of the Lambda request
-        # @return [Array] Shrine Attacher and the Lambda result (the request body parsed to a hash).
+        # @return [Array] Shrine Attacher and the Lambda result (the request body parsed to a hash) if signature in
+        #   received headers matches locally computed AWS signature
+        # @return [false] if signature in received headers does't match locally computed AWS signature
         def lambda_authorize(headers, body)
           result = JSON.parse(body)
           attacher = load(result.delete('context'))
           incoming_auth_header = auth_header_hash(headers['Authorization'])
 
-          signer = build_signer(incoming_auth_header['Credential'].split('/'),
-                                JSON.parse(attacher.record.__send__(:"#{attacher.data_attribute}"))['metadata']['key'],
-                                headers['x-amz-security-token'])
-          signature = signer.sign_request(
-            http_method: 'PUT',
-            url: Shrine.opts[:callback_url],
-            headers: { 'X-Amz-Date' => headers['X-Amz-Date'] },
-            body: body
+          signer = build_signer(
+            incoming_auth_header['Credential'].split('/'),
+            JSON.parse(attacher.record.__send__(:"#{attacher.data_attribute}") || '{}').dig('metadata', 'key') || 'key',
+            headers['x-amz-security-token']
           )
+          signature = signer.sign_request(http_method: 'PUT',
+                                          url:         Shrine.opts[:callback_url],
+                                          headers:     { 'X-Amz-Date' => headers['X-Amz-Date'] },
+                                          body:        body)
           calculated_signature = auth_header_hash(signature.headers['authorization'])['Signature']
           return false if incoming_auth_header['Signature'] != calculated_signature
+
           [attacher, result]
         end
 
@@ -83,13 +102,13 @@ class Shrine
 
         def build_signer(headers, secret_access_key, security_token = nil)
           Aws::Sigv4::Signer.new(
-            service: headers[3],
-            region: headers[2],
-            access_key_id: headers[0],
-            secret_access_key: secret_access_key,
-            session_token: security_token,
+            service:               headers[3],
+            region:                headers[2],
+            access_key_id:         headers[0],
+            secret_access_key:     secret_access_key,
+            session_token:         security_token,
             apply_checksum_header: false,
-            unsigned_headers: %w[content-length user-agent x-amzn-trace-id]
+            unsigned_headers:      %w[content-length user-agent x-amzn-trace-id]
           )
         end
 
@@ -110,27 +129,28 @@ class Shrine
         # function for signing the request.
         #
         # Stores the DB record class and name, attacher data atribute and uploader class names, into the context
-        # attribute of the Lambda function invokation payload. Also stores the cahced file has and the generated path
-        # into the payload.
+        # attribute of the Lambda function invokation payload. Also stores the cached file hash object and the
+        # generated path into the payload.
         #
-        # After the AWS Lambda function was invoked, it raises a `Shrine::Error`if the response is containing errors.
-        # No more response analysis is performed, because Lambda is invoked asynchronously (note the
+        # After the AWS Lambda function invocation, a `Shrine::Error` will be raised if the response is containing
+        # errors. No more response analysis is performed, because Lambda is invoked asynchronously (note the
         # `invocation_type`: 'Event' in the `invoke` call). The results will be sent by Lambda by HTTP requests to
         # the specified `callbackUrl`.
         def lambda_process(data)
           cached_file = uploaded_file(data['attachment'])
-          assembly = Shrine.lambda_default_values
-          assembly.merge!(store.lambda_process(cached_file, context))
+          assembly = lambda_default_values
+          assembly.merge!(store.lambda_process_versions(cached_file, context))
           function = assembly.delete(:function)
           raise Error, 'No Lambda function specified!' unless function
           raise Error, "Function #{function} not available on Lambda!" unless function_available?(function)
 
           prepare_assembly(assembly, cached_file, context)
           assembly[:context] = data.except('attachment', 'action', 'phase')
-          response = lambda_client.invoke(function_name: function,
+          response = lambda_client.invoke(function_name:   function,
                                           invocation_type: 'Event',
-                                          payload: assembly.to_json)
+                                          payload:         assembly.to_json)
           raise Error, "#{response.function_error}: #{response.payload.read}" if response.function_error
+
           swap(cached_file) || _set(cached_file)
         end
 
@@ -141,7 +161,7 @@ class Shrine
         # Deletes the signing key, if it is present in the original file's metadata, converts the result to a JSON
         # string, and writes this string into the `data_attribute` of the Shrine attacher's record.
         #
-        # Chooses the `save_methodz` either for the ActiveRecord or for Sequel, and saves the record.
+        # Chooses the `save_method` either for the ActiveRecord or for Sequel, and saves the record.
         # @param [Hash] result
         def lambda_save(result)
           versions = result['versions']
@@ -165,6 +185,20 @@ class Shrine
 
         private
 
+        def lambda_default_values
+          { callbackURL:    Shrine.opts[:callback_url],
+            copy_original:  true,
+            storages:       buckets_to_use(%i[cache store]),
+            target_storage: :store }
+        end
+
+        # @param [Array] buckets that will be sent to Lambda function for use
+        def buckets_to_use(buckets)
+          buckets.map do |b|
+            { b.to_s => { name: Shrine.storages[b].bucket.name, prefix: Shrine.storages[b].prefix } }
+          end.inject(:merge!)
+        end
+
         # A cached instance of an AWS Lambda client.
         def lambda_client
           @lambda_client ||= Shrine.lambda_client
@@ -213,24 +247,11 @@ class Shrine
         def lambda_function_list(master_region: nil, function_version: 'ALL', marker: nil, items: 100, force: false)
           fl = opts[:lambda_function_list]
           return fl unless force || fl.nil? || fl.empty?
-          opts[:lambda_function_list] = lambda_client.list_functions(master_region: master_region,
-                                                                     function_version: function_version,
-                                                                     marker: marker,
-                                                                     max_items: items).functions
-        end
 
-        # @param [Array] buckets that will be sent to Lambda function for use
-        def buckets_to_use(buckets)
-          buckets.map do |b|
-            { b.to_s => { name: Shrine.storages[b].bucket.name, prefix: Shrine.storages[b].prefix } }
-          end.inject(:merge!)
-        end
-
-        def lambda_default_values
-          { callbackURL:    Shrine.opts[:callback_url],
-            copy_original:  true,
-            storages:       Shrine.buckets_to_use(%i[cache store]),
-            target_storage: :store }
+          opts[:lambda_function_list] = lambda_client.list_functions(master_region:    master_region,
+                                                                     function_version: function_version,
+                                                                     marker:           marker,
+                                                                     max_items:        items).functions
         end
       end
     end

data/shrine-lambda.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'shrine-lambda'
-  gem.version       = '0.0.1'
+  gem.version       = '0.1.0'
 
   gem.required_ruby_version = '>= 2.3'
 
@@ -19,17 +19,19 @@ Gem::Specification.new do |gem|
   gem.files        = Dir['CHANGELOG.md', 'README.md', 'LICENSE', 'lib/**/*.rb', '*.gemspec']
   gem.require_path = 'lib/shrine/plugins'
 
-  gem.metadata = {
-      "bug_tracker_uri"   => "https://github.com/texpert/shrine-lambda/issues",
-      "changelog_uri"     => "https://github.com/texpert/shrine-lambda/CHANGELOG.md",
-      "source_code_uri"   => "https://github.com/texpert/shrine-lambda"
-  }
+  gem.metadata = { 'bug_tracker_uri' => 'https://github.com/texpert/shrine-lambda/issues',
+                   'changelog_uri'   => 'https://github.com/texpert/shrine-lambda/CHANGELOG.md',
+                   'source_code_uri' => 'https://github.com/texpert/shrine-lambda' }
 
   gem.add_dependency 'aws-sdk-lambda', '~> 1.0'
   gem.add_dependency 'aws-sdk-s3', '~> 1.2'
   gem.add_dependency 'shrine', '~> 2.6'
 
+  gem.add_development_dependency 'activerecord', '>= 4.2.0'
   gem.add_development_dependency 'dotenv'
+  gem.add_development_dependency 'github_changelog_generator'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rubocop', '~> 0.52'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop', '0.81'
+  gem.add_development_dependency 'sqlite3' unless RUBY_ENGINE == 'jruby'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-lambda
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Aurel Branzeanu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2020-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-lambda
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +108,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.81'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.81'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: |2
         AWS Lambda integration plugin for Shrine File Attachment toolkit for Ruby applications.
         Used for invoking AWS Lambda functions for processing files already stored in some AWS S3 bucket.
@@ -130,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: AWS Lambda integration plugin for Shrine.