rails_maint 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2b1b8a1904b4d02c2f73d2274afdef2bd999883d326e1c12308802454b97c22
+  data.tar.gz: 5772a26f65a8c5bd00d76ed7b155fb6bb34fd4f20e524a337d0da1b2471c663c
+SHA512:
+  metadata.gz: fef32a839d45b57beed5f2bb3937a41b00ec546557c5117d061c6104bdd55d35576ce35634cef15c421ed10261d1dbfcd4992856c4afce23d07c021c0c14144a
+  data.tar.gz: 7315dcadd5a482c59c85a301e157b2fd786459d6f15c75434992f6498c0ac6da27acd346854754b923afa9b4e7139c3643c1c2e9e15122cb0b6be294518dfe54

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.1] - 2024-03-XX
+### Added
+- New feature
+### Fixed
+- Bug fix

data/LICENSE.txt

@@ -0,0 +1,22 @@
+# LICENSE.txt
+MIT License
+
+Copyright (c) 2024 CodesCaptain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,178 @@
+# RailsMaint
+
+RailsMaint is a simple and customizable maintenance mode gem for Rails applications. It allows you to display a sleek maintenance page to your users during maintenance work.
+
+## Features
+
+- 🚀 Easy setup and usage
+- 🎨 Customizable, modern maintenance page design
+- 🌍 Multi-language support (English and Turkish)
+- 🔒 IP whitelist support
+- 💻 Simple CLI commands
+- 🎯 Rails Middleware integration
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+```
+gem 'rails_maint'
+```
+
+2. Execute:
+
+```
+bundle install
+```
+
+3. Add the middleware to your Rails application's `config/application.rb`:
+
+```
+config.middleware.use RailsMaint::Middleware
+```
+
+## Usage
+
+### Installing the Gem
+
+```
+# For English (default)
+rails_maint install
+
+# For Turkish
+rails_maint install --locale=tr
+```
+
+This command creates the following files:
+- `config/rails_maint.yml` - Configuration file
+- `config/locales/rails_maint.{locale}.yml` - Language file
+
+### Managing Maintenance Mode
+
+```
+# To enable maintenance mode
+rails_maint enable
+
+# To disable maintenance mode
+rails_maint disable
+
+# To remove all files
+rails_maint uninstall
+```
+
+## Configuration
+
+You can customize your settings in `config/rails_maint.yml`:
+
+```
+# Default language setting
+locale: en
+
+# IP addresses allowed to access
+white_listed_ips:
+- 127.0.0.1
+- ::1
+# Add your IPs
+# - 192.168.1.1
+```
+
+## Language Support
+
+Language files are stored in the `config/locales` directory. You can customize existing translations or add new languages:
+
+```
+# config/locales/rails_maint.en.yml
+en:
+rails_maint:
+title: "System Maintenance"
+description: "Our system is currently being updated..."
+estimated_time: "Estimated time: 1 hour"
+```
+
+```
+# config/locales/rails_maint.tr.yml
+tr:
+rails_maint:
+title: "Sistem Bakımda"
+description: "Sistemimiz şu anda güncelleniyor..."
+estimated_time: "Tahmini süre: 1 saat"
+```
+
+## How IP Whitelist Works
+
+- When maintenance mode is active, IPs in the whitelist can access the site normally
+- All other IPs will see the maintenance page
+- If behind a proxy, the gem checks the X-Forwarded-For header
+- Each IP should be added to the configuration file
+
+## Development
+
+1. Clone the repository
+2. Install dependencies: `bundle install`
+3. Run tests: `bundle exec rspec`
+
+## Customizing the Maintenance Page
+
+The maintenance page template can be customized by creating your own version in `public/maintenance.html`. The default template includes:
+
+- Responsive design
+- Animated maintenance icon
+- Clean and modern layout
+- Estimated time display
+
+## Rails Version Support
+
+- Rails 6.0 or higher
+- Ruby 2.6 or higher
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/amazing_feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing_feature`)
+5. Create a Pull Request
+
+## Best Practices
+
+- Always test your changes
+- Follow the Ruby Style Guide
+- Write meaningful commit messages
+- Add tests for new features
+- Update documentation when needed
+
+## Common Issues
+
+### IP Whitelist Not Working
+
+Make sure your IP is correctly added to the configuration file and you're not behind an unexpected proxy.
+
+### Language Not Changing
+
+Verify that:
+1. The locale file exists
+2. The locale is correctly set in the configuration
+3. The Rails server was restarted after changes
+
+## Security
+
+- The gem uses Rails' built-in security features
+- IP validation is performed securely
+- No sensitive information is exposed
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contact & Support
+
+- GitHub Issues: [rails_maint/issues](https://github.com/codescaptain/rails_maint/issues)
+- Email: [ahmet-57-@hotmail.com](mailto:ahmet-57-@hotmail.com)
+
+## Credits
+
+Developed and maintained by [CodesCaptain](https://github.com/codescaptain)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.

data/exe/rails_maint

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/rails_maint'
+RailsMaint::CLI.start

data/lib/rails_maint/assets/default.css

@@ -0,0 +1,65 @@
+* {
+    margin: 0;
+    padding: 0;
+    box-sizing: border-box;
+}
+
+body {
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, sans-serif;
+    background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%);
+    min-height: 100vh;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    text-align: center;
+    padding: 20px;
+}
+
+.maintenance-container {
+    background: white;
+    padding: 40px;
+    border-radius: 20px;
+    box-shadow: 0 10px 30px rgba(0,0,0,0.1);
+    max-width: 600px;
+    width: 90%;
+}
+
+.icon {
+    width: 150px;
+    height: 150px;
+    margin-bottom: 30px;
+}
+
+h1 {
+    color: #2d3748;
+    font-size: 2.5rem;
+    margin-bottom: 20px;
+}
+
+p {
+    color: #4a5568;
+    font-size: 1.1rem;
+    line-height: 1.6;
+    margin-bottom: 30px;
+}
+
+.estimated-time {
+    background: #ebf8ff;
+    color: #2b6cb0;
+    padding: 12px 24px;
+    border-radius: 12px;
+    display: inline-block;
+    font-weight: 500;
+    margin-top: 10px;
+}
+
+@keyframes wrench-rotate {
+    0% { transform: rotate(-15deg); }
+    50% { transform: rotate(15deg); }
+    100% { transform: rotate(-15deg); }
+}
+
+.rotating-wrench {
+    animation: wrench-rotate 3s infinite ease-in-out;
+    display: inline-block;
+}

data/lib/rails_maint/assets/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  rails_maint:
+    title: "System Maintenance"
+    description: "Our system is currently being updated..."
+    estimated_time: "Estimated time: 1 hour"

data/lib/rails_maint/assets/locales/tr.yml

@@ -0,0 +1,5 @@
+tr:
+  rails_maint:
+    title: "Sistem Bakımda"
+    description: "Sistemimiz şu anda güncelleniyor..."
+    estimated_time: "Tahmini süre: 1 saat"

data/lib/rails_maint/assets/maintenance.html

@@ -0,0 +1,26 @@
+<!-- lib/rails_maint/templates/maintenance.html -->
+<!DOCTYPE html>
+<html lang="<%= lang %>">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= title %></title>
+    <style>
+        <%= css_content %>
+    </style>
+</head>
+<body>
+<div class="maintenance-container">
+    <div class="rotating-wrench">
+        <svg class="icon" viewBox="0 0 512 512">
+            <path fill="#4A5568" d="M507.73 109.1c-2.24-9.03-13.54-12.09-20.12-5.51l-74.36 74.36-67.88-11.31-11.31-67.88 74.36-74.36c6.62-6.62 3.43-17.9-5.66-20.16-47.38-11.74-99.55.91-136.58 37.93-39.64 39.64-50.55 97.1-34.05 147.2L18.74 402.76c-24.99 24.99-24.99 65.51 0 90.5 24.99 24.99 65.51 24.99 90.5 0l213.21-213.21c50.12 16.71 107.47 5.68 147.37-34.22 37.07-37.07 49.7-89.32 37.91-136.73zM64 472c-13.25 0-24-10.75-24-24 0-13.26 10.75-24 24-24s24 10.74 24 24c0 13.25-10.75 24-24 24z"/>
+        </svg>
+    </div>
+    <h1><%= title %></h1>
+    <p><%= description %></p>
+    <div class="estimated-time">
+        <%= estimated_time %>
+    </div>
+</div>
+</body>
+</html>

data/lib/rails_maint/cli.rb

@@ -0,0 +1,93 @@
+# lib/rails_maint/cli.rb
+require 'thor'
+require 'fileutils'
+require_relative 'helpers/maintenance_page_helper'
+
+module RailsMaint
+  class CLI < Thor
+    include MaintenancePageHelper
+
+    desc "install", "Generate configuration file and locale file"
+    method_option :locale, type: :string, default: 'en', desc: "Set the language for maintenance page"
+    def install
+      create_config_file
+      create_locale_file(options[:locale])
+      puts "RailsMaint has been installed with #{options[:locale]} locale."
+    end
+
+    desc "enable", "Enable maintenance mode"
+    def enable
+      File.write('tmp/maintenance_mode.txt', Time.now.to_s)
+      puts "Maintenance mode enabled."
+    end
+
+    desc "disable", "Disable maintenance mode"
+    def disable
+      delete_file('tmp/maintenance_mode.txt')
+      puts "Maintenance mode disabled"
+    end
+
+    desc "uninstall", "Remove all files created by RailsMaint"
+    def uninstall
+      delete_file('tmp/maintenance_mode.txt')
+      delete_file('config/rails_maint.yml')
+      delete_file('config/locales/rails_maint.en.yml')
+      delete_file('config/locales/rails_maint.tr.yml')
+      puts "RailsMaint has been uninstalled and all related files have been removed."
+    end
+
+    private
+
+    def create_maintenance_page(locale = 'en')
+      maintenance_page_path = "public/maintenance.html"
+      unless File.exist?(maintenance_page_path)
+        File.write(maintenance_page_path, default_maintenance_page_content(locale))
+      end
+    end
+
+    def create_locale_file(locale = 'en')
+      locale_dir = "config/locales"
+      FileUtils.mkdir_p(locale_dir) unless Dir.exist?(locale_dir)
+
+      locale_file_path = "#{locale_dir}/rails_maint.#{locale}.yml"
+      unless File.exist?(locale_file_path)
+        base_path = File.expand_path('../', __FILE__)
+        source_locale_file = File.join(base_path, "assets/locales/#{locale}.yml")
+        FileUtils.cp(source_locale_file, locale_file_path)
+      end
+    end
+
+    def create_config_file
+      config_path = "config/rails_maint.yml"
+      unless File.exist?(config_path)
+        File.write(config_path, default_config_content)
+      end
+    end
+
+    def delete_file(path)
+      if File.exist?(path)
+        File.delete(path)
+        puts "#{path} has been removed."
+      else
+        puts "#{path} does not exist, so it cannot be removed."
+      end
+    end
+
+    def default_config_content
+      <<~YAML
+        # RailsMaint Configuration
+        # -----------------------
+        
+        # Default locale for maintenance page
+        locale: #{options[:locale] || 'en'}
+        
+        # IP addresses that can access the application during maintenance
+        white_listed_ips:
+          - 127.0.0.1
+          - "::1"
+          # Add more IPs below
+          # - 192.168.1.1
+      YAML
+    end
+  end
+end

data/lib/rails_maint/helpers/maintenance_page_helper.rb

@@ -0,0 +1,51 @@
+# lib/rails_maint/helpers/maintenance_page_helper.rb
+require 'yaml'
+
+module RailsMaint
+  module MaintenancePageHelper
+    def default_maintenance_page_content(locale = 'en')
+      base_path = File.expand_path('../../', __FILE__)
+      css_file = File.join(base_path, 'assets/default.css')
+      html_file = File.join(base_path, 'assets/maintenance.html')
+      locale_file = File.join(base_path, "assets/locales/#{locale}.yml")
+
+      # CSS ve HTML içeriğini oku
+      css_content = File.read(css_file)
+      html_template = File.read(html_file)
+
+      app_locale_file = "config/locales/rails_maint.#{locale}.yml"
+
+      puts "APP LOCALE FILE: #{app_locale_file}"
+      translations = if File.exist?(app_locale_file)
+                       YAML.load_file(app_locale_file)[locale]['rails_maint']
+                     else
+                       YAML.load_file(locale_file)[locale]['rails_maint']
+                     end
+
+      # Placeholder'ları değiştir
+      html_content = html_template
+                       .gsub('<%= css_content %>', css_content)
+                       .gsub('<%= lang %>', locale)
+                       .gsub('<%= title %>', translations['title'])
+                       .gsub('<%= description %>', translations['description'])
+                       .gsub('<%= estimated_time %>', translations['estimated_time'])
+
+      html_content
+    end
+
+    def available_locales
+      base_path = File.expand_path('../../', __FILE__)
+      locale_dir = File.join(base_path, 'assets/locales')
+      app_locale_dir = 'config/locales'
+
+      gem_locales = Dir.glob("#{locale_dir}/*.yml").map { |f| File.basename(f, '.yml') }
+      app_locales = if Dir.exist?(app_locale_dir)
+                      Dir.glob("#{app_locale_dir}/rails_maint.*.yml").map { |f| File.basename(f, '.yml').split('.').last }
+                    else
+                      []
+                    end
+
+      (gem_locales + app_locales).uniq
+    end
+  end
+end

data/lib/rails_maint/middleware.rb

@@ -0,0 +1,46 @@
+# lib/rails_maint/middleware.rb
+module RailsMaint
+  class Middleware
+    include MaintenancePageHelper
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if maintenance_mode_enabled? && !ip_whitelisted?(env)
+        [503, { 'Content-Type' => 'text/html' }, [maintenance_page]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def maintenance_mode_enabled?
+      File.exist?('tmp/maintenance_mode.txt')
+    end
+
+    def ip_whitelisted?(env)
+      config = load_config
+      white_listed_ips = config['white_listed_ips'] || []
+      client_ip = env['HTTP_X_FORWARDED_FOR']&.split(',')&.first&.strip || env['REMOTE_ADDR']
+      white_listed_ips.include?(client_ip)
+    end
+
+    def load_config
+      config_path = 'config/rails_maint.yml'
+      if File.exist?(config_path)
+        YAML.load_file(config_path)
+      else
+        {}
+      end
+    end
+
+    def maintenance_page
+      config = load_config
+      locale = config['locale'] || 'en'
+      default_maintenance_page_content(locale)
+    end
+  end
+end

data/lib/rails_maint/version.rb

@@ -0,0 +1,3 @@
+module RailsMaint
+  VERSION = "0.1.1"
+end

data/lib/rails_maint.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rails_maint/version'
+require_relative 'rails_maint/cli'
+require_relative 'rails_maint/middleware'
+
+module RailsMaint
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rails_maint
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- codescaptain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+description: RailsMaint is a gem that helps you enable maintenance mode for your Rails
+  application with customizable options and IP whitelisting.
+email:
+- ahmet-57-@hotmail.com
+executables:
+- rails_maint
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/rails_maint
+- lib/rails_maint.rb
+- lib/rails_maint/assets/default.css
+- lib/rails_maint/assets/locales/en.yml
+- lib/rails_maint/assets/locales/tr.yml
+- lib/rails_maint/assets/maintenance.html
+- lib/rails_maint/cli.rb
+- lib/rails_maint/helpers/maintenance_page_helper.rb
+- lib/rails_maint/middleware.rb
+- lib/rails_maint/version.rb
+homepage: https://github.com/codescaptain/rails_maint
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codescaptain/rails_maint
+  source_code_uri: https://github.com/codescaptain/rails_maint
+  changelog_uri: https://github.com/codescaptain/rails_maint/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A maintenance mode helper for Rails applications
+test_files: []