cloudflare 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e27cb2bec2e08d2652f1095ea2a59b81ab2e1bdf7859ceec4e7cd6b8f8789e1
-  data.tar.gz: bfeada1f9e3c1d828b99e5e6767b441453d9455d5a8a044ef67105576397418f
+  metadata.gz: 0bdda4cf1d75b71db4667d63da7382958e2cbebedb052e51adce192bf5db2a81
+  data.tar.gz: ea73942a2251da8f3de0e9a4b46af6a0f877cb1d52b39567ea5aee0c5514aff3
 SHA512:
-  metadata.gz: d225c93aeead46e57d21a62d06854907ded827fb255e7c6773df1462d85268df67421796eac4883a9184fa9e7f2de8876bf311a00e2931742ef53cb6c78db299
-  data.tar.gz: d2a2d558755b653ff5679507fc06e2c049e64fbdc7849f1c398199239408292002b722813431c1697a4d6bd577740ad293957eb362cc470fe48c9205e2b79ce0
+  metadata.gz: cbe1fe27c1dcbdf5bcf1480c21058e8b2f82d3c43829c606355e864e56390b9f0e128e80af3d6274ce09c45a40548e0a5ce29d1dd70d9ca9bfa707a86982a477
+  data.tar.gz: d1c18b4b98110472759b0e3400f3e22717d91cb1022292a997b21920eca74ceabefa78b830c22231f9338efda14d99ff99e0310b1f33ffbd2f637b0a092b5d21

data/.travis.yml

@@ -1,24 +1,22 @@
 language: ruby
-sudo: false
-dist: trusty
+dist: xenial
 cache: bundler
 
-before_script:
-  - gem update --system
-  - gem install bundler
-
-rvm:
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-- 2.6
-- jruby-head
-- ruby-head
 matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: truffleruby
+    - rvm: ruby-head
   allow_failures:
-  - rvm: ruby-head
-  - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: truffleruby
+
 env:
   global:
     secure: c5yG7N1r9nYuw47Y90jGeoHNvkL59AAC55dtPAhKP+gjXWW8hKbntj3oj+lVkxEqzRpzEQgYZzUElrP+6mJnb20ldclZg03L56243tMtVEcpGOx/MFhnIBkx3kKu1H6ydKKMxieHxjsLQ3vnpcIZ3p0skTQjYbjdu607tjbyg7s=

data/README.md

@@ -2,7 +2,7 @@
 
 It is a Ruby wrapper for the Cloudflare V4 API. It provides a light weight wrapper using `RestClient::Resource`. The wrapper functionality is limited to zones and DNS records at this time, *PRs welcome*.
 
