njalla-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f72df8521c71ea623de74330884149c0e4e50062ce3975f383df93596c3fc6a
+  data.tar.gz: 31fd7fe09ff10b162483a376d5c70749e500530e525c8ad993f8f64dd2609fba
+SHA512:
+  metadata.gz: 45268437c7dad3eeef8eecc08b3faaad7919cbfced142a514aa87e6345f55143cfce1f299d63f591fab8518117ac9b5b9bcf89b738079bf11df231fbc7ee280a
+  data.tar.gz: 9e84b3bdbf8a41b8e5767f77e62bbe983e8e5d5e80e0d730b27e12c39c6ec978befa0ff0d9d5a968866d8db053bb93345d7c51961e46373677aa525ab5af3cbd

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,3 @@
+# Njalla
+
+An API client for [Njalla](https://njal.la/)

data/lib/njalla/v1/client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Njalla
+  module V1
+    # Implements HTTP client
+    class Client
+      include HTTParty
+
+      base_uri 'https://njal.la/api/1'
+
+      # @param token [String]
+      def initialize(token:)
+        @token = token
+      end
+
+      # @param method [String]
+      # @param params [Dry::Schema::Result]
+      def get(method, params = nil)
+        raise params.errors.inspect unless params&.success?
+
+        self.class.get('/', headers: headers, body: {
+          jsonrpc: '2.0',
+          method: method,
+          params: params&.to_h
+        }.to_json)
+      end
+
+      # @param method [String]
+      # @param params [Dry::Schema::Result]
+      def post(method, params)
+        raise params.errors.inspect unless params.success?
+
+        self.class.post('/', headers: headers, body: {
+          jsonrpc: '2.0',
+          method: method,
+          params: params.to_h
+        }.to_json)
+      end
+
+      private
+
+      # @return [Hash]
+      def headers
+        @headers ||= {
+          Accept: 'application/json',
+          'Content-Type': 'application/json',
+          Authorization: "Njalla #{@token}"
+        }
+      end
+    end
+  end
+end

data/lib/njalla/v1/domain.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'schemas/add_record'
+require_relative 'schemas/record'
+
+module Njalla
+  module V1
+    # Implement domain method APIv1
+    class Domain
+      # @return [Njalla::V1::Client]
+      attr_reader :client
+      # @return [String]
+      attr_reader :domain
+
+      # @param client [Njalla::V1::Client]
+      # @param domain [String]
+      def initialize(client:, domain:)
+        @client = client
+        @domain = domain
+      end
+
+      # Adds a record
+      #
+      # @param content [String]
+      # @param name [String]
+      # @param type [String]
+      # @param ttl [Integer]
+      # @return [Njalla::V1::Schemas::Record]
+      def add_record(content:, name: '@', ttl: 60, type: 'A')
+        record = Schemas::AddRecord.new.call(domain: domain, content: content, name: name, type: type, ttl: ttl)
+
+        Schemas::Record.new.call(**client.post('add-record', record).dig('result'))
+      end
+    end
+  end
+end

data/lib/njalla/v1/schemas/add_record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+module Njalla
+  module V1
+    module Schemas
+      class AddRecord < Dry::Schema::JSON
+        define do
+          required(:domain).filled(:string)
+          required(:name).filled(:string)
+          required(:type).filled(:string)
+          required(:ttl).filled(:integer)
+          required(:content).filled(:string)
+        end
+      end
+    end
+  end
+end

data/lib/njalla/v1/schemas/json_rpc.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+module Njalla
+  module V1
+    module Schemas
+      class JsonRpc < Dry::Schema::JSON
+        define do
+          required(:jsonrpc).filled(:string)
+          required(:method).filled(:string)
+          optional(:params).filled(:hash)
+        end
+      end
+    end
+  end
+end

data/lib/njalla/v1/schemas/record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dry-schema'
+
+module Njalla
+  module V1
+    module Schemas
+      class Record < Dry::Schema::JSON
+        define do
+          required(:id).filled(:string)
+          required(:name).filled(:string)
+          required(:type).filled(:string)
+          required(:ttl).filled(:integer)
+          required(:content).filled(:string)
+        end
+      end
+    end
+  end
+end

data/lib/njalla/v1/schemas.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'schemas/add_record'
+require_relative 'schemas/record'

data/lib/njalla/v1.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'v1/client'
+require_relative 'v1/domain'
+require_relative 'v1/schemas'
+
+module Njalla
+  module V1
+  end
+end

data/lib/njalla.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'v1'
+
+module Njalla
+end

data/lib/njalla_api_client.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'njalla'

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: njalla-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- f
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec-tap-formatters
+  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: yard
+  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: rubocop
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+description: An API client for Njalla (https://njal.la/)
+email:
+- f@sutty.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/njalla.rb
+- lib/njalla/v1.rb
+- lib/njalla/v1/client.rb
+- lib/njalla/v1/domain.rb
+- lib/njalla/v1/schemas.rb
+- lib/njalla/v1/schemas/add_record.rb
+- lib/njalla/v1/schemas/json_rpc.rb
+- lib/njalla/v1/schemas/record.rb
+- lib/njalla_api_client.rb
+homepage: https://0xacab.org/sutty/njalla-api-client
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://0xacab.org/sutty/njalla-api-client/issues
+  homepage_uri: https://0xacab.org/sutty/njalla-api-client
+  source_code_uri: https://0xacab.org/sutty/njalla-api-client
+  changelog_uri: https://0xacab.org/sutty/njalla-api-client/-/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/njalla-api-client
+post_install_message:
+rdoc_options:
+- "--title"
+- njalla-api-client - Njalla API Client
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Njalla API Client
+test_files: []