cloudflare 4.3.0 → 4.5.0

data/lib/cloudflare/firewall.rb

@@ -1,70 +1,59 @@
 # 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, 2019-2024, by Samuel Williams.
+# Copyright, 2019, by Rob Widmer.
 
-require_relative 'representation'
-require_relative 'paginate'
+require_relative "representation"
+require_relative "paginate"
 
 module Cloudflare
 	module Firewall
 		class Rule < Representation
+			include Async::REST::Representation::Mutable
+			
 			def mode
-				value[:mode]
+				result[:mode]
 			end
-
+			
 			def notes
-				value[:notes]
+				result[:notes]
 			end
-
+			
 			def configuration
-				value[:configuration]
+				result[:configuration]
 			end
-
+			
 			def to_s
 				"#{configuration[:value]} - #{mode} - #{notes}"
 			end
 		end
-
+		
 		class Rules < Representation
 			include Paginate
-
+			
 			def representation
 				Rule
 			end
-
-			def set(mode, value, notes: nil, target: 'ip')
+			
+			def set(mode, value, notes: nil, target: "ip")
 				notes ||= "cloudflare gem [#{mode}] #{Time.now.strftime('%m/%d/%y')}"
-
-				message = self.post({
-					mode: mode.to_s,
-					notes: notes,
-					configuration: {
-						target: target,
-						value: value.to_s,
-					}
-				})
-
-				represent_message(message)
+				
+				payload = {mode: mode.to_s, notes: notes, configuration: {target: target, value: value.to_s}}
+				
+				Rule.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
+					
+					Rule.new(resource, value: value, metadata: metadata)
+				end
 			end
-
+			
 			def each_by_value(value, &block)
 				each(configuration_value: value, &block)
 			end

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

@@ -1,79 +1,113 @@
 # 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 }
+				each.find{|namespace| namespace.title == title}
 			end
 		end
 	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,34 +1,19 @@
-# 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
-	
+		
 		class Received < Representation
 			include Paginate
 			
@@ -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,73 @@
 # 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(', ')}")
+require_relative "request_error"
 
-			@representation = representation
+module Cloudflare
+	class Wrapper < Async::REST::Wrapper::JSON
+		def process_response(request, response)
+			super
+			
+			if response.failure?
+				raise RequestError.new(request, response.read)
+			end
 		end
-
-		attr_reader :representation
 	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)
+	
+	class Representation < Async::REST::Representation
+		WRAPPER = Wrapper.new
+		
+		def representation
+			Representation
 		end
-
-		attr :response
-		attr :body
-
-		def headers
-			@response.headers
+		
+		def represent(metadata, attributes)
+			resource = @resource.with(path: attributes[:id])
+			
+			representation.new(resource, metadata: metadata, value: {
+				success: true, result: attributes
+			})
 		end
-
+		
+		def represent_message(message)
+			represent(message.headers, message.result)
+		end
+		
 		def result
-			@body[:result]
+			value[:result]
 		end
-
-		def read
-			@body[:result]
+		
+		def to_hash
+			result
 		end
-
+		
+		def to_id
+			{id: result[:id]}
+		end
+		
 		def results
 			Array(result)
 		end
-
+		
 		def errors
-			@body[:errors]
+			value[:errors]
 		end
-
+		
 		def messages
-			@body[:messages]
+			value[:messages]
 		end
-
+		
 		def success?
-			@body[:success]
-		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
-
-		def representation
-			Representation
-		end
-
-		def represent(metadata, attributes)
-			resource = @resource.with(path: attributes[:id])
-
-			representation.new(resource, metadata: metadata, value: attributes)
-		end
-
-		def represent_message(message)
-			represent(message.headers, message.result)
-		end
-
-		def to_hash
-			if value.is_a?(Hash)
-				return value
-			end
+			value[:success]
 		end
 	end
 end

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/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