actionpack-fly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 140984d4dc59826e134ea4bbe2af37e23eeffcc03d293638ec03d720b8261b11
+  data.tar.gz: 9a8b76fdfd3f26cb1568a3906f0e6d939fde9b2438f0ed1f6d986d54ec85ebbd
+SHA512:
+  metadata.gz: b43eefacbd58df28e71cb665c7dc2ca5da1f5788bf1a25971a108621d46fd5f2b488fa905efcac248417838dde7867ff63dd41c70e48c3a1a133b79e0f08a1c7
+  data.tar.gz: 6e2e7755062a0377d63ce72ae74dc3d0dd4bc8710c7e9336331f20a6c0c3fd635c5b24c3c333de6ff2a6472b9457c5e98bea77aadb295c8611ee668625b46f2e

data/.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:0-3-bullseye",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"Shopify.ruby-lsp"
+			]
+		}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+actionpack-fly-*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rails', '~> 7.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Peter Cai
+
+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,33 @@
+
+# Actionpack::Fly
+
+![Build Status](https://github.com/pcai/actionpack-fly/actions/workflows/ruby.yml/badge.svg)
+
+Simple gem that extends Rails `request.remote_ip` to default to Fly's `Fly-Client-IP` header. More about [Fly HTTP Request Headers](https://fly.io/docs/reference/runtime-environment/#fly-client-ip) and why we choose to trust `Fly-Client-IP`.
+
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'actionpack-fly'
+```
+
+## Usage
+
+None! Just install and feel confident that `request.remote_ip` is doing its job.
+
+
+## Contributing
+
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+Forked from https://github.com/customink/actionpack-cloudflare

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new { |t| t.pattern = "spec/**/*_spec.rb" }
+
+task default: :spec

data/actionpack-fly.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_pack/fly/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "actionpack-fly"
+  spec.version = ActionPack::Fly::VERSION
+  spec.authors = ["Peter Cai"]
+  spec.email = ["hello@petercai.com"]
+  spec.summary =
+    "Allow Rails request.remote_ip to defer to Fly's connecting IP address."
+  spec.description =
+    "Simple gem that extends Rails `request.remote_ip` to default to Fly's `Fly-Client-IP` header."
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.homepage = "https://github.com/pcai/actionpack-fly"
+  spec.license = "MIT"
+  spec.files =
+    `git ls-files -z`.split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "actionpack", ">= 6.0", "< 8.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actionpack/fly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_pack/fly/request.rb

@@ -0,0 +1,17 @@
+module ActionPack
+  module Fly
+    module Request
+      def remote_ip
+        remote_ip_fly || super
+      end
+
+      private
+
+      def remote_ip_fly
+        @env["HTTP_FLY_CLIENT_IP"]
+      end
+    end
+  end
+end
+
+ActionDispatch::Request.class_eval { prepend ActionPack::Fly::Request }

data/lib/action_pack/fly/version.rb

@@ -0,0 +1,5 @@
+module ActionPack
+  module Fly
+    VERSION = "1.0.0".freeze
+  end
+end

data/lib/action_pack/fly.rb

@@ -0,0 +1,10 @@
+require "action_pack"
+require "action_dispatch"
+require "action_dispatch/http/request"
+require "action_pack/fly/version"
+require "action_pack/fly/request"
+
+module ActionPack
+  module Fly
+  end
+end

data/lib/actionpack-fly.rb

@@ -0,0 +1 @@
+require "action_pack/fly"

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: actionpack-fly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Cai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.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'
+description: Simple gem that extends Rails `request.remote_ip` to default to Fly's
+  `Fly-Client-IP` header.
+email:
+- hello@petercai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/devcontainer.json"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionpack-fly.gemspec
+- bin/console
+- bin/setup
+- lib/action_pack/fly.rb
+- lib/action_pack/fly/request.rb
+- lib/action_pack/fly/version.rb
+- lib/actionpack-fly.rb
+homepage: https://github.com/pcai/actionpack-fly
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Allow Rails request.remote_ip to defer to Fly's connecting IP address.
+test_files: []