mythic-beasts 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff19b7149b4146959d99412af78e9cc2ffe5b9c7a210faff7ee5fc83dbbcb957
-  data.tar.gz: e200bed772b3a84c4c39ed454ab4f2b957f066d3710d83d0b3fa9e5e77865d51
+  metadata.gz: b3ce37ca163918f82d1612c56fc75ce81e8de315abf65500a90b98ff6ca586dd
+  data.tar.gz: 21885db9c87b16458429a26a886b5873437d29d4232d7b11833ce9a9c2016029
 SHA512:
-  metadata.gz: bf9e744f9f587ca9ea65d78a5d86b4cb6b20876770ec559667c94b635fc2d04687c510b5b125f8560560e33df4595142d6a2dae9a7307608e668cf082676303d
-  data.tar.gz: f5d16e71f563a97e9c4b570d7b90e7c48a0f546bc1ab3428b570feff147fed6f69453855e46e2de4682137a311a56b9ffcfd6a968f2edb9eded8ec18f75058ec
+  metadata.gz: b4629b547c7aa646fdba1eedf30c51d9e524005f3e8c7de3c112abc1d38f305a1befa6f421cf2334520e9a8ba683450709b7398a7e29bdd2f8f1bb6ddf204e2a
+  data.tar.gz: 8e9e1879278b5b9fa898328835be2ceaa3bcb1a4d6dd809f58050374903e609869a5af216095e09fb46f8a72b7f0a92d0e4944c7ca85afbf7e44d98fa6f68586

data/CHANGELOG.md

@@ -5,10 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2025-01-27
+## [0.1.2] - 2025-11-05
 
 ### Added
 
+- VPS zones listing method (`MythicBeasts.client.vps.zones`) to query available datacenters
+- VPS types listing method (`MythicBeasts.client.vps.types`) to query available VPS plans
+- Optional parameters for VPS creation: `location`, `service`, `description`, `notes`
+- IPv6-only VPS provisioning support (`ipv4: false`) for cost savings
+- Example scripts in `examples/` directory:
+  - `list_zones_and_types.rb` - List available zones and VPS types
+  - `provision_vps.rb` - Complete VPS provisioning example
+  - `ipv6_only_vps.rb` - IPv6-only VPS with proxy setup guide
+- Test coverage for IPv6-only VPS provisioning
+
+### Changed
+
+- Updated README with new VPS methods and examples
+- Improved VPS create documentation with optional parameters
+- Added IPv6-only servers documentation with proxy setup instructions
+
+## [0.1.0] - 2025-01-27
+
+### Features
+
 - Initial release by James Inman (@jfi)
 - OAuth2 authentication support with automatic token refresh
 - DNS API v2 client with full CRUD operations

data/README.md

@@ -87,6 +87,14 @@ MythicBeasts.client.dns.dynamic_update('home.example.com')
 ### VPS Management
 
 ```ruby
+# List available zones/datacenters
+zones = MythicBeasts.client.vps.zones
+# => ["london", "cambridge", "amsterdam", "fremont"]
+
+# List available VPS types/plans
+types = MythicBeasts.client.vps.types
+# => ["VPS-1", "VPS-2", "VPS-3", ...]
+
 # List all VPS servers
 servers = MythicBeasts.client.vps.list
 
@@ -97,7 +105,11 @@ server = MythicBeasts.client.vps.get('my-server')
 MythicBeasts.client.vps.create(
   name: 'my-new-server',
   type: 'VPS-2',
-  ssh_key: 'ssh-rsa AAAAB3...'
+  ssh_key: 'ssh-rsa AAAAB3...',
+  location: 'london',  # Optional: specify datacenter
+  service: 'my-service',  # Optional: service/project name
+  description: 'My test server',  # Optional: server description
+  notes: 'Any additional notes'  # Optional: special requests
 )
 
 # Control servers
@@ -112,6 +124,37 @@ console = MythicBeasts.client.vps.console('my-server')
 MythicBeasts.client.vps.delete('my-server')
 ```
 
+#### IPv6-Only Servers (Cost Savings)
+
+Provision cheaper IPv6-only servers without IPv4 addresses. Perfect for services accessible via Mythic Beasts' IPv4-to-IPv6 proxy:
+
+```ruby
+# Create an IPv6-only VPS (cheaper!)
+MythicBeasts.client.vps.create(
+  name: 'my-ipv6-server',
+  type: 'VPS-2',
+  ipv4: false,  # No IPv4 address = lower cost
+  ssh_key: 'ssh-rsa AAAAB3...',
+  location: 'london'
+)
+```
+
+**IPv4-to-IPv6 Proxy Setup:**
+
+1. Provision your IPv6-only VPS (as shown above)
+2. In Mythic Beasts control panel, configure IPv4-to-IPv6 proxy
+3. Point your domain's DNS to `proxy.mythic-beasts.com` (CNAME or ANAME)
+
+**Supported proxy protocols:**
+
+- HTTP (port 80) and HTTPS (port 443)
+- IMAPS (port 993) and SMTPS (port 465)
+- Gemini (port 1965)
+
+See `examples/ipv6_only_vps.rb` for a complete working example with setup instructions.
+
+**Documentation:** [IPv4 to IPv6 Proxy](https://www.mythic-beasts.com/support/topics/proxy)
+
 ## Error Handling
 
 The gem provides specific error classes:
@@ -131,6 +174,7 @@ end
 ```
 
 Available error classes:
+
 - `MythicBeasts::Error` - Base error class
 - `MythicBeasts::AuthenticationError` - Invalid credentials
 - `MythicBeasts::NotFoundError` - Resource not found
@@ -138,13 +182,49 @@ Available error classes:
 - `MythicBeasts::RateLimitError` - Rate limit exceeded
 - `MythicBeasts::ServerError` - Server-side error
 
+## Examples
+
+See the `examples/` directory for complete working examples:
+
+- `examples/list_zones_and_types.rb` - List available zones and VPS types
+- `examples/provision_vps.rb` - Provision a new VPS server
+- `examples/ipv6_only_vps.rb` - Provision an IPv6-only VPS with proxy setup guide
+
+Run examples with:
+
+```bash
+export MYTHIC_BEASTS_API_KEY=your_key
+export MYTHIC_BEASTS_API_SECRET=your_secret
+ruby examples/list_zones_and_types.rb
+```
+
 ## Development
 
-After checking out the repo:
+After checking out the repo, run the setup script to install dependencies and git hooks:
 
 ```bash
-bundle install
-bundle exec rspec
+bin/setup
+```
+
+This will:
+
+- Install all gem dependencies
+- Set up lefthook git hooks that run before pushing
+
+The pre-push hooks automatically run:
+
+- `bundle exec standardrb` - Ruby code linting
+- `npx markdownlint-cli2 "**/*.md"` - Markdown linting
+- `bundle exec rspec` - Test suite
+- `bundle exec bundler-audit check --update` - Security audit
+
+You can also run these checks manually:
+
+```bash
+bundle exec rspec                           # Run tests
+bundle exec standardrb                      # Run linter
+npx markdownlint-cli2 "**/*.md"             # Run markdown linter
+bundle exec bundler-audit check --update    # Run security audit
 ```
 
 ## Contributing
@@ -154,6 +234,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/tastyb
 ## Author
 
 **James Inman** ([@jfi](https://github.com/jfi))
+
 - Email: james@otaina.co.uk
 - GitHub: https://github.com/tastybamboo
 

data/lib/mythic_beasts/version.rb

@@ -1,3 +1,3 @@
 module MythicBeasts
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/mythic_beasts/vps.rb

@@ -57,5 +57,15 @@ module MythicBeasts
     def console(server_name)
       client.get("/api/vps/#{server_name}/console")
     end
+
+    # List available zones/locations for VPS provisioning
+    def zones
+      client.get("/api/vps/zones")
+    end
+
+    # List available VPS types/plans
+    def types
+      client.get("/api/vps/types")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mythic-beasts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - James Inman
@@ -121,6 +121,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: A Ruby gem for interacting with Mythic Beasts APIs including DNS, VPS
   provisioning, and domain management
 email: