cloudflare 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7803b3a770a2ca6cfe874d77a7172bce3b0a3016
-  data.tar.gz: 8e97d03f70b94c9c6e5534adeff3fd9258c6a56c
+SHA256:
+  metadata.gz: 9e424c7c834e532b5a8783095b16ebde0f449ba26c39d33b3cf08042af234e6d
+  data.tar.gz: 48d3e57b0ffaafc85633b7ee7d3ac3d65046bcb4d6d563f005f6ae364204275d
 SHA512:
-  metadata.gz: df0801c3eaeca54ebdf36c45eecb85ae27f39eeae1163474ace6fda7211357aae6c9ddefee4f4fa12a45a34d99509011965e9d2af4d9e4139f75dbb7ee68c6d4
-  data.tar.gz: bb7ee1e783f5288612252a2908ef7e1d8b27daa2ba5c96947b09faf35fb6b536c91512d0fda099c6cac3a453ec8db9a8211fa5fcf12069b9a82c382e57b4c562
+  metadata.gz: cf74a6f05ab0c6188efadce6a8744b4f46dbec3d8d386c7287274b84e46eb5e9aaa3c40bd51c1e26084d9e86b831d76cdf6471e9c550baf8d30ee04804e04671
+  data.tar.gz: f2825bb5f23eb32b12141cf58f05405e38a41bde64a6a3b92ff58934a3f5b36594428caf4d14b69434dbbedf71f8e565bfc3fd01a59fe4af87b86584bf1e0070

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+  - ip
+  - id
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Lint/Debugger:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -2,12 +2,16 @@ language: ruby
 sudo: false
 dist: trusty
 cache: bundler
+
+before_script:
+  - gem update --system
+  - gem install bundler
+
 rvm:
-- 2.0
-- 2.1
-- 2.2
 - 2.3
 - 2.4
+- 2.5
+- 2.6
 - jruby-head
 - ruby-head
 matrix:

data/README.md

@@ -89,6 +89,14 @@ data = {"mode":"block","configuration":{"target":"ip","value":"#{ip}"},"notes":"
 response = zones.first.firewall_rules.post(data.to_json, content_type: 'application/json')
 ```
 
+Add a DNS record dynamically.  Here we add an A record for `batman.example.com`:
+
+```ruby
+client = Cloudflare.connect(key: CF_KEY, email: CF_EMAIL)
+zone = client.zones.find_by_name("example.com")
+zone.dns_records.post({"type":"A","name":"batman","content":"127.0.0.1","proxied":false}.to_json, :content_type => "application/json")
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,22 +1,24 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:test)
 
-task :default => :test
+task default: :test
 
 task :coverage do
-	ENV['COVERAGE'] = 'y'
+  ENV['COVERAGE'] = 'y'
 end
 
 task :console do
-	require 'cloudflare'
-	require 'pry'
-	
-	email = ENV['CLOUDFLARE_EMAIL']
-	key = ENV['CLOUDFLARE_KEY']
-	
-	connection = Cloudflare::Connection.new(key: key, email: email)
-	
-	binding.pry
+  require 'cloudflare'
+  require 'pry'
+
+  email = ENV['CLOUDFLARE_EMAIL']
+  key = ENV['CLOUDFLARE_KEY']
+
+  connection = Cloudflare::Connection.new(key: key, email: email)
+
+  binding.pry
 end

data/cloudflare.gemspec

@@ -1,4 +1,6 @@
-# -*- encoding: utf-8 -*-
+
+# frozen_string_literal: true
+
 require_relative 'lib/cloudflare/version'
 
 Gem::Specification.new do |spec|
@@ -12,16 +14,16 @@ Gem::Specification.new do |spec|
   spec.homepage    = 'https://github.com/b4k3r/cloudflare'
   spec.licenses    = ['MIT']
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  
+  spec.require_paths = ['lib']
+
   spec.required_ruby_version = '>= 2.0.0'
-  
-  spec.add_dependency 'rest-client'
-  
-  spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'rest-client', '~> 2.0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.6'
 end

data/lib/cloudflare.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Marcin Prokop.
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
@@ -24,7 +26,7 @@ require_relative 'cloudflare/zone'
 require_relative 'cloudflare/user'
 
 module Cloudflare
-	def self.connect(**options)
-		Connection.new(**options)
-	end
+  def self.connect(**options)
+    Connection.new(**options)
+  end
 end

data/lib/cloudflare/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Marcin Prokop.
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
@@ -23,51 +25,53 @@ require 'net/http'
 require 'json'
 
 require 'rest-client'
+require 'uri'
 
 require_relative 'response'
 
 module Cloudflare
