cloudflare 4.0.1 → 4.2.0

data/lib/cloudflare/dns.rb

@@ -34,28 +34,33 @@ module Cloudflare
 				@record = record || get.result
 			end
 
-			def update_content(content)
+			def update_content(content, **options)
 				response = put(
 					type: @record[:type],
 					name: @record[:name],
-					content: content
+					content: content,
+					**options
 				)
-				
+
 				@value = response.result
 			end
-			
+
 			def type
 				value[:type]
 			end
-			
+
 			def name
 				value[:name]
 			end
-			
+
 			def content
 				value[:content]
 			end
-			
+
+			def proxied
+				value[:proxied]
+			end
+
 			def to_s
 				"#{@record[:name]} #{@record[:type]} #{@record[:content]}"
 			end
@@ -63,29 +68,20 @@ module Cloudflare
 
 		class Records < Representation
 			include Paginate
-			
+
 			def representation
 				Record
 			end
-			
+
 			TTL_AUTO = 1
 			
 			def create(type, name, content, **options)
-				message = self.post(type: type, name: name, content: content, **options)
-				
-				id = message.result[:id]
-				resource = @resource.with(path: id)
-				
-				return representation.new(resource, metadata: message.headers, value: message.result)
+				represent_message(self.post(type: type, name: name, content: content, **options))
 			end
-			
+
 			def find_by_name(name)
 				each(name: name).first
 			end
-			
-			def find_by_id(id)
-				Record.new(@resource.with(path: id))
-			end
 		end
 	end
 end

data/lib/cloudflare/firewall.rb

@@ -29,15 +29,15 @@ module Cloudflare
 			def mode
 				value[:mode]
 			end
-			
+
 			def notes
 				value[:notes]
 			end
-			
+
 			def configuration
 				value[:configuration]
 			end
-			
+
 			def to_s
 				"#{configuration[:value]} - #{mode} - #{notes}"
 			end
@@ -45,14 +45,14 @@ module Cloudflare
 
 		class Rules < Representation
 			include Paginate
-			
+
 			def representation
 				Rule
 			end
-			
+
 			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,
@@ -61,17 +61,10 @@ module Cloudflare
 						value: value.to_s,
 					}
 				})
-				
-				id = message.result[:id]
-				resource = @resource.with(path: id)
-				
-				return representation.new(resource, metadata: message.headers, value: message.result)
-			end
-			
-			def find_by_id(id)
-				Rule.new(@resource.with(path: id))
+
+				represent_message(message)
 			end
-			
+
 			def each_by_value(value, &block)
 				each(configuration_value: value, &block)
 			end

data/lib/cloudflare/kv/namespaces.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# This implements the Worker KV Store API
+# https://api.cloudflare.com/#workers-kv-namespace-properties
+
+require_relative '../paginate'
+require_relative '../representation'
+
+module Cloudflare
+	module KV
+		class Key < Representation
+			def name
+				value[:name]
+			end
+		end
+
+		class Keys < Representation
+			include Paginate
+
+			def representation
+				Key
+			end
+		end
+
+		class Namespace < Representation
+			def delete_value(name)
+				value_representation(name).delete.success?
+			end
+
+			def id
+				value[:id]
+			end
+
+			def 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
+			end
+
+			def title
+				value[:title]
+			end
+
+			def write_value(name, value)
+				value_representation(name).put(value).success?
+			end
+
+			private
+
+			def value_representation(name)
+				self.with(Representation, path: "values/#{name}")
+			end
+		end
+
+		class Namespaces < Representation
+			include Paginate
+
+			def representation
+				Namespace
+			end
+
+			def create(title)
+				represent_message(post(title: title))
+			end
+
+			def find_by_title(title)
+				each.find {|namespace| namespace.title == title }
+			end
+		end
+	end
+end

data/lib/cloudflare/paginate.rb

@@ -1,15 +1,15 @@
 # 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
@@ -21,34 +21,32 @@
 module Cloudflare
 	module Paginate
 		include Enumerable
-		
-		def empty?
-			self.value.empty?
-		end
-		
-		def representation
-			Representation
-		end
-		
+
 		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|
-					resource = @resource.with(path: attributes[:id])
-					
-					yield representation.new(resource, metadata: zones.metadata, value: attributes)
+					yield represent(zones.metadata, attributes)
 				end
-				
+
 				page += 1
-				
+
 				# Was this the last page?
-				break if zones.value.count < per_page
+				break if zones.value.size < per_page
 			end
 		end
+
+		def empty?
+			self.value.empty?
+		end
+
+		def find_by_id(id)
+			representation.new(@resource.with(path: id))
+		end
 	end
 end

data/lib/cloudflare/representation.rb

@@ -29,62 +29,79 @@ module Cloudflare
 	class RequestError < StandardError
 		def initialize(resource, errors)
 			super("#{resource}: #{errors.map{|attributes| attributes[:message]}.join(', ')}")
-			
+
 			@representation = representation
 		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)
 		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]
 		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

data/lib/cloudflare/rspec/connection.rb

@@ -21,6 +21,8 @@
 # THE SOFTWARE.
 
 require 'async/rspec'
+require 'async/http/proxy'
+
 require_relative '../../cloudflare'
 
 module Cloudflare
@@ -35,10 +37,20 @@ module Cloudflare
 			let(:email) {ENV['CLOUDFLARE_EMAIL']}
 			let(:key) {ENV['CLOUDFLARE_KEY']}
 			
-			let(:connection) {@connection = Cloudflare.connect(key: key, email: email)}
+			let(:connection) do
+				if proxy_url = ENV['CLOUDFLARE_PROXY']
+					proxy_endpoint = Async::HTTP::Endpoint.parse(proxy_url)
+					@client = Async::HTTP::Client.new(proxy_endpoint)
+					@connection = Cloudflare.connect(@client.proxied_endpoint(DEFAULT_ENDPOINT), key: key, email: email)
+				else
+					@client = nil
+					@connection = Cloudflare.connect(key: key, email: email)
+				end
+			end
 			
 			after do
 				@connection&.close
+				@client&.close
 			end
 		end
 	end

data/lib/cloudflare/version.rb

@@ -22,5 +22,5 @@
 # THE SOFTWARE.
 
 module Cloudflare
-	VERSION = '4.0.1'
+	VERSION = '4.2.0'
 end

data/lib/cloudflare/zones.rb

@@ -25,22 +25,27 @@
 require_relative 'representation'
 require_relative 'paginate'
 
+require_relative 'custom_hostnames'
 require_relative 'firewall'
 require_relative 'dns'
 require_relative 'logs'
 
 module Cloudflare
 	class Zone < Representation
+		def custom_hostnames
+			self.with(CustomHostnames, path: 'custom_hostnames')
+		end
+
 		def dns_records
-			DNS::Records.new(@resource.with(path: 'dns_records'))
+			self.with(DNS::Records, path: 'dns_records')
 		end
 		
 		def firewall_rules
-			Firewall::Rules.new(@resource.with(path: 'firewall/access_rules/rules'))
+			self.with(Firewall::Rules, path: 'firewall/access_rules/rules')
 		end
 		
 		def logs
-			Logs::Received.new(@resource.with(path: 'logs/received'))
+			self.with(Logs::Received, path: 'logs/received')
 		end
 		
 		DEFAULT_PURGE_CACHE_PARAMS = {
@@ -48,9 +53,9 @@ module Cloudflare
 		}.freeze
 		
 		def purge_cache(parameters = DEFAULT_PURGE_CACHE_PARAMS)
-			message = self.with(path: 'purge_cache').post(parameters)
+			self.with(Zone, path: 'purge_cache').post(parameters)
 			
-			return message.success?
+			return self
 		end
 		
 		def name
@@ -66,22 +71,13 @@ module Cloudflare
 		def representation
 			Zone
 		end
-		
+
 		def create(name, account, jump_start = false)
-			message = self.post(name: name, account: account.to_hash, jump_start: jump_start)
-			
-			id = message.result[:id]
-			resource = @resource.with(path: id)
-			
-			return representation.new(resource, metadata: message.headers, value: message.result)
+			represent_message(self.post(name: name, account: account.to_hash, jump_start: jump_start))
 		end
-		
+
 		def find_by_name(name)
 			each(name: name).first
 		end
-
-		def find_by_id(id)
-			Zone.new(@resource.with(path: id))
-		end
 	end
 end