rails_action_deprecation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819a233f23d2424bb400a0da7b1faddfd273ec32a82b78d491e3fe0592b2a7e7
-  data.tar.gz: 33520a45d7a801d4f6776bb8ff98e7b170b51ac20f94459ffae86842571cbb03
+  metadata.gz: ccae3581cfc634686eb8f0a9b21309db739dff0f3e7b8b55a3667d0e2efd5abc
+  data.tar.gz: 525195bebf4b792f3819593bc1feb0390cd3c330ae90c26d710f59dd64548b23
 SHA512:
-  metadata.gz: 67c50563383ec059a43075dde8df22d10e9ca2d76f3d64cab6e67d54b733d06aae45070795086062771d56a37eb30e313aae072ce1bb9c1ff025ec9ee55b8582
-  data.tar.gz: 70a64ce006972448a010ce44c40242d00989e67a743e54f61056ebac28d9861a74ea7804c39a97a161a7225a4bcdb08b87cc35073f8532164bf5ba7a33980083
+  metadata.gz: 10767b6b4b23e8a294e6c27b88b5f804ac4bee8a9cbe38f6587c03c7e79c1b22e356beb084dd29e3346a07f18c6e8e886e4117df35e6bd421f306df2febf89c5
+  data.tar.gz: 78124ba4a85f6b869e8f500e119dffd2d238e24217865bf105d095a76bd4f1053dc588d05fde3b38cc824345a1cb71e1387939d5344db2e9a31605a213ca02b8

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Rails Action Deprecation Changelog
 
+0.2.0
+---
+- Add link option to *_endpoint functions. This allows users to provide additional information at the specified URL 
+
 0.1.0
 ---
 - Initial commit of the Rails Action Deprecation gem

data/README.md

@@ -31,19 +31,58 @@ Or install it yourself as:
 
 ## Usage
 
-To enable deprecation and sunset in your controller, simply use the provided `deprecate_endpoint` and `sunset_endpoint` functions. These register an `after_action` hook that sets the relevant HTTP headers and outputs a message via `ActiveSupport::Deprecation`.
+To enable deprecation and sunset in your controller, simply use the provided `deprecate_endpoint` and `sunset_endpoint` functions.
+These register an `after_action` hook that sets the relevant HTTP headers and outputs a message via `ActiveSupport::Deprecation`.
 
-Both functions take exactly the same parameters. The first is a DateTime describing the date of deprecation or sunset. By default the deprecation or sunset is set for any action in the controller. To limit this the `only:` parameter can be used exactly as it is available for the rails controller hooks.
+Both functions take exactly the same parameters.
+The first is a DateTime describing the date of deprecation or sunset.
+By default the deprecation or sunset is set for any action in the controller.
+To limit this the `only:` parameter can be used exactly as it is available for the rails controller hooks.
+
+If you want to make more information available to your users, the `link:` parameter must be specified with a percent encoded URL.
+This URL will be part of the response's Link HTTP header with the relation `deprecation` or respectively `sunset`.
+
+Example with deprecated and/or sunset `create` and `destroy` actions:
+```ruby
+class ExampleController < ActionController::Base
+  deprecate_endpoint DateTime.new(2022, 07, 01, 12, 34, 56), only: [:create]
+  deprecate_endpoint DateTime.new(2022, 07, 01, 12, 34, 56), only: [:destroy], link: "https://github.com/Qurasoft"
+  sunset_endpoint DateTime.new(2023, 07, 01), only: [:destroy]
+
+  def index
+    render json: ['element1', 'element2']
+  end
+
+  def show
+    render json: 'element1'
+  end
+
+  def create
+    render json: 'newElement'
+  end
+
+  def update
+    render json: 'changedElement'
+  end
+
+  def destroy
+    head :no_content
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/qurasoft/rails_action_deprecation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qurasoft/rails_action_deprecation.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/rails_action_deprecation/controller.rb

@@ -3,21 +3,21 @@ module RailsActionDeprecation
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def deprecate_endpoint(datetime, only: nil)
+      def deprecate_endpoint(datetime, only: nil, link: nil)
         # Deliver the (draft) Deprecation HTTP header with the response
         # https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-deprecation-header
-        deprecation 'Deprecation', datetime, only: only
+        deprecation 'Deprecation', datetime, only: only, link: link
       end
 
-      def sunset_endpoint(datetime, only: nil)
+      def sunset_endpoint(datetime, only: nil, link: nil)
         # Deliver the Sunset HTTP header with the response
         # https://datatracker.ietf.org/doc/html/rfc8594
-        deprecation 'Sunset', datetime, only: only
+        deprecation 'Sunset', datetime, only: only, link: link
       end
 
       protected
 
-      def deprecation(header, datetime, only: nil)
+      def deprecation(header, datetime, only: nil, link: nil)
         after_action(only: only) do |controller|
           klass = controller.class
           user_agent = request.headers['User-Agent']
@@ -25,7 +25,18 @@ module RailsActionDeprecation
           # Log the deprecation
           ActiveSupport::Deprecation.warn("#{klass}##{method} deprecated endpoint (#{header.downcase} date #{datetime.iso8601}) has been called by #{user_agent}")
 
-          response.headers[header] = datetime.httpdate
+          response.set_header header, datetime.httpdate
+
+          # Add a Link header with the correct relation if specified
+          if link.present?
+            link_header = "<#{link}>; rel=\"#{header.downcase}\""
+            # Append if a Link header is already present
+            if response.has_header? "Link"
+              response.set_header "Link", "#{response.get_header("Link")}, #{link_header}"
+            else
+              response.set_header "Link", link_header
+            end
+          end
         end
       end
     end

data/lib/rails_action_deprecation/version.rb

@@ -1,3 +1,3 @@
 module RailsActionDeprecation
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_action_deprecation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Keune
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails