porkbunrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71a1c6fb6edf51ffd81eae3ea00fc27b1aaefffadcdab55232b90f429fcc42db
+  data.tar.gz: f48d70ad50673741124827a310bfd9239bf2649b5945855d3af691177f5aaeb0
+SHA512:
+  metadata.gz: 68c9f3b2697ab024076430297b2aa90a97582864835e54ca949a5bf6be8b5d20f8d6219354d64dcb5d6ba823ab76567c297a9303520c968986df9814e7a0f585
+  data.tar.gz: 7a72f2a393df6ca61dfa83b9ee7b2fc5da7ec5563281fa4dd3697ba23030a8629af3dc747d1ed55b192df1c0d52da648de5440f023ed0334f7c7e4f6317398fc

data/.env.example

@@ -0,0 +1,2 @@
+PORKBUN_API_KEY=
+PORKBUN_API_SECRET=

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: deanpcmad

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 3.1
+          - 3.2
+          - 3.3
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler: default
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twitch.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "dotenv"
+
+gem "vcr"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    porkbunrb (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (3.1.2)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    minitest (5.23.1)
+    net-http (0.4.1)
+      uri
+    rake (12.3.3)
+    uri (0.13.0)
+    vcr (6.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  minitest (~> 5.0)
+  porkbunrb!
+  rake (~> 12.0)
+  vcr
+
+BUNDLED WITH
+   2.5.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dean Perry
+
+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,122 @@
+# PorkbunRB
+
+PorkbunRB is a Ruby library for the Porkbun API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "porkbunrb"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to create an API Key & Secret, which you can generate on the [Porkbun API page](https://porkbun.com/account/api).
+Once you have these details, you can configure the client with the following:
+
+```ruby
+Porkbun.configure do |config|
+  config.api_key    = ENV["PORKBUN_API_KEY"]
+  config.api_secret = ENV["PORKBUN_API_SECRET"]
+end
+```
+
+### Domains
+
+```ruby
+# Retrieve a list of all domains
+# Returns a Porkbun::Collection
+Porkbun::Domain.list
+#=> #<Porkbun::Collection:0x00 @data=[#<Porkbun::Domain domain="deanpcmad.dev">]>
+
+# Get name servers for a domain
+# Returns a Porkbun::Collection
+Porkbun::Domain.get("deanpcmad.dev").name_servers
+#=> #<Porkbun::Collection:0x00 @data=[#<Porkbun::NameServer ns="ns1.deanpcmad.dev">]>
+
+# Get forwards for a domain
+# Returns a Porkbun::Collection
+Porkbun::Domain.get("deanpcmad.dev").forwards
+#=> #<Porkbun::Collection:0x00 @data=[#<Porkbun::Forward record="www.deanpcmad.dev">]>
+
+# Add a forward
+# Subdomain is optional
+# API Docs: https://porkbun.com/api/json/v3/documentation#Domain%20Add%20URL%20Forward
+Porkbun::Domain.add_forward(
+  domain: "deanpcmad.dev",
+  subdomain: "site",
+  location: "https://deanpcmad.com",
+  type: "temporary",
+  include_path: true
+)
+#=> true
+
+# Delete a forward
+Porkbun::Domain.delete("deanpcmad.dev", record: "123123")
+#=> true
+```
+
+### Records
+
+```ruby
+# Retrieve a list of all records for a domain
+# Returns a Porkbun::Collection
+Porkbun::Record.list(domain: "deanpcmad.dev")
+#=> #<Porkbun::Collection:0x00 @data=[#<Porkbun::Record content="pixie.porkbun.com">]>
+
+# Retrieve a list of all records for a domain by type
+# Returns a Porkbun::Collection
+Porkbun::Record.list_by_type(domain: "deanpcmad.dev", type: "CNAME", subdomain: "*")
+#=> #<Porkbun::Collection:0x00 @data=[#<Porkbun::Record content="pixie.porkbun.com">]>
+
+# Get a record
+Porkbun::Record.retrieve(domain: "deanpcmad.dev", id: "123")
+#=> #<Porkbun::Record content="pixie.porkbun.com">
+
+# Add a record
+# Name, TTL and Prio are optional
+# API Docs: https://porkbun.com/api/json/v3/documentation#DNS%20Create%20Record
+Porkbun::Domain.add_record(
+  domain: "deanpcmad.dev",
+  type: "A",
+  value: "1.2.3.4",
+  name: "test"
+)
+#=> true
+
+# Update a record
+Porkbun::Domain.update_record(
+  domain: "deanpcmad.dev",
+  id: "123123",
+  type: "A",
+  value: "1.2.3.5",
+  name: "test"
+)
+#=> true
+
+# Delete a record
+Porkbun::Domain.delete_record(
+  domain: "deanpcmad.dev",
+  record: "www.deanpcmad.dev"
+)
+#=> true
+
+# Delete a record by subdomain and type
+Porkbun::Record.delete_by_subdomain(
+  domain: "deanpcmad.dev",
+  type: "A",
+  subdomain: "test"
+)
+#=> true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/porkbunrb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "porkbun"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# 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
+
+Porkbun.configure do |config|
+  config.api_key = ENV["PORKBUN_API_KEY"]
+  config.api_secret = ENV["PORKBUN_API_SECRET"]
+end
+
+require "irb"
+IRB.start(__FILE__)

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/porkbun/client.rb

@@ -0,0 +1,69 @@
+module Porkbun
+  class Client
+
+    BASE_URL = "https://porkbun.com/api/json/v3"
+
+    class << self
+
+      def connection
+        @connection ||= Faraday.new(BASE_URL) do |conn|
+          conn.headers = {
+            "User-Agent" => "porkbun/v#{VERSION} (github.com/deanpcmad/porkbun)"
+          }
+
+          conn.request :json
+
+          conn.response :json, content_type: "application/json"
+        end
+      end
+
+      def post_request(url, body: {}, headers: {})
+        auth = {apikey: Porkbun.config.api_key, secretapikey: Porkbun.config.api_secret}
+        body.merge!(auth)
+        handle_response connection.post(url, body, headers)
+      end
+
+      def put_request(url, body:, headers: {})
+        handle_response connection.put(url, body, headers)
+      end
+
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
+
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["message"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request. '#{response.body["message"]}'"
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+        when 422
+          raise Error, "Error 422: Unprocessable Content. '#{response.body["message"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["message"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["message"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["message"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["message"]}'"
+        when 204
+          return true
+        end
+
+        response
+      end
+    end
+
+  end
+end

data/lib/porkbun/collection.rb

@@ -0,0 +1,25 @@
+module Porkbun
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key: nil)
+      body = response.body
+
+      if key.is_a?(String)
+        data = body[key].map { |attrs| type.new(attrs) }
+      else
+        data = body.map { |attrs| type.new(attrs) }
+      end
+
+      new(
+        data: data,
+        total: body.count
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/porkbun/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Porkbun
+  class Configuration
+
+    attr_accessor :api_key, :api_secret
+
+  end
+end

data/lib/porkbun/error.rb

@@ -0,0 +1,4 @@
+module Porkbun
+  class Error < StandardError
+  end
+end

data/lib/porkbun/models/domain.rb

@@ -0,0 +1,42 @@
+module Porkbun
+  class Domain < Object
+
+    class << self
+
+      def list
+        response = Client.post_request("domain/listAll", body: {})
+        Collection.from_response(response, type: Domain, key: "domains")
+      end
+
+      def name_servers(domain:)
+        response = Client.post_request("domain/getNs/#{domain}", body: {})
+        data = response.body["ns"].map { |attrs| NameServer.new(ns: attrs) }
+        Collection.new data: data, total: data.size
+      end
+
+      def forwards(domain:)
+        response = Client.post_request("domain/getUrlForwarding/#{domain}", body: {})
+        Collection.from_response(response, type: Forward, key: "forwards")
+      end
+
+      def add_forward(domain:, location:, type:, include_path: false, wildcard: false, **options)
+        body = {
+          domain: domain,
+          location: location,
+          type: type,
+          includePath: include_path ? "yes" : "no",
+          wildcard: wildcard ? "yes" : "no",
+        }.merge(options)
+        response = Client.post_request("domain/addUrlForward/#{domain}", body: body)
+        response.body["status"] == "SUCCESS"
+      end
+
+      def delete_forward(domain:, record:)
+        response = Client.post_request("domain/deleteUrlForward/#{domain}/#{record}", body: {})
+        response.body["status"] == "SUCCESS"
+      end
+
+    end
+
+  end
+end

data/lib/porkbun/models/forward.rb

@@ -0,0 +1,4 @@
+module Porkbun
+  class Forward < Object
+  end
+end

data/lib/porkbun/models/name_server.rb

@@ -0,0 +1,4 @@
+module Porkbun
+  class NameServer < Object
+  end
+end

data/lib/porkbun/models/record.rb

@@ -0,0 +1,60 @@
+module Porkbun
+  class Record < Object
+
+    class << self
+
+      def list(domain:)
+        response = Client.post_request("dns/retrieve/#{domain}", body: {})
+        Collection.from_response(response, type: Record, key: "records")
+      end
+
+      def list_by_type(domain:, type:, subdomain:)
+        response = Client.post_request("dns/retrieveByNameType/#{domain}/#{type}/#{subdomain}", body: {})
+        Collection.from_response(response, type: Record, key: "records")
+      end
+
+      def retrieve(domain:, id:)
+        response = Client.post_request("dns/retrieve/#{domain}/#{id}", body: {})
+        Record.new(response.body["records"][0])
+      end
+
+      def create(domain:, type:, content:, **options)
+        body = {
+          type: type,
+          content: content,
+        }.merge(options)
+        response = Client.post_request("dns/create/#{domain}", body: body)
+        Record.new(id: response.body["id"]) if response.body["status"] == "SUCCESS"
+      end
+
+      def update(domain:, id:, type:, content:, **options)
+        body = {
+          type: type,
+          content: content,
+        }.merge(options)
+        response = Client.post_request("dns/edit/#{domain}/#{id}", body: body)
+        response.body["status"] == "SUCCESS"
+      end
+
+      def update_by_subdomain(domain:, type:, subdomain:, content:, **options)
+        body = {
+          content: content,
+        }.merge(options)
+        response = Client.post_request("dns/editByNameType/#{domain}/#{type}/#{subdomain}", body: body)
+        response.body["status"] == "SUCCESS"
+      end
+
+      def delete(domain:, id:)
+        response = Client.post_request("dns/delete/#{domain}/#{id}", body: {})
+        response.body["status"] == "SUCCESS"
+      end
+
+      def delete_by_subdomain(domain:, type:, subdomain:)
+        response = Client.post_request("dns/deleteByNameType/#{domain}/#{type}/#{subdomain}", body: {})
+        response.body["status"] == "SUCCESS"
+      end
+
+    end
+
+  end
+end

data/lib/porkbun/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Porkbun
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/porkbun/version.rb

@@ -0,0 +1,3 @@
+module Porkbun
+  VERSION = "0.1.0"
+end

data/lib/porkbun.rb

@@ -0,0 +1,30 @@
+require "faraday"
+
+require_relative "porkbun/version"
+
+module Porkbun
+
+  autoload :Configuration, "porkbun/configuration"
+  autoload :Client, "porkbun/client"
+  autoload :Collection, "porkbun/collection"
+  autoload :Error, "porkbun/error"
+  autoload :Object, "porkbun/object"
+
+  class << self
+    attr_writer :config
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= Porkbun::Configuration.new
+  end
+
+  autoload :Domain, "porkbun/models/domain"
+  autoload :Record, "porkbun/models/record"
+  autoload :NameServer, "porkbun/models/name_server"
+  autoload :Forward, "porkbun/models/forward"
+
+end

data/lib/porkbunrb.rb

@@ -0,0 +1 @@
+require "porkbun"

data/porkbunrb.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/porkbun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "porkbunrb"
+  spec.version       = Porkbun::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for the Porkbun API"
+  spec.homepage      = "https://deanpcmad.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/porkbunrb"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: porkbunrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/porkbun.rb
+- lib/porkbun/client.rb
+- lib/porkbun/collection.rb
+- lib/porkbun/configuration.rb
+- lib/porkbun/error.rb
+- lib/porkbun/models/domain.rb
+- lib/porkbun/models/forward.rb
+- lib/porkbun/models/name_server.rb
+- lib/porkbun/models/record.rb
+- lib/porkbun/object.rb
+- lib/porkbun/version.rb
+- lib/porkbunrb.rb
+- porkbunrb.gemspec
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/porkbunrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Ruby library for the Porkbun API
+test_files: []