cloudflare 3.2.1 → 4.0.0

data/lib/cloudflare/firewall.rb

@@ -0,0 +1,80 @@
+# 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.
+
+require_relative 'representation'
+require_relative 'paginate'
+
+module Cloudflare
+	module Firewall
+		class Rule < Representation
+			def mode
+				value[:mode]
+			end
+			
+			def notes
+				value[:notes]
+			end
+			
+			def configuration
+				value[: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')
+				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,
+					}
+				})
+				
+				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))
+			end
+			
+			def each_by_value(value, &block)
+				each(configuration_value: value, &block)
+			end
+		end
+	end
+end

data/lib/cloudflare/logs.rb

@@ -0,0 +1,41 @@
+# 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.
+
+require_relative 'representation'
+require_relative 'paginate'
+
+module Cloudflare
+	module Logs
+		class Entry < Representation
+			def to_s
+				"#{value[:rayid]}-#{value[:ClientRequestURI]}"
+			end
+		end
+	
+		class Received < Representation
+			include Paginate
+			
+			def representation
+				Entry
+			end
+		end
+	end
+end
+

data/lib/cloudflare/paginate.rb

@@ -0,0 +1,54 @@
+# 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.
+
+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)
+				end
+				
+				page += 1
+				
+				# Was this the last page?
+				break if zones.value.count < per_page
+			end
+		end
+	end
+end

data/lib/cloudflare/representation.rb

@@ -0,0 +1,94 @@
+# 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.
+
+require 'json'
+
+require 'async/rest/representation'
+
+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
+		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 to_hash
+			if value.is_a?(Hash)
+				return value
+			end
+		end
+	end
+end

data/lib/cloudflare/rspec/connection.rb

@@ -20,19 +20,26 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'async/rspec'
 require_relative '../../cloudflare'
 
 module Cloudflare
-  module RSpec
-    module Connection
-    end
+	module RSpec
+		module Connection
+		end
 
-    RSpec.shared_context Connection do
-      # You must specify these in order for the tests to run.
-      let(:email) { 'jake@example.net' }
-      let(:key) { '5up3rS3cr3tAuthK3y' }
-
-      let(:connection) { Cloudflare.connect(key: key, email: email) }
-    end
-  end
+		RSpec.shared_context Connection do
+			include_context Async::RSpec::Reactor
+			
+			# You must specify these in order for the tests to run.
+			let(:email) {ENV['CLOUDFLARE_EMAIL']}
+			let(:key) {ENV['CLOUDFLARE_KEY']}
+			
+			let(:connection) {@connection = Cloudflare.connect(key: key, email: email)}
+			
+			after do
+				@connection&.close
+			end
+		end
+	end
 end

data/lib/cloudflare/user.rb

@@ -21,15 +21,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'connection'
+require_relative 'representation'
 
 module Cloudflare
-  class Connection < Resource
-    def user
-      @user ||= User.new(concat_urls(url, 'user'), options)
-    end
-  end
-
-  class User < Resource
-  end
+	class User < Representation
+		def id
+			value[:id]
+		end
+		
+		def email
+			value[:email]
+		end
+	end
 end

data/lib/cloudflare/version.rb

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

data/lib/cloudflare/zones.rb

@@ -0,0 +1,85 @@
+# 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.
+
+require_relative 'representation'
+require_relative 'paginate'
+
+require_relative 'firewall'
+require_relative 'dns'
+require_relative 'logs'
+
+module Cloudflare
+	class Zone < Representation
+		def dns_records
+			DNS::Records.new(@resource.with(path: 'dns_records'))
+		end
+		
+		def firewall_rules
+			Firewall::Rules.new(@resource.with(path: 'firewall/access_rules/rules'))
+		end
+		
+		def logs
+			Logs::Received.new(@resource.with(path: 'logs/received'))
+		end
+		
+		DEFAULT_PURGE_CACHE_PARAMS = {
+			purge_everything: true
+		}.freeze
+		
+		def purge_cache(parameters = DEFAULT_PURGE_CACHE_PARAMS)
+			message = self.with(path: 'purge_cache').post(parameters)
+			
+			return message.success?
+		end
+		
+		def name
+			value[:name]
+		end
+	end
+	
+	class Zones < Representation
+		include Paginate
+		
+		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)
+		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/dns_spec.rb

@@ -0,0 +1,32 @@
+
+require 'cloudflare/rspec/connection'
+
+RSpec.describe Cloudflare::DNS, order: :defined, timeout: 30 do
+	include_context Cloudflare::Zone
+	
+	let(:subdomain) {"www#{ENV['TRAVIS_JOB_ID']}"}
+	
+	let(:record) {@record = zone.dns_records.create("A", subdomain, "1.2.3.4")}
+	
+	after do
+		if defined? @record
+			expect(@record.delete).to be_success
+		end
+	end
+	
+	it "can create dns record" do
+		expect(record.type).to be == "A"
+		expect(record.name).to be_start_with subdomain
+		expect(record.content).to be == "1.2.3.4"
+	end
+	
+	context "with existing record" do
+		it "can update dns content" do
+			record.update_content("4.3.2.1")
+			expect(record.content).to be == "4.3.2.1"
+			
+			fetched_record = zone.dns_records.find_by_name(record.name)
+			expect(fetched_record.content).to be == record.content
+		end
+	end
+end