cloudflare 3.1.0 → 3.2.0

data/spec/cloudflare/zone_spec.rb

@@ -1,92 +1,126 @@
-
-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: 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_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
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+RSpec.describe 'Cloudflare DNS Zones' do
+  include_context Cloudflare::RSpec::Connection
+
+  before(:each) { stub_get_zones }
+  it 'should list zones' do
+    zones = connection.zones.all
+    expect(zones).to be_any
+  end
+
+  describe Cloudflare::Zone, order: :defined do
+    before(:each) do
+      stub_get_zones
+      stub_purge_cache
+    end
+
+    let(:zone) { connection.zones.all.first }
+
+    describe '#purge_cache' do
+      it 'should purge cache' do
+        expect(zone.purge_cache).to eq(true)
+      end
+    end
+  end
+
+  describe Cloudflare::DNSRecords, order: :defined do
+    before(:each) do
+      stub_get_zones
+      stub_get_dns_records
+      stub_create_dns_record
+      stub_delete_dns_record '123123123'
+      stub_find_dns_record_by_id '123123123'
+    end
+    let(:zone) { connection.zones.all.first }
+
+    let(:name) { 'test' }
+    let(:ip) { '123.123.123.123' }
+
+    it 'should get all records' do
+      result = zone.dns_records.all
+      expect(result.size).to be > 0
+    end
+
+    it 'should create dns record' do
+      response = zone.dns_records.post({
+        type: 'A',
+        name: name,
+        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)
+    end
+
+    before do
+      stub_get_dns_record '1231231234'
+      stub_delete_dns_record '1231231234'
+    end
+    it 'should delete dns record' do
+      dns_record = zone.dns_records.find_by_id('1231231234')
+      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' }
+    before do
+      stub_get_zones
+      stub_create_rule 'block', ip2, notes
+      stub_list_access_rules 1, [cf_access_rule('whitelist', ip, notes)]
+      stub_list_access_rules 2, [cf_access_rule('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
+
+    %i[block challenge whitelist].each do |mode|
+      it "should create a #{mode} rule" do
+        stub_create_rule mode, ip, notes
+        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
+      end
+    end
+    before do
+      stub_get_access_rule('123123123')
+      stub_delete_access_rule(id: '123123123')
+    end
+    it 'should delete firewall rule by record' do
+      response = zone.firewall_rules.unset('id', '123123123')
+      assert_requested stub_get_access_rule('123123123')
+      assert_requested stub_delete_access_rule(id: '123123123')
+      expect(response).to be_successful
+    end
+
+    before do
+      stub_find_rule_by_value ip: ip2
+      stub_get_access_rule '123123124'
+      stub_delete_access_rule id: '123123124'
+    end
+    it 'should delete firewall rule by ip' do
+      response = zone.firewall_rules.unset('ip', ip2)
+      expect(response).to be_successful
+    end
+  end
 end
+# rubocop:enable Metrics/BlockLength

data/spec/fake_cloudflare/cloudflare.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+class FakeCloudFlare < Sinatra::Base
+  get '/zones/:id/dns_records/?page=1&per_page=50&scope_type=organization' do
+    json_response 200, 'get_all_zones.json'
+  end
+
+  private
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+end

data/spec/spec_helper.rb

@@ -1,30 +1,177 @@
+# frozen_string_literal: true
 
 if ENV['COVERAGE'] || ENV['TRAVIS']
-	begin
-		require 'simplecov'
-		
-		SimpleCov.start do
-			add_filter "/spec/"
-		end
-		
-		if ENV['TRAVIS']
-			require 'coveralls'
-			Coveralls.wear!
-		end
-	rescue LoadError
-		warn "Could not load simplecov: #{$!}"
-	end
-end
-
-require "bundler/setup"
-require "cloudflare"
-require "cloudflare/rspec/connection"
+  begin
+    require 'simplecov'
+
+    SimpleCov.start do
+      add_filter '/spec/'
+    end
+  rescue LoadError
+    warn "Could not load simplecov: #{$ERROR_INFO}"
+  end
+end
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+require 'bundler/setup'
+require 'cloudflare'
+require 'cloudflare/rspec/connection'
+
+def base_url
+  %(https://api.cloudflare.com/client/v4)
+end
+
+def zone_id
+  '1337z0n31d3n71f13r'
+end
+
+def stub_get_zones
+  stub_request(:get, "#{base_url}/zones/?page=1&per_page=50&scope_type=organization")
+      .with(cf_headers)
+      .to_return(status: 200, body: cf_results([{
+                                                    name: 'example.com',
+                                                    ip: '123.123.123.123',
+                                                    id: zone_id
+                                                }]),
+                 headers: {})
+end
+
+def stub_get_dns_records
+  dns_record = {
+      "id": 'b12a037696862c2fc1d45a0e288c82a5',
+      "type": 'A',
+      "name": 'www.example.com',
+      "content": '123.123.123.123',
+      "ttl": 1,
+      "zone_id": zone_id,
+      "zone_name": 'example.com'
+  }
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/dns_records/?page=1&per_page=50&scope_type=organization")
+      .with(cf_headers)
+      .to_return(status: 200,
+                 body: cf_results([dns_record]),
+                 headers: {})
+end
+
+def stub_create_dns_record
+  stub_request(:post, "#{base_url}/zones/#{zone_id}/dns_records")
+      .with(cf_headers('Content-Type': 'application/json'))
+      .with(
+          body: hash_including(:type, :name, :content, :ttl, :proxied)
+      )
+      .to_return(status: 200,
+                 body: cf_results(id: '123231123', type: 'A', name: 'test', content: '123.123.123.123', ttl: 240),
+                 headers: {})
+end
+
+def stub_find_dns_record_by_id(id)
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/dns_records")
+      .with(query: {id: id})
+      .with(cf_headers)
+      .to_return(status: 200,
+                 body: cf_results(
+                     id: '123231123',
+                     type: 'A',
+                     name: 'test',
+                     content: '123.123.123.123',
+                     ttl: 240
+                 ),
+                 headers: {})
+end
+
+def stub_get_dns_record(id)
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/dns_records/#{id}")
+      .with(cf_headers)
+      .to_return(status: 200,
+                 body: cf_results(
+                     id: '123231123',
+                     type: 'A',
+                     name: 'test',
+                     content: '123.123.123.123',
+                     ttl: 240
+                 ),
+                 headers: {})
+end
+
+def stub_delete_dns_record(id)
+  stub_request(:delete, "#{base_url}/zones/#{zone_id}/dns_records/#{id}")
+      .with(cf_headers)
+      .to_return(status: 200, body: cf_results(id: id), headers: {})
+end
+
+def stub_find_rule_by_value(ip:)
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/firewall/access_rules/rules/?configuration_value=#{ip}")
+      .with(cf_headers)
+      .to_return(status: 200,
+                 body: cf_results([cf_access_rule('block', '123.123.123.124', 'gemtest')]),
+                 headers: {})
+end
+
+def stub_list_access_rules(page, rules)
+  query = URI.encode_www_form(page: page, per_page: 50, scope_type: :organization)
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/firewall/access_rules/rules/?#{query}")
+      .with(cf_headers)
+      .to_return(status: 200, body: cf_results(rules), headers: {})
+end
+
+def stub_get_access_rule(id)
+  stub_request(:get, "#{base_url}/zones/#{zone_id}/firewall/access_rules/rules/#{id}")
+      .with(cf_headers)
+      .to_return(status: 200,
+                 body: cf_results(cf_access_rule('whitelist', '123.123.123.124', 'gemtest', id)),
+                 headers: {})
+end
+
+def stub_delete_access_rule(id: nil)
+  stub_request(:delete, "#{base_url}/zones/#{zone_id}/firewall/access_rules/rules/#{id}")
+      .with(cf_headers)
+      .to_return(status: 200, body: cf_results(id: id), headers: {})
+end
+
+def stub_create_rule(mode, ip, note)
+  notes = "cloudflare gem firewall_rules [#{mode}] #{note} #{Time.now.strftime('%m/%d/%y')}"
+  body = "{\"mode\":\"#{mode}\",\"configuration\":{\"target\":\"ip\",\"value\":\"#{ip}\",\"notes\":\"#{notes}\"}}"
+  stub_request(:post, "https://api.cloudflare.com/client/v4/zones/#{zone_id}/firewall/access_rules/rules")
+      .with(cf_headers(
+                'Content-Length' => body.bytesize,
+                'Content-Type' => 'application/json'
+            ))
+      .with(body: body)
+      .to_return(status: 200, body: cf_results(cf_access_rule(mode, ip, notes)), headers: {})
+end
+
+def stub_purge_cache
+  stub_request(:post, "#{base_url}/zones/#{zone_id}/purge_cache")
+      .with(cf_headers)
+      .to_return(status: 200, body: cf_results(id: zone_id), headers: {})
+end
 
 RSpec.configure do |config|
-	# Enable flags like --only-failures and --next-failure
-	config.example_status_persistence_file_path = ".rspec_status"
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def cf_results(result, messages = [], errors = [])
+  {result: result, success: true, messages: messages, errors: errors}.to_json
+end
+
+def cf_headers(extra = {})
+  {headers: {
+      'Accept' => '*/*',
+      'Accept-Encoding' => 'gzip, deflate',
+      'Host' => 'api.cloudflare.com',
+      'X-Auth-Email' => 'jake@example.net',
+      'X-Auth-Key' => '5up3rS3cr3tAuthK3y',
+      'X-Auth-User-Service-Key' => ''
+  }.merge(extra)}
+end
 
-	config.expect_with :rspec do |c|
-		c.syntax = :expect
-	end
+def cf_access_rule(mode, ip, note, id = '12312312' + ip.slice(-1))
+  {id: id, mode: mode, notes: note, configuration: {}}
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Marcin Prokop
@@ -9,36 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
+        version: 2.0.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: 
 email:
 - marcin@prokop.co
@@ -77,6 +77,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -90,6 +92,7 @@ files:
 - lib/cloudflare/version.rb
 - lib/cloudflare/zone.rb
 - spec/cloudflare/zone_spec.rb
+- spec/fake_cloudflare/cloudflare.rb
 - spec/spec_helper.rb
 homepage: https://github.com/b4k3r/cloudflare
 licenses:
@@ -111,10 +114,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.
 test_files:
 - spec/cloudflare/zone_spec.rb
+- spec/fake_cloudflare/cloudflare.rb
 - spec/spec_helper.rb