fog-dnsimple 2.0.0 → 3.0.0

data/lib/fog/dnsimple/requests/dns/get_record.rb

@@ -1,6 +1,6 @@
 module Fog
-  module DNS
-    class Dnsimple
+  module Dnsimple
+    class DNS
       class Real
         # Gets record from given domain.
         #
@@ -13,11 +13,7 @@ module Fog
         #   * body<~Hash>:
         #     * "data"<~Hash> The representation of the record.
         def get_record(zone_name, record_id)
-          request(
-            expects:  200,
-            method:   "GET",
-            path:     "/#{@dnsimple_account}/zones/#{zone_name}/records/#{record_id}"
-          )
+          request { |client| client.zones.zone_record(@dnsimple_account, zone_name, record_id) }
         end
       end
 
@@ -26,21 +22,22 @@ module Fog
           response = Excon::Response.new
 
           if self.data[:records].key?(zone_name)
-            response.status = 200
-            response.body = { "data" => self.data[:records][zone_name].find { |record| record["id"] == record_id }}
+            payload = self.data[:records][zone_name].find { |record| record["id"] == record_id }
 
-            if response.body.nil?
-              response.status = 404
-              response.body = {
-                "error" => "Couldn't find Record with id = #{record_id}"
-              }
+            if payload
+              response.status = 200
+              response.body = { "data" => payload }
+            else
+              # response.status = 404
+              # response.body = { "message" => "Record `#{record_id}` not found" }
+              raise Excon::Errors::NotFound, "Record `#{record_id}` not found"
             end
           else
-            response.status = 404
-            response.body = {
-              "error" => "Couldn't find Domain with name = #{zone_name}"
-            }
+            # response.status = 404
+            # response.body = { "message" => "Domain `#{zone_name}` not found" }
+            raise Excon::Errors::NotFound, "Domain `#{zone_name}` not found"
           end
+
           response
         end
       end

data/lib/fog/dnsimple/requests/dns/list_all_domains.rb

@@ -0,0 +1,38 @@
+module Fog
+  module Dnsimple
+    class DNS
+      class Real
+        # Get the list of ALL domains in the account.
+        #
+        # This method is similar to #list_domains, but instead of returning the results
+        # of a specific page it iterates all the pages and returns the entire collection.
+        #
+        # Please use this method carefully, as fetching the entire collection will increase
+        # the number of requests you send to the API server and you may eventually be rate-limited.
+        #
+        # @see https://developer.dnsimple.com/v2/domains/#list
+        # @see https://github.com/dnsimple/dnsimple-developer/tree/master/fixtures/v2/listDomains
+        #
+        # @param  query [Hash]
+        # @return [Excon::Response]
+        def list_all_domains(query: {})
+          paginate(query: query) do |current_query|
+            list_domains(query: current_query)
+          end
+        end
+      end
+
+      class Mock
+        def list_all_domains(_query: {})
+          response = Excon::Response.new
+          response.status = 200
+          response.body = {
+              "data" => self.data[:domains],
+              "pagination" => { "current_page" => nil, "per_page" => nil, "total_entries" => 60, "total_pages" => 2 }
+          }
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/dnsimple/requests/dns/list_all_records.rb

@@ -0,0 +1,39 @@
+module Fog
+  module Dnsimple
+    class DNS
+      class Real
+        # Get the list of ALL records for the specific zone.
+        #
+        # This method is similar to #list_domains, but instead of returning the results
+        # of a specific page it iterates all the pages and returns the entire collection.
+        #
+        # Please use this method carefully, as fetching the entire collection will increase
+        # the number of requests you send to the API server and you may eventually be rate-limited.
+        #
+        # @see https://developer.dnsimple.com/v2/zones/records/#list
+        # @see https://github.com/dnsimple/dnsimple-developer/tree/master/fixtures/v2/listZoneRecords
+        #
+        # @param  zone_name [String]
+        # @param  query [Hash]
+        # @return [Excon::Response]
+        def list_all_records(zone_name, query: {})
+          paginate(query: query) do |current_query|
+            list_records(zone_name, query: current_query)
+          end
+        end
+      end
+
+      class Mock
+        def list_all_records(zone_name, _query: {})
+          response = Excon::Response.new
+          response.status = 200
+          response.body = {
+              "data" => Array(self.data[:records][zone_name]),
+              "pagination" => { "current_page" => nil, "per_page" => nil, "total_entries" => 60, "total_pages" => 2 }
+          }
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/dnsimple/requests/dns/list_domains.rb

@@ -1,30 +1,30 @@
 module Fog
-  module DNS
-    class Dnsimple
+  module Dnsimple
+    class DNS
       class Real
-        # Get the list of domains in the account.
+        # Get the paginated list of domains in the account.
         #
