cloudflare 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7df158b1fb45428a5bd2f3a2147700e691ed6a4bdadbc26f7a6cf0229d77ff98
-  data.tar.gz: 909cd8848e8368d670592c2108ffe1231147226d56d98e23e499807f48d80e8c
+  metadata.gz: 410e2e2d3f001bb5cb9a42cfd6ad2ae32245fa1cd887cb872dae9473275b3e8b
+  data.tar.gz: 5c7b45600a2588bb90f9af55f69c90d61179e9e90ad5481ec97957758ccd1c19
 SHA512:
-  metadata.gz: df08439266659d4232501e8cd22dc1013b5d7d764c9c0d09c3a2768704cb460031ef69139c72de03b5c84b3e8618e1714c1b00624652e3dd557e9206a0fedd3b
-  data.tar.gz: 7c006538e659c65ff3059f6bbbac4feaeed6ac36763f683498be20b2cc8b0ff7d42e0bc43faeda1a8786967a829b152d7575f52c8904502302c7a2a0aa818b95
+  metadata.gz: 87fcb82185237fd6debabe4adc3b6bc74dc9de74f892c9cfb9103b932df01b6830ec2fb32972c2ebca054505577bbd1643351e64f47f7ae2ff794e57da92c70a
+  data.tar.gz: 24959d33b3017e6154cdbef2126eded40c427caa9a4cd3a4335ceabfc53182e7f1515f9a562f0c6f3ab0a9e47052bb4e27d76177b46e2b426ee27b9d8d71f4c9

data/lib/cloudflare/accounts.rb

@@ -1,45 +1,27 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# Copyright, 2017, by David Rosenbloom. <http://artifactory.com>
-#
-# 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.
+# Released under the MIT License.
+# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2019, by Rob Widmer.
 
-require_relative 'representation'
-require_relative 'paginate'
-require_relative 'kv/namespaces'
+require_relative "representation"
+require_relative "paginate"
+require_relative "kv/namespaces"
 
 module Cloudflare
 	class Account < Representation
 		def id
-			value[:id]
+			result[:id]
 		end
-
+		
 		def kv_namespaces
-			self.with(KV::Namespaces, path: 'storage/kv/namespaces')
+			self.with(KV::Namespaces, path: "storage/kv/namespaces")
 		end
 	end
-
+	
 	class Accounts < Representation
 		include Paginate
-
+		
 		def representation
 			Account
 		end

data/lib/cloudflare/certificates.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "representation"
+require_relative "paginate"
+
+module Cloudflare
+	class Certificate < Representation
+		def certificate
+			result[:certificate]
+		end
+	end
+	
+	class Certificates < Representation
+		include Paginate
+		
+		def representation
+			Certificate
+		end
+		
+		def create(csr_pem, hostnames, request_type = "origin-rsa", requested_validity = 5475)
+			represent_message(self.post({
+				csr: csr_pem,
+				request_type: request_type,
+				hostnames: hostnames,
+				requested_validity: requested_validity
+			}))
+		end
+	end
+end

data/lib/cloudflare/connection.rb

@@ -1,60 +1,62 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-#
-# 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.
+# Released under the MIT License.
+# Copyright, 2014-2016, by Marcin Prokop.
+# Copyright, 2014-2024, by Samuel Williams.
+# Copyright, 2015, by Kyle Corbitt.
+# Copyright, 2015, by Guillaume Leseur.
+# Copyright, 2018, by Leonhardt Wille.
+# Copyright, 2018, by Michael Kalygin.
+# Copyright, 2018, by Sherman Koa.
+# Copyright, 2019, by Akinori Musha.
 
-require_relative 'representation'
+require "async/rest/resource"
 
-require_relative 'zones'
-require_relative 'accounts'
-require_relative 'user'
+require_relative "ips"
+require_relative "zones"
+require_relative "accounts"
+require_relative "user"
+require_relative "certificates"
 
 module Cloudflare
-	class Connection < Representation
+	class Connection < Async::REST::Resource
+		ENDPOINT = Async::HTTP::Endpoint.parse("https://api.cloudflare.com/client/v4/")
+		
 		def authenticated(token: nil, key: nil, email: nil)
 			headers = {}
 			
 			if token
-				headers['Authorization'] = "Bearer #{token}"
+				headers["authorization"] = "bearer #{token}"
 			elsif key
 				if email
-					headers['X-Auth-Key'] = key
-					headers['X-Auth-Email'] = email
+					headers["x-auth-key"] = key
+					headers["x-auth-email"] = email
 				else
-					headers['X-Auth-User-Service-Key'] = key
+					headers["x-auth-user-service-key"] = key
 				end
 			end
 			
 			self.with(headers: headers)
 		end
 		
+		def cidrs(ipv: nil)
+			IPs.new(self.with(path: "ips")).cidrs(ipv: ipv)
+		end
+		
 		def zones
-			self.with(Zones, path: 'zones')
+			Zones.new(self.with(path: "zones/"))
 		end
 		
 		def accounts
