embargoed 2.5.0

data/lib/embargoed/maintenance_page.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+module Embargoed
+  module MaintenancePage
+    require 'rack/accept'
+
+    def self.all
+      @all ||= []
+    end
+
+    def self.best_for(env)
+      request = Rack::Accept::Request.new(env)
+
+      all_types = all.map(&:media_types).flatten
+      best_type = request.best_media_type(all_types)
+      best = all.find { |page| page.media_types.include?(best_type) && File.exist?(page.new.custom_path) }
+      best || Embargoed.config.default_maintenance_page
+    end
+
+    require 'embargoed/maintenance_page/base'
+    require 'embargoed/maintenance_page/erb'
+    require 'embargoed/maintenance_page/html'
+    require 'embargoed/maintenance_page/json'
+  end
+end

data/lib/embargoed/ordered_options.rb

@@ -0,0 +1,98 @@
+module Embargoed
+  class OrderedOptions < Hash
+    alias_method :_get, :[] # preserve the original #[] method
+    protected :_get # make it protected
+
+    def initialize(constructor = {}, &block)
+      if constructor.respond_to?(:to_hash)
+        super()
+        update(constructor, &block)
+        hash = constructor.to_hash
+
+        self.default = hash.default if hash.default
+        self.default_proc = hash.default_proc if hash.default_proc
+      else
+        super()
+      end
+    end
+
+    def update(other_hash)
+      if other_hash.is_a? Hash
+        super(other_hash)
+      else
+        other_hash.to_hash.each_pair do |key, value|
+          if block_given?
+            value = yield(key, value)
+          end
+          self[key] = value
+        end
+        self
+      end
+    end
+
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+
+    def [](key)
+      super(key.to_sym)
+    end
+
+    def method_missing(name, *args)
+      name_string = name.to_s
+      if name_string.chomp!('=')
+        self[name_string] = args.first
+      else
+        bangs = name_string.chomp!('!')
+
+        if bangs
+          value = fetch(name_string.to_sym)
+          raise(RuntimeError.new("#{name_string} is blank.")) if value.nil? || value.empty?
+          value
+        else
+          self[name_string]
+        end
+      end
+    end
+
+    def except(*keys)
+      dup.except!(*keys)
+    end
+
+    def except!(*keys)
+      keys.each { |key| delete(key) }
+      self
+    end
+
+
+    def respond_to_missing?(name, include_private)
+      true
+    end
+  end
+
+
+  # +InheritableOptions+ provides a constructor to build an +OrderedOptions+
+  # hash inherited from another hash.
+  #
+  # Use this if you already have some hash and you want to create a new one based on it.
+  #
+  #   h = ActiveSupport::InheritableOptions.new({ girl: 'Mary', boy: 'John' })
+  #   h.girl # => 'Mary'
+  #   h.boy  # => 'John'
+  class InheritableOptions < Embargoed::OrderedOptions
+    def initialize(parent = nil)
+      if parent.kind_of?(Embargoed::OrderedOptions)
+        # use the faster _get when dealing with OrderedOptions
+        super(parent) {|key,value| parent._get(key) }
+      elsif parent
+        super(parent) { |key, value| parent[key] }
+      else
+        super(parent)
+      end
+    end
+
+    def inheritable_copy
+      self.class.new(self)
+    end
+  end
+end

data/lib/embargoed/rake_tasks.rb

@@ -0,0 +1,3 @@
+# This file is meant to be used to include rake tasks in a Rakefile by adding
+# require 'embargoed/rake_tasks'
+Dir[File.expand_path('../../tasks/*.rake', __FILE__)].each { |ext| import ext }

data/lib/embargoed/request.rb

@@ -0,0 +1,39 @@
+require 'ipaddr'
+
+module Embargoed
+  class Request
+    def initialize(env)
+      @rack_request = Rack::Request.new(env)
+    end
+
+    def allowed?
+      path_allowed? || ip_allowed?
+    end
+
+    private
+
+    attr_reader :rack_request
+
+    def path_allowed?
+      allowed_paths = []
+
+      allowed_paths.any? do |allowed_path|
+        rack_request.path =~ Regexp.new(allowed_path)
+      end
+    end
+
+    def ip_allowed?
+
+      begin
+        ip = IPAddr.new(rack_request.ip.to_s)
+      rescue ArgumentError
+        return false
+      end
+
+      ip_country_code = IPLocator.get_country_code(ip)
+
+      ip_country_code != "RU"
+
+    end
+  end
+end

data/lib/embargoed/version.rb

@@ -0,0 +1,3 @@
+module Embargoed
+  VERSION = '2.5.0'.freeze
+end

data/lib/embargoed.rb

@@ -0,0 +1,16 @@
+module Embargoed
+  require 'embargoed/configuration'
+  require 'embargoed/maintenance_file'
+  require 'embargoed/maintenance_page'
+  require 'embargoed/request'
+  require 'embargoed/ip_locator'
+  require 'embargoed/engine' if defined? Rails
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/lib/rack/embargoed.rb

@@ -0,0 +1,21 @@
+require 'rack'
+require 'embargoed'
+
+class Rack::Embargoed
+  def initialize(app, config={})
+    @app = app
+  end
+
+  def call(env)
+    request = Embargoed::Request.new(env)
+
+    if !request.allowed?
+      page_class = Embargoed::MaintenancePage.best_for(env)
+      page = page_class.new("Reason", env: env)
+
+      page.rack_response(503, 7200)
+    else
+      @app.call(env)
+    end
+  end
+end

data/lib/tasks/maintenance.rake