-	DEFAULT_URL = "https://api.cloudflare.com/client/v4/"
-	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)
-			headers = options[:headers] || {}
-			
-			if email.nil?
-				headers['X-Auth-User-Service-Key'] = key
-			else
-				headers['X-Auth-Key'] = key
-				headers['X-Auth-Email'] = email
-			end
-			
-			# Convert HTTP API responses to our own internal response class:
-			super(url, headers: headers, accept: 'application/json', **options) do |response|
-				Response.new(response.request.url, response.body)
-			end
-		end
+  DEFAULT_URL = 'https://api.cloudflare.com/client/v4/'
+  TIMEOUT = 10 # Default is 5 seconds
+  DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+
+  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)
+      headers = options[:headers] || DEFAULT_HEADERS.dup
+
+      if email.nil?
+        headers['X-Auth-User-Service-Key'] = key
+      else
+        headers['X-Auth-Key'] = key
+        headers['X-Auth-Email'] = email
+      end
+
+      # Convert HTTP API responses to our own internal response class:
+      super(url, headers: headers, accept: 'application/json', **options) do |response|
+        Response.new(response.request.url, response.body)
+      end
+    end
+
+    def paginate(obj, url, url_args = '')
+      page = 1
+      page_size = 50
+      results = []
 
-		def paginate(obj, url, url_args = "")
-			page = 1
-			page_size = 100
-			results = []
+      # fetch and aggregate all pages
+      loop do
+        query = URI.encode_www_form scope_type: :organization, per_page: page_size, page: page
+        rules = obj.new(concat_urls(url, "?#{query}#{url_args}"), self, **options)
+        results += rules.get.results
+        break if results.empty? || results.size % page_size != 0
+        page += 1
+      end
+      results
+    end
+  end
 
-			# 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
-	end
+  class Connection < Resource
+  end
 end

data/lib/cloudflare/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Marcin Prokop.
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
@@ -22,52 +24,50 @@
 require 'json'
 
 module Cloudflare
-	class RequestError < StandardError
-		def initialize(what, response)
-			super("#{what}: #{response.errors.join(', ')}")
-			
-			@response = response
-		end
-		
-		attr :response
-	end
-	
-	class Response
-		def initialize(what, content)
-			@what = what
-			
-			@body = JSON.parse(content, symbolize_names: true)
-		end
-		
-		attr :body
+  class RequestError < StandardError
+    def initialize(what, response)
+      super("#{what}: #{response.errors.join(', ')}")
+
+      @response = response
+    end
+
+    attr_reader :response
+  end
+
+  class Response
+    def initialize(what, content)
+      @what = what
+
+      @body = JSON.parse(content, symbolize_names: true)
+    end
+
+    attr_reader :body
+
+    def result
+      raise RequestError.new(@what, self) unless successful?
 
-		def result
-			unless successful?
-				raise RequestError.new(@what, self)
-			end
-			
-			body[:result]
-		end
+      body[:result]
+    end
 
-		# Treat result as an array (often it is).
-		def results
-			Array(result)
-		end
+    # Treat result as an array (often it is).
+    def results
+      Array(result)
+    end
 
-		def empty?
-			result.empty?
-		end
+    def empty?
+      result.empty?
+    end
 
-		def successful?
-			body[:success]
-		end
+    def successful?
+      body[:success]
+    end
 
-		def errors
-			body[:errors]
-		end
+    def errors
+      body[:errors]
+    end
 
-		def messages
-			body[:messages]
-		end
-	end
+    def messages
+      body[:messages]
+    end
+  end
 end

data/lib/cloudflare/rspec/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -21,16 +23,16 @@
 require_relative '../../cloudflare'
 
 module Cloudflare
-	module RSpec
-		module Connection
-		end
-		
-		RSpec.shared_context Connection do
-			# You must specify these in order for the tests to run.
-			let(:email) {ENV['CLOUDFLARE_EMAIL']}
-			let(:key) {ENV['CLOUDFLARE_KEY']}
-			
-			let(:connection) {Cloudflare.connect(key: key, email: email)}
-		end
-	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
 end

data/lib/cloudflare/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Marcin Prokop.
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
@@ -22,12 +24,12 @@
 require_relative 'connection'
 
 module Cloudflare
-	class Connection < Resource
-		def user
-			@user ||= User.new(concat_urls(url, 'user'), options)
-		end
-	end
+  class Connection < Resource
+    def user
+      @user ||= User.new(concat_urls(url, 'user'), options)
+    end
+  end
 
-	class User < Resource
-	end
+  class User < Resource
+  end
 end

