dns_record_updater 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76c69d9369e9b0b64c2fef645d07f43f611dc540c06a1c73a4994d90a56ee0c2
+  data.tar.gz: 2614538f88b8b3feb1277caf8182d4a6996eea9933e155cd19d7a15d925735ee
+SHA512:
+  metadata.gz: 8adbd4a4ed69157ca49b4e13d7cce24087d1cf9b263ec7d461ae13d302c7a73e6d563d3bd6334d9f4a3e675cc12d1901b86931ac9e164ae521acd39fe60b9525
+  data.tar.gz: 6a48dd95076b36735c81d6e500567dbba3632c1d25ce7649958d7bb4d19638813fb81efb75b1a201f88fc4d7936486c8af79ff6698b0f590a523200580dda177

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Taeyang Lee
+
+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,46 @@
+# DnsRecordUpdater
+
+Library for updating DNS record on Cloudflare with support for notifications.
+
+## Installation
+
+```
+gem install dns_record_updater
+```
+
+## Usage
+
+Here's a simple example of how to use the `DNSRecordUpdater` gem:
+
+```ruby
+notification_service = DNSRecordUpdater::NotificationService.new([
+  slackuri=''          # URI for Slack WebHook "https://hooks.slack.com/services/xxxxx"
+  discorduri=''        # URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"
+])
+cloudflare_provider = DNSRecordUpdater::CloudflareProvider.new({
+  auth_email: '',      # The email used to login 'https://dash.cloudflare.com'
+  auth_method: '',     # Set to "global" for Global API Key or "token" for Scoped API Token
+  auth_key: '',        # Your API Token or Global API Key
+  zone_identifier: '', # Can be found in the "Overview" tab of your domain
+  record_name: ''      # record you want to be synced
+}, notification_service)
+dns_updater = DNSRecordUpdater::DNSUpdater.new(cloudflare_provider)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dns_record_updater. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dns_record_updater/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DnsRecordUpdater project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dns_record_updater/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/dns_record_updater/cloudflare_provider.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DNSRecordUpdater
+  class CloudflareProvider < DNSProvider
+    def initialize(config)
+      @auth_email = config[:auth_email]
+      @auth_method = config[:auth_method]
+      @auth_key = config[:auth_key]
+      @zone_identifier = config[:zone_identifier]
+      @record_name = config[:record_name]
+      @ttl = config[:ttl] || 3600
+      @proxy = config[:proxy] || false
+    end
+
+    def fetch_dns_record
+      auth_header = @auth_method == "global" ? "X-Auth-Key" : "Authorization: Bearer"
+      uri = URI("https://api.cloudflare.com/client/v4/zones/#{@zone_identifier}/dns_records?type=A&name=#{@record_name}")
+      request = Net::HTTP::Get.new(uri)
+      request["X-Auth-Email"] = @auth_email
+      request[auth_header] = @auth_key
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+      result = JSON.parse(response.body)
+
+      if result["success"]
+        record = result["result"].first
+        { record_id: record["id"], current_ip: record["content"] }
+      else
+        raise "Failed to fetch DNS record: #{result['errors']}"
+      end
+    end
+
+    def update_dns_record(ip, record_id)
+      auth_header = @auth_method == "global" ? "X-Auth-Key" : "Authorization: Bearer"
+      uri = URI("https://api.cloudflare.com/client/v4/zones/#{@zone_identifier}/dns_records/#{record_id}")
+      request = Net::HTTP::Patch.new(uri)
+      request["X-Auth-Email"] = @auth_email
+      request[auth_header] = @auth_key
+      request["Content-Type"] = "application/json"
+      request.body = { type: "A", name: @record_name, content: ip, ttl: @ttl, proxied: @proxy }.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+      result = JSON.parse(response.body)
+
+      if result["success"]
+        puts "Updated DNS record: #{@record_name} -> #{ip}"
+        true
+      else
+        puts "Failed to update DNS record: #{result['errors']}"
+        false
+      end
+    end
+  end
+end

data/lib/dns_record_updater/dns_provider.rb

@@ -0,0 +1,13 @@
+module DNSRecordUpdater
+  class DNSProvider
+    attr_reader :record_name
+
+    def fetch_dns_record
+      raise NotImplementedError, "Must be implemented by a provider"
+    end
+
+    def update_dns_record(ip, record_id)
+      raise NotImplementedError, "Must be implemented by a provider"
+    end
+  end
+end

data/lib/dns_record_updater/dns_updater.rb

@@ -0,0 +1,52 @@
+require 'net/http'
+
+module DNSRecordUpdater
+  class DNSUpdater
+    def initialize(provider, notification_service: nil)
+      @provider = provider
+      @notification_service = notification_service
+    end
+
+    def update(send_notification: false)
+      ip = fetch_public_ip
+      puts "Detected public IP: #{ip}"
+
+      dns_record = @provider.fetch_dns_record
+      record_id = dns_record[:record_id]
+      current_ip = dns_record[:current_ip]
+
+      if ip == current_ip
+        puts "IP has not changed: #{ip}"
+        return true
+      end
+
+      success = @provider.update_dns_record(ip, record_id)
+      if send_notification && success
+        @notification_service&.notify("DNS record updated: #{@provider.record_name} -> #{ip}")
+      end
+      success
+    rescue StandardError => e
+      puts "Error during update: #{e.message}"
+      false
+    end
+
+    private
+
+    def fetch_public_ip
+      ipv4_regex = /\A((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\z/
+      sources = [
+        "https://cloudflare.com/cdn-cgi/trace",
+        "https://api.ipify.org",
+        "https://ipv4.icanhazip.com"
+      ]
+
+      sources.each do |url|
+        response = Net::HTTP.get(URI(url))
+        ip = response[/\d+\.\d+\.\d+\.\d+/]
+        return ip if ip&.match?(ipv4_regex)
+      end
+
+      raise "Unable to fetch a valid public IP address."
+    end
+  end
+end

data/lib/dns_record_updater/notification_service.rb

@@ -0,0 +1,16 @@
+require 'net/http'
+
+module DNSRecordUpdater
+  class NotificationService
+    def initialize(endpoints)
+      @endpoints = endpoints
+    end
+
+    def notify(message)
+      @endpoints.each do |uri|
+        payload = { content: message }.to_json
+        Net::HTTP.post(URI(uri), payload, { "Content-Type" => "application/json" })
+      end
+    end
+  end
+end

data/lib/dns_record_updater/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DNSRecordUpdater
+  VERSION = "0.1.1"
+end

data/lib/dns_record_updater.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "dns_record_updater/version"
+require_relative "dns_record_updater/dns_updater"
+require_relative "dns_record_updater/dns_provider"
+require_relative "dns_record_updater/cloudflare_provider"
+require_relative "dns_record_updater/notification_service"
+
+module DNSRecordUpdater
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/dns_record_updater.rbs

@@ -0,0 +1,4 @@
+module DnsRecordUpdater
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: dns_record_updater
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Taeyang Lee
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A composable gem to update DNS records with support for Cloudflare and
+  notifications.
+email:
+- taeyang91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dns_record_updater.rb
+- lib/dns_record_updater/cloudflare_provider.rb
+- lib/dns_record_updater/dns_provider.rb
+- lib/dns_record_updater/dns_updater.rb
+- lib/dns_record_updater/notification_service.rb
+- lib/dns_record_updater/version.rb
+- sig/dns_record_updater.rbs
+homepage: https://github.com/taeyang91/dns_record_updater
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/taeyang91/dns_record_updater
+  source_code_uri: https://github.com/taeyang91/dns_record_updater
+  changelog_uri: https://github.com/taeyang91/dns_record_updater/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A gem for updating DNS records on multiple platforms.
+test_files: []