darjeelink 0.14.4 → 0.14.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f395d01b733415c7836867132dd888ac5f5dcd567a338e8d1d845d5e12a952
-  data.tar.gz: fdf3c1b4f775a88169adacd74ae43529a00c1ae16f05df0e7f904226ae95d6e4
+  metadata.gz: 4303964ff9a26e9645a23dc23ddf42b0e4c0149d96bf0be0ff190cdabe45a3e9
+  data.tar.gz: 923d1bc1d321f08b66cf519bad76ce50c07418558ab15d2b97185071ffc9aee7
 SHA512:
-  metadata.gz: 67c05cf3fab55ab937a75a511d55f231aef131b21fbb9baabcae3ba0819014346532e91d321b1674231e9bdce32f4bef7d52bf2e1eecc92635e62b6902fed322
-  data.tar.gz: 914f84301d2cdd53df3501180082dc556b7bae47a415c4775fd750a07343a2f7fd466be5d49c37761bf76d653df4e003ac0e0f4c52fd6ca4c7d9d9b35cbf80a1
+  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
@@ -131,6 +154,10 @@ Note that if you are running in a vagrant VM, most of these steps can be done fr
 - Run `gem build darjeelink.gemspec` this will output a file `darjeelink-X.X.X.gem` the version should match what version.rb and github.
 - Run `gem push darjeelink-X.X.X.gem`
 
+## TODOs
+
+We have a few TODOs in the project. Please grep for TODO in the codebase to see them, and consider picking one up during maintainance.
+
 ## GDPR
 No personally identifiable data is stored about the public by this gem.
 It does not store information on individual clicks, only a counter of how many times a link has been clicked.

data/app/controllers/darjeelink/api_controller.rb

@@ -53,7 +53,7 @@ module Darjeelink
     def valid_authorization_token?(username_token)
       username, token = username_token.split ':'
 
-      stored_token = ApiToken.find_by(username: username, active: true)&.token
+      stored_token = ApiToken.find_by(username:, active: true)&.token
       return false if stored_token.nil?
 
       ActiveSupport::SecurityUtils.secure_compare(

data/app/controllers/darjeelink/application_controller.rb

@@ -9,20 +9,27 @@ module Darjeelink
 
     private
 
+    # 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 = 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
+                       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/app/importers/darjeelink/short_link_importer.rb

@@ -24,7 +24,7 @@ module Darjeelink
 
     def create_short_link(url, auto_generated_key, custom_key)
       shortened_path = custom_key.present? ? custom_key : auto_generated_key
-      ::Darjeelink::ShortLink.create!(url: url, shortened_path: shortened_path)
+      ::Darjeelink::ShortLink.create!(url:, shortened_path:)
     rescue ActiveRecord::RecordNotUnique
       duplicates << "#{url}/#{custom_key || auto_generated_key}"
     end

data/lib/darjeelink/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darjeelink
 version: !ruby/object:Gem::Version
-  version: 0.14.4
+  version: 0.14.6
 platform: ruby
 authors:
 - James Hulme
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: omniauth-google-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 6.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 6.1.7
 - !ruby/object:Gem::Dependency
   name: rebrandly
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +198,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - james@38degrees.org.uk
 executables: []
@@ -244,8 +250,9 @@ files:
 homepage: https://github.com/38degrees/darjeelink
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: URL Shortener
 test_files: []