cloudflare 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93312512447e91ad4a4e49d249d0474ce69304fbaed539a49cee2277afdc35f7
-  data.tar.gz: 40c655960faf06672e9b0720cb9e24bfa2b47d09e87bc6e24f23b7def429f014
+  metadata.gz: 8f5bd083595954567afddacb3dccb6ad1dbe614d3d654d6ec5edfb7967d99e19
+  data.tar.gz: f1ac3f29decb6108455805f5a24d68cda0ab7a142cd781b0df991ed11014835f
 SHA512:
-  metadata.gz: 212b1e7f5ec0c274676c6458a940eff14c9df4d2e43d990e1a03833bfa2ece184cb85e002a9eafe879ac6e8001e7750d23ebb07efb10bd8f1c02ae31686c5766
-  data.tar.gz: c8e62b92827dc64b0833f821f07b526164a1da58cd408dfbe9b597d5c64a38d51ab805359655049a4dc98ce3e2e520f330ddf58f98039cfcb6e04dfdbeea5c2a
+  metadata.gz: 6113d2ffeb66def38c41b35ed739a24f2d8b568596e0fc5623e55c8b49dd17954235e37c0288ccef0aaf0a370c54c8bec5a4321cb5b2bfdc5f461a438184300d
+  data.tar.gz: bc5c727f94c5078d0a506d9cf6006b7d46582802d24a3089dbc3a8000be48e28a14d072f7a7a6125f835a14d567cd51f1424f2142dea44e992dafcfaff7d0d29

data/.travis.yml

@@ -21,4 +21,5 @@ matrix:
 
 env:
   global:
-    secure: c5yG7N1r9nYuw47Y90jGeoHNvkL59AAC55dtPAhKP+gjXWW8hKbntj3oj+lVkxEqzRpzEQgYZzUElrP+6mJnb20ldclZg03L56243tMtVEcpGOx/MFhnIBkx3kKu1H6ydKKMxieHxjsLQ3vnpcIZ3p0skTQjYbjdu607tjbyg7s=
+    - CLOUDFLARE_TEST_ZONE_MANAGEMENT=true
+    - secure: c5yG7N1r9nYuw47Y90jGeoHNvkL59AAC55dtPAhKP+gjXWW8hKbntj3oj+lVkxEqzRpzEQgYZzUElrP+6mJnb20ldclZg03L56243tMtVEcpGOx/MFhnIBkx3kKu1H6ydKKMxieHxjsLQ3vnpcIZ3p0skTQjYbjdu607tjbyg7s=

data/README.md

@@ -36,7 +36,7 @@ require 'cloudflare'
 email = ENV['CLOUDFLARE_EMAIL']
 key = ENV['CLOUDFLARE_KEY']
 
-Cloudflare.connect(key: key, email: email) do
+Cloudflare.connect(key: key, email: email) do |connection|
 	# Get all available zones:
 	zones = connection.zones
 	

data/lib/cloudflare/accounts.rb

@@ -24,28 +24,24 @@
 
 require_relative 'representation'
 require_relative 'paginate'
+require_relative 'kv/namespaces'
 
 module Cloudflare
 	class Account < Representation
+		def id
+			value[:id]
+		end
+
+		def kv_namespaces
+			KV::Namespaces.new(@resource.with(path: 'storage/kv/namespaces'))
+		end
 	end
-	
+
 	class Accounts < Representation
 		include Paginate
-		
-		def represent(metadata, attributes)
-			resource = @resource.with(path: attributes[:id])
-			
-			return Account.new(resource, metadata: metadata, value: attributes)
-		end
-		
-		def create(name)
-			response = self.post(name: name)
-			
-			return represent(response.headers, response.read)
-		end
-		
-		def find_by_id(id)
-			Zone.new(@resource.with(path: id))
+
+		def representation
+			Account
 		end
 	end
 end

data/lib/cloudflare/custom_hostname/ssl_attribute.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative './ssl_attribute/settings'
+
+module Cloudflare
+	class CustomHostname < Representation
+		class SSLAttribute
+			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
+		end
+	end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Cloudflare
+	class CustomHostname < Representation
+		class SSLAttribute
+			class 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'
+				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)
+					else
+						@settings[key] = !value || value == 'off' ? 'off' : 'on'
+					end
+				end
+			end
+		end
+	end
+end

data/lib/cloudflare/custom_hostnames.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# This implements the Custom Hostname API
+# https://api.cloudflare.com/#custom-hostname-for-a-zone-properties
+
+require_relative 'custom_hostname/ssl_attribute'
+require_relative 'paginate'
+require_relative 'representation'
+
+module Cloudflare
+	class CustomHostname < Representation
+		# Only available if enabled for your zone
+		def custom_origin
+			value[:custom_origin_server]
+		end
+
+		# Only available if enabled for your zone
+		def custom_metadata
+			value[:custom_metadata]
+		end
+
+		def hostname
+			value[:hostname]
+		end
+
+		def id
+			value[:id]
+		end
+
+		def ssl
+			@ssl ||= SSLAttribute.new(value[: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?
+		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)
+		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
+		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))
+		end
+
+		def find_by_hostname(hostname)
+			each(hostname: hostname).first
+		end
+	end
+end

data/lib/cloudflare/dns.rb

@@ -40,22 +40,22 @@ module Cloudflare
 					name: @record[:name],
 					content: content
 				)
-				
+
 				@value = response.result
 			end
-			
+
 			def type
 				value[:type]
 			end
-			
+
 			def name
 				value[:name]
 			end
-			
+
 			def content
 				value[:content]
 			end
-			
+
 			def to_s
 				"#{@record[:name]} #{@record[:type]} #{@record[:content]}"
 			end
