cloudflare 4.3.0 → 4.4.0

data/lib/cloudflare/kv/namespaces.rb

@@ -1,77 +1,111 @@
 # frozen_string_literal: true
 
-# This implements the Worker KV Store API
-# https://api.cloudflare.com/#workers-kv-namespace-properties
+# Released under the MIT License.
+# Copyright, 2019, by Rob Widmer.
+# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2021, by Terry Kerr.
 
-require_relative '../paginate'
-require_relative '../representation'
-require_relative 'rest_wrapper'
+require_relative "../paginate"
+require_relative "../representation"
+require_relative "wrapper"
 
 module Cloudflare
 	module KV
 		class Key < Representation
 			def name
-				value[:name]
+				result[:name]
 			end
 		end
-
+		
+		class Value < Representation[Wrapper]
+			include Async::REST::Representation::Mutable
+			
+			def put(value)
+				self.class.put(@resource, value) do |resource, response|
+					value = response.read
+					
+					return value[:success]
+				end
+			end
+		end
+		
 		class Keys < Representation
 			include Paginate
-
+			
 			def representation
 				Key
 			end
 		end
-
+		
 		class Namespace < Representation
+			include Async::REST::Representation::Mutable
+			
 			def delete_value(name)
 				value_representation(name).delete.success?
 			end
-
+			
 			def id
-				value[:id]
+				result[:id]
 			end
-
+			
 			def keys
-				self.with(Keys, path: 'keys')
+				self.with(Keys, path: "keys")
 			end
-
+			
 			def read_value(name)
 				value_representation(name).value
 			end
-
+			
 			def rename(new_title)
-				put(title: new_title)
-				value[:title] = new_title
+				self.class.put(@resource, title: new_title) do |resource, response|
+					value = response.read
+					
+					if value[:success]
+						result[:title] = new_title
+					else
+						raise RequestError.new(resource, value)
+					end
+				end
 			end
-
+			
 			def title
-				value[:title]
+				result[:title]
 			end
-
+			
 			def write_value(name, value)
-				value_representation(name).put(value).success?
+				value_representation(name).put(value)
 			end
-
+			
 			private
-
+			
 			def value_representation(name)
-				@representation_class ||= Representation[RESTWrapper]
-				self.with(@representation_class, path: "values/#{name}")
+				self.with(Value, path: "values/#{name}/")
 			end
 		end
-
+		
 		class Namespaces < Representation
 			include Paginate
-
+			
 			def representation
 				Namespace
 			end
-
-			def create(title)
-				represent_message(post(title: title))
+			
+			def create(title, **options)
+				payload = {title: title, **options}
+				
+				Namespace.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
+					
+					Namespace.new(resource, value: value, metadata: metadata)
+				end
 			end
-
+			
 			def find_by_title(title)
 				each.find {|namespace| namespace.title == title }
 			end

data/lib/cloudflare/kv/wrapper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021, by Terry Kerr.
+# Copyright, 2024, by Samuel Williams.
+
+require "json"
+
+module Cloudflare
+	module KV
+		class Wrapper < Cloudflare::Wrapper
+			APPLICATION_OCTET_STREAM = "application/octet-stream"
+			def prepare_request(request, payload)
+				request.headers.add("accept", APPLICATION_OCTET_STREAM)
+				
+				if payload
+					request.headers["content-type"] = APPLICATION_OCTET_STREAM
+					
+					request.body = ::Protocol::HTTP::Body::Buffered.new([payload.to_s])
+				end
+			end
+			
+			def parser_for(response)
+				if response.headers["content-type"].start_with?(APPLICATION_OCTET_STREAM)
+					OctetParser
+				else
+					super
+				end
+			end
+
+			class OctetParser < ::Protocol::HTTP::Body::Wrapper
+				def join
+					super.force_encoding(Encoding::BINARY)
+				end
+			end
+		end
+	end
+end

data/lib/cloudflare/logs.rb

@@ -1,31 +1,16 @@
-# Copyright, 2019, 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.
+# frozen_string_literal: true
 
