cloudflare 4.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93312512447e91ad4a4e49d249d0474ce69304fbaed539a49cee2277afdc35f7
-  data.tar.gz: 40c655960faf06672e9b0720cb9e24bfa2b47d09e87bc6e24f23b7def429f014
+  metadata.gz: 9da58bc3e8cf7394296aafbe26d50731d145f1587df2ecd940057c01de31585c
+  data.tar.gz: 0b8523d30369c61c1fa5aaf1d749daa9a05c03f36c1a9aa898bb5782e662fa6c
 SHA512:
-  metadata.gz: 212b1e7f5ec0c274676c6458a940eff14c9df4d2e43d990e1a03833bfa2ece184cb85e002a9eafe879ac6e8001e7750d23ebb07efb10bd8f1c02ae31686c5766
-  data.tar.gz: c8e62b92827dc64b0833f821f07b526164a1da58cd408dfbe9b597d5c64a38d51ab805359655049a4dc98ce3e2e520f330ddf58f98039cfcb6e04dfdbeea5c2a
+  metadata.gz: 8079f41055721191fd999e1b4e948d0061bf5e710503940c07d4125a315c812cda8e5603cc891e50671f5992dbc75ab1e65d6a297c9f6656db0317e85784cc35
+  data.tar.gz: 9f6ac470ada76aea32143026ac1b7923b76b0b50775a362759817dd7fc3118b792d6ad36f4dcd2829e3b3faba097f3c1072e01db3d1a9d21ab5c653285421683

data/.gitignore

@@ -1,6 +1,14 @@
-t/
-Gemfile*
-*.gem
-tags
-.byebug_history
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
 .rspec_status
+.covered.db
+.env

data/.travis.yml

@@ -2,9 +2,13 @@ language: ruby
 dist: xenial
 cache: bundler
 
+addons:
+  apt:
+    packages:
+    - squid
+
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
@@ -14,6 +18,12 @@ matrix:
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: truffleruby
     - rvm: ruby-head
+    - rvm: 2.6
+      env: CLOUDFLARE_PROXY=http://localhost:3128
+      before_script: sudo service squid start
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O" CLOUDFLARE_PROXY=http://localhost:3128
+      before_script: sudo service squid start
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
@@ -21,4 +31,5 @@ matrix:
 
 env:
   global:
-    secure: c5yG7N1r9nYuw47Y90jGeoHNvkL59AAC55dtPAhKP+gjXWW8hKbntj3oj+lVkxEqzRpzEQgYZzUElrP+6mJnb20ldclZg03L56243tMtVEcpGOx/MFhnIBkx3kKu1H6ydKKMxieHxjsLQ3vnpcIZ3p0skTQjYbjdu607tjbyg7s=
+    - CLOUDFLARE_TEST_ZONE_MANAGEMENT=true
+    - secure: c5yG7N1r9nYuw47Y90jGeoHNvkL59AAC55dtPAhKP+gjXWW8hKbntj3oj+lVkxEqzRpzEQgYZzUElrP+6mJnb20ldclZg03L56243tMtVEcpGOx/MFhnIBkx3kKu1H6ydKKMxieHxjsLQ3vnpcIZ3p0skTQjYbjdu607tjbyg7s=

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudflare.gemspec
+gemspec
+
+gem 'async-http', '~> 0.48', '>= 0.48.2'
+
+group :development do
+	gem 'pry'
+	gem 'pry-coolline'
+end
+
+group :test do
+	gem 'coveralls', require: false
+	gem 'simplecov'
+	gem 'sinatra'
+	gem 'webmock'
+end

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
 	
@@ -63,6 +63,20 @@ Cloudflare.connect(key: key, email: email) do
 end
 ```
 
+### Using a Bearer Token
+
+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'
+
+token = 'a_generated_api_token'
+
+Cloudflare.connect(token: token) do |connection|
+	# ...
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -101,6 +115,3 @@ 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.
-
-
-

data/cloudflare.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
 	spec.required_ruby_version = '>= 2.0.0'
 
-	spec.add_dependency 'async-rest'
+	spec.add_dependency 'async-rest', '~> 0.10.0'
 
 	spec.add_development_dependency 'async-rspec'
 

data/lib/cloudflare.rb

@@ -25,13 +25,13 @@ require 'async'
 require_relative 'cloudflare/connection'
 
 module Cloudflare
-	DEFAULT_URL = 'https://api.cloudflare.com/client/v4'
+	DEFAULT_ENDPOINT = Async::HTTP::Endpoint.parse('https://api.cloudflare.com/client/v4')
 	
-	def self.connect(key: nil, email: nil)
-		representation = Connection.for(DEFAULT_URL)
+	def self.connect(endpoint = DEFAULT_ENDPOINT, **auth_info)
+		representation = Connection.for(endpoint)
 		
-		if key
-			representation = representation.authenticated(key, email)
+		if !auth_info.empty?
+			representation = representation.authenticated(**auth_info)
 		end
 		
 		return representation unless block_given?

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
+			self.with(KV::Namespaces, 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/connection.rb

@@ -28,29 +28,33 @@ require_relative 'user'
 
 module Cloudflare
 	class Connection < Representation
-		def authenticated(key, email = nil)
+		def authenticated(token: nil, key: nil, email: nil)
 			headers = {}
 			
-			if email.nil?
-				headers['X-Auth-User-Service-Key'] = key
-			else
-				headers['X-Auth-Key'] = key
-				headers['X-Auth-Email'] = email
+			if token
+				headers['Authorization'] = "Bearer #{token}"
+			elsif key
+				if email
+					headers['X-Auth-Key'] = key
+					headers['X-Auth-Email'] = email
+				else
+					headers['X-Auth-User-Service-Key'] = key
+				end
 			end
 			
-			self.class.new(@resource.with(headers: headers))
+			self.with(headers: headers)
 		end
 		
 		def zones
-			Zones.new(@resource.with(path: 'zones'))
+			self.with(Zones, path: 'zones')
 		end
 		
 		def accounts
-			Accounts.new(@resource.with(path: 'accounts'))
+			self.with(Accounts, path: 'accounts')
 		end
 		
 		def user
-			User.new(@resource.with(path: 'user'))
+			self.with(User, path: 'user')
 		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