@@ -63,29 +63,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
+				Keys.new(@resource.with(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)
+				Representation.new(@resource.with(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
 			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/version.rb

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

data/lib/cloudflare/zones.rb

@@ -25,12 +25,17 @@
 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
+			CustomHostnames.new(@resource.with(path: 'custom_hostnames'))
+		end
+
 		def dns_records
 			DNS::Records.new(@resource.with(path: 'dns_records'))
 		end
@@ -48,9 +53,9 @@ module Cloudflare
 		}.freeze
 		
 		def purge_cache(parameters = DEFAULT_PURGE_CACHE_PARAMS)
-			message = self.with(path: 'purge_cache').post(parameters)
+			Zone.new(@resource.with(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

data/spec/cloudflare/accounts_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec.describe Cloudflare::Accounts, order: :defined, timeout: 30 do
+	include_context Cloudflare::Account
+
+	before do
+		account.id # Force a fetch if it hasn't happened yet
+	end
+
+	it 'can list existing accounts' do
+		accounts = connection.accounts.to_a
+		expect(accounts.any? {|a| a.id == account.id }).to be true
+	end
+
+	it 'can get a specific account' do
+		expect(connection.accounts.find_by_id(account.id).id).to eq account.id
+	end
+
+	it 'can generate a representation for the KV namespace endpoint' do
+		ns = connection.accounts.find_by_id(account.id).kv_namespaces
+		expect(ns).to be_kind_of(Cloudflare::KV::Namespaces)
+		expect(ns.resource.reference.path).to end_with("/#{account.id}/storage/kv/namespaces")
+	end
+end

data/spec/cloudflare/custom_hostname/ssl_attribute/settings_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe Cloudflare::CustomHostname::SSLAttribute::Settings do
+
+	subject { described_class.new({}) }
+
+	it 'has an accessor for ciphers' do
+		ciphers = double
+		expect(subject.ciphers).to be_nil
+		subject.ciphers = ciphers
+		expect(subject.ciphers).to be ciphers
+	end
+
+	it 'has a boolean accessor for http2' do
+		expect(subject.http2).to be_nil
+		expect(subject.http2?).to be false
+		subject.http2 = true
+		expect(subject.http2).to eq 'on'
+		expect(subject.http2?).to be true
+		subject.http2 = false
+		expect(subject.http2).to eq 'off'
+		expect(subject.http2?).to be false
+		subject.http2 = 'on'
+		expect(subject.http2).to eq 'on'
+		expect(subject.http2?).to be true
+		subject.http2 = 'off'
+		expect(subject.http2).to eq 'off'
+		expect(subject.http2?).to be false
+	end
+
+	it 'has an accessor for min_tls_version' do
+		tls_version = double
+		expect(subject.min_tls_version).to be_nil
+		subject.min_tls_version = tls_version
+		expect(subject.min_tls_version).to be tls_version
+	end
+
+	it 'has a boolean accessor for tls_1_3' do
+		expect(subject.tls_1_3).to be_nil
+		expect(subject.tls_1_3?).to be false
+		subject.tls_1_3 = true
+		expect(subject.tls_1_3).to eq 'on'
+		expect(subject.tls_1_3?).to be true
+		subject.tls_1_3 = false
+		expect(subject.tls_1_3).to eq 'off'
+		expect(subject.tls_1_3?).to be false
+		subject.tls_1_3 = 'on'
+		expect(subject.tls_1_3).to eq 'on'
+		expect(subject.tls_1_3?).to be true
+		subject.tls_1_3 = 'off'
+		expect(subject.tls_1_3).to eq 'off'
+		expect(subject.tls_1_3?).to be false
+	end
+
+
+end

data/spec/cloudflare/custom_hostname/ssl_attribute_spec.rb

@@ -0,0 +1,73 @@
+RSpec.describe Cloudflare::CustomHostname::SSLAttribute do
+
+	accessors = [:cname, :cname_target, :http_body, :http_url, :method, :status, :type, :validation_errors]
+
+	let(:original_hash) { {} }
+
+	subject { described_class.new(original_hash) }
+
+	accessors.each do |key|
+
+		it "has an accessor for the #{key} value" do
+			test_value = double
+			expect(subject.send(key)).to be_nil
+			original_hash[key] = test_value
+			expect(subject.send(key)).to be test_value
+		end
+
+	end
+
+	it '#active? returns true when the status is "active" and false otherwise' do
+		expect(subject.active?).to be false
+		original_hash[:status] = 'initializing'
+		expect(subject.active?).to be false
+		original_hash[:status] = 'pending_validation'
+		expect(subject.active?).to be false
+		original_hash[:status] = 'pending_deployment'
+		expect(subject.active?).to be false
+		original_hash[:status] = 'active'
+		expect(subject.active?).to be true
+	end
+
+	it '#pending_validation? returns true when the status is "pending_validation" and false otherwise' do
+		expect(subject.pending_validation?).to be false
+		original_hash[:status] = 'initializing'
+		expect(subject.pending_validation?).to be false
+		original_hash[:status] = 'active'
+		expect(subject.pending_validation?).to be false
+		original_hash[:status] = 'pending_deployment'
+		expect(subject.pending_validation?).to be false
+		original_hash[:status] = 'pending_validation'
+		expect(subject.pending_validation?).to be true
+	end
+
+	describe '#settings' do
+
+		it 'should return a Settings object' do
+			expect(subject.settings).to be_kind_of Cloudflare::CustomHostname::SSLAttribute::Settings
+		end
+
+		it 'initailizes the settings object with the value from the settings key' do
+			settings = { min_tls_version: double }
+			original_hash[:settings] = settings
+			expect(subject.settings.min_tls_version).to be settings[:min_tls_version]
+		end
+
+		it 'initializes the settings object with a new hash if the settings key does not exist' do
+			expected_value = double
+			expect(original_hash[:settings]).to be_nil
+			expect(subject.settings.min_tls_version).to be_nil
+			expect(original_hash[:settings]).not_to be_nil
+			original_hash[:settings][:min_tls_version] = expected_value
+			expect(subject.settings.min_tls_version).to be expected_value
+		end
+
+		it 'updates the stored hash with values set on the settings object' do
+			expected_value = double
+			expect(subject.settings.min_tls_version).to be_nil
+			subject.settings.min_tls_version = expected_value
+			expect(original_hash[:settings][:min_tls_version]).to be expected_value
+		end
+	end
+
+end

data/spec/cloudflare/custom_hostnames_spec.rb

@@ -0,0 +1,213 @@
+
+RSpec.describe Cloudflare::CustomHostnames, order: :defined, timeout: 30 do
+	include_context Cloudflare::Zone
+
+	let(:domain) { "www#{ENV['TRAVIS_JOB_ID'] || rand(1..5)}.ourtest.com" }
+
+	let(:record) { @record = zone.custom_hostnames.create(domain) }
+
+	let(:custom_origin) do
+		id = rand(1...100)
+		id += (job_id * 100) if job_id.positive?
+		subdomain = "origin-#{id}"
+		@dns_record = zone.dns_records.create("A", subdomain, "1.2.3.4") # This needs to exist or the calls will fail
+		"#{subdomain}.#{zone.name}"
+	end
+
+	after do
+		if defined? @record
+			expect(@record.delete).to be_success
+		end
+
+		if defined? @dns_record
+			expect(@dns_record.delete).to be_success
+		end
+	end
+
+	it 'can create a custom hostname record' do
+    expect(record).to be_kind_of Cloudflare::CustomHostname
+		expect(record.custom_metadata).to be_nil
+		expect(record.hostname).to eq domain
+		expect(record.custom_origin).to be_nil
+		expect(record.ssl.method).to eq 'http'
+		expect(record.ssl.type).to eq 'dv'
+	end
+
+	it 'can create a custom hostname record with a custom origin' do
+		begin
+			@record = zone.custom_hostnames.create(domain, origin: custom_origin)
+
+			expect(@record).to be_kind_of Cloudflare::CustomHostname
+			expect(@record.custom_metadata).to be_nil
+			expect(@record.hostname).to eq domain
+			expect(@record.custom_origin).to eq custom_origin
+			expect(@record.ssl.method).to eq 'http'
+			expect(@record.ssl.type).to eq 'dv'
+		rescue Cloudflare::RequestError => e
+			if e.message.include?('custom origin server has not been granted')
+				skip(e.message) # This currently doesn't work but might start eventually: https://github.com/socketry/async-rspec/issues/7
+			else
+				raise
+			end
+		end
+	end
+
+	it 'can create a custom hostname record with different ssl options' do
+		@record = zone.custom_hostnames.create(domain, ssl: { method: 'cname' })
+
+		expect(@record).to be_kind_of Cloudflare::CustomHostname
+		expect(@record.custom_metadata).to be_nil
+		expect(@record.hostname).to eq domain
+		expect(@record.custom_origin).to be_nil
+		expect(@record.ssl.method).to eq 'cname'
+		expect(@record.ssl.type).to eq 'dv'
+	end
+
+	it 'can create a custom hostname record with additional metadata' do
+		metadata = { a: rand(1..10) }
+
+		begin
+			@record = zone.custom_hostnames.create(domain, metadata: metadata)
+
+			expect(@record).to be_kind_of Cloudflare::CustomHostname
+			expect(@record.custom_metadata).to eq metadata
+			expect(@record.hostname).to eq domain
+			expect(@record.custom_origin).to be_nil
+			expect(@record.ssl.method).to eq 'http'
+			expect(@record.ssl.type).to eq 'dv'
+		rescue Cloudflare::RequestError => e
+			if e.message.include?('No custom metadata access has been allocated for this zone')
+				skip(e.message) # This currently doesn't work but might start eventually: https://github.com/socketry/async-rspec/issues/7
+			else
+				raise
+			end
+		end
+	end
+
+	it 'can look up an existing custom hostname by the hostname or id' do
+		expect(zone.custom_hostnames.find_by_hostname(record.hostname).id).to eq record.id
+		expect(zone.custom_hostnames.find_by_id(record.id).id).to eq record.id
+	end
+
+	context 'with existing record' do
+
+		it 'returns the hostname when calling #to_s' do
+			expect(record.to_s).to eq domain
+		end
+
+		it 'can update metadata' do
+			metadata = { c: rand(1..10) }
+
+			expect(record.custom_metadata).to be_nil
+
+			begin
+				record.update_settings(metadata: metadata)
+
+				# Make sure the existing object is updated
+				expect(record.custom_metadata).to eq metadata
+
+				# Verify that the server has the changes
+				found_record = zone.custom_hostnames.find_by_id(record.id)
+
+				expect(found_record.custom_metadata).to eq metadata
+				expect(found_record.hostname).to eq domain
+				expect(found_record.custom_origin).to be_nil
+			rescue Cloudflare::RequestError => e
+				if e.message.include?('No custom metadata access has been allocated for this zone')
+					skip(e.message) # This currently doesn't work but might start eventually: https://github.com/socketry/async-rspec/issues/7
+				else
+					raise
+				end
+			end
+		end
+
+		it 'can update the custom origin' do
+			expect(record.custom_origin).to be_nil
+
+			begin
+				record.update_settings(origin: custom_origin)
+
+				# Make sure the existing object is updated
+				expect(record.custom_origin).to eq custom_origin
+
+				# Verify that the server has the changes
+				found_record = zone.custom_hostnames.find_by_id(record.id)
+
+				expect(found_record.custom_metadata).to be_nil
+				expect(found_record.hostname).to eq domain
+				expect(found_record.custom_origin).to eq custom_origin
+			rescue Cloudflare::RequestError => e
+				if e.message.include?('custom origin server has not been granted')
+					skip(e.message) # This currently doesn't work but might start eventually: https://github.com/socketry/async-rspec/issues/7
+				else
+					raise
+				end
+			end
+		end
+
+		it 'can update ssl information' do
+				expect(record.ssl.method).to eq 'http'
+
+				record.update_settings(ssl: { method: 'cname', type: 'dv' })
+
+				# Make sure the existing object is updated
+				expect(record.ssl.method).to eq 'cname'
+
+				# Verify that the server has the changes
+				found_record = zone.custom_hostnames.find_by_id(record.id)
+
+				expect(found_record.custom_metadata).to be_nil
+				expect(found_record.hostname).to eq domain
+				expect(found_record.custom_origin).to be_nil
+				expect(found_record.ssl.method).to eq 'cname'
+		end
+
+		context 'has an ssl section' do
+
+			it 'wraps it in an SSLAttributes object' do
+				expect(record.ssl).to be_kind_of Cloudflare::CustomHostname::SSLAttribute
+			end
+
+			it 'has some helpers for commonly used keys' do
+				# Make sure our values exist before we check to make sure that they are returned correctly
+				expect(record.value[:ssl].values_at(:method, :http_body, :http_url).compact).not_to be_empty
+				expect(record.ssl.method).to be record.value[:ssl][:method]
+				expect(record.ssl.http_body).to be record.value[:ssl][:http_body]
+				expect(record.ssl.http_url).to be record.value[:ssl][:http_url]
+			end
+
+		end
+
+		describe '#ssl_active?' do
+
+			it 'returns the result of calling ssl.active?' do
+				expected_value = double
+				expect(record.ssl).to receive(:active?).and_return(expected_value)
+				expect(record).not_to receive(:send_patch)
+				expect(record.ssl_active?).to be expected_value
+			end
+
+			it 'returns the result of calling ssl.active? without triggering an update if force_update is true and the ssl is not in the pending_validation state' do
+				expected_value = double
+				expect(record.ssl).to receive(:active?).and_return(expected_value)
+				expect(record.ssl.method).not_to be_nil
+				expect(record.ssl.type).not_to be_nil
+				expect(record.ssl.pending_validation?).to be false
+				expect(record).not_to receive(:send_patch).with(ssl: { method: record.ssl.method, type: record.ssl.type })
+				expect(record.ssl_active?(true)).to be expected_value
+			end
+
+			it 'returns the result of calling ssl.active? after triggering an update if force_update is true and the ssl is in the pending_validation state' do
+				expected_value = double
+				expect(record.ssl).to receive(:active?).and_return(expected_value)
+				expect(record.ssl.method).not_to be_nil
+				expect(record.ssl.type).not_to be_nil
+				record.value[:ssl][:status] = 'pending_validation'
+				expect(record).to receive(:send_patch).with(ssl: { method: record.ssl.method, type: record.ssl.type })
+				expect(record.ssl_active?(true)).to be expected_value
+			end
+
+		end
+
+	end
+end

data/spec/cloudflare/kv/namespaces_spec.rb

@@ -0,0 +1,71 @@
+
+RSpec.describe Cloudflare::KV::Namespaces, kv_spec: true, order: :defined, timeout: 30 do
+	include_context Cloudflare::Account
+
+	let(:namespace) { @namespace = account.kv_namespaces.create(namespace_title) }
+	let(:namespace_title) { "Test NS ##{rand(1..100)}" }
+
+	after do
+		if defined? @namespace
+			expect(@namespace.delete).to be_success
+		end
+	end
+
+	it 'can create a namespace' do
+    expect(namespace).to be_kind_of Cloudflare::KV::Namespace
+		expect(namespace.id).not_to be_nil
+		expect(namespace.title).to eq namespace_title
+	end
+
+	it 'can find a namespace by title' do
+		namespace # Call this so that the namespace gets created
+		expect(account.kv_namespaces.find_by_title(namespace_title).id).to eq namespace.id
+	end
+
+	it 'can rename the namespace' do
+		new_title = "#{namespace_title}-#{rand(1..100)}"
+		namespace.rename(new_title)
+		expect(namespace.title).to eq new_title
+		expect(account.kv_namespaces.find_by_title(new_title).id).to eq namespace.id
+		expect(account.kv_namespaces.find_by_title(namespace_title)).to be_nil
+	end
+
+	it 'can store a key/value, read it back' do
+		key = "key-#{rand(1..100)}"
+		value = rand(100..999)
+		namespace.write_value(key, value)
+		expect(account.kv_namespaces.find_by_id(namespace.id).read_value(key)).to eq value.to_s
+	end
+
+	it 'can read a previously stored key' do
+		key = "key-#{rand(1..100)}"
+		value = rand(100..999)
+		expect(account.kv_namespaces.find_by_id(namespace.id).write_value(key, value)).to be true
+		expect(namespace.read_value(key)).to eq value.to_s
+	end
+
+	it 'can delete keys' do
+		key = "key-#{rand(1..100)}"
+		value = rand(100..999)
+		expect(namespace.write_value(key, value)).to be true
+		expect(namespace.read_value(key)).to eq value.to_s
+		expect(namespace.delete_value(key)).to be true
+		expect do
+			account.kv_namespaces.find_by_id(namespace.id).read_value(key)
+		end.to raise_error(Cloudflare::RequestError)
+	end
+
+	it 'can get the keys that exist in the namespace' do
+		counter = 0
+		keys = Array.new(rand(1..9)) { "key-#{counter += 1}" } # Keep this single digits so ordering works
+		keys.each_with_index do |key, i|
+			namespace.write_value(key, i)
+		end
+
+		saved_keys = account.kv_namespaces.find_by_id(namespace.id).keys.to_a
+		expect(saved_keys.length).to eq keys.length
+		saved_keys.each_with_index do |key, i|
+			expect(key.name).to eq keys[i]
+		end
+	end
+end

data/spec/cloudflare/zone_spec.rb

@@ -1,23 +1,25 @@
 
 RSpec.describe Cloudflare::Zones, order: :defined, timeout: 30 do
 	include_context Cloudflare::Zone
-	
-	it "can delete existing domain if exists" do
-		if zone = zones.find_by_name(name)
-			expect(zone.delete).to be_success
+
+	if ENV['CLOUDFLARE_TEST_ZONE_MANAGEMENT'] == 'true'
+		it "can delete existing domain if exists" do
+			if zone = zones.find_by_name(name)
+				expect(zone.delete).to be_success
+			end
+		end
+
+		it "can create a zone" do
+			zone = zones.create(name, account)
+			expect(zone.value).to include(:id)
 		end
 	end
-	
-	it "can create zone" do
-		zone = zones.create(name, account)
-		expect(zone.value).to include(:id)
-	end
-	
+
 	it "can list zones" do
 		matching_zones = zones.select{|zone| zone.name == name}
 		expect(matching_zones).to_not be_empty
 	end
-	
+
 	it "can get zone by name" do
 		found_zone = zones.find_by_name(name)
 		expect(found_zone.name).to be == name

data/spec/spec_helper.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+AUTH_EMAIL = ENV['CLOUDFLARE_EMAIL']
+AUTH_KEY = ENV['CLOUDFLARE_KEY']
+
+if AUTH_EMAIL.nil? || AUTH_EMAIL.empty? || AUTH_KEY.nil? || AUTH_KEY.empty?
+	puts 'Please make sure you have defined CLOUDFLARE_EMAIL and CLOUDFLARE_KEY in your environment'
+	puts 'You can also specify CLOUDFLARE_ZONE_NAME to test with your own zone and'
+	puts 'CLOUDFLARE_ACCOUNT_ID to use a specific account'
+	exit(1)
+end
+
+ACCOUNT_ID = ENV['CLOUDFLARE_ACCOUNT_ID']
+NAMES = ['testing', 'horse', 'cat', 'dog', 'fish', 'dolphin', 'lion', 'tiger'].freeze
+JOB_ID = ENV.fetch('TRAVIS_JOB_ID', 0).to_i
+ZONE_NAME = ENV['CLOUDFLARE_ZONE_NAME'] || "#{NAMES[JOB_ID % NAMES.size]}.com"
 
 require 'covered/rspec'
 require 'async/rspec'
@@ -5,18 +21,30 @@ require 'async/rspec'
 require 'cloudflare/rspec/connection'
 require 'cloudflare/zones'
 
-RSpec.shared_context Cloudflare::Zone do
+RSpec.shared_context Cloudflare::Account do
 	include_context Cloudflare::RSpec::Connection
-	
-	let(:job_id) {ENV.fetch('TRAVIS_JOB_ID', 0).to_i}
-	let(:names) {['testing', 'horse', 'cat', 'dog', 'fish', 'dolphin', 'lion', 'tiger']}
-	let(:name) {"#{names[job_id % names.size]}.com"}
-	
-	let(:account) {connection.accounts.first}
+
+	let(:account) do
+		if ACCOUNT_ID
+			connection.accounts.find_by_id(ACCOUNT_ID)
+		else
+			connection.accounts.first
+		end
+	end
+
+end
+
+RSpec.shared_context Cloudflare::Zone do
+	include_context Cloudflare::Account
+
+	let(:job_id) { JOB_ID }
+	let(:names) { NAMES.dup }
+	let(:name) { ZONE_NAME.dup }
+
 	let(:zones) {connection.zones}
-	
+
 	let(:zone) {@zone = zones.find_by_name(name) || zones.create(name, account)}
-	
+
 	# after do
 	# 	if defined? @zone
 	# 		@zone.delete
@@ -31,4 +59,27 @@ RSpec.configure do |config|
 	config.expect_with :rspec do |c|
 		c.syntax = :expect
 	end
+
+	disabled_specs = {}
+
+	# Check for features the current account has enabled
+	Cloudflare.connect(key: AUTH_KEY, email: AUTH_EMAIL) do |conn|
+		begin
+			account = if ACCOUNT_ID
+				conn.accounts.find_by_id(ACCOUNT_ID)
+			else
+				conn.accounts.first
+			end
+			account.kv_namespaces.to_a
+		rescue Cloudflare::RequestError => e
+			if e.message.include?('your account is not permitted')
+				puts 'Disabling KV specs due to no access'
+				disabled_specs[:kv_spec] = true
+			else
+				raise
+			end
+		end
+	end
+
+	config.filter_run_excluding disabled_specs unless disabled_specs.empty?
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Marcin Prokop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2019-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -113,8 +113,12 @@ files:
 - lib/cloudflare.rb
 - lib/cloudflare/accounts.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/kv/namespaces.rb
 - lib/cloudflare/logs.rb
 - lib/cloudflare/paginate.rb
 - lib/cloudflare/representation.rb
@@ -122,8 +126,13 @@ files:
 - lib/cloudflare/user.rb
 - lib/cloudflare/version.rb
 - lib/cloudflare/zones.rb
+- spec/cloudflare/accounts_spec.rb
+- spec/cloudflare/custom_hostname/ssl_attribute/settings_spec.rb
+- spec/cloudflare/custom_hostname/ssl_attribute_spec.rb
+- spec/cloudflare/custom_hostnames_spec.rb
 - spec/cloudflare/dns_spec.rb
 - spec/cloudflare/firewall_spec.rb
+- spec/cloudflare/kv/namespaces_spec.rb
 - spec/cloudflare/zone_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/b4k3r/cloudflare
@@ -145,12 +154,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.
 test_files:
+- spec/cloudflare/accounts_spec.rb
+- spec/cloudflare/custom_hostname/ssl_attribute/settings_spec.rb
+- spec/cloudflare/custom_hostname/ssl_attribute_spec.rb
+- spec/cloudflare/custom_hostnames_spec.rb
 - spec/cloudflare/dns_spec.rb
 - spec/cloudflare/firewall_spec.rb
+- spec/cloudflare/kv/namespaces_spec.rb
 - spec/cloudflare/zone_spec.rb
 - spec/spec_helper.rb