cloudflare 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ba2d239f123bdb4e182b88d91784524799c70c90bd5c807667f95901892263f
-  data.tar.gz: bf5e63e363ec5da14af177bb87849c9e00b883c964c18b7ebcb227cae994758a
+  metadata.gz: 410e2e2d3f001bb5cb9a42cfd6ad2ae32245fa1cd887cb872dae9473275b3e8b
+  data.tar.gz: 5c7b45600a2588bb90f9af55f69c90d61179e9e90ad5481ec97957758ccd1c19
 SHA512:
-  metadata.gz: ad9c07a221587403f1d997273b05c121c9fe658113cd3d460f8b1394c17285518cdbbf98cc31865315189bb9402901a23d775003b75760d0c5e7f13b1342d5e5
-  data.tar.gz: 4f72ebb38c78fd734b235be37a5088c1f632877f592370924dfb89461bd3f4a4f0fe5f8ac85d071c9395467f928b62a530f165cded2718b7c50eb339b5065025
+  metadata.gz: 87fcb82185237fd6debabe4adc3b6bc74dc9de74f892c9cfb9103b932df01b6830ec2fb32972c2ebca054505577bbd1643351e64f47f7ae2ff794e57da92c70a
+  data.tar.gz: 24959d33b3017e6154cdbef2126eded40c427caa9a4cd3a4335ceabfc53182e7f1515f9a562f0c6f3ab0a9e47052bb4e27d76177b46e2b426ee27b9d8d71f4c9

data/lib/cloudflare/accounts.rb

@@ -13,15 +13,15 @@ module Cloudflare
 		def id
 			result[:id]
 		end
-
+		
 		def 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

@@ -12,9 +12,11 @@
 
 require "async/rest/resource"
 
+require_relative "ips"
 require_relative "zones"
 require_relative "accounts"
 require_relative "user"
+require_relative "certificates"
 
 module Cloudflare
 	class Connection < Async::REST::Resource
@@ -37,6 +39,10 @@ module Cloudflare
 			self.with(headers: headers)
 		end
 		
+		def cidrs(ipv: nil)
+			IPs.new(self.with(path: "ips")).cidrs(ipv: ipv)
+		end
+		
 		def zones
 			Zones.new(self.with(path: "zones/"))
 		end
@@ -48,5 +54,9 @@ module Cloudflare
 		def 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

@@ -13,57 +13,57 @@ module Cloudflare
 				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"
 				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"
 				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)

data/lib/cloudflare/custom_hostname/ssl_attribute.rb

@@ -13,52 +13,52 @@ module Cloudflare
 			def initialize(params)
 				@params = params
 			end
-
+			
 			def 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"
 			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

@@ -62,7 +62,7 @@ module Cloudflare
 			self.class.patch(@resource, payload) do |resource, response|
 				value = response.read
 				
-				if value[:sucess]
+				if value[:success]
 					@ssl = nil
 					@value = value
 				else
@@ -71,7 +71,7 @@ module Cloudflare
 			end
 		end
 	end
-
+	
 	class CustomHostnames < Representation
 		include Paginate
 		
@@ -97,7 +97,7 @@ module Cloudflare
 				CustomHostname.new(resource, value: value, metadata: metadata)
 			end
 		end
-
+		
 		def find_by_hostname(hostname)
 			each(hostname: hostname).first
 		end

data/lib/cloudflare/dns.rb

@@ -76,7 +76,7 @@ module Cloudflare
 					Record.new(resource, value: value, metadata: metadata)
 				end
 			end
-
+			
 			def find_by_name(name)
 				each(name: name).find{|record| record.name == name}
 			end

data/lib/cloudflare/firewall.rb

@@ -28,7 +28,7 @@ module Cloudflare
 				"#{configuration[:value]} - #{mode} - #{notes}"
 			end
 		end
-
+		
 		class Rules < Representation
 			include Paginate
 			

data/lib/cloudflare/ips.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "representation"
+
+module Cloudflare
+	class IPs < Representation
+		def cidrs(ipv: nil)
+			if ipv
+				result[:"ipv#{ipv}_cidrs"]
+			else
+				result[:ipv4_cidrs].to_a + result[:ipv6_cidrs].to_a
+			end
+		end
+	end
+end

data/lib/cloudflare/kv/namespaces.rb

@@ -107,7 +107,7 @@ module Cloudflare
 			end
 			
 			def find_by_title(title)
-				each.find {|namespace| namespace.title == title }
+				each.find{|namespace| namespace.title == title}
 			end
 		end
 	end

data/lib/cloudflare/kv/wrapper.rb

@@ -27,7 +27,7 @@ module Cloudflare
 					super
 				end
 			end
-
+			
 			class OctetParser < ::Protocol::HTTP::Body::Wrapper
 				def join
 					super.force_encoding(Encoding::BINARY)

data/lib/cloudflare/logs.rb

@@ -13,7 +13,7 @@ module Cloudflare
 				"#{result[:rayid]}-#{result[:ClientRequestURI]}"
 			end
 		end
-	
+		
 		class Received < Representation
 			include Paginate
 			

data/lib/cloudflare/representation.rb

@@ -10,23 +10,9 @@ require "json"
 require "async/rest/representation"
 require "async/rest/wrapper/json"
 
+require_relative "request_error"
+
 module Cloudflare
-	class RequestError < StandardError
-		def initialize(request, value)
-			if error = value[:error]
-				super("#{request}: #{error}")
-			elsif errors = value[:errors]
-				super("#{request}: #{errors.map{|attributes| attributes[:message]}.join(', ')}")
-			else
-				super("#{request}: #{value.inspect}")
-			end
-			
-			@value = value
-		end
-		
-		attr :value
-	end
-	
 	class Wrapper < Async::REST::Wrapper::JSON
 		def process_response(request, response)
 			super

data/lib/cloudflare/request_error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2024, by Samuel Williams.
+
+module Cloudflare
+	class RequestError < StandardError
+		def self.error_string_for(value)
+			if value.is_a?(Hash)
+				if error = value[:error]
+					return error
+				elsif errors = value[:errors]
+					return errors.map{|attributes| attributes[:message]}.join(", ")
+				end
+			end
+			
+			return value.inspect
+		end
+		
+		def initialize(request, value)
+			super("#{request}: #{self.class.error_string_for(value)}")
+			
+			@value = value
+		end
+		
+		attr :value
+	end
+end

data/lib/cloudflare/version.rb

@@ -8,5 +8,5 @@
 # Copyright, 2018, by Casey Lopez.
 
 module Cloudflare
-	VERSION = "4.4.0"
+	VERSION = "4.5.0"
 end

data/lib/cloudflare/zones.rb

@@ -11,6 +11,7 @@
 # Copyright, 2018, by Casey Lopez.
 # Copyright, 2019, by Akinori Musha.
 # Copyright, 2019, by Rob Widmer.
+# Copyright, 2025, by Travis Skindzier.
 
 require_relative "representation"
 require_relative "paginate"
@@ -27,7 +28,7 @@ module Cloudflare
 		def custom_hostnames
 			self.with(CustomHostnames, path: "custom_hostnames")
 		end
-
+		
 		def dns_records
 			self.with(DNS::Records, path: "dns_records")
 		end
@@ -52,6 +53,10 @@ module Cloudflare
 			self.class.post(@resource.with(path: "purge_cache"), options)
 		end
 		
+		def activation_check
+			self.class.put(@resource.with(path: "activation_check"))
+		end
+		
 		def name
 			result[:name]
 		end
@@ -65,7 +70,7 @@ module Cloudflare
 		def representation
 			Zone
 		end
-
+		
 		def create(name, account, jump_start: false, **options)
 			payload = {name: name, account: account.to_id, jump_start: jump_start, **options}
 			

data/license.md

@@ -21,6 +21,7 @@ Copyright, 2019, by Fedishin Nazar.
 Copyright, 2019, by David Wegman.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2021, by Terry Kerr.  
+Copyright, 2025, by Travis Skindzier.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -9,7 +9,7 @@ It is a Ruby wrapper for the Cloudflare V4 API. It provides a light weight wrapp
 Add this line to your application's Gemfile:
 
 ``` ruby
-gem 'cloudflare'
+gem "cloudflare"
 ```
 
 And then execute:
@@ -25,11 +25,11 @@ Or install it yourself as:
 Here are some basic examples. For more details, refer to the code and specs.
 
 ``` ruby
-require 'cloudflare'
+require "cloudflare"
 
 # Grab some details from somewhere:
-email = ENV['CLOUDFLARE_EMAIL']
-key = ENV['CLOUDFLARE_KEY']
+email = ENV["CLOUDFLARE_EMAIL"]
+key = ENV["CLOUDFLARE_KEY"]
 
 Cloudflare.connect(key: key, email: email) do |connection|
 	# Get all available zones:
@@ -48,13 +48,13 @@ Cloudflare.connect(key: key, email: email) do |connection|
 	
 	# Add a DNS record. Here we add an A record for `batman.example.com`:
 	zone = zones.find_by_name("example.com")
-	zone.dns_records.create('A', 'batman', '1.2.3.4', proxied: false)
+	zone.dns_records.create("A", "batman", "1.2.3.4", proxied: false)
 	
 	# Get firewall rules:
 	all_rules = zone.firewall_rules
 	
 	# Block an ip:
-	rule = zone.firewall_rules.set('block', '1.2.3.4', notes: "ssh dictionary attack")
+	rule = zone.firewall_rules.set("block", "1.2.3.4", notes: "ssh dictionary attack")
 end
 ```
 
@@ -63,9 +63,9 @@ end
 You can read more about [bearer tokens here](https://blog.cloudflare.com/api-tokens-general-availability/). This allows you to limit priviledges.
 
 ``` ruby
-require 'cloudflare'
+require "cloudflare"
 
-token = 'a_generated_api_token'
+token = "a_generated_api_token"
 
 Cloudflare.connect(token: token) do |connection|
 	# ...
@@ -76,7 +76,7 @@ end
 
 ``` ruby
 Async do
-	connection = Cloudflare.connect(...)
+	connection = Cloudflare.connect
 	
 	# ... do something with connection ...
 ensure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -24,8 +24,8 @@ authors:
 - Mike Perham
 - Olle Jonsson
 - Terry Kerr
+- Travis Skindzier
 - 莫粒
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -57,7 +57,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -73,25 +73,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/cloudflare.rb
 - lib/cloudflare/accounts.rb
+- lib/cloudflare/certificates.rb
 - lib/cloudflare/connection.rb
 - lib/cloudflare/custom_hostname/ssl_attribute.rb
 - lib/cloudflare/custom_hostname/ssl_attribute/settings.rb
 - lib/cloudflare/custom_hostnames.rb
 - lib/cloudflare/dns.rb
 - lib/cloudflare/firewall.rb
+- lib/cloudflare/ips.rb
 - lib/cloudflare/kv/namespaces.rb
 - lib/cloudflare/kv/wrapper.rb
 - lib/cloudflare/logs.rb
 - lib/cloudflare/paginate.rb
 - lib/cloudflare/representation.rb
+- lib/cloudflare/request_error.rb
 - lib/cloudflare/user.rb
 - lib/cloudflare/version.rb
 - lib/cloudflare/zones.rb
@@ -102,7 +103,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/socketry/cloudflare.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,15 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.
 test_files: []

metadata.gz.sig

@@ -1,2 +1,2 @@
-C��`���M�*�?���G|5|�t(�G�[�l�P�4�E�Q�H���K*U3ٿR�a�;8l����
-,sF�ɛbTTz�(MJ��[�lj�=�c�D��}|��<��
+����7+ul��ȻSt�>���j��N�\����K'U���,if~;OKM����~(
+�vH�A���͟�:�
YQqb���3Ⱦ�ϸ��s	k��V�%�?Qp�����9M�{U;����sRQn�:V�2�H����B��[����ؠ