cloudflare-dns-update 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa9b24e6ffc40d12356af99056e1a7a368cfad2e
-  data.tar.gz: 7716dec0c1bef1387630c5a41bf5767041d6b1d0
+  metadata.gz: 139312af49a524c2b48844c8a0fa74a388b18b52
+  data.tar.gz: 1a27eef227948c07d63b3d87e958c9fdb6a5aaa8
 SHA512:
-  metadata.gz: 61be27aa05bf43c502abbda0a6f3ad6938054faf2d4b6000a4b782a08115b89cf369dbb279211215c9d5b9f5e6258b4449c8b91970b506689c4b975de4964460
-  data.tar.gz: e90d6e996215498532f3d9ffb6f1bd246c27dde0de4e49421a7e7d2b8b501c564bed86cb27347ca34506de49cf20c00d456ed40aecf31f07b53d28c7d4cee7f3
+  metadata.gz: 9c9b4fccfb946c75d3b48c9671fe05b303c52db40a93b8b36f010be8a5c7fe29ddbd69682f9a6e3e6782ec10d3afa4b8463d97ca2273b9b2df07a2bdbcd8f1ce
+  data.tar.gz: 24048eaa654109883df94a27ee150829ed8cc1bc1113dde904f19dc2f7d2e8ba019cae2de37b927b7ba2a1fc2fc3db339ad2a6bc07f7954c8fa63c9c0385650e

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+.rspec_status
+spec/**/test.yaml

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--backtrace
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+sudo: false
+dist: trusty
+cache: bundler
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- 2.3
+- 2.4
+- jruby-head
+- ruby-head
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  - rvm: jruby-head
+env:
+  global:
+    secure: LU7mGKnIrWrnrdtq7Ug7HTxzqJoB+NbLHwT8dPmGf4GIfNosO4Jx+G4JLzUd/sCHzUR+XXrsMd7El8WkTVV28+nt6Cv2JvO4EJRIplnAL8Yauc0YSWRwA9nGYhcc2TJc5czbL0mZkJSOv4B+aWco0VWerJfgLYurIA05XrQFGGY=

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in cloudflare-dns-update.gemspec
+# Specify your gem's dependencies in utopia.gemspec
 gemspec
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -1,6 +1,8 @@
-# CloudFlare::DNS::Update
+# Cloudflare::DNS::Update
 
-This gem provides a simple executable tool for managing CloudFlare records to provide dynamic DNS like functionality. You need to add it to whatever `cron` system your host system uses.
+This gem provides a simple executable tool for managing Cloudflare records to provide dynamic DNS like functionality. You need to add it to whatever `cron` system your host system uses.
+
+[![Build Status](https://secure.travis-ci.org/ioquatix/cloudflare-dns-update.svg)](http://travis-ci.org/ioquatix/cloudflare-dns-update)
 
 ## Installation
 
@@ -18,18 +20,25 @@ Simply set up configurations for each domain you wish to update, and add to `/et
 
 	#!/usr/bin/env sh
 
-	cloudflare-dns-update --configuration /srv/dyndns/hinoki.oriontransfer.co.nz.yml
+	cloudflare-dns-update --configuration /srv/dyndns/example.A.yml
+	cloudflare-dns-update --configuration /srv/dyndns/example.AAAA.yml
 
-Note that in case you want to update more than one domains in a zone with the same IP address, you can have multiple domains in a configuration file. Follow instructions of the configuration process.
+Note that in case you want to update more than one domains in a zone with the same IP address, you can have multiple domains in a configuration file. Follow instructions of the configuration process. Just to note, each domain would be updated with the same content. Having both IPv4 and IPv6 records in the same configuration file is not possible nor recommended. Please create separate configuration files.
 
 The configuration file would end up looking something like this:
 
 	---
-	:key: b10a8db164e0754105b7a99be72e3fe5
-	:email: samuel@oriontransfer.org
-	:zone: oriontransfer.co.nz
+	:key: b10_NOT_A_REAL_KEY_fe5
+	:email: cloudflare-account@example.com
+	:zone: example.com
 	:content_command: curl ipinfo.io/ip
 
+### IPv6 Support
+
+It is possible to update IPv6 when you have a dynamically allocated prefix. To get your current IPv6 address, the following command can be used:
+
+	/sbin/ip -6 addr | awk -F '[ \t]+|/' '$3 == "::1" { next;} $3 ~ /^fe80::/ { next ; } /inet6/ {print $3}'
+
 ## Contributing
 
 1. Fork it
@@ -38,11 +47,15 @@ The configuration file would end up looking something like this:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## See Also
+
+- [cloudflare](https://github.com/ioquatix/cloudflare) – Provides access to Cloudflare.
+
 ## License
 
 Released under the MIT license.
 
-Copyright, 2013, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test
+
+task :coverage do
+	ENV['COVERAGE'] = 'y'
+end

data/bin/cloudflare-dns-update

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright, 2013, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,114 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'trollop'
-require 'yaml/store'
+require 'cloudflare/dns/update/command'
 
-require 'cloudflare'
-
-def check_result(result, success_message = 'Finished.')
-	if result['result'] == 'success'
-	    puts success_message
-		yield
-	else
-		puts result['msg'] # error message
-		exit(1)
-	end
-end
-
-def get_input(message)
-	$stdout.write(message + ' ')
-	gets.chomp
-end
-
-def run(*command)
-	puts "Running command #{command.join(' ')}"
-	
-	IO.popen(*command) do |io|
-		return io.read.chomp
-	end
-end
-
-opts = Trollop::options do
-	opt :configuration, "Path to the configuration database.", :default => "cloudflare-dns.yml"
-end
-
-configuration_store = YAML::Store.new(opts[:configuration])
-
-configuration_store.transaction do |configuration|
-	unless configuration[:key] && configuration[:email]
-		puts "This configuration file appears to be new, we require some details."
-		configuration[:key] = get_input "CloudFlare Key:"
-		configuration[:email] = get_input "CloudFlare Email:"
-	end
-end
-
-cloudflare = nil
-
-configuration_store.transaction do |configuration|
-	cloudflare = CloudFlare.connection(configuration[:key], configuration[:email])
-end
-
-configuration_store.transaction do |configuration|
-	unless configuration[:zone]
-		puts "What zone do you want to modify? e.g. 'oriontransfer.co.nz'"
-		configuration[:zone] = get_input "DNS Zone:"
-	end
-end
-
-configuration_store.transaction do |configuration|
-	unless configuration[:domains] || configuration[:domain]
-		puts "Getting list of domains for #{configuration[:zone]}..."
-		
-		result = cloudflare.rec_load_all(configuration[:zone])
-		
-		records = result['response']['recs']['objs']
-		
-		records.each.with_index do |record, index|
-			puts "(#{index}) #{record['name']} #{record['type']} #{record['content']}"
-		end
-		
-		input = get_input "Which record to update?\nYou can select more than one record by separating numbers with comma (e.g. 0,2,5):"
-		indexes = input.split(',').map(&:strip)
-		
-		configuration[:domains] = indexes.inject([]) do |a, index|
-			a << records[index.to_i]
-		end
-	end
-end
-
-configuration_store.transaction do |configuration|
-	unless configuration[:content_command]
-		puts "What command to get content for record? e.g. 'curl ipinfo.io/ip'"
-		configuration[:content_command] = get_input "Command to get latest IP address:"
-	end
-end
-
-configuration_store.transaction do |configuration|
-	content = run(configuration[:content_command])
-	domains = configuration[:domains] || [configuration[:domain]]
-	
-	domains.each do |domain|
-		if domain['content'] != content
-			puts "Content changed #{content.dump}, updating record..."
-			# zone, type, zoneid, name, content, ttl, service_mode = nil, prio = nil, service = nil, srvname = nil, protocol = nil, weight = nil, port = nil, target = nil
-			
-			arguments = [
-				configuration[:zone],
-				domain['type'],
-				domain['rec_id'],
-				domain['name'],
-				content,
-				domain['ttl']
-			]
-			
-			result = cloudflare.rec_edit(*arguments)
-			
-			puts "Updating domain content: #{content}"
-			domain['content'] = content
-			configuration[:domain] = domain
-		else
-			puts "Content hasn't changed."
-		end
-	end
-end
+Cloudflare::DNS::Update::Command::Top.parse(ARGV).invoke

data/cloudflare-dns-update.gemspec

@@ -5,15 +5,15 @@ require 'cloudflare/dns/update/version'
 
 Gem::Specification.new do |spec|
 	spec.name          = "cloudflare-dns-update"
-	spec.version       = CloudFlare::DNS::Update::VERSION
+	spec.version       = Cloudflare::DNS::Update::VERSION
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 	spec.description   = <<-EOF
-	Provides a client tool for updating CloudFlare records, with a specific
+	Provides a client tool for updating Cloudflare records, with a specific
 	emphasis on updating IP addresses for domain records. This provides
 	dyndns-like functionality.
 	EOF
-	spec.summary       = "A dyndns client for CloudFlare."
+	spec.summary       = "A dyndns client for Cloudflare."
 	spec.homepage      = ""
 	spec.license       = "MIT"
 
@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 
+	spec.add_dependency "samovar", "~> 1.3"
+	spec.add_dependency "tty-prompt", "~> 0.12.0"
+	spec.add_dependency "cloudflare", "~> 3.0"
+
+	spec.add_development_dependency "rspec", "~> 3.6"
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rake"
-	
-	spec.add_dependency "trollop", "~> 2.0.0"
-	spec.add_dependency "cloudflare", "~> 2.0.0"
 end

data/lib/cloudflare/dns/update.rb

@@ -20,7 +20,7 @@
 
 require "cloudflare/dns/update/version"
 
-module CloudFlare
+module Cloudflare
 	module DNS
 		module Update
 		end

data/lib/cloudflare/dns/update/command.rb

@@ -0,0 +1,168 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+#
+# 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.
+
+require 'samovar'
+require 'yaml/store'
+require 'tty/prompt'
+
+require 'open3'
+require 'json'
+
+require 'cloudflare'
+require_relative 'version'
+
+module Cloudflare::DNS::Update
+	module Command
+		# The top level utopia command.
+		class Top < Samovar::Command
+			self.description = "Update remote DNS records according to locally run commands."
+			
+			options do
+				option '-c/--configuration <path>', "Use the specified configuration file."
+				option '-h/--help', "Print out help information."
+				option '-v/--version', "Print out the application version."
+			end
+			
+			def prompt
+				@prompt ||= TTY::Prompt.new
+			end
+			
+			def configuration_store
+				@store ||= YAML::Store.new(@options[:configuration])
+			end
+			
+			attr_accessor :connection
+			
+			def connect!
+				configuration_store.transaction do |configuration|
+					unless configuration[:key]
+						prompt.puts "This configuration file appears to be new, we require some details."
+						configuration[:key] = prompt.mask("Cloudflare Key:")
+						configuration[:email] = prompt.ask("Cloudflare Email:")
+					end
+					
+					key = configuration[:key]
+					email = configuration[:email]
+					
+					@connection = Cloudflare.connect(key: key, email: email)
+				end
+			end
+			
+			def initialize_zone
+				configuration_store.transaction do |configuration|
+					unless configuration[:zone]
+						zone = prompt.select("What zone do you want to update?", @connection.zones.all)
+						
+						configuration[:zone] = zone.record
+					end
+				end
+			end
+			
+			def initialize_domains
+				configuration_store.transaction do |configuration|
+					domains = configuration[:domains]
+					
+					while domains.nil? || domains.empty?
+						prompt.puts "Getting list of domains for #{configuration[:zone]}..."
+						
+						zone_id = configuration[:zone][:id]
+						zone = @connection.zones.find_by_id(zone_id)
+						
+						dns_records = prompt.multi_select("What records do you want to update (select 1 or more)?", zone.dns_records.all)
+						
+						domains = configuration[:domains] = dns_records.map(&:record)
+					end
+				end
+			end
+			
+			def initialize_command
+				configuration_store.transaction do |configuration|
+					unless configuration[:content_command]
+						configuration[:content_command] = prompt.ask("What command to get content for record?", default: 'curl ipinfo.io/ip')
+					end
+				end
+			end
+			
+			def update_domains
+				configuration_store.transaction do |configuration|
+					prompt.puts "Executing content command: #{configuration[:content_command]}"
+					content, status = Open3.capture2(configuration[:content_command])
+					
+					unless status.success?
+						raise RuntimeError.new("Content command failed with non-zero output: #{status}")
+					end
+					
+					unless zone = @connection.zones.find_by_id(configuration[:zone][:id])
+						raise RuntimeError.new("Couldn't load zone #{configuration[:zone].inspect} from API!")
+					end
+					
+					domains = configuration[:domains]
+					
+					content.chomp!
+					
+					configuration[:domains].each do |record|
+						if record[:content] != content
+							puts "Content changed #{content.inspect}, updating record..."
+							
+							domain = zone.dns_records.find_by_id(record[:id])
+							
+							changes = {
+								type: domain.record[:type],
+								name: domain.record[:name],
+								content: content
+							}
+							
+							response = domain.put(changes.to_json, content_type: 'application/json')
+							
+							if response.successful?
+								puts "Updated domain content to #{content}."
+								record[:content] = content
+							else
+								puts "Failed to update domain content to #{content}: #{response.errors.join(', ')}!"
+							end
+						else
+							puts "Content hasn't changed."
+						end
+					end
+					
+					return content
+				end
+			end
+			
+			def invoke(program_name: File.basename($0))
+				if @options[:version]
+					puts VERSION
+				elsif @options[:help]
+					print_usage(program_name)
+				else
+					track_time do
+						connect!
+						
+						initialize_zone
+						initialize_domains
+						initialize_command
+						
+						update_domains
+					end
+				end
+			end
+		end
+	end
+end

data/lib/cloudflare/dns/update/version.rb

@@ -19,10 +19,10 @@
 # THE SOFTWARE.
 
 
-module CloudFlare
+module Cloudflare
 	module DNS
 		module Update
-			VERSION = "1.0.0"
+			VERSION = "2.0.0"
 		end
 	end
 end

data/spec/cloudflare/dns/update/command_spec.rb

@@ -0,0 +1,50 @@
+
+require 'cloudflare/dns/update/command'
+
+RSpec.describe Cloudflare::DNS::Update::Command::Top, order: :defined do
+	include_context Cloudflare::RSpec::Connection
+	
+	let(:configuration_path) {File.join(__dir__, 'test.yaml')}
+	
+	subject{described_class.new(["-c", configuration_path])}
+	
+	let(:zone) {connection.zones.all.first}
+	let(:name) {"dyndns"}
+	let(:qualified_name) {"dyndns.#{zone.record[:name]}"}
+	
+	it "should create dns record" do
+		response = zone.dns_records.post({
+			type: "A",
+			name: name,
+			content: "127.0.0.1",
+			ttl: 240,
+			proxied: false
+		}.to_json, content_type: 'application/json')
+		
+		expect(response).to be_successful
+	end
+	
+	let(:dns_record) {zone.dns_records.find_by_name(qualified_name)}
+	
+	it "should update dns record" do
+		subject.connection = connection
+		
+		puts 
+		
+		subject.configuration_store.transaction do |configuration|
+			configuration[:content_command] = 'curl ipinfo.io/ip'
+			configuration[:zone] = zone.record
+			configuration[:domains] = [dns_record.record]
+		end
+		
+		content = subject.update_domains
+		
+		response = dns_record.get
+		
+		expect(response.result[:content]).to be == content
+	end
+	
+	it "should delete dns record" do
+		expect(dns_record.delete).to be_successful
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "cloudflare/rspec/connection"
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = ".rspec_status"
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-dns-update
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: samovar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,48 +25,76 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.12.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: cloudflare
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: cloudflare
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: "\tProvides a client tool for updating CloudFlare records, with a specific\n\temphasis
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\tProvides a client tool for updating Cloudflare records, with a specific\n\temphasis
   on updating IP addresses for domain records. This provides\n\tdyndns-like functionality.\n"
 email:
 - samuel.williams@oriontransfer.co.nz
@@ -76,13 +104,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/cloudflare-dns-update
 - cloudflare-dns-update.gemspec
 - lib/cloudflare/dns/update.rb
+- lib/cloudflare/dns/update/command.rb
 - lib/cloudflare/dns/update/version.rb
+- spec/cloudflare/dns/update/command_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -103,8 +136,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: A dyndns client for CloudFlare.
-test_files: []
+summary: A dyndns client for Cloudflare.
+test_files:
+- spec/cloudflare/dns/update/command_spec.rb
+- spec/spec_helper.rb