ovh_dnsup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1ac8b726a44dd4004ac71fc04ce7933329500d8b506647cb8c6d51758853b08
-  data.tar.gz: 4957373f5151ad11041ccc39e9308d1c699e0e04cc76fb92e36f25fce28ba086
+  metadata.gz: 06b3967e54f0a66f9e3b42c8e804208e15302401ee338e7d253d484bb58f0a9c
+  data.tar.gz: 4242c9feb329b3511d27bbe25bfd026ba0ef6269246d01d9a5990b79147f69a4
 SHA512:
-  metadata.gz: 0a70d7dcbb1aed2ae47e6300e525851a5d30402e8d0bbef24ef6dbecf7c03296bb8c232e1dd8e30db45df044be1d1367a85da1eb80f448ea8ea64df7cccfc8d2
-  data.tar.gz: 00b6ec721be8a9e0319e605fb8d6be7c10fa778231cc36705eef6f636d55279b943ae660e52386f1ad7b511ad6c324c400b581b8c221735bc31965860ab9baf0
+  metadata.gz: c6ff5d8c42407bd84d36d2e779d8410beec9153c6fbee6fa175efdf7e72c680ad8e3831c00c75c718d1cf49aeef7ff6a48843bb8a0532baaf45d1293dd135a48
+  data.tar.gz: e46c823e842d3b1e525f47def025f42668abda6f908fe1284d408329d1b83d9acdf07b94dfc622d9845bca9595d5db8d392aaa12cd349938ea3102458f3035fc

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# OvhDnsup - Dynamic DNS for IPv6
+
+## 0.2.0
+
+- Added comments
+- Fixed detection of IPv6 local addresses
+

data/lib/ovh_dnsup/cli.rb

@@ -17,7 +17,10 @@ require 'socket'
 require_relative 'domain_manager'
 
 module OvhDnsup
+  # The command-line interface.
   module Cli
+
+    # Run the command-line interface.
     def self.run
 
       @conf_fn = File.join(Dir.home, '.ovh_dnsup.conf')
@@ -323,7 +326,10 @@ module OvhDnsup
       end
     end
 
-    # version: the IP version
+    # Get the IP address of an interface
+    #
+    # @param interface The interface name.
+    # @param version The IP version, either 4 or 6.
     def self.get_interface_address(interface:, version: nil)
       ipv4 = []
       ipv6 = []
@@ -339,7 +345,7 @@ module OvhDnsup
       end
 
       # filter local addresses
-      ipv6.select { |addr| !/^fe80/ =~ addr }
+      ipv6.select! { |addr| !(/^(fc|fd|fe8|fe9|fea|feb)/ =~ addr) }
 
       if !ipv6.empty? && (version == nil || version == 6)
         return ipv6[0]
@@ -350,6 +356,7 @@ module OvhDnsup
       end
     end
 
+    # Lists all local interfaces and their IP addresses.
     def self.interfaces
       parser = OptionParser.new do |opts|
         opts.banner = 'Usage: ovh_dnsup interfaces'

data/lib/ovh_dnsup/domain_manager.rb

@@ -16,6 +16,7 @@ require_relative 'ovh_api'
 
 module OvhDnsup
 
+  # Allows managing a DNS zone.
   class DomainManager
     def initialize(args)
       @api = OvhApi.new(args)
@@ -145,6 +146,7 @@ module OvhDnsup
     end
   end
 
+  # Once authorized, can be used to change a DNS zone entry.
   class DomainUpdater
     def initialize(endpoint: nil, application_key: nil, application_secret: nil, state: nil)
       if state

data/lib/ovh_dnsup/ovh_api.rb

@@ -29,6 +29,8 @@ module OvhDnsup
     'soyoustart-ca' => 'https://ca.api.soyoustart.com/',
   }
 
+  # Access to the OVH rest API. This class manages authentication and
+  # signage of API requests.
   class OvhApi
     attr_reader :endpoint, :application_key, :application_secret, :consumer_key
 
@@ -40,6 +42,13 @@ module OvhDnsup
       ENDPOINTS[endpoint]
     end
 
+    # You have either to provide endpoint, application_key, and
+    # application_secret or provide a state.
+    #
+    # @param endpoint
+    # @param application_key
+    # @param application_secret
+    # @param state
     def initialize(endpoint: nil, application_key: nil, application_secret: nil, state: nil)
       if state
         self.state = state
@@ -55,6 +64,7 @@ module OvhDnsup
       end
     end
 
+    # The state which can be saved and later restored.
     def state
       { 'endpoint' => @endpoint,
         'application_key' => @application_key,

data/lib/ovh_dnsup/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module OvhDnsup
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ovh_dnsup.gemspec

@@ -11,6 +11,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/hrittich/ovh_dnsup"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/hrittich/ovh_dnsup/blob/main/CHANGELOG.md'
+  }
+
   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ovh_dnsup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hannah Rittich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,6 +39,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -54,7 +55,8 @@ files:
 homepage: https://github.com/hrittich/ovh_dnsup
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/hrittich/ovh_dnsup/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: