cloudflare 4.3.0 → 4.4.0

data/lib/cloudflare.rb

@@ -1,47 +1,31 @@
 # frozen_string_literal: true
 
-# 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.
+# Released under the MIT License.
+# Copyright, 2012-2016, by Marcin Prokop.
+# Copyright, 2013, by Eric McKay.
+# Copyright, 2014, by Jason Green.
+# Copyright, 2014-2024, by Samuel Williams.
+# Copyright, 2014, by Greg Retkowski.
+# Copyright, 2018, by Leonhardt Wille.
+# Copyright, 2019, by Akinori Musha.
 
-require 'async'
-require_relative 'cloudflare/connection'
+require "async"
+require_relative "cloudflare/connection"
 
 module Cloudflare
-	DEFAULT_ENDPOINT = Async::HTTP::Endpoint.parse('https://api.cloudflare.com/client/v4')
-	
-	def self.connect(endpoint = DEFAULT_ENDPOINT, **auth_info)
-		representation = Connection.for(endpoint)
+	def self.connect(*arguments, **auth_info)
+		connection = Connection.open(*arguments)
 		
 		if !auth_info.empty?
-			representation = representation.authenticated(**auth_info)
+			connection = connection.authenticated(**auth_info)
 		end
 		
-		return representation unless block_given?
+		return connection unless block_given?
 		
-		Async do
-			begin
-				yield representation
-			ensure
-				representation.close
-			end
+		Sync do
+			yield connection
+		ensure
+			connection.close
 		end
 	end
 end

data/license.md

@@ -0,0 +1,41 @@
+# MIT License
+
+Copyright, 2012-2017, by Marcin Prokop.  
+Copyright, 2013, by Eric McKay.  
+Copyright, 2014, by Jason Green.  
+Copyright, 2014-2024, by Samuel Williams.  
+Copyright, 2014, by Greg Retkowski.  
+Copyright, 2015, by Kyle Corbitt.  
+Copyright, 2015, by Guillaume Leseur.  
+Copyright, 2017, by Denis Sadomowski.  
+Copyright, 2017, by 莫粒.  
+Copyright, 2018, by Leonhardt Wille.  
+Copyright, 2018, by Mike Perham.  
+Copyright, 2018, by Michael Kalygin.  
+Copyright, 2018, by Sherman Koa.  
+Copyright, 2018, by Kugayama Nana.  
+Copyright, 2018, by Casey Lopez.  
+Copyright, 2019, by Akinori Musha.  
+Copyright, 2019, by Rob Widmer.  
+Copyright, 2019, by Fedishin Nazar.  
+Copyright, 2019, by David Wegman.  
+Copyright, 2020, by Olle Jonsson.  
+Copyright, 2021, by Terry Kerr.  
+
+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.

data/readme.md