-        # ==== Parameters
+        # @see https://developer.dnsimple.com/v2/domains/#list
+        # @see https://github.com/dnsimple/dnsimple-developer/tree/master/fixtures/v2/listDomains
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * "data"<~Array>:
-        #       * <~Hash> The representation of the domain.
-        def list_domains
-          request(
-            expects:  200,
-            method:   "GET",
-            path:     "/#{@dnsimple_account}/domains"
-          )
+        # @param  query [Hash]
+        # @return [Excon::Response]
+        def list_domains(query: {})
+          request { |client| client.domains.list_domains(@dnsimple_account, query: query) }
         end
       end
 
       class Mock
-        def list_domains
+        def list_domains(query: {})
+          page = query[:page] || 1
+          per_page = query[:per_page] || 30
+
           response = Excon::Response.new
           response.status = 200
-          response.body = { "data" => self.data[:domains] }
+          response.body = {
+              "data" => self.data[:domains],
+              "pagination" => { "current_page" => page, "per_page" => per_page, "total_entries" => 60, "total_pages" => 2 }
+          }
           response
         end
       end

data/lib/fog/dnsimple/requests/dns/list_records.rb

@@ -1,31 +1,31 @@
 module Fog
-  module DNS
-    class Dnsimple
+  module Dnsimple
+    class DNS
       class Real
-        # Get the list of records for the specific domain.
+        # Get the paginated list of records for the specific zone.
         #
-        # ==== Parameters
-        # * zone_name<~String> - zone name
+        # @see https://developer.dnsimple.com/v2/zones/records/#list
+        # @see https://github.com/dnsimple/dnsimple-developer/tree/master/fixtures/v2/listZoneRecords
         #
-        # ==== Returns
-        # * response<~Excon::Response>:
-        #   * body<~Hash>:
-        #     * "data"<~Array>:
-        #       * <~Hash> The representation of the record.
-        def list_records(zone_name)
-          request(
-            expects:  200,
-            method:   "GET",
-            path:     "/#{@dnsimple_account}/zones/#{zone_name}/records"
-          )
+        # @param  zone_name [String]
+        # @param  query [Hash]
+        # @return [Excon::Response]
+        def list_records(zone_name, query: {})
+          request { |client| client.zones.list_zone_records(@dnsimple_account, zone_name, query: query) }
         end
       end
 
       class Mock
-        def list_records(zone_name)
+        def list_records(zone_name, query: {})
+          page = query[:page] || 1
+          per_page = query[:per_page] || 30
+
           response = Excon::Response.new
           response.status = 200
-          response.body = { "data" => self.data[:records][zone_name] || [] }
+          response.body = {
+              "data" => Array(self.data[:records][zone_name]),
+              "pagination" => { "current_page" => page, "per_page" => per_page, "total_entries" => 60, "total_pages" => 2 }
+          }
           response
         end
       end

data/lib/fog/dnsimple/requests/dns/update_record.rb

@@ -1,6 +1,6 @@
 module Fog
-  module DNS
-    class Dnsimple
+  module Dnsimple
+    class DNS
       class Real
         # Update the given record for the given domain.
         #
@@ -18,14 +18,7 @@ module Fog
         #   * body<~Hash>:
         #     * "data"<~Hash> The representation of the record.
         def update_record(zone_name, record_id, options)
-          body = options
-
-          request(
-            body:     Fog::JSON.encode(body),
-            expects:  200,
-            method:   "PATCH",
-            path:     "/#{@dnsimple_account}/zones/#{zone_name}/records/#{record_id}"
-          )
+          request { |client| client.zones.update_zone_record(@dnsimple_account, zone_name, record_id, options) }
         end
       end
 

data/lib/fog/dnsimple/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Dnsimple
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/fog/dnsimple.rb

@@ -5,6 +5,8 @@ module Fog
   module Dnsimple
     extend Fog::Provider
 
+    autoload :DNS, File.expand_path('../dnsimple/dns', __FILE__)
+
     service(:dns, 'DNS')
   end
 

metadata

@@ -1,111 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: fog-dnsimple
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Simone Carletti
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dnsimple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: shindo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
+        version: '13.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: fog-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.38'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.38'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: fog-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: |-
-  This library can be used as a module for `fog` or as standalone provider
-                          to use the DNSimple in applications.
+        version: '2.5'
+description: This library can be used as a module for `fog` or as standalone provider
+  to use the DNSimple in applications.
 email:
-- weppos@weppos.net
+- code@simonecarletti.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".ruby-gemset"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- LICENSE.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- fog-dnsimple.gemspec
 - lib/fog/bin/dnsimple.rb
 - lib/fog/dnsimple.rb
 - lib/fog/dnsimple/dns.rb
@@ -119,23 +63,21 @@ files:
 - lib/fog/dnsimple/requests/dns/delete_record.rb
 - lib/fog/dnsimple/requests/dns/get_domain.rb
 - lib/fog/dnsimple/requests/dns/get_record.rb
+- lib/fog/dnsimple/requests/dns/list_all_domains.rb
+- lib/fog/dnsimple/requests/dns/list_all_records.rb
 - lib/fog/dnsimple/requests/dns/list_domains.rb
 - lib/fog/dnsimple/requests/dns/list_records.rb
 - lib/fog/dnsimple/requests/dns/update_record.rb
 - lib/fog/dnsimple/version.rb
