cloudflare 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bdda4cf1d75b71db4667d63da7382958e2cbebedb052e51adce192bf5db2a81
-  data.tar.gz: ea73942a2251da8f3de0e9a4b46af6a0f877cb1d52b39567ea5aee0c5514aff3
+  metadata.gz: 93312512447e91ad4a4e49d249d0474ce69304fbaed539a49cee2277afdc35f7
+  data.tar.gz: 40c655960faf06672e9b0720cb9e24bfa2b47d09e87bc6e24f23b7def429f014
 SHA512:
-  metadata.gz: cbe1fe27c1dcbdf5bcf1480c21058e8b2f82d3c43829c606355e864e56390b9f0e128e80af3d6274ce09c45a40548e0a5ce29d1dd70d9ca9bfa707a86982a477
-  data.tar.gz: d1c18b4b98110472759b0e3400f3e22717d91cb1022292a997b21920eca74ceabefa78b830c22231f9338efda14d99ff99e0310b1f33ffbd2f637b0a092b5d21
+  metadata.gz: 212b1e7f5ec0c274676c6458a940eff14c9df4d2e43d990e1a03833bfa2ece184cb85e002a9eafe879ac6e8001e7750d23ebb07efb10bd8f1c02ae31686c5766
+  data.tar.gz: c8e62b92827dc64b0833f821f07b526164a1da58cd408dfbe9b597d5c64a38d51ab805359655049a4dc98ce3e2e520f330ddf58f98039cfcb6e04dfdbeea5c2a

data/.travis.yml

@@ -8,6 +8,8 @@ matrix:
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: truffleruby

data/README.md

@@ -3,6 +3,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/socketry/cloudflare.svg)](http://travis-ci.org/socketry/cloudflare)
+[![Coverage Status](https://coveralls.io/repos/socketry/cloudflare/badge.svg)](https://coveralls.io/r/socketry/cloudflare)
 
 ## Installation
 
@@ -26,7 +27,7 @@ $ gem install cloudflare
 
 ## Usage
 
-Prepare a connection to the remote API:
+Here are some basic examples. For more details, refer to the code and specs.
 
 ```ruby
 require 'cloudflare'
@@ -35,66 +36,31 @@ require 'cloudflare'
 email = ENV['CLOUDFLARE_EMAIL']
 key = ENV['CLOUDFLARE_KEY']
 
-# Set up the connection:
-connection = Cloudflare.connect(key: key, email: email)
-```
-
-Get all available zones:
-
-```ruby
-zones = connection.zones
-```
-
-Get a specific zone:
-
-```ruby
-zone = connection.zones.find_by_id("...")
-zone = connection.zones.find_by_name("example.com")
-```
-
-Get DNS records for a given zone:
-
-```ruby
-dns_records = zones.first.dns_records
-```
-
-Show some details of the DNS record:
-
-```ruby
-dns_record = records.first
-puts records.first.record[:name]
-puts records
-```
-
-Get firewall rules:
-
-```ruby
-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("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')
-```
-
-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")
+Cloudflare.connect(key: key, email: email) do
+	# Get all available zones:
+	zones = connection.zones
+	
+	# Get a specific zone:
+	zone = connection.zones.find_by_id("...")
+	zone = connection.zones.find_by_name("example.com")
+	
+	# Get DNS records for a given zone:
+	dns_records = zone.dns_records
+	
+	# Show some details of the DNS record:
+	dns_record = dns_records.first
+	puts dns_record.name
+	
+	# Add a DNS record. Here we add an A record for `batman.example.com`:
+	zone = zones.find_by_name("example.com")
+	zone.dns_records.create('A', 'batman', '1.2.3.4', proxied: false)
+	
+	# Get firewall rules:
+	all_rules = zone.firewall_rules
+	
+	# Block an ip:
+	rule = zone.firewall_rules.set('block', '1.2.3.4', notes: "ssh dictionary attack")
+end
 ```
 
 ## Contributing

data/cloudflare.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 
 	spec.add_development_dependency 'async-rspec'
 
+	spec.add_development_dependency 'covered'
 	spec.add_development_dependency 'bundler'
 	spec.add_development_dependency 'rake'
 	spec.add_development_dependency 'rspec', '~> 3.6'

data/lib/cloudflare/version.rb

@@ -22,5 +22,5 @@
 # THE SOFTWARE.
 
 module Cloudflare
-	VERSION = '4.0.0'
+	VERSION = '4.0.1'
 end

data/lib/cloudflare/zones.rb

@@ -56,6 +56,8 @@ module Cloudflare
 		def name
 			value[:name]
 		end
+		
+		alias to_s name
 	end
 	
 	class Zones < Representation

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 
+require 'covered/rspec'
 require 'async/rspec'
 
 require 'cloudflare/rspec/connection'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Marcin Prokop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-26 00:00:00.000000000 Z
+date: 2019-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.