darjeelink 0.14.5 → 0.14.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11b58c6d79e63e250e80fccc4dc0ab8aa6e1daf8848e51e14afd9a3637a6dea2
-  data.tar.gz: 2ab545a7e59ac4a248f773ead73aeb4e35b3937afd3ffb37b912a1c537c6c8ea
+  metadata.gz: 4303964ff9a26e9645a23dc23ddf42b0e4c0149d96bf0be0ff190cdabe45a3e9
+  data.tar.gz: 923d1bc1d321f08b66cf519bad76ce50c07418558ab15d2b97185071ffc9aee7
 SHA512:
-  metadata.gz: 92311cceed07587d5e2ba80c25849e1e7a39d4f7e37351482bd6eaa2d65b47bf712ff25600acae1b6508cab6ed65dc792cf9506b94093d8275005027e620bd75
-  data.tar.gz: ed319fe3f5aaded52f783defcaedeb9efa2e199cf1a6e060cc23ad68318c872de5b95d49af7146ec4b2c0b2c9758e0afb493edf156c92dea947d8b61ccfcbdf1
+  metadata.gz: 701f1be73fdefefed0ae84171fc7ac341bda12b182eaefb48bc1d3654781163b79a9c022dbcbe0097cd6542a8831ede814a251fdf9adf65b3bec6a39c6887053
+  data.tar.gz: cd5a66b7216dce4a247a5a3ce586caf75ec259653228e76e31daad7745a708fdacd2de6fb7f35fbfe757027077d90ac8573677663116a07da18cffd3017e45eb

data/README.md

@@ -120,9 +120,32 @@ Change the database url to be different to the development one i.e. `postgres://
 ## Releasing
 Darjeelink follows [Semantic Versioning](https://semver.org)
 
+### Pre-releasing - Staging tests
+There are several ways to test the gem before releasing it.
+
+One way, is to check the new development branch into Github, and then use `portkey-app` to test it in a staging environment.
+
+- Create a new branch in the `darjeelink` repo with a sensible name related to your intended release: e.g. `darjeelink-v0.14.6-upgrade`.
+  - Perform the required upgrades, security patching, etc for the new release.
+  - Bump the version number as required (see below).
+- Create a new branch in the `portkey-app` repo with a sensible name related to your intdended release: e.g. `darjeelink-v0.14.6-upgrade`.
+- In the `Gemfile` of the portkey-app repo, change the `darjeelink` gem to point to the branch you just created in the darjeelink repo.
+  ```gemfile
+  # Actual URL Shortener
+  # gem 'darjeelink' <-- Temporarilly change this. Remeber to change it back, and run bundle install to update the Gemfile.lock when done!
+  gem 'darjeelink', git: 'https://github.com/38degrees/darjeelink.git',
+                    branch: 'darjeelink-v0.14.6-upgrade'
+  ```
+- Update the `Gemfile.lock` in the `portkey-app` repo by running `bundle install` and commit then push the changes.
+- Deploy your branch of the portkey-app to the staging environment and test the changes.
+
+NB: When you have followed the production release steps below and created a GitHub release, you can then update the `Gemfile` in the `portkey-app` repo to point to the new release tag. 
+
+### Releasing - Production
+
 Once all necessary changes have made it in to master and you are ready to do a release you need to do these steps.
 
-Note that if you are running in a vagrant VM, most of these steps can be done from within the VM.
+Note that if you are running in a vagrant VM or `docker-shell.sh` constainer, most of these steps can be done from the terminal session.
 
 - Update `lib/darjeelink/version.rb` to the new version
 - Run `bundle install` to pick up the change in Gemfile.lock

data/app/controllers/darjeelink/application_controller.rb

@@ -9,25 +9,27 @@ module Darjeelink
 
     private
 
-    def determine_ip_to_verify
-      if Rails.application.client_ip_header
-        request.headers[Rails.application.client_ip_header]
-      else
-        request.ip
-      end
-    end
-
+    # Disabling these rubocop rules. This is a simple function and tested in production sinve version 0.14.4.
+    #
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Layout/LineLength
     # Check user IP address against whitelist from ENV
     def check_ip_whitelist
       return unless Rails.env.production?
       return unless Rails.application.config.permitted_ips
 
-      ip_to_verify = determine_ip_to_verify
+      ip_to_verify = if Rails.application.config.respond_to?(:client_ip_header) && Rails.application.config.client_ip_header.present?
+                       request.headers[Rails.application.config.client_ip_header]
+                     else
+                       request.ip
+                     end
 
       return if Rails.application.config.permitted_ips.split(',').include? ip_to_verify
 
       render plain: 'Access Denied', status: :forbidden
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Layout/LineLength
 
     # Authenticate against Google OAuth
     def authenticate

data/lib/darjeelink/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Darjeelink
-  VERSION = '0.14.5'
+  VERSION = '0.14.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darjeelink
 version: !ruby/object:Gem::Version
-  version: 0.14.5
+  version: 0.14.6
 platform: ruby
 authors:
 - James Hulme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth