redirectly 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b305a59fc4d5381391df73f884b91f59c815dc970559828cc5712be4df530f
-  data.tar.gz: 70bbd12337717b1df14f3ece87f638a0e629e24949b8788b468ca3ab6dbd9387
+  metadata.gz: 28d72de69cfc6b42a127abbfdca9c9f7a1cde760d68ad82c266454322d57d7dd
+  data.tar.gz: 62e1e4b12baef717c4d1a1da76769e159fd76299d55a3bad926e75680253d72f
 SHA512:
-  metadata.gz: 290704128855a3587277ba607737f27701860e9ad0760c1c6f6bfed91c44670ed826deff7cad7a6120f3c3b0b1fcd23f2d620edb88f588e8cbb263524f4d8b0e
-  data.tar.gz: 8122538c649f2a946ba6b70fbbe5218d8761511c13f7ed0bde8202eb52727bd089650d403588f1d996f9d54bc919c29f4fe6043d1fdf9415713a7c8959b917bc
+  metadata.gz: 422b81686d1b73abbf17f0a595598ac0b017c96f03e2c3e63cf934c204c45f2a10e21535c9a234da5e52245b6c0bb53c053f358d937b6f4d833e43080eb6c87a
+  data.tar.gz: f39c63692882148bd630ad0fba5972d5a8f0dd8fd2176228f2497c0526491c22e253bcae847616c776c06637db8ce697aedce6b60fdc188a1b8c86025396673c

data/README.md

@@ -95,6 +95,8 @@ example.com = https://other-site.com/
 example.org/* = https://other-site.com/
 *.old-site.com = !https://permanent.redirect.com
 :sub.app.localhost/* = http://it-works.com/%{sub}
+proxy.localhost/*rest = @https://proxy.target.com/base/*rest
+internal.localhost/reload = :reload
 (*)old-domain.com/*rest = http://new-domain.com/%{rest}
 ```
 
@@ -109,14 +111,44 @@ The configuration file is built of `pattern = target` pairs, where:
 - `pattern` - is any URL pattern that is supported by [Mustermann][mustermann].
 - `target` - is the target URL to redirect to.
 
-Notes:
+### Special INI Notation
 
-- If `target` starts with an exclamation mark, it will be a permanent
-  redirect (301), otherwise it will be a temporary redirect (302).
-- If `pattern` includes named arguments (e.g. `example.com/:something`), they
-  will be available to the `target` as Ruby string substitution variables
-  (e.g. `%{something}`).
+#### Redirect type
 
+If the target starts with `!`, a permanent redirect (301) will be performed.  
+If it does not, a temporary redirect (302) will be performed by default:
+
+```ini
+test.localhost/temporary = http://example.com
+test.localhost/permanent = !http://example.com
+```
+
+#### Proxying
+
+If the target starts with `@`, the content will be proxied instead of being
+redirected:
+
+```ini
+test.localhost = @http://example.com
+```
+
+#### Named arguments
+
+Patterns that include strings starting with a colon `:` will expose those
+strings as Ruby substitution variables in the target:
+
+```ini
+test.localhost/:anything = http://example.com/path/%{anything}
+```
+
+#### Splats
+
+You can use a splat `*` or a named splat `*name` in the pattern.  
+Named splats will also be exposed as Ruby substitution variables in the target:
+
+```ini
+(*)test.localhost/*rest = http://example.com/%{rest}
+```
 
 ## Contributing / Support
 

data/lib/redirectly/app.rb

@@ -1,6 +1,8 @@
 require 'cgi'
-require 'rack'
 require 'mustermann'
+require 'net/http'
+require 'rack'
+require 'uri'
 
 module Redirectly
   class App
@@ -14,10 +16,10 @@ module Redirectly
 
     def call(env)
       @req = Rack::Request.new env
-      found = match
+      found = find_match
 
       if found
-        redirect_to found
+        handle_target found
       else
         not_found
       end
@@ -25,6 +27,16 @@ module Redirectly
 
   private
 
+    def handle_target(target)
+      if target.start_with? ':'
+        run_internal_command target[1..]
+      elsif target.start_with? '@'
+        proxy_to target[1..]
+      else
+        redirect_to target
+      end
+    end
+
     def redirect_to(target)
       code = 302
 
@@ -36,20 +48,48 @@ module Redirectly
       [code, { 'location' => target }, []]
     end
 
+    def proxy_to(target)
+      uri = URI target
+      uri.query = req.query_string unless req.query_string.empty?
+
+      response = Net::HTTP.get_response uri
+
+      headers = { 'Content-Type' => response['Content-Type'] }
+      [response.code.to_i, headers, [response.body]]
+    rescue => e
+      [502, { 'Content-Type' => 'text/plain' }, ["Bad Gateway: #{e.message}"]]
+    end
+
+    def run_internal_command(target)
+      case target.to_sym
+      when :reload then reload_ini
+      else not_found
+      end
+    end
+
     def not_found
       [404, { 'content-type' => 'text/plain' }, ['Not Found']]
     end
 
     def redirects
-      @redirects ||= ini_read(config_path)
+      if ENV['REDIRECTLY_RELOAD']
+        ini_read config_path
+      else
+        @redirects ||= ini_read(config_path)
+      end
+    end
+
+    def reload_ini
+      @redirects = nil
+      [200, { 'content-type' => 'text/plain' }, ['OK (:reload)']]
     end
 
     def ini_read(path)
-      content = File.readlines(path, chomp: true).reject(&:comment?).reject(&:empty?)
+      content = File.readlines(path, chomp: true).reject(&:ignored?)
       content.to_h { |line| line.split(/\s*=\s*/, 2) }
     end
 
-    def match
+    def find_match
       redirects.each do |pattern, target|
         found = find_target pattern, target
         return found if found

data/lib/redirectly/command.rb

@@ -8,17 +8,21 @@ module Redirectly
     help 'Start the redirect server'
     version Redirectly::VERSION
 
-    usage 'redirectly [CONFIG --port PORT]'
+    usage 'redirectly [CONFIG --port PORT --reload]'
     usage 'redirectly --init'
-    usage 'redirectly --help | --version'
+    usage 'redirectly -h | --help | --version'
 
     option '-p --port PORT', 'Listening port [default: 3000]'
     option '-i --init', 'Create a sample config file and exit'
+    option '-r --reload', 'Read the INI file with every request'
 
     param 'CONFIG', 'Path to config file [default: redirects.ini]'
 
+    environment 'REDIRECTLY_RELOAD',
+      'Set to a non empty value in order to read the INI file with every request (same as --reload)'
+
     example 'redirectly --init'
-    example 'redirectly config.ini'
+    example 'redirectly config.ini --port 4000 --reload'
 
     attr_reader :config_path, :port
 
@@ -44,6 +48,8 @@ module Redirectly
         example.org/* = https://other-site.com/
         *.old-site.com = !https://permanent.redirect.com
         :sub.app.localhost/* = http://it-works.com/%{sub}
+        proxy.localhost/*rest = @https://proxy.target.com/base/*rest
+        internal.localhost/reload = :reload
         (*)old-domain.com/*rest = http://new-domain.com/%{rest}
       TEMPLATE
     end
@@ -51,6 +57,7 @@ module Redirectly
     def start_server
       raise ArgumentError, "Cannot find config file #{config_path}" unless File.exist? config_path
 
+      ENV['REDIRECTLY_RELOAD'] = '1' if args['--reload']
       Rackup::Server.start(app: app, Port: port, environment: 'production')
     end
 

data/lib/redirectly/refinements.rb

@@ -1,8 +1,16 @@
 module Redirectly
   module Refinements
     refine String do
+      def ignored?
+        empty? || comment? || section?
+      end
+
       def comment?
-        start_with? ';' or start_with? '#'
+        start_with?(';') || start_with?('#')
+      end
+
+      def section?
+        match?(/^\[.+\]\s*$/)
       end
     end
   end

data/lib/redirectly/version.rb

@@ -1,3 +1,3 @@
 module Redirectly
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redirectly
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -122,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Redirectly redirect server