r53z 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83c9097772ffb2446770deb433f151234c7d48c6
-  data.tar.gz: f4c97405669e49664f15461cea6df4edb0dbc8da
+  metadata.gz: 01330f8ce2de5edce6c20dc4f8a38df05b89bef3
+  data.tar.gz: cfde757ab218ccd71630ccc51459f904b38c5943
 SHA512:
-  metadata.gz: 72b8bee3563a3eb8804473695ff5c9fe0d58115d544aef2b4fab69a098c26709b3f272fe0fdd0550ebad446ff4b2404f0f3d25ddb673c7d98f5ae492e729563c
-  data.tar.gz: b942db9c3fc19c72b056b75cf388271e3c85222a62426e04bff7b64a9a606b3e2017a3d5efcbfd76a0c2e74c7fc04dee84ade1807e6e8fa6cf02a979acdccfbd
+  metadata.gz: c6e4f8cee2366bdf67c884128c7190bee6e1c0796211d34ee7706b0573e5bdc514231c09cd64870dbc93f2b37ed1d9127cdbd9a422ccdd3bbb1b38baf49a8b17
+  data.tar.gz: 5f124496e1d75f8bd22542b506cc8a5fd152edebb2bfeead85f96bdec16758072d17d84b15b88abaa3f934d0d59bb810c42084733ccda2f0e3935a5c6ba3d1bf

data/README.md

@@ -1,6 +1,6 @@
 # R53z
 
-A simple CLI, REPL, and library for managing Route 53. It's primary purpose is to back up and restore Route 53 zones. It can write zones to files in JSON format. It also provides a simple API (not a whole lot easier than the Amazon official API, but for backups and restores, it's much easier to script with and removes tons of boilerplate).
+A simple CLI, REPL, and library for managing Route 53. It's primary purpose is to back up and restore Route 53 zones. It can write zones to files in JSON format. It also provides a simple API (not a whole lot easier than the Amazon official API, but for backups and restores, it's much easier to script with and removes tons of boilerplate). There are several other similar tools on github (cli53 probably being the best and best known), but they all had something preventing them from working for the use cases I needed to support (or were based on old versions of the AWS API or had built their own incomplete API); as far as I can tell, r53z currently does more then the other tools out there, and once all of the backend has been hooked up to the front end, it'll be a pretty complete CLI and REPL for Route 53.
 
 ## Installation
 
@@ -16,10 +16,20 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as (it's on rubygems.org, but installation of the binary isn't working right yet, will be fixed sooon):
+Run the command with:
 
-    $ gem install r53z
+    $ bundle exec bin/r53z
+
+And, you can run a REPL with:
+
+    $ bundle exec bin/console
+
+A `client` object has methods for most common tasks with Route 53, maybe it easy to script with. The REPL is a little clumsy on startup, as it uses the binding method, which gives some clunky output, but it allows setting up both the credentials and client automatically.
 
+Or install it yourself as (the gem installs an r53z executable in the path, but not the `console` REPL):
+
+    $ gem install r53z
+    
 ## Usage
 
 **NOTE:** Don't get too attached to the current CLI options. I'm rewriting the option parser to use sub-commands in the near future. So, if you love it like it is (surely, nobody could love it like it is), you'll need to lock in a version that still has this parser.
@@ -35,12 +45,12 @@ region=us-east-1
 
 You can use the `--section` option to choose which section to use from the credentials file, and the credentials file can be specified with the `--credentials` option. Region is irrelevant with Route 53, but the aws-sdk weirdly still requires it be present.
 
-```
+```sh
 Usage: r53z [options] [args...]
 
 Simple CLI to manage, backup, and restore, Route 53 zones
 
-v0.3.0
+v0.3.2
 
 Options:
     -h, --help                       Show command line help
@@ -76,7 +86,7 @@ Two files will be generated in the directory specified, one for the zone metadat
 
 ##### Example
 
-```
+```sh
 $ r53z --export /home/joe/zones swelljoe.com
 ```
 
@@ -90,7 +100,7 @@ If `--delegation-set` is specified on the command line, it will override the del
 
 ##### Example
 
-```
+```sh
 $ r53z --restore /home/joe/zones swelljoe.com
 ```
 
@@ -104,7 +114,7 @@ Create zone of the NAME provided. An optional command an delegation set ID may b
 
 ##### Example
 
-```
+```sh
 $ r53z --create swelljoe.com --comment "My domain"
 ```
 
@@ -114,7 +124,7 @@ Delete one or more zones. Argument is the name of the zone, or zones, to delete.
 
 ##### Example
 
-```
+```sh
 $ r53z --delete swelljoe.com virtualmin.com
 ```
 
@@ -128,7 +138,7 @@ Specify the credentials configuration file on the command line. The file must be
 
 Finding the delegation set of a zone, and backing up all zones that share that delegation set:
 
-```
+```sh
 $ r53z --list-delegation-sets swelljoe.com
 {
   "id": "/delegationset/NKXKQ56JI1ZGT",
@@ -145,13 +155,13 @@ $ r53z --export ~/dumps --delegation-set "/delegationset/NKXKQ56JI1ZGT"
 
 Creating a new zone with an existing delegation set:
 
-```
+```sh
 $ r53z --create swelljoe.com --comment "dootdoot" --delegation-set "/delegationset/NKXKQ56JI1ZGT"
 ```
 
 Restoring a zone into a specific delegation set (this will override the delegation set specified in the dump file):
 
-```
+```sh
 $ r53z --restore ~/dumps swelljoe.com --delegation-set "/delegationset/NKXKQ56JI1ZGT"
 ```
 
@@ -167,12 +177,15 @@ To run the full test suite, you need a read/write capable account. There must be
 
 To run all tests:
 
-```
+```sh
 $ rake test
 ```
 
 This will create a few test zones in your account, but unless something goes wrong during the test, they will be removed immediately after, never triggering billing from Amazon. The zones will have somewhat randomly generated names, so they should never clash with existing names (but you may wish to create a non-production account just for testing).
 
+There is one extra tests file called disabled_tc_101.rb. It is disabled, by default, because it takes quite a while to run, especially on a slow link. It produces 101 zones, in order to exercise the list truncation handling code for sets over 100
+zones.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/swelljoe/r53z.

data/bin/r53z

@@ -9,7 +9,7 @@ class App
   include Methadone::CLILogging
 
   main do |*args|
-    help_now! "No options provided." if options.empty? 
+    help_now! "No options provided." if options.empty?
     R53z::Cli.new(:options => options, :args => args)
   end
 
@@ -20,7 +20,7 @@ class App
   on("-x DIR", "--export", "Export zones to files in specified directory, optionally specify one or more zones.")
   on("-r DIR", "--restore", "Restore zone from directory, optionally specify one or more zones.")
   on("-l", "--list", "List name and ID of one or all zones.")
-  on("-s", "--record-sets", "List record sets for the given zone.")
+  on("-s", "--list-records", "List record sets for the given zone.")
   on("-c NAME", "--create", "Create a zone with the given name and optional --comment and --delegation-set.")
   on("-n COMMENT", "--comment", "Optional comment when creating a zone.")
   on("-d", "--delete", "Delete one or more zone(s) by name (WARNING: No confirmation!)")
@@ -31,6 +31,8 @@ class App
   on("-S", "--create-delegation-sets", "Create one or more delegation sets, optionally associated with listed zones.")
   on("-D", "--delete-delegation-sets", "Delete one or more delegation sets by ID (WARNING: No confirmation!)")
   on("-N ID", "--name-servers", "List name servers for delegation set.")
+  on("-L", "--list-by-id", "List one or more zones for the given hosted zone ID(s).")
+  on("-R", "--list-records-by-id", "List one or more record sets for the given hosted zone ID(s).")
   # args greedily grabs any files or zones listed after the options
   arg(:args, :any)
 
@@ -40,4 +42,3 @@ class App
 
   go!
 end
-

data/lib/r53z/cli.rb

@@ -79,6 +79,20 @@ module R53z
         dset = @client.get_delegation_set(options['name-servers'])
         puts JSON.pretty_generate(dset.delegation_set[:name_servers])
       end
+
+      if options['list-by-id']
+        if args.empty?
+          exit_now! "List by ID requires one or more zone IDs."
+        end
+        list_by_id(args)
+      end
+
+      if options['list-records-by-id']
+        if args.empty?
+          exit_now! "List records by ID requies on or more zone IDs."
+        end
+        list_records_by_id(args)
+      end
     end
 
     def export(options:, args:)
@@ -215,6 +229,17 @@ module R53z
         end
       end
     end
+
+    def list_by_id(args)
+      args.each do |id|
+        puts JSON.pretty_generate(@client.list_by_id(id).to_hash)
+      end
+    end
+
+    def list_records_by_id(args)
+      args.each do |id|
+        puts JSON.pretty_generate(@client.list_records(id))
+      end
+    end
   end
 end
-

data/lib/r53z/client.rb

@@ -1,5 +1,5 @@
 module R53z
-  class Client 
+  class Client
     include Methadone::Main
     include Methadone::CLILogging
     attr_accessor :client
@@ -42,6 +42,9 @@ module R53z
               delegation_set_id: delegation_set_id,
               marker: marker,
               )
+            # R53 imposes a 5 request per second limit
+            # Could catch "throttling"/"rate exceeded" error and retry
+            sleep 0.3
           else
             resp = self.client.list_hosted_zones(
               delegation_set_id: delegation_set_id)
@@ -59,11 +62,11 @@ module R53z
     # Create zone with record(s) from an info and records hash
     def create(info:, records: nil)
       rv = {} # pile up the responses in a single hash
-      #if self.list(info[:name]).any?
-      #  error(info[:name] + "exists")
+      #if self.list(name: info[:name]).any?
+      #  error(info[:name].to_s + " already exists")
       #end
       # XXX: AWS sends out a data structure with config:, but expects
-      # hosted_zone_config on create/restore. argh.
+      # hosted_zone_config: on create/restore. argh.
       # XXX: also, private_zone is not accepted here for some reason
       zone = info[:hosted_zone]
       # Populate a zone_data hash with options for zone creation
@@ -84,7 +87,7 @@ module R53z
       # Optionally populate records
       if records
         records.each do |record|
-          # skip these, as they are handled separately (delegation set?)
+          # skip these, as they are handled separately (delegation sets)
           unless (record[:type] == "NS" || record[:type] == "SOA")
             record_resp = self.client.change_resource_record_sets({
               :hosted_zone_id => zone_resp[:hosted_zone][:id],
@@ -104,12 +107,18 @@ module R53z
       return rv
     end
 
-    # delete a zone by name
-    def delete(name)
-      # get the ID
-      zone_id = self.list(:name => name).first[:id]
-      self.delete_all_rr_sets(zone_id)
-      client.delete_hosted_zone(:id => zone_id)
+    # delete a zone by name, optionally by ID
+    def delete(name, id: nil)
+      # if we got both, demand nil for name, because AWS allows multiples
+      if name and id
+        raise "Name should be nil when id is provided."
+      end
+      unless id
+        id = self.list(:name => name).first[:id]
+      end
+      # Can't delete unless empty of record sets
+      self.delete_all_rr_sets(id)
+      client.delete_hosted_zone(:id => id)
     end
 
     # delete all of the resource record sets in a zone (this is required to delete
@@ -130,7 +139,7 @@ module R53z
       end
     end
 
-    # dump a zone to a direcory. Will generate two files; a zoneinfo file and a 
+    # dump a zone to a direcory. Will generate two files; a zoneinfo file and a
     # records file.
     def dump(dirpath, name)
       # Get the ID
@@ -147,17 +156,15 @@ module R53z
         data: self.list_records(zone_id))
 
       # Dump the zone metadata, plus the delegated set info
-      out = { :hosted_zone => 
+      out = { :hosted_zone =>
                 self.client.get_hosted_zone({ :id => zone_id}).hosted_zone.to_h,
-              :delegation_set => 
+              :delegation_set =>
                 self.client.get_hosted_zone({:id => zone_id}).delegation_set.to_h
             }
 
       R53z::JsonFile.write_json(
         path: File.join(dirpath, name + "zoneinfo"),
         data: out)
-        #data: self.client.get_hosted_zone({
-        #  :id => zone_id}).hosted_zone.to_h)
     end
 
     # Restore a zone from the given path. It expects files named
@@ -201,7 +208,7 @@ module R53z
       resp = self.client.list_reusable_delegation_sets({})
       return resp.delegation_sets
     end
-    
+
     # get details of a delegation set specified by ID, incuding name servers
     def get_delegation_set(id)
       self.client.get_reusable_delegation_set({
@@ -227,13 +234,22 @@ module R53z
         return nil
       end
       return self.client.get_hosted_zone({
-        id: zone_id 
+        id: zone_id
       }).delegation_set[:id]
     end
 
+    # Get zone information in a different way for testing
+    def list_by_id(id)
+      # no begin, let exceptions bubble up, maybe it'll give useful data
+      zone = self.client.get_hosted_zone({
+        id: id
+      }).hosted_zone
+      return zone
+    end
+
     # Get the zone id from name
     def get_zone_id(name)
-      return self.list(:name => name).first[:id]
+      self.list(:name => name).first[:id]
     end
 
     # random string generator helper function
@@ -242,4 +258,3 @@ module R53z
     end
   end
 end
-

data/lib/r53z/version.rb

@@ -1,3 +1,3 @@
 module R53z
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r53z
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Joe Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,7 +146,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md