ser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5345e11f6ed095517bc354c22cf36159bef1ffcaa14c4a5f1f679c3aacbaf56
+  data.tar.gz: a926ba1d4f811fd81b4d55ccac291658e2f5632b0e37fee78036e5a006a984d0
+SHA512:
+  metadata.gz: 979c901457369e1534acd00cadd99544c50d12a2c6a24a1e8457a67bb308b5532d51e33e0031f3976ba54b509ab8e9d6c01e55c4eb7bff7288c4ec3ff77e3830
+  data.tar.gz: f72b539bc8550b10017dd1b71eb778c9a57e898b1fcb9558d50e6932586e1c8555de22949636880fcda96ce2d4032f91360a643983cba4293ef9e08672e46b0a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 3v0k4
+
+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,127 @@
+# Ser
+
+<div align="center">
+  <img width="250" width="250" src=".github/images/ser.png" />
+</div>
+
+<br />
+
+Ser(ve) your web app with HTTPS to any device on your network (mDNS):
+- Use convenient domain names without ports (`https://app.local` vs `http://127.0.0.1:3000`)
+- Use mDNS for `.local` domains, so you can visit them from your phone or any other device connected to the same network
+- Locally-trusted development certificates (read on [filosottile/mkcert](https://github.com/filosottile/mkcert) how to trust certificates on mobile devices)
+
+Use-cases:
+- Simulate production-like subdomains (e.g., `blog.example.com`, `api.example.com`)
+- Test cookies scoped to specific domains
+- Preview multi-tenant routing (e.g., `tenant1.example.com`, `tenant2.example.com`)
+- Use third-party APIs that need HTTPS
+
+## Installation
+
+You can install ser with Go:
+
+```bash
+go install github.com/3v0k4/ser
+```
+
+Ser is also distributed as a Ruby gem. Because Ser is written in Go, several pre-built platform-specific binaries are available. Installing the gem will automatically fetch the appropriate binary for your platform.
+
+To install it, add it to your application's Gemfile:
+
+```ruby
+gem 'ser'
+```
+
+Or install it globally:
+
+```sh
+$ gem install ser
+```
+
+## Usage
+
+If your app server listens on `http://localhost:3000`, you can just run `ser [APP-SERVER]` and visit `https://ser.local` on any device connected to the same network.
+
+Otherwise, you can customise the addresses with ENVs:
+
+```bash
+Usage: ser CMD
+
+Ser(ve) your web app with HTTPS to any device on your network (mDNS):
+  Provisions HTTPS certificates for FROM
+  Executes CMD
+  Proxies requests from FROM to TO
+  Starts a mDNS server to announce FROM (if .local)
+
+Arguments:
+  CMD the command that launches the app server (it must expect requests at TO)
+
+ENVs:
+  FROM (default: https://ser.local) comma-separated HTTPS domains you want to access
+  SER_FROM same as above but takes precedence
+  TO   (default: http://localhost:3000) address where CMD expects requests
+  SER_TO same as above but takes precedence
+
+Examples:
+  ser bundle exec rails server
+  # Access the Rails app at https://ser.local (from your phone)
+
+  FROM=https://app.local TO=http://127.0.0.1:8080 ser npm run start
+  # Access the Node app at https://app.local (from your phone)
+```
+
+## Development
+
+### Testing
+
+```bash
+make test
+```
+
+### Running || Building
+
+You can run the application using `go run`:
+
+```bash
+go run ./cmd/ser
+```
+
+You can also build for the current environment (`bin/`) using the Makefile:
+
+```bash
+make build
+```
+
+To build binaries for all supported architectures and operating systems (`dist/`), use:
+
+```bash
+make dist
+```
+
+### Releasing
+
+In order to ship the platform-specific binary inside a gem, multiple gems are released, one for each platform. The `rake release` task builds all the necessary gems.
+
+Checklist:
+
+- Update version & changelog:
+  - [ ] Update `lib/ser/version.rb`
+  - [ ] Update `CHANGELOG.md`
+  - [ ] Commit and `git tag vX.Y.Z`
+
+- Build native gems:
+  - [ ] `rake clobber` (to clean up any old packages)
+  - [ ] `rake package`
+
+- Push gems:
+  - [ ] `for g in pkg/*.gem ; do gem push $g ; done`
+  - [ ] `git push`
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/3v0k4/ser).
+
+## License
+
+The module is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/ser

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+PLATFORM = [ :cpu, :os ].map { |m| Gem::Platform.local.send(m) }.join("-")
+EXECUTABLE = File.expand_path(File.join(__dir__, PLATFORM, "ser"))
+
+if File.exist?(EXECUTABLE)
+  exec(EXECUTABLE, *ARGV)
+else
+  STDERR.puts("ERROR: Unsupported platform: #{PLATFORM}")
+  exit 1
+end

data/lib/ser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ser
+  VERSION = '0.1.0'
+end

data/lib/ser.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ser
+end
+
+require_relative 'ser/version'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: ser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 3v0k4
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Ser(ve) your web app with HTTPS to any device on your network (mDNS):
+  1. Use convenient domain names without ports (https://app.local vs http://127.0.0.1:3000);
+  2. Use mDNS for .local domains, so you can visit them from your phone or any other device connected to the same network;
+  3. Locally-trusted development certificates (read on filosottile/mkcert how to trust certificates on mobile devices).
+
+  Use-cases:
+  1. Simulate production-like subdomains (e.g., blog.example.com, api.example.com);
+  2. Test cookies scoped to specific domains;
+  3. Preview multi-tenant routing (e.g., tenant1.example.com, tenant2.example.com);
+  4. Use third-party APIs that need HTTPS.
+email:
+- riccardo.odone@gmail.com
+executables:
+- ser
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/ser
+- lib/ser.rb
+- lib/ser/version.rb
+homepage: https://github.com/3v0k4/ser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/3v0k4/ser
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ser(ve) your web app with HTTPS to any device on your network (mDNS)
+test_files: []