cloudflare-ddns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 298c188002a7a30d02154717a008377c6aa054b92aaf61fdf10e3a75cbedaad9
+  data.tar.gz: 9ccaf594f529a37f24c33fce5324ff1b037e5ff2366370d9ba26b141667b57cd
+SHA512:
+  metadata.gz: 9cbe83c4d6ad54f72f8542f3b1f08773b4bdc9d79db91951b4ec02297e85f4c772fe72a29b7c4d4819ebea8ffc5d8e84fc8dbd147d4a53c47320b7093a36104a
+  data.tar.gz: c03299b2567ea0c2246aedee7000e0e9d17f276ac9327d6cf74de7ebe619759fc0e2a4ac8180e06f31f010922f0b4351acdda281fd88708a620410a91bbda6b4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rufo

@@ -0,0 +1 @@
+quote_style :single

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSaveMode": "file"
+}

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cloudflare-ddns.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    cloudflare-ddns (0.1.0)
+      docopt (~> 0.5)
+      httparty (~> 0.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    docopt (0.6.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudflare-ddns!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Daniel Perez
+
+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/README.md

@@ -0,0 +1,16 @@
+# Cloudflare::Ddns
+
+Simple script to update DDNS record on Cloudflare
+
+## Installation
+
+```
+gem install cloudflare-ddns
+```
+
+## Usage
+
+```
+export CLOUDFLARE_API_TOKEN=very-secret-token
+cloudflare-ddns --zone example.com --record foo.example.com
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloudflare/ddns"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloudflare-ddns.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/cloudflare/ddns/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cloudflare-ddns'
+  spec.version = Cloudflare::DDNS::VERSION
+  spec.authors = ['Daniel Perez']
+  spec.email = ['daniel@perez.sh']
+
+  spec.summary = %q{Set DNS record using Cloudflare API}
+  spec.homepage = 'https://github.com/danhper/cloudflare-ddns'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/danhper/cloudflare-ddns'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.17'
+  spec.add_runtime_dependency 'docopt', '~> 0.5'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/exe/cloudflare-ddns

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'cloudflare/ddns'
+require 'docopt'
+
+# Cloudflare::DDNS.hello
+PROGRAM_NAME = File.basename(__FILE__)
+
+doc = <<DOCOPT
+Updates Cloudflare DNS record with current IP
+
+Usage:
+  #{PROGRAM_NAME} --zone=<zone> --record=<record> [--api-token=<api-token>]
+
+Options:
+  --zone=<zone>           The name of the zone to update
+  --record=<record>       The name of the record to update
+  --api-token=<api-token> The API token (can also be passed using CLOUDFLARE_API_TOKEN env variable)
+DOCOPT
+
+begin
+  args = Docopt.docopt(doc)
+  api_token = args['--api-token'] || ENV['CLOUDFLARE_API_TOKEN']
+  raise Docopt::Exit, "CLOUDFLARE_API_TOKEN not found, see `#{PROGRAM_NAME} -h` for help" if api_token.nil?
+  record = args['--record']
+
+  result = Cloudflare::DDNS.update_record(api_token, args['--zone'], record)
+  puts "#{record} updated to #{result}" if result
+rescue Docopt::Exit => e
+  puts e.message
+  exit
+end

data/lib/cloudflare/api.rb

@@ -0,0 +1,68 @@
+require 'httparty'
+
+module Cloudflare
+  class BaseAPI
+    include HTTParty
+
+    class Error < StandardError; end
+
+    class Parser::Cloudflare < HTTParty::Parser
+      protected
+
+      def json
+        parsed = JSON.parse(body, :quirks_mode => true, :allow_nan => true)
+        raise Error, "call failed: #{body}" if !parsed['success']
+        parsed['result']
+      end
+    end
+
+    parser Parser::Cloudflare
+  end
+
+  class API < BaseAPI
+    base_uri 'api.cloudflare.com/client/v4'
+
+    def initialize(api_token)
+      @options = {
+        headers: {
+          'Authorization' => "Bearer #{api_token}",
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        },
+      }
+    end
+
+    def zone_api(name)
+      zone_id = zone_id(name)
+      Zone.new(@options, zone_id)
+    end
+
+    def zone_id(name)
+      zones = self.class.get('/zones', @options.merge(query: { name: name })).parsed_response
+      raise "#{name} not found" if zones.empty?
+      zones.first['id']
+    end
+
+    class Zone < BaseAPI
+      def initialize(options, zone_id)
+        @options = options
+        self.class.base_uri "https://api.cloudflare.com/client/v4/zones/#{zone_id}"
+      end
+
+      def records(query = {})
+        options = @options.merge(query: query)
+        self.class.get('/dns_records', options).parsed_response
+      end
+
+      def record(name)
+        records = records(name: name)
+        raise "#{name} not found" if records.empty?
+        records.first
+      end
+
+      def patch_record(id, updates)
+        self.class.patch("/dns_records/#{id}", @options.merge(body: updates.to_json))
+      end
+    end
+  end
+end

data/lib/cloudflare/ddns.rb

@@ -0,0 +1,26 @@
+require 'cloudflare/ddns/version'
+require 'httparty'
+require_relative './api'
+
+module Cloudflare
+  module DDNS
+    IP_RESOLVER = 'https://api.ipify.org'
+
+    class Error < StandardError; end
+
+    def self.update_record(api_token, zone_name, record_name)
+      api = API.new(api_token)
+      zone_api = api.zone_api(zone_name)
+      record = zone_api.record(record_name)
+      current_ip = fetch_ip
+      return if record['content'] == current_ip
+
+      zone_api.patch_record(record['id'], content: current_ip)
+      current_ip
+    end
+
+    def self.fetch_ip
+      HTTParty.get(IP_RESOLVER).body
+    end
+  end
+end

data/lib/cloudflare/ddns/version.rb

@@ -0,0 +1,5 @@
+module Cloudflare
+  module DDNS
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare-ddns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Perez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description:
+email:
+- daniel@perez.sh
+executables:
+- cloudflare-ddns
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rufo"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudflare-ddns.gemspec
+- exe/cloudflare-ddns
+- lib/cloudflare/api.rb
+- lib/cloudflare/ddns.rb
+- lib/cloudflare/ddns/version.rb
+homepage: https://github.com/danhper/cloudflare-ddns
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/danhper/cloudflare-ddns
+  source_code_uri: https://github.com/danhper/cloudflare-ddns
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Set DNS record using Cloudflare API
+test_files: []