-- tests/dns/helper.rb
-- tests/dns/models/record_tests.rb
-- tests/dns/models/records_tests.rb
-- tests/dns/models/zone_tests.rb
-- tests/dns/models/zones_tests.rb
-- tests/helper.rb
-- tests/helpers/mock_helper.rb
-- tests/requests/dns/dns_tests.rb
 homepage: https://github.com/fog/fog-dnsimple
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/fog/fog-dnsimple/issues
+  changelog_uri: https://github.com/fog/fog-dnsimple/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/fog-dnsimple/3.0.0
+  homepage_uri: https://github.com/fog/fog-dnsimple
+  source_code_uri: https://github.com/fog/fog-dnsimple/tree/v3.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -143,16 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Module for the 'fog' gem to support DNSimple.
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.ruby-gemset

@@ -1 +0,0 @@
-fog-dnsimple

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - ruby-head
-  - jruby9k
-  - jruby-head
-
-before_install:
-  - gem install bundler
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: jruby9k

data/LICENSE.md

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016-2016 Aetrion LLC.
-
-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/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task :default => :test
-
-mock = ENV['FOG_MOCK'] || 'true'
-task :test do
-  sh("export FOG_MOCK=#{mock} && bundle exec shindont")
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "fog/dnsimple"
-
-# 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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/fog-dnsimple.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fog/dnsimple/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "fog-dnsimple"
-  spec.version       = Fog::Dnsimple::VERSION
-  spec.authors       = ["Simone Carletti"]
-  spec.email         = ["weppos@weppos.net"]
-
-  spec.summary       = %q{Module for the 'fog' gem to support DNSimple.}
-  spec.description   = %q{This library can be used as a module for `fog` or as standalone provider
-                        to use the DNSimple in applications.}
-  spec.homepage      = "https://github.com/fog/fog-dnsimple"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "shindo", "~> 0.3"
-
-  spec.add_dependency 'fog-core',  '>= 1.38', '< 3'
-  spec.add_dependency 'fog-json',  '~> 1.0'
-end

data/tests/dns/helper.rb

@@ -1,19 +0,0 @@
-def dns_providers
-  {
-    :dnsimple     => {
-      :mocked => false
-    },
-  }
-end
-
-def generate_unique_domain( with_trailing_dot = false)
-  #get time (with 1/100th of sec accuracy)
-  #want unique domain name and if provider is fast, this can be called more than once per second
-  time= (Time.now.to_f * 100).to_i
-  domain = 'test-' + time.to_s + '.com'
-  if with_trailing_dot
-    domain+= '.'
-  end
-
-  domain
-end

data/tests/dns/models/record_tests.rb

@@ -1,41 +0,0 @@
-for provider, config in dns_providers
-
-  domain_name = uniq_id + '.com'
-
-  Shindo.tests("Fog::DNS[:#{provider}] | record", [provider.to_s]) do
-
-    a_record_attributes = {
-      :name   => 'a.' + domain_name,
-      :type   => 'A',
-      :value  => '1.2.3.4'
-    }.merge!(config[:record_attributes] || {})
-
-    aaaa_record_attributes = {
-      :name   => 'aaaa.' + domain_name,
-      :type   => 'AAAA',
-      :value  => '2001:0db8:0000:0000:0000:ff00:0042:8329'
-    }.merge!(config[:record_attributes] || {})
-
-    cname_record_attributes = {
-      :name   => 'cname.' + domain_name,
-      :type   => 'CNAME',
-      :value  => 'real.' + domain_name
-    }.merge!(config[:record_attributes] || {})
-
-    if !Fog.mocking? || config[:mocked]
-      zone_attributes = {
-        :domain => domain_name
-      }.merge(config[:zone_attributes] || {})
-
-      @zone = Fog::DNS[provider].zones.create(zone_attributes)
-
-      model_tests(@zone.records, a_record_attributes, config[:mocked])
-      model_tests(@zone.records, aaaa_record_attributes, config[:mocked])
-      model_tests(@zone.records, cname_record_attributes, config[:mocked])
-
-      @zone.destroy
-    end
-
-  end
-
-end

data/tests/dns/models/records_tests.rb

@@ -1,27 +0,0 @@
-for provider, config in dns_providers
-
-  domain_name = uniq_id + '.com'
-
-  Shindo.tests("Fog::DNS[:#{provider}] | records", [provider.to_s]) do
-
-    record_attributes = {
-      :name   => 'www.' + domain_name,
-      :type   => 'A',
-      :value  => '1.2.3.4'
-    }.merge!(config[:record_attributes] || {})
-
-    if !Fog.mocking? || config[:mocked]
-      zone_attributes = {
-        :domain => domain_name
-      }.merge(config[:zone_attributes] || {})
-
-      @zone = Fog::DNS[provider].zones.create(zone_attributes)
-
-      collection_tests(@zone.records, record_attributes, config[:mocked])
-
-      @zone.destroy
-    end
-
-  end
-
-end