porkbun 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd160032fe0fe5e7fdd9c899fcf253609f0104f0080ba73090edf9a4c01a5a97
-  data.tar.gz: 1bd55b3b7cc3b3b564ff6836bd7d51666d32035a423f409ed1784ea22ff8c16b
+  metadata.gz: bfab2dd7301e980ef4e44f2db8579b6797cf18371863b295d904ba1129720b31
+  data.tar.gz: 18c9df86bbbf47ad1a7cf4d9c2805a63195f17ee87edb79abb95492ca82023af
 SHA512:
-  metadata.gz: '07881fdc1d92373386a055e2dc732dd230d0b2bfa48f690793a623c0fede50a6438041bce3b1133eb0dd3ca8a8298ffbf4a70c79a857bff126c70accebd117a7'
-  data.tar.gz: 502b183391a39ba249c38abb6829c22ea925646d512df3fa5cbdf0670ac8311b3583b4afa6fa4735426098ed909a0c9bfbbb72945d2c2b85e6e9953ec2cabb50
+  metadata.gz: 9fd355b2102b8ad2352e6e389c103877e3b4cea191d4d88420be4f6460755b30541ee67def037bed4b9f0192b5e6afa8b84bc5fd3df3e77059e37ec67ee8cd45
+  data.tar.gz: 1f1b61ce3edb87a0d846c8f7e5089d4d02619e9bf07334c8b9da93903a424650eed89416e057199a4250a72fa88590262d354b79069b7086ca3a10bebe9d1f2d

data/Gemfile

@@ -12,3 +12,5 @@ gem "rspec", "~> 3.12", :group => :test
 gem "webmock", "~> 3.19", :group => :test
 
 gem "pry", "~> 0.14.2", :group => :test
+
+gem "thor", "~> 1.2"

data/README.md

@@ -9,15 +9,50 @@ Reference: https://porkbun.com/api/json/v3/documentation
 ## Usage
 
 ```ruby
-Porkbun.API_KEY = 'YOUR_API_KEY'
-Porkbun.SECRET_KEY = 'YOUR_SECRET_KEY'
+ENV['PORKBUN_API_KEY'] = 'YOUR_API_KEY'
+ENV['PORKBUN_SECRET_API_KEY'] = 'YOUR_SECRET_API_KEY'
 record = Porkbun::DNS.create(name: 'test',
-type: 'A',
-content: '1.1.1.1',
-ttl: 300
+  type: 'A',
+  content: '1.1.1.1',
+  ttl: 300
 )
 ```
 
+## API
+
+### `Porkbun::Domain.ping`
+
+Make sure your keys are good.
+
+### `Porkbun::DNS.retrieve(domain, id)`
+
+Retrive all or specific record for a domain
+
+### `Porkbun::DNS.create(options)`
+
+Create record for a domain
+
+options:
+- `name` - name of record. example `www`
+- `type` - record type. example: CNAME
+- `content` - content of record. example '1.1.1.1',
+- `ttl` - time to live. example: 600. porkbun seems to have this as a minimum
+- `prio` - record priority. mainly for MX records. example 10.
+
+returns instance of DNS which can be used to delete
+
+## CLI
+
+The gem also comes with a CLI
+
+    $ porkbun
+    Commands:
+      porkbun delete_all <domain>       # deletes all records for a domain. this is destructive. use with caution
+      porkbun help [COMMAND]            # Describe available commands or one specific command
+      porkbun import <file>             # Import BIND zone file
+      porkbun list                      # List all domains
+      porkbun retrieve <domain> [<id>]  # List all records for a domain
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -26,4 +61,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/danielb2/porkbun.
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielb2/porkbun-ruby.

data/bin/porkbun

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'porkbun'
+require 'thor'
+
+class CLI < Thor
+  desc 'import <file>', 'Import BIND zone file'
+  def import(file)
+    record_regex = /^(?<hostname>[^\s]+)\.\s+(?<ttl>\d+)\s+IN\s+(?<type>[^\s]+)\s*(?<priority>\d+)?\s+(?<content>.+)$/
+    IO.readlines(file).each do |line|
+      match_data = line.match(record_regex)
+      next unless match_data
+
+      domain = match_data[:hostname].split('.')[-2..].join('.').chomp '.'
+      name = match_data[:hostname].split('.')[0..-3].join('.')
+
+      options = {
+        domain:,
+        name:,
+        ttl: match_data[:ttl],
+        type: match_data[:type],
+        prio: match_data[:priority],
+        content: match_data[:content].chomp('.').gsub(/^"|"$/, '')
+      }.compact
+
+      record = Porkbun::DNS.create options
+      pp record
+    end
+  end
+
+  desc 'list', 'List all domains'
+  def list
+    Porkbun::Domain.list_all[:domains].each do |domain|
+      puts domain[:domain]
+    end
+  end
+
+  desc 'delete_all <domain>', 'deletes all records for a domain. this is destructive. use with caution'
+  def delete_all(domain, id = '')
+    records = get_all(domain, id)
+    records.each do |record|
+      next if record.type == 'NS'
+
+      puts "DELETE #{record}"
+      record.delete
+    end
+  end
+
+  desc 'retrieve <domain> [<id>]', 'List all records for a domain'
+  def retrieve(domain, id = '')
+    records = get_all(domain, id)
+    puts records
+  end
+
+  def self.exit_on_failure?
+    exit 1
+  end
+
+  private
+
+  def get_all(domain, id = '')
+    records = Porkbun::DNS.retrieve(domain, id)
+    if records.instance_of?(Porkbun::Error)
+      puts records.message
+      exit 1
+    end
+    records
+  end
+end
+
+CLI.start(ARGV)

data/lib/porkbun/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Porkbun
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/porkbun.rb

@@ -7,7 +7,6 @@ module Porkbun
   class Error < StandardError; end
 
   def self.porkbun(path, options = {})
-    pp path
     res = HTTP.post File.join('https://porkbun.com/api/json/v3', path), json: {
       secretapikey: ENV.fetch('PORKBUN_SECRET_API_KEY', nil),
       apikey: ENV.fetch('PORKBUN_API_KEY', nil)
@@ -65,6 +64,8 @@ module Porkbun
       raise Error, 'need domain' unless domain
 
       res = Porkbun.porkbun File.join('dns/retrieve', domain, id || '').chomp('/')
+      return Error.new(res[:message]) if res[:status] == 'ERROR'
+
       res[:records].map do |record|
         DNS.new record.merge(domain:)
       end
@@ -78,13 +79,30 @@ module Porkbun
       self
     end
 
+    require 'pry'
+    def to_s
+      content_str = case type
+                    when /TXT|SPF/
+                      "\"#{content}\""
+                    when /MX|CNAME|NS/
+                      "#{content}."
+                    else
+                      String(content)
+                    end
+
+      prio_str = prio == '0' ? '' : prio
+      "#{name}. #{ttl} IN #{type} #{prio_str} #{content_str}".tr_s(' ', ' ')
+    end
+
     def create
-      res = Porkbun.porkbun File.join('dns/create', domain), {
+      options = {
         name:,
         content:,
         type:,
         ttl:
       }
+      options.merge!(prio:) if prio
+      res = Porkbun.porkbun File.join('dns/create', domain), options
       parse_response res
       @id = res[:id]
       self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porkbun
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Bretoi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -27,7 +27,8 @@ dependencies:
 description: Porkbun API wrapper for Ruby.
 email:
 - daniel@otherware.org
-executables: []
+executables:
+- porkbun
 extensions: []
 extra_rdoc_files: []
 files:
@@ -35,6 +36,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/porkbun
 - lib/porkbun.rb
 - lib/porkbun/version.rb
 - sig/porkbun.rbs