cloudflare-dns-update 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfd1d7cdb372156dae4df530134cafabe534eff9
+  data.tar.gz: d1d015bc4534779c80a0b9d9e84277724091a11f
+SHA512:
+  metadata.gz: b26ee451d1feab4842b9a15da29ea79c72b35ec05160d8a1474a7fe780f1ecc9ebaacbb461b1eafd0250f4ab9d79c212623be43fa78c26ba3360d972258efb61
+  data.tar.gz: 4a89074cb8c9d70579a222f1efce524cc3cb5b5a10a1200e0e0f3e636ae741b297b3228dc266a631bc462f67ab1f547725c5f91bf3fc467b96af1a95ad4465b8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudflare-dns-update.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# 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.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install cloudflare-dns-update
+
+## Usage
+
+Run the included `cloudflare-dns-update` tool and you will be walked through the configuration process. You might want to specify a specific configuration file, using the `--configuration /path/to/configuration.yml` option.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2013, 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
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cloudflare-dns-update

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2013, 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 'trollop'
+require 'yaml/store'
+
+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.inspect}"
+	
+	IO.popen(*command) do |io|
+		return io.read.chomp
+	end
+end
+
+command = ARGV.shift
+
+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.new(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[:domain]
+		puts "Getting list of domains for #{configuration[:zone]}..."
+	
+		result = cloudflare.rec_load_all(configuration[:zone])
+		
+		check_result(result) do
+			records = result['response']['recs']['objs']
+			
+			
+			records.each.with_index do |record, index|
+				puts "(#{index}) #{record['name']} #{record['type']} #{record['content']}"
+			end
+			
+			index = get_input "Which record to update?"
+			
+			configuration[:domain] = 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])
+	domain = configuration[: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)
+		
+		check_result(result) do
+			puts "Updating domain content: #{content}"
+			domain['content'] = content
+			configuration[:domain] = domain
+		end
+	else
+		puts "Content hasn't changed."
+	end
+end

data/cloudflare-dns-update.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudflare/dns/update/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "cloudflare-dns-update"
+	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
+	emphasis on updating IP addresses for domain records. This provides
+	dyndns-like functionality.
+	EOF
+	spec.summary       = "A dyndns client for CloudFlare."
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+	
+	spec.add_dependency "trollop"
+	spec.add_dependency "cloudflare"
+end

data/cloudflare-dns.yml

@@ -0,0 +1,32 @@
+---
+:key: e949a982e76093acbcd21277fcd3915e25163
+:email: samuel@oriontransfer.org
+:zone: oriontransfer.co.nz
+:domain:
+  rec_id: '23414485'
+  rec_tag: 6978e0f1c24639abffb1d23a84ecb102
+  zone_name: oriontransfer.co.nz
+  name: hinoki.oriontransfer.co.nz
+  display_name: hinoki
+  type: A
+  prio: 
+  content: 111.69.246.106
+  display_content: 111.69.246.106
+  ttl: '7200'
+  ttl_ceil: 86400
+  ssl_id: 
+  ssl_status: 
+  ssl_expires_on: 
+  auto_ttl: 0
+  service_mode: '0'
+  props:
+    proxiable: 1
+    cloud_on: 0
+    cf_open: 1
+    ssl: 0
+    expired_ssl: 0
+    expiring_ssl: 0
+    pending_ssl: 0
+    vanity_lock: 0
+  :content: 111.69.238.117
+:content_command: curl ipinfo.io/ip

data/lib/cloudflare/dns/update.rb

@@ -0,0 +1,28 @@
+# Copyright, 2013, 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 "cloudflare/dns/update/version"
+
+module CloudFlare
+	module DNS
+		module Update
+		end
+	end
+end

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

@@ -0,0 +1,28 @@
+# Copyright, 2013, 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.
+
+
+module CloudFlare
+	module DNS
+		module Update
+			VERSION = "0.0.1"
+		end
+	end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare-dns-update
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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: cloudflare
+  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: "\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
+executables:
+- cloudflare-dns-update
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/cloudflare-dns-update
+- cloudflare-dns-update.gemspec
+- cloudflare-dns.yml
+- lib/cloudflare/dns/update.rb
+- lib/cloudflare/dns/update/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A dyndns client for CloudFlare.
+test_files: []