-			self.with(Accounts, path: 'accounts')
+			Accounts.new(self.with(path: "accounts"))
 		end
 		
 		def user
-			self.with(User, path: 'user')
+			User.new(self.with(path: "user"))
+		end
+		
+		def certificates
+			Certificates.new(self.with(path: "certificates"))
 		end
 	end
 end

data/lib/cloudflare/custom_hostname/ssl_attribute/settings.rb

@@ -1,68 +1,74 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2019, by Rob Widmer.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require_relative "../../representation"
+
 module Cloudflare
 	class CustomHostname < Representation
 		class SSLAttribute
 			class Settings
-				def initialize(settings)
+				def initialize(settings = {})
 					@settings = settings
 				end
-
+				
 				def ciphers
 					@settings[:ciphers]
 				end
-
+				
 				def ciphers=(value)
 					@settings[:ciphers] = value
 				end
-
+				
 				# This will return the raw value, it is needed because
 				# if a value is nil we can't assume that it means it is off
 				def http2
 					@settings[:http2]
 				end
-
+				
 				# Always coerce into a boolean, if the key is not
 				# provided, this value may not be accurate
 				def http2?
-					http2 == 'on'
+					http2 == "on"
 				end
-
+				
 				def http2=(value)
 					process_boolean(:http2, value)
 				end
-
+				
 				def min_tls_version
 					@settings[:min_tls_version]
 				end
-
+				
 				def min_tls_version=(value)
 					@settings[:min_tls_version] = value
 				end
-
+				
 				# This will return the raw value, it is needed because
 				# if a value is nil we can't assume that it means it is off
 				def tls_1_3
 					@settings[:tls_1_3]
 				end
-
+				
 				# Always coerce into a boolean, if the key is not
 				# provided, this value may not be accurate
 				def tls_1_3?
-					tls_1_3 == 'on'
+					tls_1_3 == "on"
 				end
-
+				
 				def tls_1_3=(value)
 					process_boolean(:tls_1_3, value)
 				end
-
+				
 				private
-
+				
 				def process_boolean(key, value)
 					if value.nil?
 						@settings.delete(key)
 					else
-						@settings[key] = !value || value == 'off' ? 'off' : 'on'
+						@settings[key] = !value || value == "off" ? "off" : "on"
 					end
 				end
 			end

data/lib/cloudflare/custom_hostname/ssl_attribute.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require_relative './ssl_attribute/settings'
+# Released under the MIT License.
+# Copyright, 2019, by Rob Widmer.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require_relative "ssl_attribute/settings"
+require_relative "../representation"
 
 module Cloudflare
 	class CustomHostname < Representation
@@ -8,52 +13,52 @@ module Cloudflare
 			def initialize(params)
 				@params = params
 			end
-
+			
 			def active?
-				status == 'active'
+				status == "active"
 			end
-
+			
 			def cname
 				@params[:cname]
 			end
-
+			
 			def cname_target
 				@params[:cname_target]
 			end
-
+			
 			def http_body
 				@params[:http_body]
 			end
-
+			
 			def http_url
 				@params[:http_url]
 			end
-
+			
 			def method
 				@params[:method]
 			end
-
+			
 			def pending_validation?
-				status == 'pending_validation'
+				status == "pending_validation"
 			end
-
+			
 			# Wraps the settings hash if it exists or initializes the settings hash and then wraps it
 			def settings
 				@settings ||= Settings.new(@params[:settings] ||= {})
 			end
-
+			
 			def status
 				@params[:status]
 			end
-
+			
 			def to_h
 				@params
 			end
-
+			
 			def type
 				@params[:type]
 			end
-
+			
 			def validation_errors
 				@params[:validation_errors]
 			end

data/lib/cloudflare/custom_hostnames.rb

@@ -1,80 +1,103 @@
 # frozen_string_literal: true
 
-# This implements the Custom Hostname API
-# https://api.cloudflare.com/#custom-hostname-for-a-zone-properties
+# Released under the MIT License.
+# Copyright, 2019, by Rob Widmer.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'custom_hostname/ssl_attribute'
-require_relative 'paginate'
-require_relative 'representation'
+require_relative "custom_hostname/ssl_attribute"
+require_relative "paginate"
+require_relative "representation"
 
 module Cloudflare
 	class CustomHostname < Representation
+		include Async::REST::Representation::Mutable
+		
 		# Only available if enabled for your zone
 		def custom_origin
-			value[:custom_origin_server]
+			result[:custom_origin_server]
 		end
-
+		
 		# Only available if enabled for your zone
 		def custom_metadata
-			value[:custom_metadata]
+			result[:custom_metadata]
 		end
-
+		
 		def hostname
-			value[:hostname]
+			result[:hostname]
 		end
-
+		
 		def id
-			value[:id]
+			result[:id]
 		end
-
+		
 		def ssl
-			@ssl ||= SSLAttribute.new(value[:ssl])
+			@ssl ||= SSLAttribute.new(result[:ssl])
 		end
-
+		
 		# Check if the cert has been validated
 		# passing true will send a request to Cloudflare to try to validate the cert
 		def ssl_active?(force_update = false)