-[![Build Status](https://secure.travis-ci.org/ioquatix/cloudflare.svg)](http://travis-ci.org/ioquatix/cloudflare)
+[![Build Status](https://secure.travis-ci.org/socketry/cloudflare.svg)](http://travis-ci.org/socketry/cloudflare)
 
 ## Installation
 
@@ -42,7 +42,7 @@ connection = Cloudflare.connect(key: key, email: email)
 Get all available zones:
 
 ```ruby
-zones = connection.zones.all
+zones = connection.zones
 ```
 
 Get a specific zone:
@@ -55,7 +55,7 @@ zone = connection.zones.find_by_name("example.com")
 Get DNS records for a given zone:
 
 ```ruby
-dns_records = zones.first.dns_records.all
+dns_records = zones.first.dns_records
 ```
 
 Show some details of the DNS record:
@@ -69,14 +69,14 @@ 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"
+all_rules = zones.first.firewall_rules
+block_rules = zones.first.firewall_rules("block") # or "whitelist" or "challenge"
 ```
 
 Get blocked ips:
 
 ```ruby
-block_rules = zones.first.firewall_rules.all("block") 
+block_rules = zones.first.firewall_rules("block") 
 blocked_ips = zones.first.firewall_rules.firewalled_ips(block_rules)
 ```
 
@@ -89,7 +89,7 @@ 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`:
+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)
@@ -114,9 +114,9 @@ zone.dns_records.post({"type":"A","name":"batman","content":"127.0.0.1","proxied
 
 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, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
 Copyright, 2017, by [David Rosenbloom](http://artifactory.com).  
+Copyright, 2012, 2014, by [Marcin Prokop](https://github.com/b4k3r).  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -8,17 +8,19 @@ RSpec::Core::RakeTask.new(:test)
 task default: :test
 
 task :coverage do
-  ENV['COVERAGE'] = 'y'
+	ENV['COVERAGE'] = 'y'
 end
 
 task :console do
-  require 'cloudflare'
-  require 'pry'
+	require_relative 'lib/cloudflare'
+	require 'pry'
 
-  email = ENV['CLOUDFLARE_EMAIL']
-  key = ENV['CLOUDFLARE_KEY']
+	email = ENV.fetch('CLOUDFLARE_EMAIL')
+	key = ENV.fetch('CLOUDFLARE_KEY')
 
-  connection = Cloudflare::Connection.new(key: key, email: email)
-
-  binding.pry
+	Async.run do
+		connection = Cloudflare.connect(key: key, email: email)
+		
+		binding.pry
+	end
 end

data/cloudflare.gemspec

@@ -4,26 +4,28 @@
 require_relative 'lib/cloudflare/version'
 
 Gem::Specification.new do |spec|
-  spec.name     = 'cloudflare'
-  spec.version  = Cloudflare::VERSION
-  spec.platform = Gem::Platform::RUBY
+	spec.name     = 'cloudflare'
+	spec.version  = Cloudflare::VERSION
+	spec.platform = Gem::Platform::RUBY
 
-  spec.summary     = 'A Ruby wrapper for the Cloudflare API.'
-  spec.authors     = ['Marcin Prokop', 'Samuel Williams']
-  spec.email       = ['marcin@prokop.co', 'samuel.williams@oriontransfer.co.nz']
-  spec.homepage    = 'https://github.com/b4k3r/cloudflare'
-  spec.licenses    = ['MIT']
+	spec.summary     = 'A Ruby wrapper for the Cloudflare API.'
+	spec.authors     = ['Marcin Prokop', 'Samuel Williams']
+	spec.email       = ['marcin@prokop.co', 'samuel.williams@oriontransfer.co.nz']
+	spec.homepage    = 'https://github.com/b4k3r/cloudflare'
+	spec.licenses    = ['MIT']
 
-  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.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.required_ruby_version = '>= 2.0.0'
+	spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'rest-client', '~> 2.0.2'
+	spec.add_dependency 'async-rest'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.6'
+	spec.add_development_dependency 'async-rspec'
+
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rake'
+	spec.add_development_dependency 'rspec', '~> 3.6'
 end

data/lib/cloudflare.rb

@@ -21,12 +21,27 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'async'
 require_relative 'cloudflare/connection'
-require_relative 'cloudflare/zone'
-require_relative 'cloudflare/user'
 
 module Cloudflare
-  def self.connect(**options)
-    Connection.new(**options)
-  end
+	DEFAULT_URL = 'https://api.cloudflare.com/client/v4'
+	
+	def self.connect(key: nil, email: nil)
+		representation = Connection.for(DEFAULT_URL)
+		
+		if key
+			representation = representation.authenticated(key, email)
+		end
+		
+		return representation unless block_given?
+		
+		Async do
+			begin
+				yield representation
+			ensure
+				representation.close
+			end
+		end
+	end
 end

data/lib/cloudflare/{response.rb → accounts.rb}

@@ -2,6 +2,7 @@
 
 # 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
@@ -21,53 +22,30 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'json'
+require_relative 'representation'
+require_relative 'paginate'
 
 module Cloudflare
-  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?
-
-      body[:result]
-    end
-
-    # Treat result as an array (often it is).
-    def results
-      Array(result)
-    end
-
-    def empty?
-      result.empty?
-    end
-
-    def successful?
-      body[:success]
-    end
-
-    def errors
-      body[:errors]
-    end
-
-    def messages
-      body[:messages]
-    end
-  end
+	class Account < Representation
+	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))
+		end
+	end
 end

data/lib/cloudflare/connection.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, by Marcin Prokop.
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -21,57 +20,37 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'net/http'
-require 'json'
+require_relative 'representation'
 
-require 'rest-client'
-require 'uri'
-
-require_relative 'response'
+require_relative 'zones'
+require_relative 'accounts'
+require_relative 'user'
 
 module Cloudflare
-  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 = []
-
-      # 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
-
-  class Connection < Resource
-  end
+	class Connection < Representation
+		def authenticated(key, email = nil)
+			headers = {}
+			
+			if email.nil?
+				headers['X-Auth-User-Service-Key'] = key
+			else
+				headers['X-Auth-Key'] = key
+				headers['X-Auth-Email'] = email
+			end
+			
+			self.class.new(@resource.with(headers: headers))
+		end
+		
+		def zones
+			Zones.new(@resource.with(path: 'zones'))
+		end
+		
+		def accounts
+			Accounts.new(@resource.with(path: 'accounts'))
+		end
+		
+		def user
+			User.new(@resource.with(path: 'user'))
+		end
+	end
 end

data/lib/cloudflare/dns.rb

@@ -0,0 +1,91 @@
+# 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'
+
+module Cloudflare
+	module DNS
+		class Record < Representation
+			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
+				)
+				
+				@value = response.result
+			end
+			
+			def type
+				value[:type]
+			end
+			
+			def name
+				value[:name]
+			end
+			
+			def content
+				value[:content]
+			end
+			
+			def to_s
+				"#{@record[:name]} #{@record[:type]} #{@record[:content]}"
+			end
+		end
+
+		class Records < Representation
+			include Paginate
+			
+			def representation
+				Record
+			end
+			
+			TTL_AUTO = 1
+			
+			def create(type, name, content, **options)
+				message = self.post(type: type, name: name, content: content, **options)
+				
+				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)
+				Record.new(@resource.with(path: id))
+			end
+		end
+	end
+end