cfc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40bb48cf72eeb9528ed6c44396499aea91a719845094f1b389a7d891edb64b4c
+  data.tar.gz: f2ffa1a259fdb63166799b050f4035a0023ca9424753336cb21ef4b138ddbc76
+SHA512:
+  metadata.gz: ae3acc4b662407967520e549a66cd73846ab834a89159d4592a8775af0efccf15ffbdacd09da8464e7f88f3b1a48bf677411614094d5342e95242a795e45b87b
+  data.tar.gz: eccf63a35470b2ee94f33324dd733b1393d43c0e36055840855c711c229b11e708bfae42f50c12443b0a6f6dd8f3b81026bf9fd7c5088996c689afa46ad50458

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2020– The Codidact Foundation
+
+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,24 @@
+# cfc
+Simple library for interacting with the Cloudflare API.
+
+## Install
+Clone the repository. That's it!
+
+## Usage
+This library is intended to be very lightweight, to help with usage in quick but effective scripts. Scripts that use
+this library can be added to `scripts/` and run from there—it's *possible* for them to go anywhere, of course,
+but relative `require`s are easier from a proximate directory.
+
+You can use the library either by instantiating `CFC::API` and using that class to send API requests directly,
+or, for simpler tasks, you can use pre-provided objects in `lib/objects/`, which represent a data type from the
+Cloudflare API and may provide methods to perform common or simple tasks on those types. See
+`lib/scripts/clear_cache.rb` for an example of how this may be done using `CFC::Zone` objects.
+
+## Contributing
+As with all Codidact projects, contributions are welcome and must adhere to the
+[Codidact Code of Conduct](https://meta.codidact.com/policy/code-of-conduct). Please create an issue to discuss any
+major changes you propose to make, or if you think your changes may not be accepted for any reason—we'd always
+rather discuss something unnecessarily than have to reject someone's hard work.
+
+## License
+This project is licensed under the terms of the MIT license, which may be found in the LICENSE file.

data/lib/cfc/api.rb

@@ -0,0 +1,75 @@
+require 'net/http'
+require 'json'
+require 'digest'
+require 'yaml'
+require_relative 'config'
+require_relative 'cache'
+require_relative 'errors/http_error.rb'
+
+module CFC
+  class API
+    def initialize
+      @base = 'https://api.cloudflare.com/client/v4/'
+      @cache = CFC::Cache.new
+    end
+
+    def get(path, params: nil, headers: nil, cache: true, expiry: nil)
+      request(Net::HTTP::Get, build_uri(path, params), headers: headers, cache: cache, expiry: expiry)
+    end
+
+    def get_json(path, params: nil, headers: nil, cache: true, expiry: nil)
+      request_json(Net::HTTP::Get, build_uri(path, params), headers: headers, cache: cache, expiry: expiry)
+    end
+
+    [:post, :put, :patch].each do |method|
+      define_method method do |path, data, headers: nil, cache: false, expiry: nil|
+        request("Net::HTTP::#{method.capitalize}".constantize, URI("#{@base}#{path}"), data: data, headers: headers, cache: cache, expiry: expiry)
+      end
+
+      define_method "#{method}_to_json" do |path, data, headers: nil, cache: false, expiry: nil|
+        request_json(Object.const_get("Net::HTTP::#{method.capitalize}"), URI("#{@base}#{path}"), data: data, headers: headers, cache: cache,
+                     expiry: expiry)
+      end
+    end
+
+    protected
+
+    def request(cls, uri, data: nil, headers: nil, cache: true, expiry: nil)
+      final_headers = (headers || {}).merge({
+        'Authorization' => "Bearer #{CFC::Config.instance.token}",
+        'Content-Type' => 'application/json'
+      })
+
+      rq = cls.new(uri, final_headers)
+      unless data.nil? || rq.is_a?(Net::HTTP::Head)
+        rq.body = JSON.dump(data)
+      end
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        if cache
+          @cache.fetch(Digest::SHA256.hexdigest("#{uri}|#{JSON.dump(final_headers)}"), expiry: expiry) do
+            http.request(rq)
+          end
+        else
+          http.request(rq)
+        end
+      end
+
+      if response.is_a?(Net::HTTPSuccess)
+        response
+      else
+        raise CFC::Errors::HTTPError.new(rq, response)
+      end
+    end
+
+    def request_json(cls, path, data: nil, headers: nil, cache: true, expiry: nil)
+      JSON.parse(request(cls, path, data: data, headers: headers, cache: cache, expiry: expiry).body)
+    end
+
+    def build_uri(path, params)
+      uri = URI("#{@base}#{path}")
+      uri.query = URI.encode_www_form((params || {}).to_a)
+      uri
+    end
+  end
+end

data/lib/cfc/cache.rb

@@ -0,0 +1,42 @@
+require 'ostruct'
+require 'date'
+
+module CFC
+  class Cache
+    def initialize
+      @cache = {}
+    end
+
+    def include?(key)
+      @cache.include?(key) && (@cache[key].expiry.nil? || @cache[key].expiry >= DateTime.now.to_time.to_i)
+    end
+
+    def [](key)
+      valid?(key) ? @cache[key].data : nil
+    end
+
+    def []=(key, value)
+      @cache[key] = OpenStruct.new(data: value, expiry: nil)
+    end
+
+    def write(key, value, expiry: nil)
+      @cache[key] = OpenStruct.new(data: value, expiry: expiry)
+    end
+
+    def read(key)
+      valid?(key) ? @cache[key].data : nil
+    end
+
+    def fetch(key, expiry: nil)
+      if valid?(key)
+        @cache[key].data
+      else
+        data = block_given? ? yield : nil
+        write(key, data, expiry: expiry)
+        data
+      end
+    end
+
+    alias_method :valid?, :include?
+  end
+end

data/lib/cfc/config.rb

@@ -0,0 +1,12 @@
+require 'singleton'
+
+module CFC
+  class Config
+    include Singleton
+    attr_accessor :token
+
+    def self.configure
+      yield CFC::Config.instance
+    end
+  end
+end

data/lib/cfc/errors/http_error.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module CFC
+  module Errors
+    class HTTPError < StandardError
+      attr_reader :request, :response
+
+      def initialize(request, response)
+        super "Cloudflare API request returned HTTP #{response.code}"
+        @request = request
+        @response = response
+      end
+
+      def data
+        JSON.parse(@response.body)
+      end
+    end
+  end
+end

data/lib/cfc/errors/missing_property.rb

@@ -0,0 +1,14 @@
+module CFC
+  module Errors
+    class MissingProperty < StandardError
+      def self.default_message(obj, property)
+        "This #{obj.class.name} does not have a `#{property}' property. If you are accessing this object from a relationship on " \
+        "another object, the property may not have been fetched."
+      end
+
+      def initialize(message)
+        super
+      end
+    end
+  end
+end

data/lib/cfc/objects/account.rb

@@ -0,0 +1,9 @@
+require_relative 'object'
+
+module CFC
+  class Account < CFC::APIObject
+    def initialize(data)
+      super(data)
+    end
+  end
+end

data/lib/cfc/objects/object.rb

@@ -0,0 +1,55 @@
+require_relative '../errors/missing_property'
+require_relative '../api'
+
+module CFC
+  class APIObject
+    @relationships = []
+
+    def self.relationships
+      @relationships
+    end
+
+    def initialize(data)
+      @data = data
+      @api = CFC::API.new
+      initialize_relationships
+    end
+
+    def method_missing(name)
+      if @data.include?(name.to_s)
+        @data[name.to_s]
+      else
+        raise CFC::Errors::MissingProperty,
+              CFC::Errors::MissingProperty.default_message(self, name)
+      end
+    end
+    
+    def respond_to_missing?(name, *_args, **_opts)
+      @data.include?(name.to_s)
+    end
+
+    def inspect
+      "#<#{self.class.name}:0x#{(object_id << 1).to_s(16)} #{@data.map { |k, v| "#{k}=#{v.inspect}" }.join(', ')}>"
+    end
+
+    alias_method :to_s, :inspect
+
+    protected
+
+    def self.relationship(property, cls)
+      unless defined?(@relationships)
+        @relationships = []
+      end
+      @relationships << [property, cls]
+    end
+
+    private
+
+    def initialize_relationships
+      (self.class.relationships || []).each do |rel|
+        property, cls = rel
+        @data[property.to_s] = cls.new(@data[property.to_s])
+      end
+    end
+  end
+end

data/lib/cfc/objects/record.rb

@@ -0,0 +1,21 @@
+module CFC
+  class Record < CFC::APIObject
+    def initialize(data)
+      super(data)
+    end
+
+    def proxy
+      set_proxied(true)
+    end
+
+    def deproxy
+      set_proxied(false)
+    end
+
+    private
+
+    def set_proxied(to)
+      @api.patch_to_json("zones/#{zone_id}/dns_records/#{id}", { proxied: to })
+    end
+  end
+end

data/lib/cfc/objects/user.rb

@@ -0,0 +1,9 @@
+require_relative 'object'
+
+module CFC
+  class User < CFC::APIObject
+    def initialize(data)
+      super(data)
+    end
+  end
+end

data/lib/cfc/objects/zone.rb

@@ -0,0 +1,31 @@
+require_relative 'object'
+require_relative 'user'
+require_relative 'account'
+require_relative 'record'
+
+module CFC
+  class Zone < CFC::APIObject
+    relationship :owner, CFC::User
+    relationship :account, CFC::Account
+
+    @api = CFC::API.new
+
+    def self.list
+      data = @api.get_json('zones')['result']
+      data.map { |z| new(z) }
+    end
+
+    def initialize(data)
+      super(data)
+    end
+
+    def purge_all_files
+      @api.post_to_json("zones/#{id}/purge_cache", { purge_everything: true })
+    end
+
+    def records
+      data = @api.get_json("zones/#{id}/dns_records")['result']
+      data.map { |r| CFC::Record.new(r) }
+    end
+  end
+end

data/lib/cfc/version.rb

@@ -0,0 +1,3 @@
+module CFC
+  VERSION = '0.1.1'
+end

data/lib/cfc.rb

@@ -0,0 +1,10 @@
+require_relative 'cfc/api'
+require_relative 'cfc/config'
+require_relative 'cfc/version'
+
+require_relative 'cfc/objects/account'
+require_relative 'cfc/objects/record'
+require_relative 'cfc/objects/user'
+require_relative 'cfc/objects/zone'
+
+module CFC; end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: cfc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- The Codidact Foundation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-31 00:00:00.000000000 Z
+dependencies: []
+description: 'See GitHub for usage details: https://github.com/codidact/cfc'
+email: gems@codidact.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cfc.rb
+- lib/cfc/api.rb
+- lib/cfc/cache.rb
+- lib/cfc/config.rb
+- lib/cfc/errors/http_error.rb
+- lib/cfc/errors/missing_property.rb
+- lib/cfc/objects/account.rb
+- lib/cfc/objects/object.rb
+- lib/cfc/objects/record.rb
+- lib/cfc/objects/user.rb
+- lib/cfc/objects/zone.rb
+- lib/cfc/version.rb
+homepage: https://github.com/codidact/cfc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Simple API library for interacting with the Cloudflare API.
+test_files: []