-			send_patch(ssl: { method: ssl.method, type: ssl.type }) if force_update && ssl.pending_validation?
-			ssl.active?
+			if force_update && ssl.pending_validation?
+				self.patch(ssl: {method: ssl.method, type: ssl.type})
+			end
+			
+			return ssl.active?
 		end
-
+		
 		def update_settings(metadata: nil, origin: nil, ssl: nil)
-			attrs = {}
-			attrs[:custom_metadata] = metadata if metadata
-			attrs[:custom_origin_server] = origin if origin
-			attrs[:ssl] = ssl if ssl
-
-			send_patch(attrs)
+			payload = {}
+			
+			payload[:custom_metadata] = metadata if metadata
+			payload[:custom_origin_server] = origin if origin
+			payload[:ssl] = ssl if ssl
+			
+			self.patch(payload)
 		end
-
+		
 		alias :to_s :hostname
-
+		
 		private
-
-		def send_patch(data)
-			response = patch(data)
-
-			@ssl = nil # Kill off our cached version of the ssl object so it will be regenerated from the response
-			@value = response.result
+		
+		def patch(payload)
+			self.class.patch(@resource, payload) do |resource, response|
+				value = response.read
+				
+				if value[:success]
+					@ssl = nil
+					@value = value
+				else
+					raise RequestError.new(@resource, value)
+				end
+			end
 		end
 	end
-
+	
 	class CustomHostnames < Representation
 		include Paginate
-
+		
 		def representation
 			CustomHostname
 		end
-
-		# initializes a custom hostname object and yields it for customization before saving
-		def create(hostname, metadata: nil, origin: nil, ssl: {}, &block)
-			attrs = { hostname: hostname, ssl: { method: 'http', type: 'dv' }.merge(ssl) }
-			attrs[:custom_metadata] = metadata if metadata
-			attrs[:custom_origin_server] = origin if origin
-
-			represent_message(self.post(attrs))
+		
+		def create(hostname, metadata: nil, origin: nil, ssl: {}, **options)
+			payload = {hostname: hostname, ssl: {method: "http", type: "dv"}.merge(ssl), **options}
+			
+			payload[:custom_metadata] = metadata if metadata
+			payload[:custom_origin_server] = origin if origin
+			
+			CustomHostname.post(@resource, payload) do |resource, response|
+				value = response.read
+				result = value[:result]
+				metadata = response.headers
+				
+				if id = result[:id]
+					resource = resource.with(path: id)
+				end
+				
+				CustomHostname.new(resource, value: value, metadata: metadata)
+			end
 		end
-
+		
 		def find_by_hostname(hostname)
 			each(hostname: hostname).first
 		end

data/lib/cloudflare/dns.rb

@@ -1,86 +1,84 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# Copyright, 2017, by David Rosenbloom. <http://artifactory.com>
-#
-# 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.
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019, by Rob Widmer.
+# Copyright, 2019, by David Wegman.
 
-require_relative 'representation'
-require_relative 'paginate'
+require_relative "representation"
+require_relative "paginate"
 
 module Cloudflare
 	module DNS
 		class Record < Representation
-			def initialize(url, record = nil, **options)
-				super(url, **options)
-
-				@record = record || get.result
-			end
-
+			include Async::REST::Representation::Mutable
+			
 			def update_content(content, **options)
-				response = put(
-					type: @record[:type],
-					name: @record[:name],
+				self.class.put(@resource, {
+					type: self.type,
+					name: self.name,
 					content: content,
 					**options
-				)
-
-				@value = response.result
+				}) do |resource, response|
+					if response.success?
+						@value = response.read
+						@metadata = response.headers
+					else
+						raise RequestError.new(resource, response.read)
+					end
+					
+					self
+				end
 			end
-
+			
 			def type
-				value[:type]
+				result[:type]
 			end
-
+			
 			def name
-				value[:name]
+				result[:name]
 			end
-
+			
 			def content
-				value[:content]
+				result[:content]
 			end
-
-			def proxied
-				value[:proxied]
+			
+			def proxied?
+				result[:proxied]
 			end
-
+			
+			alias proxied proxied?
+			
 			def to_s
-				"#{@record[:name]} #{@record[:type]} #{@record[:content]}"
+				"#{self.name} #{self.type} #{self.content}"
 			end
 		end
-
+		
 		class Records < Representation
 			include Paginate
-
+			
 			def representation
 				Record
 			end
-
-			TTL_AUTO = 1
 			
 			def create(type, name, content, **options)
-				represent_message(self.post(type: type, name: name, content: content, **options))
+				payload = {type: type, name: name, content: content, **options}
+				
+				Record.post(@resource, payload) do |resource, response|
+					value = response.read
+					result = value[:result]
+					metadata = response.headers
+					
+					if id = result[:id]
+						resource = resource.with(path: id)
+					end
+					
+					Record.new(resource, value: value, metadata: metadata)
+				end
 			end
-
+			
 			def find_by_name(name)
-				each(name: name).first
+				each(name: name).find{|record| record.name == name}
 			end
 		end
 	end