czds 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf44d91cbccade4f1900cf55a79ba5e7e9f9a498655e411ca9546f692accee0
-  data.tar.gz: efa43634a5ac9b6e3e9dcbea6fa7c528067174d5d023aa58ccc798bdb5466357
+  metadata.gz: bad75046d0a8d1900d29e4a949a7527749419b657ccec1f112db7f0b915c0086
+  data.tar.gz: 85cf821a7467c8c6645600d41d3691f793faad3c592a5c47d40b398527802c3d
 SHA512:
-  metadata.gz: 9917ed5ab613c56750d4452610ccc6e5fa459451332be3bbdb97dce36cf8745ef096daa2ca31781241182800fd422707fbe0afa730aeaf48750fca88795ea9bf
-  data.tar.gz: e2d853df2a94402f45b5b2cab693975cc0d0b7bb8299ca2fa96953cd09a45b597f7102507bf156f63a43097e25f2de124e79cd4785079b05791eff2ef10a211a
+  metadata.gz: 3a589c30e9ad8e7597433a3579839db51ac2cac0949d4baeeb1a51ae0258bbd5a67d3f239a7bb982e46aff3f6aeff34c2bdc93352de35874fdb105e8faeb01dc
+  data.tar.gz: e259a4e46235c252eb71527cd793b1d57df6e8458a17082de5256aa5da31cd892ca7d68d229fc543ca07586860ec9f81132a6f50bfc5abf6ef2ed66c9a73eff0

data/README.md

