shrine-lambda 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de0b2ec23b85a7b74eab35936b6f031abc89251d1bfa487de9b6d3b8890f1ac1
-  data.tar.gz: 89969c5aa88c8793c24dec44f2434acf604b6e0fda20688c1e01e96e1b4a8d23
+  metadata.gz: 366018c294b31c7b6cf3fcb385dc1101df63f764fc55c1401a25dba2ed57a486
+  data.tar.gz: 2978133c7f3fd0c97063dfc550343f32f83505a9f07dc30ebfb15321906dfef4
 SHA512:
-  metadata.gz: 96593e09066a0600ef0669d6be98a040764f646899ffac2c2f18a72491b39bcd9ebd5b47c930f8454d9ab99f4779263dd48d8cd2b26410ba84fb1211ea9b087e
-  data.tar.gz: 47d53b565d9dcf0783630e42674e24761c9311a7f59048794aea7f7ab46e48f25e5ef7a98f39ad377874ae4f0370a5341c778dedd84561a10f5916dd1585286e
+  metadata.gz: 3611b568a2638199bd474b0b3075d7f7bf10e4a0f7c40c18d6386fdc3cad992e55a1e3481e59ba2b61245982f14f24c3c63e7dfd7dcd98691a4874cc81bfe813
+  data.tar.gz: e4a36b7652589214d0d35506e9631a00ede249f279db176043eb059407f8f9468ba07f5a4998288c7af485bb83d02adf094ec31bb12a08a1d50271dc189b8d68

data/CHANGELOG.md

@@ -1,12 +1,28 @@
 # Changelog
 
-## [0.1.0](https://github.com/texpert/shrine-lambda/tree/0.1.0) (2020-05-25)
+    DEPRECATION NOTICE: shrine-lambda gem will be renamed to shrine-aws-lambda for clarity
 
-[Full Changelog](https://github.com/texpert/shrine-lambda/compare/v0.0.1...0.1.0)
+    The current version, 0.1.1, is the last version under the shrine-lambda name.
+
+    Thank you for using this gem!
+
+## [v0.1.1](https://github.com/texpert/shrine-lambda/tree/v0.1.1) (2021-04-09)
+
+[Full Changelog](https://github.com/texpert/shrine-lambda/compare/v0.1.0...v0.1.1)
+
+**Merged pull requests:**
+
+- Add Gem Maintenance chapter, language labels to markdown code to README.md [\#20](https://github.com/texpert/shrine-lambda/pull/20) ([texpert](https://github.com/texpert))
+- Set post-install deprecation notice about renaming the gem, add version file [\#19](https://github.com/texpert/shrine-lambda/pull/19) ([texpert](https://github.com/texpert))
+- Fix uninitialized constant Shrine::Error when adding shrine-lambda to… [\#18](https://github.com/texpert/shrine-lambda/pull/18) ([texpert](https://github.com/texpert))
+
+## [v0.1.0](https://github.com/texpert/shrine-lambda/tree/v0.1.0) (2020-05-24)
+
+[Full Changelog](https://github.com/texpert/shrine-lambda/compare/v0.0.1...v0.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))
+- 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:**
 
@@ -14,17 +30,18 @@
 
 **Merged pull requests:**
 
+- Prepare the 0.1.0 release [\#16](https://github.com/texpert/shrine-lambda/pull/16) ([texpert](https://github.com/texpert))
 - 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))
+- 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))
 - Finalized and documented the authorization and saving methods.  [\#7](https://github.com/texpert/shrine-lambda/pull/7) ([texpert](https://github.com/texpert))
-- Fixed the class of `lambda\_client`. [\#6](https://github.com/texpert/shrine-lambda/pull/6) ([texpert](https://github.com/texpert))
+- Fixed the class of `lambda_client`. [\#6](https://github.com/texpert/shrine-lambda/pull/6) ([texpert](https://github.com/texpert))
 - AWS session security token is now used to calculate request signature… [\#5](https://github.com/texpert/shrine-lambda/pull/5) ([texpert](https://github.com/texpert))
 - Authorization of Lambda requests to `callbackURL` implemented by calc… [\#4](https://github.com/texpert/shrine-lambda/pull/4) ([texpert](https://github.com/texpert))
-- `:lambda\_process` methods implementation and `:configure` method refactoring [\#3](https://github.com/texpert/shrine-lambda/pull/3) ([texpert](https://github.com/texpert))
-- 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))
+- `:lambda_process` methods implementation and `:configure` method refactoring [\#3](https://github.com/texpert/shrine-lambda/pull/3) ([texpert](https://github.com/texpert))
+- 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)

data/README.md

@@ -30,7 +30,7 @@ Shrine-Lambda's setup. So, the invoking application must provide a HTTP endpoint
 
 Add Shrine-Lambda gem to the application's Gemfile:
 
-```
+```ruby
 gem 'shrine-lambda'
 ```
 
@@ -40,10 +40,10 @@ Run `$ bundle install` command in the application's root folder to install the g
 Note, that for working with AWS, the AWS credentials (the `access_key_id` and the `secret_access_key`) should be set 
 either in the [Shrine] initializer, or in [default profile][AWS profiles] in the `~/.aws` folder.
 
-```
+```ruby
 # config/initializers/shrine.rb:
 
-...
+# ...
 
   s3_options = { access_key_id:     'your_aws_access_key_id',
                  secret_access_key: 'your_aws_secret_access_key',
@@ -56,10 +56,10 @@ Add to the [Shrine]'s initializer file the Shrine-Lambda plugin registration wit
 the [AWS Lambda] functions list retrieval call (which will retrieve the functions list on application initialization 
 and will store the list into the `Shrine.opts[:lambda_function_list]` for further checking):
 
-```
+```ruby
 # config/initializers/shrine.rb:
 
-...
+# ...
 
   Shrine.plugin :lambda, s3_options.merge(callback_url: "https://#{ENV.fetch('APP_HOST')}/lambda")
   Shrine.lambda_function_list
@@ -74,7 +74,7 @@ Srine-Lamda uses the [Shrine backgrounding plugin] for asynchronous operation, s
 Here is a full example of a Shrine initializer of a [Rails] application using [Roda] endpoints for presigned_url's 
 (used for direct file uploads to [AWS S3]) and [AWS Lambda] callbacks:
 
-```
+```ruby
 # config/initializers/shrine.rb:
 
 # frozen_string_literal: true
@@ -173,7 +173,7 @@ the Lambda function's `:access_key_id` received in the request authorization hea
 
 Shrine-Lambda assemblies are built inside the `#lambda_process_versions` method in the `LambdaUploader` class:
 
-```
+```ruby
 # app/uploaders/lambda_uploader.rb:
 
 # frozen_string_literal: true
@@ -230,7 +230,7 @@ enable the uploader to deal with different processed versions of the original fi
 
 The default options used by Shrine-Lambda plugin are the following:
 
-```
+```ruby
   { callbackURL:    Shrine.opts[:callback_url],
     copy_original:  true,
     storages:       Shrine.buckets_to_use(%i[cache store]),
@@ -239,7 +239,7 @@ The default options used by Shrine-Lambda plugin are the following:
 
 These options could be overrided in the `LambdaUploader` specifying them as the `assembly` keys:
 
-```
+```ruby
   assembly[:callbackURL]    = some_callback_url]
   assembly[:copy_original   = false               # If this is `false`, only the processed file versions will be stored     
   assembly[:storages]       = Shrine.buckets_to_use(%i[cache store other_store])
@@ -255,7 +255,7 @@ Any S3 buckets could be specified, as long as the buckets are defined in the Shr
 A `:callbackUrl` endpoint should be implemented to catch the [AWS Lambda] processing results, authorize, and save them. 
 Here is an example of a [Roda] endpoint:
 
-```
+```ruby
 # lib/rapi/base.rb:
 
 # frozen_string_literal: true
@@ -303,7 +303,7 @@ to put it into a background job. This is configured in the `LambdaUploader` clas
 
 Then the job file should be implemented:
 
-```
+```ruby
 # app/jobs/lambda_promote_job.rb:
 
 # frozen_string_literal: true
@@ -313,9 +313,76 @@ class LambdaPromoteJob < ApplicationJob
     Timeout.timeout(30) { Shrine::Attacher.lambda_process(data) }
   end
 end
+```
+
+### Gem Maintenance
+
+#### Preparing a release
+
+Merge all the pull requests that should make it into the new release into the `main` branch, then checkout and pull the
+branch and run the `github_changelog_generator`, specifying the new version as a `--future-release` command line 
+parameter:
+
+```bash
+$ git checkout main
+$ git pull
+
+$ github_changelog_generator -u texpert -p shrine-lambda --future-release v0.1.1
+```
+
+Then add the changes to `git`, commit and push the `Preparing the new release` commit directly into the `main` branch:
+
+```bash
+$ git add .
+$ git commit -m 'Preparing the new v0.1.1 release'
+$ git push
+```
+
+#### RubyGems credentials
+
+Ensure you have the RubyGems credentials located in the `~/.gem/credentials` file.
+
+#### Adding a gem owner
+
+```bash
+$ gem owner shrine-lambda -a friend@example.com
+```
+
+#### Building a new gem version
+
+Adjust the new gem version number in the `lib/shrine/plugins/lambda/version.rb` file. It is used when building the gem
+by the following command:
+
+```bash
+$ gem build shrine-lambda.gemspec
+```
+
+Assuming the version was set to `0.1.1`, a `shrine-lambda-0.1.1.gem` binary file will be generated at the root of the app (repo).
+
+- The binary file shouldn't be added into the `git` tree, it will be pushed into the RubyGems and to the GitHub releases
 
+#### Pushing a new gem release to RubyGems
+
+```bash
+$ gem push shrine-lambda-0.1.1.gem # don't forget to specify the correct version number
 ```
 
+#### Crafting the new release on GitHub
+
+On the [Releases page](https://github.com/texpert/shrine-lambda/releases) push the `Draft a new release` button.
+
+The new release editing page opens, on which the following actions could be taken:
+
+- Choose the repo branch (default is `main`)
+- Insert a tag version (usually, the tag should correspond to the gem's new version, v0.0.1, for example)
+ - the tag will be created by GitHub on the last commit into the chosen branch
+- Fill the release Title and Description
+- Attach the binary file with the generated gem version
+- If the release is not yet ready for production, mark the `This is a pre-release` checkbox
+- Press either the `Publish release`, or the `Save draft button` if you want to publish it later
+ - After publishing the release, the the binary gem file will be available on GitHub and could be removed locally
+
+
 ## Inspiration
 
 I want to thank [Janko Marohnić][Janko] for the awesome [Shrine] gem and, also, for guiding me to look at his  

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

@@ -0,0 +1,7 @@
+class Shrine
+  module Plugins
+    module Lambda
+      VERSION = '0.1.1'
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'aws-sdk-lambda'
+require 'shrine'
 
 class Shrine
   module Plugins

data/shrine-lambda.gemspec

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = 'shrine-lambda'
-  gem.version       = '0.1.0'
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
-  gem.required_ruby_version = '>= 2.3'
+require 'shrine/plugins/lambda/version.rb'
 
-  gem.summary      = 'AWS Lambda integration plugin for Shrine.'
-  gem.homepage     = 'https://github.com/texpert/shrine-lambda'
+Gem::Specification.new do |gem|
+  gem.name          = 'shrine-lambda'
+  gem.version       = Shrine::Plugins::Lambda::VERSION
   gem.authors      = ['Aurel Branzeanu']
-  gem.description  = <<-DESC
-      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.
-  DESC
   gem.email        = ['branzeanu.aurel@gmail.com']
-  gem.license      = 'MIT'
-
+  gem.homepage     = 'https://github.com/texpert/shrine-lambda'
+  gem.summary      = 'AWS Lambda integration plugin for Shrine.'
+  gem.description  = <<~DESC
+    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.
+  DESC
+  gem.license = 'MIT'
   gem.files        = Dir['CHANGELOG.md', 'README.md', 'LICENSE', 'lib/**/*.rb', '*.gemspec']
   gem.require_path = 'lib/shrine/plugins'
 
@@ -23,6 +23,8 @@ Gem::Specification.new do |gem|
                    'changelog_uri'   => 'https://github.com/texpert/shrine-lambda/CHANGELOG.md',
                    'source_code_uri' => 'https://github.com/texpert/shrine-lambda' }
 
+  gem.required_ruby_version = '>= 2.3'
+
   gem.add_dependency 'aws-sdk-lambda', '~> 1.0'
   gem.add_dependency 'aws-sdk-s3', '~> 1.2'
   gem.add_dependency 'shrine', '~> 2.6'
@@ -34,4 +36,12 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop', '0.81'
   gem.add_development_dependency 'sqlite3' unless RUBY_ENGINE == 'jruby'
+
+  gem.post_install_message = <<~POSTINSTALL
+    DEPRECATION NOTICE: shrine-lambda gem will be renamed to shrine-aws-lambda for clarity
+
+    The current version, 0.1.1, is the last version under the shrine-lambda name.
+
+    Thank you for using this gem!
+  POSTINSTALL
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-lambda
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aurel Branzeanu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-lambda
@@ -150,9 +150,9 @@ dependencies:
     - - ">="
       - !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.
+description: |
+  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.
 email:
 - branzeanu.aurel@gmail.com
 executables: []
@@ -162,6 +162,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/shrine/plugins/lambda/version.rb
 - lib/shrine/plugins/shrine-lambda.rb
 - shrine-lambda.gemspec
 homepage: https://github.com/texpert/shrine-lambda
@@ -171,7 +172,12 @@ 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
-post_install_message: 
+post_install_message: |
+  DEPRECATION NOTICE: shrine-lambda gem will be renamed to shrine-aws-lambda for clarity
+
+  The current version, 0.1.1, is the last version under the shrine-lambda name.
+
+  Thank you for using this gem!
 rdoc_options: []
 require_paths:
 - lib/shrine/plugins
@@ -186,8 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: AWS Lambda integration plugin for Shrine.
 test_files: []