cloudflare 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a110e823c75c13f404a65302681c7dfa94259b7
-  data.tar.gz: 9124f505ca1db512e237515ffb5936921a2981b6
+  metadata.gz: 7803b3a770a2ca6cfe874d77a7172bce3b0a3016
+  data.tar.gz: 8e97d03f70b94c9c6e5534adeff3fd9258c6a56c
 SHA512:
-  metadata.gz: 45ece12909dddffe400565bad14412a58d33d1e062a4744676a4b1a6cc3e33a959aa56ee8a6d5f022c34fa31909edc46a3a9b3f7e56e84a2b4d6fb0d4fe22da2
-  data.tar.gz: 7190a218eeb9dd39b2dc43c1ce4c8ed7b9a5bd20aefdfbd3be583886f16d601360d53eb58d4fd5e4d0f1f92910cbefc9c1372785c4799ecbaac83603502f76e5
+  metadata.gz: df0801c3eaeca54ebdf36c45eecb85ae27f39eeae1163474ace6fda7211357aae6c9ddefee4f4fa12a45a34d99509011965e9d2af4d9e4139f75dbb7ee68c6d4
+  data.tar.gz: bb7ee1e783f5288612252a2908ef7e1d8b27daa2ba5c96947b09faf35fb6b536c91512d0fda099c6cac3a453ec8db9a8211fa5fcf12069b9a82c382e57b4c562

data/.gitignore

@@ -0,0 +1,6 @@
+t/
+Gemfile*
+*.gem
+tags
+.byebug_history
+.rspec_status

data/Gemfile

@@ -6,8 +6,6 @@ gemspec
 group :development do
 	gem 'pry'
 	gem 'pry-coolline'
-	
-	gem 'tty-prompt'
 end
 
 group :test do

data/README.md

@@ -66,6 +66,29 @@ puts records.first.record[:name]
 puts records
 ```
 
+Get firewall rules:
+
+```ruby
+all_rules =  zones.first.firewall_rules.all
+block_rules = zones.first.firewall_rules.all("block")  # or "whitelist" or "challenge"
+```
+
+Get blocked ips:
+
+```ruby
+block_rules = zones.first.firewall_rules.all("block") 
+blocked_ips = zones.first.firewall_rules.firewalled_ips(block_rules)
+```
+
+Block an ip:
+
+```ruby
+# ip = "nnn.nnn.nnn.nnn"
+# note: "some note about the block"
+data = {"mode":"block","configuration":{"target":"ip","value":"#{ip}"},"notes":"#{note} #{Time.now.strftime("%m/%d/%y")} "}
+response = zones.first.firewall_rules.post(data.to_json, content_type: 'application/json')
+```
+
 ## Contributing
 
 1. Fork it
@@ -84,7 +107,8 @@ puts records
 Released under the MIT license.
 
 Copyright, 2012, 2014, by [Marcin Prokop](https://github.com/b4k3r).  
-Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
+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
@@ -103,3 +127,6 @@ 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/lib/cloudflare/connection.rb

@@ -31,6 +31,8 @@ module Cloudflare
 	TIMEOUT = 10 # Default is 5 seconds
 	
 	class Resource < RestClient::Resource
+		include Enumerable
+		
 		# @param api_key [String] `X-Auth-Key` or `X-Auth-User-Service-Key` if no email provided.
 		# @param email [String] `X-Auth-Email`, your email address for the account.
 		def initialize(url = DEFAULT_URL, key: nil, email: nil, **options)
@@ -48,6 +50,22 @@ module Cloudflare
 				Response.new(response.request.url, response.body)
 			end
 		end
+
+		def paginate(obj, url, url_args = "")
+			page = 1
+			page_size = 100
+			results = []
+
+			# fetch and aggregate all pages
+			loop do
+				rules = obj.new(concat_urls(url, "?scope_type=organization#{url_args}&per_page=#{page_size}&page=#{page}"), self, **options)
+				results += rules.get.results
+				break if results.size % page_size != 0
+				page += 1
+			end
+			
+			return results
+		end
 	end
 	
 	class Connection < Resource

data/lib/cloudflare/version.rb

@@ -20,5 +20,5 @@
 # THE SOFTWARE.
 
 module Cloudflare
-	VERSION = '3.0.0'
+	VERSION = '3.1.0'
 end

data/lib/cloudflare/zone.rb

@@ -1,5 +1,6 @@
 # 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
@@ -34,7 +35,12 @@ module Cloudflare
 			
 			@record = record || self.get.result
 		end
-		
+
+		def update_content(content)
+			response = self.put({type: @record[:type], name: @record[:name], content: content}.to_json, content_type: 'application/json')
+			response.successful?
+		end
+
 		attr :record
 		
 		def to_s
@@ -52,7 +58,8 @@ module Cloudflare
 		attr :zone
 		
 		def all
-			self.get.results.map{|record| DNSRecord.new(concat_urls(url, record[:id]), record, **options)}
+			results = paginate(DNSRecords, url)
+			results.map{|record| DNSRecord.new(concat_urls(url, record[:id]), record, **options)}
 		end
 		
 		def find_by_name(name)
@@ -70,10 +77,78 @@ module Cloudflare
 		end
 	end
 	
-	class Zone < Resource
+	class FirewallRule < Resource
 		def initialize(url, record = nil, **options)
 			super(url, **options)
+
+			@record = record || self.get.result
+		end
+
+		attr :record
+
+		def to_s
+			"#{@record[:configuration][:value]} - #{@record[:mode]} - #{@record[:notes]}"
+		end
+	end
+
+	class FirewallRules < Resource
+		def initialize(url, zone, **options)
+			super(url, **options)
+
+			@zone = zone
+		end
+
+		attr :zone
+
+		def all(mode = nil, ip = nil, notes = nil)
+			url_args = ""
+			url_args.concat("&mode=#{mode}") if mode
+			url_args.concat("&configuration_value=#{ip}") if ip
+			url_args.concat("&notes=#{notes}") if notes
+
+			results = paginate(FirewallRules, url, url_args)
+			results.map{|record| FirewallRule.new(concat_urls(url, record[:id]), record, **options)}
+		end
+
+		def firewalled_ips(rules)
+			rules.collect {|r| r.record[:configuration][:value]}
+		end
+
+		def blocked_ips
+			firewalled_ips(all("block"))
+		end
+
+		def set(mode, ip, note)
+			data = {
+				mode: mode.to_s,
+				configuration: {
+					target: "ip",
+					value: ip.to_s,
+					notes: "cloudflare gem firewall_rules [#{mode}] #{note} #{Time.now.strftime("%m/%d/%y")}"
+				}
+			}
 			
+			post(data.to_json, content_type: 'application/json')
+		end
+
+		def unset(mode, value)
+			rule = send("find_by_#{mode}", value)
+			rule.delete
+		end
+
+		def find_by_id(id)
+			FirewallRule.new(concat_urls(url, id), **options)
+		end
+
+		def find_by_ip(ip)
+			rule = FirewallRule.new(concat_urls(url, "?configuration_value=#{ip}"), **options)
+			FirewallRule.new(concat_urls(url, rule.record.first[:id]), **options)
+		end
+	end
+
+	class Zone < Resource
+		def initialize(url, record = nil, **options)
+			super(url, **options)
 			@record = record || self.get.result
 		end
 		
@@ -83,6 +158,10 @@ module Cloudflare
 			@dns_records ||= DNSRecords.new(concat_urls(url, 'dns_records'), self, **options)
 		end
 		
+		def firewall_rules
+			@firewall_rules ||= FirewallRules.new(concat_urls(url, "firewall/access_rules/rules"), self, **options)
+		end
+
 		def to_s
 			@record[:name]
 		end
@@ -94,7 +173,7 @@ module Cloudflare
 		end
 		
 		def find_by_name(name)
-			record = self.get(params: {name: name}).result
+			response = self.get(params: {name: name})
 			
 			unless response.empty?
 				record = response.results.first

data/spec/cloudflare/zone_spec.rb

@@ -1,41 +1,92 @@
 
 RSpec.describe "Cloudflare DNS Zones" do
 	include_context Cloudflare::RSpec::Connection
-	
+
 	it "should list zones" do
 		zones = connection.zones.all
-		
+
 		expect(zones).to be_any
 	end
-	
+
 	describe Cloudflare::DNSRecords, order: :defined do
 		let(:zone) {connection.zones.all.first}
+
 		let(:name) {"test"}
-		
+		let(:ip) {"123.123.123.123"}
+		record = nil
+
+		it "should get all records" do
+				result = zone.dns_records.all
+
+				puts "===> #{result.size} records returned"
+				expect(result.size).to be > 0
+		end
+
+
 		it "should create dns record" do
 			response = zone.dns_records.post({
 				type: "A",
 				name: name,
-				content: "127.0.0.1",
+				content: ip,
 				ttl: 240,
 				proxied: false
 			}.to_json, content_type: 'application/json')
-			
+
 			expect(response).to be_successful
-			
+
 			result = response.result
 			expect(result).to include(:id, :type, :name, :content, :ttl)
+			record = result
 		end
-		
+
 		it "should delete dns record" do
-			dns_records = zone.dns_records.all
-			
-			expect(dns_records).to be_any
-			
-			dns_records.each do |record|
-				response = record.delete
+			dns_record = zone.dns_records.find_by_id(record[:id])
+			response = dns_record.delete
+			expect(response).to be_successful
+		end
+	end
+
+	describe Cloudflare::FirewallRules, order: :defined do
+		let(:zone) {connection.zones.all.first}
+		let(:name) {"test"}
+		let(:ip) {'123.123.123.123'}
+		let(:ip2) {'123.123.123.124'}
+		let(:notes) {"gemtest"}
+		record = nil
+		before do
+			response = zone.firewall_rules.set('block', ip2, notes)
+		end
+
+		it "should get all rules" do
+				result = zone.firewall_rules.all
+
+				puts "===> #{result.size} records returned"
+				expect(result.size).to be > 0
+		end
+
+		it "should create firewall rules for 'block', 'challenge', 'whitelist'" do
+
+			[:block, :challenge, :whitelist].each do |mode|
+				response = zone.firewall_rules.set(mode, ip, notes)
 				expect(response).to be_successful
+
+				result = response.result
+				expect(result).to include(:id, :mode, :notes, :configuration)
+				expect(result[:mode]).to eq mode.to_s
+				record = result
 			end
 		end
+
+		it "should delete firewall rule by record" do
+			response = zone.firewall_rules.unset('id', record[:id])
+
+			expect(response).to be_successful
+		end
+
+		it "should delete firewall rule by ip" do
+			response = zone.firewall_rules.unset('ip', ip2)
+
+			expect(response).to be_successful
+		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Marcin Prokop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,6 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.