@@ -0,0 +1,35 @@
+# Czds
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/czds`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/czds.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/czds/cli/main.rb

@@ -0,0 +1,63 @@
+require 'thor'
+require 'json'
+
+module CZDS
+  module CLI
+    class Main < Thor
+      attr_reader :tld
+
+      desc "download", "Download zone file"
+      option :config_file, type: :string, default: './czds.config.json', desc: 'Path to config file'
+      option :tld, type: :string, desc: 'Top-level domain, default: com'
+      option :download_dir, type: :string, desc: 'Directory to download zone file, default: ./'
+      option :no_timestamp, type: :boolean, desc: 'Disable timestamp in file name'
+      option :username, type: :string, desc: 'CZDS username'
+      option :password, type: :string, desc: 'CZDS password'
+
+      def download
+        config_file = load_config(options[:config_file])
+        configure_client(options, config_file)
+
+        tld = options[:tld] || config_file['tld'] || CZDS::Configuration::DEFAULTS[:tld]
+
+        zone_file = CZDS::ZoneFile.new(tld)
+        zone_file.download
+      end
+
+      desc "status", "Show zone file status"
+      option :config_file, type: :string, default: './czds.config.json', desc: 'Path to config file'
+      option :tld, type: :string, desc: 'Top-level domain, default: com'
+      option :no_timestamp, type: :boolean, desc: 'Disable timestamp in file name'
+      option :username, type: :string, desc: 'CZDS username'
+      option :password, type: :string, desc: 'CZDS password'
+
+      def status
+        config_file = load_config(options[:config_file])
+        configure_client(options, config_file)
+
+        tld = options[:tld] || config_file['tld'] || CZDS::Configuration::DEFAULTS[:tld]
+
+        zone_file = CZDS::ZoneFile.new(tld)
+        puts zone_file.status.to_h
+      end
+
+      private
+
+      def configure_client(options, config_file)
+        CZDS::Client.configure do |config|
+          config.username = options[:username] || config_file['username']
+          config.password = options[:password] || config_file['password']
+          config.download_dir = options[:download_dir] || config_file['download_dir'] || CZDS::Configuration::DEFAULTS[:download_dir]
+          config.timestamp_file_name = ![options[:no_timestamp], config_file['no_timestamp']].compact[0]
+        end
+      end
+
+      def load_config(config_file)
+        return {} unless File.exist?(config_file)
+
+        JSON.parse(File.read(config_file))
+      end
+    end
+  end
+end
+

data/lib/czds/client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'forwardable'
+require_relative './configuration'
+require_relative './zone_file/status'
+
+module CZDS
+  class Client
+    extend Forwardable
+
+    @config = Configuration.new
+
+    class << self
+      attr_accessor :config
+
+      def configure
+        yield(config) if block_given?
+      end
+    end
+
+    attr_reader :zone_file_statuses
+
+    def_delegators :@config, :username, :password, :download_dir, :timestamp_file_name, :user_agent
+
+    def initialize
+      @zone_file_statuses = {}
+      @config = self.class.config
+
+      raise NoCredentialsError if @config.username.nil? || @config.password.nil?
+    end
+
+    def connection(url)
+      Faraday.new(
+        url:,
+        headers: {
+          'Authorization' => "Bearer #{access_token}",
+          'User-Agent' => user_agent,
+        })
+    end
+
+    def zone_file_status(tld)
+      return zone_file_statuses[tld] unless zone_file_statuses[tld].nil?
+
+      conn = connection(download_link(tld))
+
+      response = conn.head
+
+      headers = response.headers.slice('content-disposition', 'content-length', 'last-modified')
+      headers['content-length'] = headers['content-length'].to_i
+      headers['last-modified'] = DateTime.parse(headers['last-modified']).strftime('%Y-%m-%dT%H:%M:%S')
+      headers['content-disposition'] = headers['content-disposition'].match(/filename=(.*)$/)[1]
+
+      @zone_file_statuses[tld] = CZDS::ZoneFile::Status.new(*headers.values)
+    end
+
+    def download_links
+      return @download_links unless @download_links.nil?
+
+      conn = connection('https://czds-api.icann.org')
+
+      response = conn.get("/czds/downloads/links")
+
+      download_links = JSON.parse(response.body)
+    end
+
+    def download_link(tld)
+      download_links.find { |link| link =~ /#{tld}\.zone$/ }
+    end
+
+    def download_zone_file(tld)
+      status = zone_file_status(tld)
+
+      file_name = timestamp_file_name ? "#{status.timestamp}_#{status.file_name}" : status.file_name
+      file_path = File.join(download_dir, file_name)
+
+      raise FileAlreadyDownloadedError if File.exist?(file_path) && File.size(file_path) == status.length
+
+      conn = connection(download_link(tld)) 
+
+      File.open(file_path, 'wb') do |file|
+        response = conn.get do |req|
+          req.options.on_data = Proc.new { |chunk| file.write(chunk) }
+        end
+      end
+
+      raise FileSizeError if File.size(file_path) != status.length
+
+      status.to_h.merge(file_path:)
+    end
+
+    private
+
+    def access_token
+      return @access_token unless @access_token.nil?
+
+      conn = Faraday.new(
+        url: 'https://account-api.icann.org',
+        headers: {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+          'User-Agent' => user_agent,
+        }
+      )
+
+      response = conn.post("/api/authenticate") do |req|
+        req.body = { username:, password: }.to_json
+      end
+
+      @access_token = JSON.parse(response.body)['accessToken'] if response.status == 200
+    end
+  end
+end

data/lib/czds/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CZDS
+  class Configuration
+    DEFAULTS = {
+      user_agent: "czds/#{CZDS::VERSION} (Ruby Client)",
+      tld: "com",
+      download_dir: "./"
+    }
+
+    attr_accessor :username, :password, :download_dir, :timestamp_file_name, :user_agent
+
+    def initialize
+      @download_dir = DEFAULTS[:download_dir]
+      @timestamp_file_name = true
+      @user_agent = DEFAULTS[:user_agent]
+    end
+  end
+end

data/lib/czds/version.rb

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

data/lib/czds/zone_file/status.rb

@@ -0,0 +1,18 @@
+module CZDS
+  class ZoneFile
+    Status = Data.define(:file_name, :length, :updated_at) do
+      def timestamp
+        updated_at.gsub(':', '-')  
+      end
+
+      def to_h
+        {
+          file_name:,
+          length:,
+          updated_at:,
+          timestamp:,
+        }
+      end
+    end
+  end
+end

data/lib/czds/zone_file.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative "./client"
+
+module CZDS
+  class ZoneFile
+    extend Forwardable
+
+    attr_reader :tld, :client
+
+    def_delegators :status, :file_name, :length, :updated_at, :timestamp
+
+    def initialize(tld = "com")
+      @tld = tld
+      @client = Client.new 
+    end
+
+    def download
+      client.download_zone_file(tld)
+    end
+
+    def status
+      @status ||= client.zone_file_status(tld)
+    end
+  end
+end

data/lib/czds.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./czds/version"
+require_relative "./czds/client"
+require_relative "./czds/zone_file"
+require_relative "./czds/cli/main"
+
+module CZDS
+  class FileSizeError < StandardError; end
+  class FileAlreadyDownloadedError < StandardError; end
+  class NoCredentialsError < StandardError; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Marcin Doliwa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,7 +46,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/czds
+- lib/czds.rb
+- lib/czds/cli/main.rb
+- lib/czds/client.rb
+- lib/czds/configuration.rb
+- lib/czds/version.rb
+- lib/czds/zone_file.rb
+- lib/czds/zone_file/status.rb
 homepage: https://github.com/mdoliwa/czds
 licenses:
 - MIT
@@ -66,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Ruby client for the ICANN Centralized Zone Data Service (CZDS) API.