-require_relative 'representation'
-require_relative 'paginate'
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require_relative "representation"
+require_relative "paginate"
 
 module Cloudflare
 	module Logs
 		class Entry < Representation
 			def to_s
-				"#{value[:rayid]}-#{value[:ClientRequestURI]}"
+				"#{result[:rayid]}-#{result[:ClientRequestURI]}"
 			end
 		end
 	
@@ -38,4 +23,3 @@ module Cloudflare
 		end
 	end
 end
-

data/lib/cloudflare/paginate.rb

@@ -1,52 +1,40 @@
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2019, by Rob Widmer.
 
 module Cloudflare
 	module Paginate
 		include Enumerable
-
+		
 		def each(page: 1, per_page: 50, **parameters)
 			return to_enum(:each, page: page, per_page: per_page, **parameters) unless block_given?
-
+			
 			while true
-				zones = @resource.get(self.class, page: page, per_page: per_page, **parameters)
-
-				break if zones.empty?
-
-				Array(zones.value).each do |attributes|
-					yield represent(zones.metadata, attributes)
+				resource = @resource.with(parameters: {page: page, per_page: per_page, **parameters})
+				
+				response = self.class.get(resource)
+				
+				break if response.empty?
+				
+				response.results.each do |attributes|
+					yield represent(response.metadata, attributes)
 				end
-
+				
 				page += 1
-
+				
 				# Was this the last page?
-				break if zones.value.size < per_page
+				break if response.results.size < per_page
 			end
 		end
-
+		
 		def empty?
 			self.value.empty?
 		end
-
+		
 		def find_by_id(id)
-			representation.new(@resource.with(path: id))
+			representation.new(@resource.with(path: "#{id}/"))
 		end
 	end
 end

data/lib/cloudflare/representation.rb

@@ -1,111 +1,87 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, 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, 2017-2024, by Samuel Williams.
+# Copyright, 2018, by Leonhardt Wille.
+# Copyright, 2019, by Rob Widmer.
 
-require 'json'
+require "json"
 
-require 'async/rest/representation'
+require "async/rest/representation"
+require "async/rest/wrapper/json"
 
 module Cloudflare
 	class RequestError < StandardError
-		def initialize(resource, errors)
-			super("#{resource}: #{errors.map{|attributes| attributes[:message]}.join(', ')}")
-
-			@representation = representation
+		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_reader :representation
+		
+		attr :value
 	end
-
-	class Message
-		def initialize(response)
-			@response = response
-			@body = response.read
-
-			# Some endpoints return the value instead of a message object (like KV reads)
-			@body = { success: true, result: @body } unless @body.is_a?(Hash)
-		end
-
-		attr :response
-		attr :body
-
-		def headers
-			@response.headers
-		end
-
-		def result
-			@body[:result]
-		end
-
-		def read
-			@body[:result]
-		end
-
-		def results
-			Array(result)
-		end
-
-		def errors
-			@body[:errors]
-		end
-
-		def messages
-			@body[:messages]
-		end
-
-		def success?
-			@body[:success]
+	
+	class Wrapper < Async::REST::Wrapper::JSON
+		def process_response(request, response)
+			super
+			
+			if response.failure?
+				raise RequestError.new(request, response.read)
+			end
 		end
 	end
-
+	
 	class Representation < Async::REST::Representation
-		def process_response(*)
-			message = Message.new(super)
-
-			unless message.success?
-				raise RequestError.new(@resource, message.errors)
-			end
-
-			return message
-		end
-
+		WRAPPER = Wrapper.new
+		
 		def representation
 			Representation
 		end
-
+		
 		def represent(metadata, attributes)
 			resource = @resource.with(path: attributes[:id])
-
-			representation.new(resource, metadata: metadata, value: attributes)
+			
+			representation.new(resource, metadata: metadata, value: {
+				success: true, result: attributes
+			})
 		end
-
+		
 		def represent_message(message)
 			represent(message.headers, message.result)
 		end
-
+		
+		def result
+			value[:result]
+		end
+		
 		def to_hash
-			if value.is_a?(Hash)
-				return value
-			end
+			result
+		end
+		
+		def to_id
+			{id: result[:id]}
+		end
+		
+		def results
+			Array(result)
+		end
+		
+		def errors
+			value[:errors]
+		end
+		
+		def messages
+			value[:messages]
+		end
+		
+		def success?
+			value[:success]
 		end
 	end
 end

data/lib/cloudflare/user.rb

@@ -1,36 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, 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, 2017-2024, by Samuel Williams.
+# Copyright, 2018, by Leonhardt Wille.
 
-require_relative 'representation'
+require_relative "representation"
 
 module Cloudflare
 	class User < Representation
 		def id
-			value[:id]
+			result[:id]
 		end
 		
 		def email
-			value[:email]
+			result[:email]
 		end
 	end
 end

data/lib/cloudflare/version.rb

@@ -1,26 +1,12 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, 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, 2018, by Leonhardt Wille.
+# Copyright, 2018, by Casey Lopez.
 
 module Cloudflare
-	VERSION = '4.3.0'
+	VERSION = "4.4.0"
 end

data/lib/cloudflare/zones.rb

@@ -1,65 +1,59 @@
 # 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, 2017-2024, by Samuel Williams.
+# Copyright, 2017, by Denis Sadomowski.
+# Copyright, 2017, by 莫粒.
+# Copyright, 2018, by Leonhardt Wille.
+# Copyright, 2018, by Michael Kalygin.
+# Copyright, 2018, by Sherman Koa.
+# Copyright, 2018, by Kugayama Nana.
+# Copyright, 2018, by Casey Lopez.
+# Copyright, 2019, by Akinori Musha.
+# Copyright, 2019, by Rob Widmer.
 
-require_relative 'representation'
-require_relative 'paginate'
+require_relative "representation"
+require_relative "paginate"
 
-require_relative 'custom_hostnames'
-require_relative 'firewall'
-require_relative 'dns'
-require_relative 'logs'
+require_relative "custom_hostnames"
+require_relative "firewall"
+require_relative "dns"
+require_relative "logs"
 
 module Cloudflare
 	class Zone < Representation
+		include Async::REST::Representation::Mutable
+		
 		def custom_hostnames
-			self.with(CustomHostnames, path: 'custom_hostnames')
+			self.with(CustomHostnames, path: "custom_hostnames")
 		end
 
 		def dns_records
-			self.with(DNS::Records, path: 'dns_records')
+			self.with(DNS::Records, path: "dns_records")
 		end
 		
 		def firewall_rules
-			self.with(Firewall::Rules, path: 'firewall/access_rules/rules')
+			self.with(Firewall::Rules, path: "firewall/access_rules/rules")
 		end
 		
 		def logs
-			self.with(Logs::Received, path: 'logs/received')
+			self.with(Logs::Received, path: "logs/received")
 		end
 		
-		DEFAULT_PURGE_CACHE_PARAMS = {
+		DEFAULT_PURGE_CACHE_PARAMETERS = {
 			purge_everything: true
 		}.freeze
 		
-		def purge_cache(parameters = DEFAULT_PURGE_CACHE_PARAMS)
-			self.with(Zone, path: 'purge_cache').post(parameters)
+		def purge_cache(**options)
+			if options.empty?
+				options = DEFAULT_PURGE_CACHE_PARAMETERS
+			end
 			
-			return self
+			self.class.post(@resource.with(path: "purge_cache"), options)
 		end
 		
 		def name
-			value[:name]
+			result[:name]
 		end
 		
 		alias to_s name
@@ -72,12 +66,24 @@ module Cloudflare
 			Zone
 		end
 
-		def create(name, account, jump_start = false)
-			represent_message(self.post(name: name, account: account.to_hash, jump_start: jump_start))
+		def create(name, account, jump_start: false, **options)
+			payload = {name: name, account: account.to_id, jump_start: jump_start, **options}
+			
+			Zone.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
+				
+				Zone.new(resource, value: value, metadata: metadata)
+			end
 		end
-
+		
 		def find_by_name(name)
-			each(name: name).first
+			each(name: name).find{|zone| zone.name == name}
 		end
 	end
 end