cloudflare_cli 0.0.3.pre.alpha.3 → 0.0.3.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9040ea27f4419504e8ca1685366b138182c761cf049434495aa26125dc516b7
-  data.tar.gz: 68f45141a508ef11ad4eb325f615574de01854ab669a66861653866b03e04b04
+  metadata.gz: 674fa0021f915da803db1c1b029d1414a071e840db062510e7666dcc1335bb5c
+  data.tar.gz: e0cbcb0b80cb82b9a67393373473bffd7a4ba776efe33dd05f141ce7b6745bf4
 SHA512:
-  metadata.gz: 11ec37db18fdcdbdafa403e7e792ffa9f2cf25599f365462ac6ea71dd68d64c253f2cc3880214c44f86e3e8c1be0e564c5e54d4ab96ccd863ddd81c672d52f62
-  data.tar.gz: 59819e1622c1914a6ffb6f634e34eea8878abfe72f1a7eafe23233f13bb7262379d9ed5bb1acdb838d7a86db0e564b907c599840ef1c0b70dfcbb1b8eef7e9cb
+  metadata.gz: b55ee5dc35a872462aa51f5f955a5227d6b78c07253c8caa916e57b6bb0f42f02b8c475dba1da6ac998ad74a223f14996e266d00bc41805f2dfb17315b86a8b1
+  data.tar.gz: bc4aa6e6e8ab983fc02aa4f55d557caa500ce277d3cd6966ea57d8eefcf15a50f703182f23898c0b7bfc109b9d2d95d6be13c21d02041ccd30c967e174bbf0db

data/README.md

@@ -1,18 +1,109 @@
-= cloudflare_cli
+## cloudflare_cli - Interface with the Cloudflare API!
 
-A Command Line Interface for interacting with CloudFlare's API without having to
-mess with scripting a script yourself.
+    cloudflare_cli is an interface into the Cloudflare API,
+    usage is rate-limited by Cloudflare itself, not the gem.
 
+    See https://api.cloudflare.com/#getting-started-requests for information
+    on the API and the linked anchor for rate-limiting specifically.
 
-== Installation
+v0.0.3-alpha.3
 
-    gem install cloudflare_cli
+### Global Options
 
-== About
+### --api-key APIKEY
 
-This is not a library or require'able gem, this is an executable only.
-If you wish to use CloudFlare's API in more advanced ways, then you would need
-to install a gem that is requirable like [RubyFlare](https://github.com/trev/rubyflare)
-which this gem uses behind the scenes.
+Cloudflare API Key
+
+Default Value
+: none
+
+
+### --email EMAIL
+
+Cloudflare E-Mail
+
+Default Value
+: none
+
+
+### --help
+Show this message
+
+
+### --version
+Display the program version
+
+
+### Commands
+
+#### Command: `dns-record `
+
+DNS Record Management
+
+##### Commands
+
+###### Command: `add `
+
+add a record
+
+###### Command: `rem|del|delete `
+
+remove a record
+
+###### Command: `show `
+
+get a record
+
+###### Command: `update|modify `
+
+update a record
+
+#### Command: `help  command`
+
+Shows a list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a
+way helpful to creating a bash-style completion function
+
+##### Options
+
+##### -c
+List commands one per line, to assist with shell completion
+
+
+#### Command: `initconfig `
+Initialize the config file using current global options
+
+Initializes a configuration file where you can set default options for command
+line flags, both globally and on a per-command basis.  These defaults override
+the built-in defaults and allow you to omit commonly-used command line flags
+when invoking this program
+
+##### Options
+
+##### --[no-]force
+force overwrite of existing config file
+
+
+#### Command: `ips `
+Return Cloudflare IPs
+
+##### Commands
+
+###### Command: `list `
+list out cloudflare's IPs
+
+Default Command
+:   list
+
+#### Command: `zones `
+Use all the non-dns '/zones/*' endpoints
+
+##### Commands
+
+###### Command: `all|list `
+list all zones or filter them
+
+Default Command
+:   all
 
-    gem install rubyflare

data/bin/cfcli

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+##########
+# File: cloudflare_cli/bin/cfcli
+# Project: cloudflare_cli
+# Author: Ken Spencer <me@iotaspencer.me>
+# Copyright (c) 2018 Ken Spencer
+# License: MIT
+# --------
+
+require 'cloudflare_cli'
+
+CloudflareCli::App.run(ARGV)

data/bin/cloudflare_cli

@@ -1,4 +1,12 @@
 #!/usr/bin/env ruby
+##########
+# File: cloudflare_cli/bin/cloudflare_cli
+# Project: cloudflare_cli
+# Author: Ken Spencer <me@iotaspencer.me>
+# Copyright (c) 2018 Ken Spencer
+# License: MIT
+# --------
+
 require 'cloudflare_cli'
 
 CloudflareCli::App.run(ARGV)

data/cloudflare_cli.rdoc

@@ -1,13 +1,13 @@
 == cloudflare_cli - Interface with the Cloudflare API!
 
 
-                    cloudflare_cli is an interface into the Cloudflare API,
-usage is rate-limited by Cloudflare itself, not the gem.
+    cloudflare_cli is an interface into the Cloudflare API,
+    usage is rate-limited by Cloudflare itself, not the gem.
 
-See https://api.cloudflare.com/#getting-started-requests for information
-on the API and the linked anchor for rate-limiting specifically.
+    See https://api.cloudflare.com/#getting-started-requests for information
+    on the API and the linked anchor for rate-limiting specifically.
 
-v0.0.3
+v0.0.3-alpha.3
 
 === Global Options
 === --api-key APIKEY
@@ -91,8 +91,8 @@ Use all the non-dns '/zones/*' endpoints
 
 
 ===== Commands
-====== Command: <tt>all|list-zones </tt>
+====== Command: <tt>all|list </tt>
 list all zones or filter them
 
 
-[Default Command] false
+[Default Command] all

data/lib/cloudflare_cli/app.rb

@@ -1,32 +1,32 @@
-require "gli"
-require "json"
-require "cloudflare_cli/tree"
+require 'gli'
+require 'json'
+require 'cloudflare_cli/tree'
 
 module CloudflareCli
+  # Have a class for the GLI space
   class App
     extend GLI::App
-    program_desc "Interface with the Cloudflare API!"
+    program_desc 'Interface with the Cloudflare API!'
 
-    program_long_desc <<~HEREDOC
+    program_long_desc <<-HEREDOC
 
-                        #{exe_name} is an interface into the Cloudflare API,
+    #{exe_name} is an interface into the Cloudflare API,
     usage is rate-limited by Cloudflare itself, not the gem.
 
     See https://api.cloudflare.com/#getting-started-requests for information
     on the API and the linked anchor for rate-limiting specifically.
-                      HEREDOC
+    HEREDOC
 
     version CloudflareCli::VERSION
 
-    config_file ".cfcli/config"
+    config_file '.cfcli/config'
     subcommand_option_handling :normal
     arguments :strict
     wrap_help_text :verbatim
 
-
     commands_from 'cloudflare_cli/commands'
-    flag [:email], desc: "Cloudflare E-Mail", default_value: "", arg_name: "EMAIL", mask: true
-    flag ["api-key"], desc: "Cloudflare API Key", default_value: "", arg_name: "APIKEY", mask: true
+    flag [:email], desc: 'Cloudflare E-Mail', default_value: '', arg_name: 'EMAIL', mask: true
+    flag ['api-key'], desc: 'Cloudflare API Key', default_value: '', arg_name: 'APIKEY', mask: true
 
     around do |global_options, command, options, arguments, code|
       CloudflareCli::State.initiate(global_options)

data/lib/cloudflare_cli/commands/001_dns_records.rb

@@ -1,19 +1,24 @@
+require 'gli'
 module CloudflareCli
+  # Cloudflare CLI App class
   class App
     extend GLI::App
 
-    desc "DNS Record Management"
-    command "dns-record" do |c|
-      c.desc "add a record"
+    desc 'DNS Record Management'
+    command 'dns-record' do |c|
+      c.desc 'add a record'
+
       c.command :add do |dnsadd|
-        dnsadd.action do |global_options, options, args|
+        dnsadd.flag :type, default_value: 'A', must_match: %w[A AAAA CNAME SOA PTR NS MX LOC SRV SPF TXT CAA CERT DNSKEY DS NAPTR SSHFP TLSA URI SMIMEA], desc: 'Record Type'
 
+        dnsadd.flag :zone, desc: 'DNS Zone ID or Zone Name'
+        dnsadd.action do |global_options, options, args|
           # Your command logic here
 
           # If you have any errors, just raise them
           # raise "that command made no sense"
 
-          puts "dns-record add command ran"
+          puts "dns-record add command ran with #{options}"
         end
       end
 

data/lib/cloudflare_cli/commands/003_zones.rb

@@ -1,20 +1,56 @@
+require 'gli'
+require 'cloudflare_cli/methods/term_table'
+require 'cloudflare_cli/methods/output_class'
+require 'recursive_open_struct'
+require 'cloudflare_cli/send_nested'
+
 module CloudflareCli
   class App
     extend GLI::App
 
     desc "Use all the non-dns '/zones/*' endpoints"
     command :zones do |c|
-      c.desc "list all zones or filter them"
-      c.command [:all, "list-zones"] do |lz|
-        lz.example "#{exe_name} zones [list-zones|all]", desc: "List all zones without filtering them"
-        lz.flag [:name], desc: "Zone name to search for"
+      c.desc 'list all zones or filter them'
+      c.command [:all, :list] do |lz|
+        lz.example "#{exe_name} zones [list-zones|all]", desc: 'List all zones without filtering them'
+        lz.example "#{exe_name} zones [list-zones|all] --name example.com", desc: 'List by filter'
+        lz.example "#{exe_name} zones [list-zones|all] --status active", desc: 'List active zones'
+        lz.example "#{exe_name} zones [list-zones|all] --order name --direction desc", desc: 'List zones and sort by name in descending order'
+        lz.example "#{exe_name} zones [list-zones|all] --name example.com --output success --output result[0].id", desc: 'list zones and output some fields, for use with scripts'
+        lz.flag [:name], desc: 'Zone name to search for, max length is 253 characters', arg_name: 'NAME'
+        lz.flag [:status], desc: 'Status of the zone', must_match: %w[active pending initializing moved deleted deactivated], required: false, arg_name: 'STATUS', default_value: 'active'
+        lz.flag :page, desc: 'Page number of paginated results', type: Integer, arg_name: 'PAGE#', default_value: 1
+        lz.flag :per_page, desc: 'Number of zones per page', default_value: 20, must_match: 5..50, arg_name: '##'
+        lz.flag :order, desc: 'Field to order zones by', must_match: %w[name status email], arg_name: 'ORDER', default_value: 'name'
+        lz.flag %i[direction dir], desc: 'Direction to order zones', must_match: %w[asc desc], arg_name: 'DIR', default_value: 'asc'
+        lz.flag :match, desc: 'Whether to match all search requirements or at least one (any)', must_match: %w[any all], default_value: 'all', arg_name: 'MATCH'
+        lz.flag :'output-sep', desc: 'choose character to separate output fields', must_match: [:newline, :crlf, :space], required: false, default_value: ' '
+        lz.flag :output, desc: 'output fields, use multiple times to output multiple fields', multiple: true
+        lz.switch :table, desc: 'Put some of the output into a table', default_value: true
+        lz.switch :json, desc: 'output the full raw json', negatable: true
         lz.action do |global_options, options, args|
-          puts CloudflareCli::Endpoints::Zones.all(options)
+          cf_options = options.reject{ |k,v| %w[output output-sep table].include? k }.reject{ |k,v| %i[output output-sep table].include? k }
+          js = CloudflareCli::Nodes::Zone::Zones.all(cf_options).body
+          if options[:json]
+            puts js.to_json
+          end
+          if options[:table]
+            table = CloudflareCli::Methods::Zones::TermTable.new('Zones', js)
+            table.make_rows
+          end
+          if options[:output]
+            want = CloudflareCli::Methods::Zones::Output.new(options[:output], options, js)
+            want.put
+          end
         end
       end
-      c.action do |global_options, options, args|
+      c.desc 'Create a zone'
+      c.command [:new, :create] do |cz|
+        cz.switch :'jump-start', desc: 'Automatically attempt to fetch existing DNS records', negatable: true, default_value: false
+        cz.flag :name, desc: 'The domain name', must_match: /^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$/
+        cz.flag :'account-name', desc: "The account's name, this is shown through Home->Account Home->Configurations->Preferences->Account Name"
       end
-      c.default_command false
+      c.default_command :all
     end
   end
 end

data/lib/cloudflare_cli/methods/output_class.rb

@@ -0,0 +1,33 @@
+require 'recursive_open_struct'
+module CloudflareCli
+  module Methods
+    module Zones
+      class Output
+        def initialize(fields, options, hsh)
+          @fields = fields
+          @options = options
+          @hsh = hsh
+          @struct = RecursiveOpenStruct.new(hsh, recurse_over_arrays: true)
+        end
+        def get_fields(fields = @fields)
+          fields.each do |path|
+            print @struct.send_nested(path)
+            case @options[:'output-sep']
+            when :newline
+              print "\n"
+            when :space
+              print ' '
+            when :crlf
+              print "\r\n"
+
+            end
+          end
+
+        end
+        def put
+          self.get_fields
+        end
+      end
+    end
+  end
+end

data/lib/cloudflare_cli/methods/term_table.rb

@@ -0,0 +1,39 @@
+require 'terminal-table'
+require 'recursive_open_struct'
+require 'table_print'
+module CloudflareCli
+  module Methods
+    module Zones
+      class TermTable
+        # @param [String] title Table title
+        # @param [Hash] hsh Initialize a TermTable instance
+        def initialize(title, hsh)
+          @table_title = title
+          @table = Terminal::Table.new
+          @hash = hsh
+          @struct = RecursiveOpenStruct.new(hsh, recurse_over_arrays: true)
+          @table.title = @table_title
+          #@table.style = {:width => 80}
+        end
+
+        # @return [NilClass]
+        def add_separator
+          @table.add_separator
+        end
+
+        def table
+          @table
+        end
+
+        def make_rows
+          tp.set :capitalize_headers, false
+          @struct.result.each do |res|
+            puts res
+          end
+          tp @struct, {'result.id' => {width: 40, display_name: 'ID'}}, {'result.name' => {display_name: 'Zone Name'}}
+
+        end
+      end
+    end
+  end
+end

data/lib/cloudflare_cli/send_nested.rb

@@ -0,0 +1,92 @@
+class String
+  alias_method :starts_with?, :start_with?
+  alias_method :ends_with?, :end_with?
+end
+class Object
+  # Retrieve the value of a deeply nested attribute
+  #
+  # Example usage
+  #
+  #   attribute = "data.foo['bar'].id"
+  #   value = obj.send_nested(attribute)
+  #
+  # Under the hood this will do something akin to
+  #   obj.send(data).send(foo)['bar'].send(id)
+  #
+  # This also works with symbols in the attribute string
+  #
+  #   attribute = "data.foo[:bar].id"
+  #   value = obj.send_nested(attribute)
+  #
+  # Under the hood this will do something akin to
+  #   obj.send(data).send(foo)['bar'].send(id)
+  #
+  #
+  # Parameters
+  #   attribute:  The (nested) attribute to query for
+  #   with_indifferent_access: If this is true, then this will convert any
+  #                            hashes to HashWithIndifferentAccess. As such,
+  #                            anything that was a symbol before will become a
+  #                            string.
+  # Returns whatever the attribute evaluates to with the major caveat is that
+  # if `with_indifferent_access` is used, any resulting hashes will have string
+  # keys even if they were symbols to begin with as this is how the ruby method
+  # hash.with_indifferent_access works
+  def send_nested(attribute, with_indifferent_access: false)
+    # Split in to the attribute and the deeper nested things
+    # E.g. this will split "data.foo['bar'].id" in to
+    #   data
+    #   .foo['bar'].id
+
+      matches = /([^\.\[\]]+)(.*)/.match(attribute)
+      attr = matches.captures[0]
+      obj = send(attr)
+      until matches.captures[1].empty?
+        next_part = matches.captures[1]
+        kind = next_part.slice!(0)
+
+      # This means to use a nested send
+      if kind == '.'
+        matches = /([^\.\[\]]+)(.*)/.match(next_part)
+        attr = matches.captures[0]
+        obj = obj.send(attr)
+
+      # This means we want to access something by a key or index
+      elsif kind == '['
+        matches = /(['|"|:]*[^\]]+['|"]*)\](.*)/.match(next_part)
+        attr = matches.captures[0]
+
+        # Figure out if the attribute is a string, symbol, or an integer index
+        # and do the right thing to convert it to the attribute we care about
+        if attr.starts_with?(':')
+          attr.slice!(0)
+          attr = attr.to_sym
+        elsif attr.starts_with?("'")
+          unless attr.ends_with?("'")
+            raise ArgumentError, "Hash key starts with a ' but does not end with one: #{attr}"
+          end
+          attr.slice!(0)
+          attr.chop!
+        elsif attr.starts_with?('"')
+          unless attr.ends_with?('"')
+            raise ArgumentError, "Hash key starts with a \" but does not end with one: #{attr}"
+          end
+          attr.slice!(0)
+          attr.chop!
+        elsif attr.to_i.to_s == attr
+          attr = attr.to_i
+        end
+
+        if with_indifferent_access && obj.is_a?(Hash)
+          obj = obj.with_indifferent_access
+        end
+
+        obj = obj[attr]
+
+      else
+        raise ArgumentError, "Could not parse attribute #{attribute}"
+      end
+    end
+    obj
+  end
+end

data/lib/cloudflare_cli/tree/ips.rb

@@ -1,14 +1,15 @@
 require "rubyflare"
 
 module CloudflareCli
-  module Endpoints
+  module Nodes
     class IPs
       def self.list
 
         ctx = CloudflareCli::State.ctx
         ctx.get('ips')
       rescue Rubyflare::ConnectionError => e
-        #  puts e.response.body
+        puts e.response.body
+
       end
     end
   end

data/lib/cloudflare_cli/tree/zones.rb

@@ -1,19 +1,17 @@
 require "rubyflare"
 
 module CloudflareCli
-  module Endpoints
-    class Zones
-
+  module Nodes
+    module Zone
+      class Zones
       # Return Cloudflare Account Zones
-      def self.all(options)
-        puts options
-        #begin
-        #  ctx = CloudflareCli::State.ctx
-        #  ctx.get('zones')
-        #rescue Rubyflare::ConnectionError => e
-        #  puts e.response.body
-        #end
+        def self.all(options)
+          ctx = CloudflareCli::State.ctx
+          ctx.get('zones', options)
+        rescue Rubyflare::ConnectionError => e
+          puts e.response.body
+        end
       end
     end
   end
-end
+end

data/lib/cloudflare_cli/version.rb

@@ -1,3 +1,3 @@
 module CloudflareCli
-  VERSION = '0.0.3-alpha.3'
+  VERSION = '0.0.3-alpha.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre.alpha.3
+  version: 0.0.3.pre.alpha.4
 platform: ruby
 authors:
 - Ken Spencer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,48 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: me+cloudflare_cli@iotaspencer.me
 executables:
@@ -89,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ChangeLog.md
 - README.md
+- bin/cfcli
 - bin/cloudflare_cli
 - cloudflare_cli.rdoc
 - lib/cloudflare_cli.rb
@@ -96,6 +139,9 @@ files:
 - lib/cloudflare_cli/commands/001_dns_records.rb
 - lib/cloudflare_cli/commands/002_cloudflare_ips.rb
 - lib/cloudflare_cli/commands/003_zones.rb
+- lib/cloudflare_cli/methods/output_class.rb
+- lib/cloudflare_cli/methods/term_table.rb
+- lib/cloudflare_cli/send_nested.rb
 - lib/cloudflare_cli/tree.rb
 - lib/cloudflare_cli/tree/ips.rb
 - lib/cloudflare_cli/tree/zones.rb