glare 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c9e2e4e31435dfca712365a0fcd6a23719ffcb95ce32c7b9a6c828dbc5bb8fd
-  data.tar.gz: 1ae706b32bc0cd374c20ccb4bf00eab6744e6ba2e3951079f3303ca583977c35
+  metadata.gz: 2600364f5b04c36ab6d05324f6876f4a36ea654c0dd85a6f77be1c21a65f141e
+  data.tar.gz: 5aa32304bb23e6cca6ab6c25343d346b7a3800cb02a14ba39db48c4d16765dc3
 SHA512:
-  metadata.gz: 34fcb6cbb9193e558e989d99f6d887da5159b7fef3e2910fa00f14459ea009a91073df7f3673a20caeaa668290b797bc9ab5ab13bd54d6b84fd17a88e80e8c28
-  data.tar.gz: 6201d4bcbfe6c8c22c71e7b78333e53f52900a76cb80f6295e6de4f471e2c4c8da68b53adaa789e0ee35206e83720d371adf09509dd190a4eda68e50f61b9ef2
+  metadata.gz: 4c75b4376b091ddbfd72eb3d43284be26c6d1ec4a999f06d138b40c0a686211f6a6e4efb97047a90851d211442dc14f93a01ce0431d2ab1c1d2c8b90b2aefa10
+  data.tar.gz: 0351277a39c10948b2b52210f7a221509d286c07b5c4176acf6be29e2249f9f439efbacd1a2e3a44b1663890b627448bc9f675b3a1dc1355f2ac1e19b06ab25e

data/README.md

@@ -46,6 +46,8 @@ Additionally, you can set other environment variables:
 require 'glare'
 
 Glare.register('example.domain.com', 'destination.com' ,'CNAME')
+Glare.register('example.domain.com', 'destination.com' ,'CNAME', proxied: true)
+Glare.register('example.domain.com', 'destination.com' ,'CNAME', ttl: 300)
 ```
 
 Where:

data/lib/glare.rb

@@ -10,9 +10,9 @@ require 'glare/errors'
 
 module Glare
   class << self
-    def register(fqdn, destination, type, proxied = false)
+    def register(fqdn, destination, type, proxied: false, ttl: 1)
       client = build_client
-      Domain.new(client).register(fqdn, destination, type, proxied)
+      Domain.new(client).register(fqdn, destination, type, proxied: proxied, ttl: ttl)
     end
 
     def resolve(fqdn, type)
@@ -30,6 +30,11 @@ module Glare
       Domain.new(client).proxied?(fqdn, type)
     end
 
+    def records(fqdn, type)
+      client = build_client
+      Domain.new(client).records(fqdn, type)
+    end
+
     private
 
     CF_EMAIL = 'CF_EMAIL'.freeze

data/lib/glare/cf_dns_record.rb

@@ -1,18 +1,20 @@
 module Glare
   class CfDnsRecord
-    def initialize(id:, name:, type:, content:, proxied: false)
+    def initialize(id:, name:, type:, content:, proxied: false, ttl:)
       @id = id
       @name = name
       @type = type
       @content = content
       @proxied = proxied
+      @ttl = ttl
     end
 
     def ==(cf_dns_record)
       @type == cf_dns_record.type &&
         @name == cf_dns_record.name &&
         @content == cf_dns_record.content &&
-        @proxied == cf_dns_record.proxied
+        @proxied == cf_dns_record.proxied &&
+        @ttl == cf_dns_record.ttl
     end
 
     def to_h
@@ -20,11 +22,12 @@ module Glare
         type: @type,
         name: @name,
         content: @content,
-        proxied: @proxied
+        proxied: @proxied,
+        ttl: @ttl
       }
     end
 
     attr_reader :id, :name, :type
-    attr_accessor :content, :proxied
+    attr_accessor :content, :proxied, :ttl
   end
 end

data/lib/glare/cf_dns_records.rb

@@ -13,7 +13,8 @@ module Glare
             name: item['name'],
             type: item['type'],
             content: item['content'],
-            proxied: item['proxied']
+            proxied: item['proxied'],
+            ttl: item['ttl']
           )
         end
 
@@ -45,6 +46,10 @@ module Glare
       @records.all? { |r| r.proxied == true }
     end
 
+    def all?
+      @records.all? { |record| yield(record) }
+    end
+
     def each
       @records.each { |record| yield(record) }
     end

data/lib/glare/cf_dns_records/updater.rb

@@ -80,6 +80,7 @@ module Glare
             final_record = record.dup
             final_record.content = new_record.content
             final_record.proxied = new_record.proxied
+            final_record.ttl = new_record.ttl
             operations << Operation.new(final_record, :update)
             true
           else

data/lib/glare/dns_record.rb

@@ -1,10 +1,11 @@
 module Glare
   class DnsRecord
-    def initialize(name:, type:, content:, proxied: false)
+    def initialize(name:, type:, content:, proxied:, ttl: )
       @name = name
       @type = type
       @content = content
       @proxied = proxied
+      @ttl = ttl
     end
 
     def to_h
@@ -12,7 +13,8 @@ module Glare
         type: @type,
         name: @name,
         content: @content,
-        proxied: @proxied
+        proxied: @proxied,
+        ttl: @ttl
       }
     end
 
@@ -20,9 +22,10 @@ module Glare
       @type == dns_record.type &&
         @name == dns_record.name &&
         @content == dns_record.content &&
-        @proxied == dns_record.proxied
+        @proxied == dns_record.proxied &&
+        @ttl == dns_record.ttl
     end
 
-    attr_reader :content, :type, :name, :proxied
+    attr_reader :content, :type, :name, :proxied, :ttl
   end
 end

data/lib/glare/domain.rb

@@ -7,9 +7,9 @@ module Glare
       @client = client
     end
 
-    def register(fqdn, destinations, type, proxied=false)
+    def register(fqdn, destinations, type, proxied:, ttl:)
       dns_records = Array(destinations).map do |destination|
-        DnsRecord.new(type: type, name: fqdn, content: destination, proxied: proxied)
+        DnsRecord.new(type: type, name: fqdn, content: destination, proxied: proxied, ttl: ttl)
       end
 
       zone = Zone.new(@client, fqdn)
@@ -33,5 +33,10 @@ module Glare
       records = zone.records(type)
       records.all_proxied?
     end
+
+    def records(fqdn, type)
+      zone = Zone.new(@client, fqdn)
+      zone.records(type)
+    end
   end
 end

data/lib/glare/version.rb

@@ -1,3 +1,3 @@
 module Glare
-  VERSION = '0.9.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/proxied_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe 'retrieves proxied values', integration: true do
   end
 
   def register_domain(domain, destination)
-    Glare.register(domain, destination, type, true)
+    Glare.register(domain, destination, type, proxied: true)
   end
 
   def proxied?(domain)

data/spec/ttl_spec.rb

@@ -0,0 +1,28 @@
+require 'glare'
+
+RSpec.describe 'retrieves proxied values', integration: true do
+  context 'when a domain contains more than one destination' do
+    let(:domain) { 'a.flywire.com.cn' }
+    let(:type) { 'A' }
+    before do
+      register_domain(domain, destination)
+    end
+
+    context 'two new records' do
+      let(:destination) { ['1.2.3.4', '5.6.7.8'] }
+
+      it 'sets custom ttl' do
+         records_with_correct_ttl = records(domain).all? { |r| r.ttl == 300 }
+         expect(records_with_correct_ttl).to eq(true)
+      end
+    end
+  end
+
+  def register_domain(domain, destination)
+    Glare.register(domain, destination, type, ttl: 300)
+  end
+
+  def records(domain)
+    Glare.records(domain, type)
+  end
+end

data/spec/units/glare_spec.rb

@@ -2,11 +2,21 @@ require 'glare'
 
 RSpec.describe Glare do
   before do
-    allow(ENV).to receive(:fetch).with('CF_EMAIL').and_return('an_email')
-    allow(ENV).to receive(:fetch).with('CF_AUTH_KEY').and_return('an_auth_key')
-
     allow(Glare::Client).to receive(:new).and_return(client)
   end
+
+  around do |example|
+    previous_cf_email = ENV['CF_EMAIL']
+    previous_cf_auth_key = ENV['CF_AUTH_KEY']
+    ENV['CF_EMAIL'] = 'an_email'
+    ENV['CF_AUTH_KEY'] = 'an_auth_key'
+
+    example.run
+
+    ENV['CF_EMAIL'] = previous_cf_email
+    ENV['CF_AUTH_KEY'] = previous_cf_auth_key
+  end
+
   let(:client) { spy(Glare::Client) }
   let(:zone_list) { Glare::ApiResponse.new(load_fixture('list_zone')) }
   let(:empty_result) { Glare::ApiResponse.new(load_fixture('empty_result')) }
@@ -92,7 +102,7 @@ RSpec.describe Glare do
 
       expect(client).to have_received(:post).with(
         '/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records',
-        type: 'CNAME', name: 'not-exist.example.com', content: 'a_destination', proxied: false
+        type: 'CNAME', name: 'not-exist.example.com', content: 'a_destination', proxied: false, ttl: 1
       )
     end
 
@@ -102,19 +112,19 @@ RSpec.describe Glare do
         name: 'not-exist.example.com', type: 'CNAME'
       ).and_return(empty_result)
 
-      Glare.register('not-exist.example.com', ['a_destination', 'another_destination'].shuffle, 'CNAME', true)
+      Glare.register('not-exist.example.com', ['a_destination', 'another_destination'].shuffle, 'CNAME', proxied: true, ttl: 1)
 
       expect(client).not_to have_received(:put).
         with('/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records', any_args)
 
       expect(client).to have_received(:post).with(
         '/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records',
-        type: 'CNAME', name: 'not-exist.example.com', content: 'a_destination', proxied: true
+        type: 'CNAME', name: 'not-exist.example.com', content: 'a_destination', proxied: true, ttl: 1
       )
 
       expect(client).to have_received(:post).with(
         '/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records',
-        type: 'CNAME', name: 'not-exist.example.com', content: 'another_destination', proxied: true
+        type: 'CNAME', name: 'not-exist.example.com', content: 'another_destination', proxied: true, ttl: 1
       )
     end
 
@@ -155,7 +165,7 @@ RSpec.describe Glare do
 
             expect(client).to have_received(:put).with(
               '/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records/a1f984afe5544840505494298f54c33e',
-              type: 'CNAME', name: 'wadus.example.com', content: 'a_destination.com', proxied: false
+              type: 'CNAME', name: 'wadus.example.com', content: 'a_destination.com', proxied: false, ttl: 1
             )
 
             expect(client).not_to have_received(:put).with(
@@ -168,19 +178,39 @@ RSpec.describe Glare do
         context 'all records proxied attributes are different' do
           it 'sends registration data to update endpoint' do
             destinations = ['destination.com', 'another_destination.com'].shuffle
-            Glare.register('wadus.example.com', destinations, 'CNAME', true)
+            Glare.register('wadus.example.com', destinations, 'CNAME', proxied: true)
+
+            expect(client).not_to have_received(:post).
+              with('/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records', any_args)
+
+            expect(client).to have_received(:put).with(
+              any_args,
+              type: 'CNAME', name: 'wadus.example.com', content: 'destination.com', proxied: true, ttl: 1
+            )
+
+            expect(client).to have_received(:put).with(
+              any_args,
+              type: 'CNAME', name: 'wadus.example.com', content: 'another_destination.com', proxied: true, ttl: 1
+            )
+          end
+        end
+
+        context 'all records ttl attributes are different' do
+          it 'sends registration data to update endpoint' do
+            destinations = ['destination.com', 'another_destination.com'].shuffle
+            Glare.register('wadus.example.com', destinations, 'CNAME', proxied: false, ttl: 300)
 
             expect(client).not_to have_received(:post).
               with('/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records', any_args)
 
             expect(client).to have_received(:put).with(
               any_args,
-              type: 'CNAME', name: 'wadus.example.com', content: 'destination.com', proxied: true
+              type: 'CNAME', name: 'wadus.example.com', content: 'destination.com', proxied: false, ttl: 300
             )
 
             expect(client).to have_received(:put).with(
               any_args,
-              type: 'CNAME', name: 'wadus.example.com', content: 'another_destination.com', proxied: true
+              type: 'CNAME', name: 'wadus.example.com', content: 'another_destination.com', proxied: false, ttl: 300
             )
           end
         end
@@ -194,7 +224,7 @@ RSpec.describe Glare do
 
         expect(client).to have_received(:put).with(
           any_args,
-          type: 'CNAME', name: 'wadus.example.com', content: 'a_destination.com', proxied: false
+          type: 'CNAME', name: 'wadus.example.com', content: 'a_destination.com', proxied: false, ttl: 1
         )
 
         expect(client).to have_received(:delete).once
@@ -216,7 +246,7 @@ RSpec.describe Glare do
 
         expect(client).to have_received(:post).with(
           '/zones/9de4eb694c380d79845d35cd939cc7a7/dns_records',
-          type: 'CNAME', name: 'wadus.example.com', content: 'a_third_destination.com', proxied: false
+          type: 'CNAME', name: 'wadus.example.com', content: 'a_third_destination.com', proxied: false, ttl: 1
         )
       end
     end

data/spec/units/operations_spec.rb

@@ -103,11 +103,11 @@ RSpec.describe Glare::CfDnsRecords::Updater do
     expect(operations.count).to be_zero
   end
 
-  def existing_record(id: 1_234, name: 'name', type: 'A', content:)
-    Glare::CfDnsRecord.new(id: id, name: name, type: type, content: content)
+  def existing_record(id: 1_234, name: 'name', type: 'A', content:, ttl: 1)
+    Glare::CfDnsRecord.new(id: id, name: name, type: type, content: content, ttl: ttl)
   end
 
-  def dns_record(name: 'name', type: 'A', content:, proxied: false)
-    Glare::DnsRecord.new(name: name, type: type, content: content, proxied: proxied)
+  def dns_record(name: 'name', type: 'A', content:, proxied: false, ttl: 1)
+    Glare::DnsRecord.new(name: name, type: type, content: content, proxied: proxied, ttl: ttl)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glare
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jose Luis Salas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ files:
 - spec/proxied_spec.rb
 - spec/resolve_domain_spec.rb
 - spec/spec_helper.rb
+- spec/ttl_spec.rb
 - spec/units/api_response_spec.rb
 - spec/units/glare_spec.rb
 - spec/units/operations_spec.rb
@@ -152,13 +153,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API client for CloudFlare v4 API
 test_files:
 - spec/delete_domain_spec.rb
 - spec/spec_helper.rb
+- spec/ttl_spec.rb
 - spec/proxied_spec.rb
 - spec/resolve_domain_spec.rb
 - spec/units/glare_spec.rb