@@ -0,0 +1,48 @@
+require 'embargoed'
+
+namespace :maintenance do
+  desc 'Enable the maintenance mode page ("reason", "allowed_paths", "allowed_ips" and "response_code" can be passed as environment variables)'
+  rule /\Amaintenance:(.*:|)start\Z/ do |task|
+    invoke_environment
+
+    maint_file = maintenance_file_for(task)
+    maint_file.import_env_vars(ENV)
+    maint_file.write
+
+    puts "Created #{maint_file.path}"
+    puts "Run `rake #{task.name.gsub(/\:start/, ':end')}` to stop maintenance mode"
+  end
+
+  desc 'Disable the maintenance mode page'
+  rule /\Amaintenance:(.*:|)end\Z/ do |task|
+    invoke_environment
+
+    maint_file = maintenance_file_for(task)
+
+    if maint_file.delete
+      puts "Deleted #{maint_file.path}"
+    else
+      fail 'Could not find a maintenance file to delete'
+    end
+  end
+
+  def invoke_environment
+    if Rake::Task.task_defined? 'environment'
+      Rake::Task['environment'].invoke
+    end
+  end
+
+  def maintenance_file_for(task)
+    path_name = (task.name.split(':') - ['maintenance', 'start', 'end']).join(':')
+
+    maint_file = if path_name == ''
+      Embargoed::MaintenanceFile.default
+    else
+      Embargoed::MaintenanceFile.named(path_name)
+    end
+
+    fail %{Unknown path name: "#{path_name}"} if maint_file.nil?
+
+    maint_file
+  end
+end

data/public/ip_geo_db_license.md

@@ -0,0 +1,206 @@
+The file [`Geoacumen-Country.mmdb`](https://github.com/geoacumen/geoacumen-country) is distributed under an Apache License Version 2.0.
+
+As per the license, we must also give a copy of the license under which that file is distributed, which can be found below:
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Kevin Chung
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/public/maintenance.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Page blocked for 🇷🇺 Russian visitors</title>
+
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.6.0/dist/css/bootstrap.min.css" integrity="sha384-B0vP5xmATw1+K9KRQjQERJvTumQW0nPEzvF6L/Z6nronJ3oUOFUFpCjEUQouq2+l" crossorigin="anonymous">
+
+
+    <style type="text/css">
+
+      *{
+        font-family: Lato, Arial, Helvetica, sans-serif;
+      }
+
+      body{
+        margin: 0;
+        background-color: #f6f9fc;
+        height: 100vh;
+      }
+
+      .card{
+        position: relative;
+        padding: 3em 3em;
+        text-align: center;
+        background: #ffffff;
+        color: rgb(66, 84, 102);
+        box-shadow: rgba(50, 50, 93, 0.25) 0px 50px 100px -20px, rgba(0, 0, 0, 0.3) 0px 30px 60px -30px;
+        border-radius: 8px;
+      }
+
+      h1{
+        margin: 0;
+        color: #242424;
+        font-size: 26pt;
+        margin-bottom: 1em;
+        font-weight: bolder;
+      }
+
+    </style>
+
+  </head>
+  <body>
+
+    <div class="container h-100">
+      <div class="row align-items-center h-100">
+        <div class="col-12 col-md-8 offset-md-1 col-lg-6 offset-lg-3 mx-auto">
+          <div class="card">
+            <h1>We're sorry, Russians.</h1>
+
+            <p>We've blocked this website for Russian visitors.</p>
+            <p>On Feb 24, 2022 Russian forces started invading Ukraine. We know you, a regular person, are not to blame. But your leaders have chosen a very violent path breaking international law, and we've chosen not to do business with Russian citizens at the time. We condemn this crime.</p>
+            <p>We don't like this situation either, and we'd love to do business with Russia again soon. But only you can make it stop.</p>
+            <p><b>Protest in social media and in the streets</b> to demand your leaders stop this invasion. Peace and diplomacy are the only way forward.</p>
+            <p>🇺🇦 Slava Ukraini</p>
+          </div>
+        </div>
+      </div>
+    </div>
+
+  </body>
+</html>

data/public/maintenance.html.erb

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Down for Maintenance</title>
+
+    <style type="text/css">
+
+      *{
+        font-family: Arial, Helvetica, sans-serif;
+      }
+
+      body{
+        margin: 0;
+        background-color: #fff;
+      }
+
+      #page{
+        position: relative;
+        width: 550px;
+        margin: 200px auto;
+        padding: 75px 0;
+        text-align: center;
+        background-color: #eaeaea;
+        border: solid 1px #ccc;
+        border-top: solid 10px #666;
+        -moz-box-shadow: inset 0 2px 10px #ccc;
+        -webkit-box-shadow: inset 0 2px 10px #ccc;
+        box-shadow: inset 0 2px 10px #ccc;
+      }
+
+      header, #body{
+        width: 400px;
+        margin: 0 auto;
+      }
+
+      h1{
+        margin: 0;
+        color: #CC3601;
+        font-size: 26pt;
+        border-bottom: solid 4px #666;
+      }
+
+      #reason{
+        margin: 10px 0;
+        color: #333;
+      }
+
+    </style>
+
+  </head>
+  <body>
+
+    <section id="page">
+
+      <header>
+        <h1>Down for Maintenance</h1>
+      </header>
+
+      <section id="body">
+        <div>
+          <%= reason %>
+        </div>
+      </section>
+
+    </section>
+
+  </body>
+</html>

data/public/maintenance.json

@@ -0,0 +1 @@
+{"error":"Service Unavailable","message":{{ reason }}}