@@ -0,0 +1,108 @@
+# Cloudflare
+
+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*.
+
+[![Development Status](https://github.com/socketry/cloudflare/workflows/Test/badge.svg)](https://github.com/socketry/cloudflare/actions?workflow=Test)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'cloudflare'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloudflare
+
+## Usage
+
+Here are some basic examples. For more details, refer to the code and specs.
+
+``` ruby
+require 'cloudflare'
+
+# Grab some details from somewhere:
+email = ENV['CLOUDFLARE_EMAIL']
+key = ENV['CLOUDFLARE_KEY']
+
+Cloudflare.connect(key: key, email: email) do |connection|
+	# 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
+```
+
+### Using a Bearer Token
+
+You can read more about [bearer tokens here](https://blog.cloudflare.com/api-tokens-general-availability/). This allows you to limit priviledges.
+
+``` ruby
+require 'cloudflare'
+
+token = 'a_generated_api_token'
+
+Cloudflare.connect(token: token) do |connection|
+	# ...
+end
+```
+
+### Using with Async
+
+``` ruby
+Async do
+	connection = Cloudflare.connect(...)
+	
+	# ... do something with connection ...
+ensure
+	connection.close
+end
+```
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
+
+## See Also
+
+  - [Cloudflare::DNS::Update](https://github.com/ioquatix/cloudflare-dns-update) - A dynamic DNS updater based on this gem.
+  - [Rubyflare](https://github.com/trev/rubyflare) - Another implementation.

metadata

@@ -1,15 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
-- Marcin Prokop
 - Samuel Williams
+- Marcin Prokop
+- Leonhardt Wille
+- Rob Widmer
+- Akinori Musha
+- Sherman Koa
+- Michael Kalygin
+- Denis Sadomowski
+- Eric McKay
+- Fedishin Nazar
+- Casey Lopez
+- David Wegman
+- Greg Retkowski
+- Guillaume Leseur
+- Jason Green
+- Kugayama Nana
+- Kyle Corbitt
+- Mike Perham
+- Olle Jonsson
+- Terry Kerr
+- 莫粒
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -17,70 +65,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.3
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.3
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  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
-    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: 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: 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'
+        version: '0.18'
 description:
 email:
 executables: []
@@ -96,18 +88,20 @@ files:
 - lib/cloudflare/dns.rb
 - lib/cloudflare/firewall.rb
 - lib/cloudflare/kv/namespaces.rb
-- lib/cloudflare/kv/rest_wrapper.rb
+- lib/cloudflare/kv/wrapper.rb
 - lib/cloudflare/logs.rb
 - lib/cloudflare/paginate.rb
 - lib/cloudflare/representation.rb
-- lib/cloudflare/rspec/connection.rb
 - lib/cloudflare/user.rb
 - lib/cloudflare/version.rb
 - lib/cloudflare/zones.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/cloudflare
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/socketry/cloudflare.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -116,14 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Cloudflare API.

metadata.gz.sig

@@ -0,0 +1,2 @@
+C��`���M�*�?���G|5|�t(�G�[�l�P�4�E�Q�H���K*U3ٿR�a�;8l����
+,sF�ɛbTTz�(MJ��[�lj�=�c�D��}|��<��

data/lib/cloudflare/kv/rest_wrapper.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Cloudflare
-  module KV
-    class RESTWrapper < Async::REST::Wrapper::Generic
-      APPLICATION_OCTET_STREAM = 'application/octet-stream'
-      APPLICATION_JSON = 'application/json'
-			ACCEPT_HEADER = "#{APPLICATION_JSON}, #{APPLICATION_OCTET_STREAM}"
-
-      def prepare_request(payload, headers)
-        headers['accept'] ||= ACCEPT_HEADER
-
-        if payload
-          headers['content-type'] = APPLICATION_OCTET_STREAM
-          ::Protocol::HTTP::Body::Buffered.new([payload.to_s])
-        end
-      end
-
-      def parser_for(response)
-        if response.headers['content-type'].start_with?(APPLICATION_OCTET_STREAM)
-          OctetParser
-        elsif response.headers['content-type'].start_with?(APPLICATION_JSON)
-          JsonParser
-        else
-          Async::REST::Wrapper::Generic::Unsupported
-        end
-      end
-
-      class OctetParser < ::Protocol::HTTP::Body::Wrapper
-        def join
-          super
-        end
-      end
-
-      class JsonParser < ::Protocol::HTTP::Body::Wrapper
-        def join
-          JSON.parse(super, symbolize_names: true)
-        end
-      end
-    end
-  end
-end

data/lib/cloudflare/rspec/connection.rb

@@ -1,57 +0,0 @@
-# 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
-# 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 'async/rspec'
-require 'async/http/proxy'
-
-require_relative '../../cloudflare'
-
-module Cloudflare
-	module RSpec
-		module Connection
-		end
-		
-		RSpec.shared_context Connection do
-			include_context Async::RSpec::Reactor
-			
-			# You must specify these in order for the tests to run.
-			let(:email) {ENV['CLOUDFLARE_EMAIL']}
-			let(:key) {ENV['CLOUDFLARE_KEY']}
-			
-			let(:connection) do
-				if proxy_url = ENV['CLOUDFLARE_PROXY']
-					proxy_endpoint = Async::HTTP::Endpoint.parse(proxy_url)
-					@client = Async::HTTP::Client.new(proxy_endpoint)
-					@connection = Cloudflare.connect(@client.proxied_endpoint(DEFAULT_ENDPOINT), key: key, email: email)
-				else
-					@client = nil
-					@connection = Cloudflare.connect(key: key, email: email)
-				end
-			end
-			
-			after do
-				@connection&.close
-				@client&.close
-			end
-		end
-	end
-end