data/lib/cloudflare/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Marcin Prokop.
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
@@ -20,5 +22,5 @@
 # THE SOFTWARE.
 
 module Cloudflare
-	VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/lib/cloudflare/zone.rb

@@ -1,3 +1,5 @@
+# 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>
@@ -23,167 +25,178 @@
 require_relative 'connection'
 
 module Cloudflare
-	class Connection < Resource
-		def zones
-			@zones ||= Zones.new(concat_urls(url, 'zones'), options)
-		end
-	end
-	
-	class DNSRecord < Resource
-		def initialize(url, record = nil, **options)
-			super(url, **options)
-			
-			@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
-			"#{@record[:name]} #{@record[:type]} #{@record[:content]}"
-		end
-	end
-	
-	class DNSRecords < Resource
-		def initialize(url, zone, **options)
-			super(url, **options)
-			
-			@zone = zone
-		end
-		
-		attr :zone
-		
-		def all
-			results = paginate(DNSRecords, url)
-			results.map{|record| DNSRecord.new(concat_urls(url, record[:id]), record, **options)}
-		end
-		
-		def find_by_name(name)
-			response = self.get(params: {name: name})
-			
-			unless response.empty?
-				record = response.results.first
-				
-				DNSRecord.new(concat_urls(url, record[:id]), record, **options)
-			end
-		end
-		
-		def find_by_id(id)
-			DNSRecord.new(concat_urls(url, id), **options)
-		end
-	end
-	
-	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
-		
-		attr :record
-		
-		def dns_records
-			@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
-	end
-	
-	class Zones < Resource
-		def all
-			self.get.results.map{|record| Zone.new(concat_urls(url, record[:id]), record, **options)}
-		end
-		
-		def find_by_name(name)
-			response = self.get(params: {name: name})
-			
-			unless response.empty?
-				record = response.results.first
-				
-				Zone.new(concat_urls(url, record[:id]), record, **options)
-			end
-		end
-		
-		def find_by_id(id)
-			Zone.new(concat_urls(url, id), **options)
-		end
-	end
+  class Connection < Resource
+    def zones
+      @zones ||= Zones.new(concat_urls(url, 'zones'), options)
+    end
+  end
+
+  class DNSRecord < Resource
+    def initialize(url, record = nil, **options)
+      super(url, **options)
+
+      @record = record || get.result
+    end
+
+    def update_content(content)
+      response = put({ type: @record[:type],
+                       name: @record[:name],
+                       content: content }.to_json,
+                     content_type: 'application/json')
+      response.successful?
+    end
+
+    attr_reader :record
+
+    def to_s
+      "#{@record[:name]} #{@record[:type]} #{@record[:content]}"
+    end
+  end
+
+  class DNSRecords < Resource
+    def initialize(url, zone, **options)
+      super(url, **options)
+
+      @zone = zone
+    end
+
+    attr_reader :zone
+
+    def all
+      results = paginate(DNSRecords, url)
+      results.map { |record| DNSRecord.new(concat_urls(url, record[:id]), record, **options) }
+    end
+
+    def find_by_name(name)
+      response = get(params: { name: name })
+
+      return if response.empty?
+      record = response.results.first
+
+      DNSRecord.new(concat_urls(url, record[:id]), record, **options)
+    end
+
+    def find_by_id(id)
+      DNSRecord.new(concat_urls(url, id), **options)
+    end
+  end
+
+  class FirewallRule < Resource
+    def initialize(url, record = nil, **options)
+      super(url, **options)
+
+      @record = record || get.result
+    end
+
+    attr_reader :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_reader :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
+    DEFAULT_PURGE_CACHE_PARAMS = {
+      purge_everything: true
+    }.freeze
+
+    def initialize(url, record = nil, preload = false, **options)
+      super(url, **options)
+      @record = record || get.result if preload
+    end
+
+    attr_reader :record
+
+    def dns_records
+      @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 purge_cache(params = DEFAULT_PURGE_CACHE_PARAMS)
+      response = self['purge_cache'].post(params&.to_json || {})
+      response.successful?
+    end
+
+    def to_s
+      @record[:name]
+    end
+  end
+
+  class Zones < Resource
+    def all
+      results = paginate(Zone, url)
+      results.map { |record| Zone.new(concat_urls(url, record[:id]), record, **options) }
+    end
+
+    def find_by_name(name)
+      response = get(params: { name: name })
+
+      return if response.empty?
+      record = response.results.first
+
+      Zone.new(concat_urls(url, record[:id]), record, true, **options)
+    end
+
+    def find_by_id(id)
+      Zone.new(concat_urls(url, id), **options)
+    end
+  end
 end