cloudflare 2.1.0 → 3.0.0

data/lib/cloudflare/response.rb

@@ -0,0 +1,73 @@
+# 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'
+
+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
+
+		def result
+			unless successful?
+				raise RequestError.new(@what, self)
+			end
+			
+			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
+end

data/lib/cloudflare/rspec/connection.rb

@@ -0,0 +1,36 @@
+# 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_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
+end

data/lib/cloudflare/user.rb

@@ -0,0 +1,33 @@
+# 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_relative 'connection'
+
+module Cloudflare
+	class Connection < Resource
+		def user
+			@user ||= User.new(concat_urls(url, 'user'), options)
+		end
+	end
+
+	class User < Resource
+	end
+end

data/lib/cloudflare/version.rb

@@ -1,4 +1,5 @@
 # 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
@@ -18,6 +19,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-module CloudFlare
-  VERSION = '2.1.0'
+module Cloudflare
+	VERSION = '3.0.0'
 end

data/lib/cloudflare/zone.rb

@@ -0,0 +1,110 @@
+# 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_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
+		
+		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
+			self.get.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 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 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)
+			record = self.get(params: {name: name}).result
+			
+			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
+end

data/spec/cloudflare/zone_spec.rb

@@ -0,0 +1,41 @@
+
+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"}
+		
+		it "should create dns record" do
+			response = zone.dns_records.post({
+				type: "A",
+				name: name,
+				content: "127.0.0.1",
+				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
+		
+		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
+				expect(response).to be_successful
+			end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+
+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"
+
+RSpec.configure do |config|
+	# 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

metadata

@@ -1,29 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Marcin Prokop
+- Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,39 +67,42 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby wrapper for the CloudFlare API.
-email: marcin@prokop.co
+description: 
+email:
+- marcin@prokop.co
+- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
+extra_rdoc_files: []
 files:
+- ".rspec"
+- ".travis.yml"
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile
 - cloudflare.gemspec
 - lib/cloudflare.rb
 - lib/cloudflare/connection.rb
+- lib/cloudflare/response.rb
+- lib/cloudflare/rspec/connection.rb
+- lib/cloudflare/user.rb
 - lib/cloudflare/version.rb
-- test/test_cloudflare.rb
+- lib/cloudflare/zone.rb
+- spec/cloudflare/zone_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/b4k3r/cloudflare
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--main"
-- README.md
-- "--charset=UTF-8"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -78,9 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for the CloudFlare API.
+summary: A Ruby wrapper for the Cloudflare API.
 test_files:
-- test/test_cloudflare.rb
+- spec/cloudflare/zone_spec.rb
+- spec/spec_helper.rb