cfc 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 563b2293943b85d67b3dff9d612481addd9dc32272647691d891d3376ccdcf92
-  data.tar.gz: efa22237c80919923fe33a514bbb8779fd9bd9f36d568cf52c56f1f36bf02553
+  metadata.gz: 820b83bedc1e954528d342f7060a43f05e1ca108293a0a6ec180604f1afbfa6b
+  data.tar.gz: 6425fb5bade05ada6d104b10d6ef5bbf6817c9a10a7336645dcdb39bdb7486f3
 SHA512:
-  metadata.gz: 9b3de0e73d175282548bbf7c1e67a547d2942285feec299c3cb094af4bb836f10de4814039dc88e7df481b96c4b6a7276b3f559b353abb3b8147aacc12cf7f2f
-  data.tar.gz: 1b709a15c173a3d9b0476469a785e65f90d8d5e0cc76da60f20a34b2f821ae0dc6a4ebf8dba4d515df9c0f70800eef9cdb2c1865d75cc728e72322ca12d23678
+  metadata.gz: af74f88b7fa189a2ff33a4ed8ca365e6fcfd3fc89711da0b5db369c07f1df9f1a17d08093e333c9651520c7dcf611f0a620bca49a8519e5c1083b5d028d97077
+  data.tar.gz: 0d0440c563e99d4bd6e36f2801c7cec242df6aa1b870229169f08d112cb7f518654f714fae3c38a6acc5a526ffa5235a74c9872032f4ca4ba5776602f33f7e03

data/lib/cfc.rb

@@ -3,8 +3,11 @@ require_relative 'cfc/config'
 require_relative 'cfc/version'
 
 require_relative 'cfc/objects/account'
+require_relative 'cfc/objects/api_token_policy'
+require_relative 'cfc/objects/permission_group'
 require_relative 'cfc/objects/record'
 require_relative 'cfc/objects/user'
+require_relative 'cfc/objects/user_api_token'
 require_relative 'cfc/objects/zone'
 
 module CFC; end

data/lib/cfc/api.rb

@@ -4,7 +4,7 @@ require 'digest'
 require 'yaml'
 require_relative 'config'
 require_relative 'cache'
-require_relative 'errors/http_error.rb'
+require_relative 'errors/http_error'
 
 module CFC
   class API
@@ -21,33 +21,51 @@ module CFC
       request_json(Net::HTTP::Get, build_uri(path, params), headers: headers, cache: cache, expiry: expiry)
     end
 
+    def delete(path, data: {}, headers: nil, cache: false, expiry: nil)
+      request(Net::HTTP::Delete, URI("#{@base}#{path}"), data: data, headers: headers, cache: cache, expiry: expiry)
+    end
+
+    def delete_to_json(path, data: {}, headers: nil, cache: false, expiry: nil)
+      request_json(Net::HTTP::Delete, URI("#{@base}#{path}"), data: data, 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)
+        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)
+        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'
-      })
+      headers = (headers || {}).merge({ 'Content-Type' => 'application/json' })
+      @auth_method = CFC::Config.instance.token.nil? ? :key : :token
+
+      case @auth_method
+      when :token
+        headers.merge!({ 'Authentication' => "Bearer #{CFC::Config.instance.token}" })
+      when :key
+        headers.merge!({
+                         'X-Auth-Key' => CFC::Config.instance.api_key,
+          'X-Auth-Email' => CFC::Config.instance.api_email
+                       })
+      end
 
-      rq = cls.new(uri, final_headers)
+      rq = cls.new(uri, 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
+          @cache.fetch(Digest::SHA256.hexdigest("#{uri}|#{JSON.dump(headers)}"), expiry: expiry) do
             http.request(rq)
           end
         else

data/lib/cfc/cache.rb

@@ -37,6 +37,6 @@ module CFC
       end
     end
 
-    alias_method :valid?, :include?
+    alias valid? include?
   end
 end

data/lib/cfc/config.rb

@@ -1,12 +1,19 @@
 require 'singleton'
+require_relative 'errors/configuration_error'
 
 module CFC
   class Config
     include Singleton
-    attr_accessor :token
+    attr_accessor :token, :api_key, :api_email
 
     def self.configure
       yield CFC::Config.instance
+      if [instance.token, instance.api_key, instance.api_email].all?(&:nil?)
+        raise CFC::Errors::ConfigurationError, 'Either `token` or BOTH of `api_key`, `api_email` must be set on call ' \
+                                               "to `configure'."
+      elsif instance.token.nil? && [instance.api_key, instance.api_email].any?(&:nil?)
+        raise CFC::Errors::ConfigurationError, 'Both `api_key` AND `api_email` must be set when not using token auth.'
+      end
     end
   end
-end
+end

data/lib/cfc/errors/configuration_error.rb

@@ -0,0 +1,6 @@
+module CFC
+  module Errors
+    class ConfigurationError < StandardError
+    end
+  end
+end

data/lib/cfc/errors/missing_property.rb

@@ -2,12 +2,8 @@ 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
+        "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
     end
   end

data/lib/cfc/objects/account.rb

@@ -2,8 +2,5 @@ require_relative 'object'
 
 module CFC
   class Account < CFC::APIObject
-    def initialize(data)
-      super(data)
-    end
   end
 end

data/lib/cfc/objects/api_token_policy.rb

@@ -0,0 +1,8 @@
+require_relative 'object'
+require_relative 'permission_group'
+
+module CFC
+  class APITokenPolicy < CFC::APIObject
+    relationship :permission_groups, CFC::PermissionGroup, multiple: true
+  end
+end

data/lib/cfc/objects/object.rb

@@ -5,8 +5,8 @@ module CFC
   class APIObject
     @relationships = []
 
-    def self.relationships
-      @relationships
+    class << self
+      attr_reader :relationships
     end
 
     def initialize(data)
@@ -23,7 +23,7 @@ module CFC
               CFC::Errors::MissingProperty.default_message(self, name)
       end
     end
-    
+
     def respond_to_missing?(name, *_args, **_opts)
       @data.include?(name.to_s)
     end
@@ -32,24 +32,32 @@ module CFC
       "#<#{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
+    alias to_s inspect
 
-    def self.relationship(property, cls)
+    def self.relationship(property, cls, multiple: false)
       unless defined?(@relationships)
         @relationships = []
       end
-      @relationships << [property, cls]
+      @relationships << [property, cls, { multiple: multiple }]
+    end
+
+    def self.opts(bind)
+      bind.local_variables.map do |var|
+        [var, bind.local_variable_get(var)]
+      end.to_h
     end
 
     private
 
     def initialize_relationships
       (self.class.relationships || []).each do |rel|
-        property, cls = rel
-        @data[property.to_s] = cls.new(@data[property.to_s])
+        property, cls, opts = rel
+        @data[property.to_s] = if opts[:multiple]
+                                 @data[property.to_s].map { |o| cls.new(o) }
+                               else
+                                 cls.new(@data[property.to_s])
+                               end
       end
     end
   end
-end
+end

data/lib/cfc/objects/permission_group.rb

@@ -0,0 +1,6 @@
+require_relative 'object'
+
+module CFC
+  class PermissionGroup < CFC::APIObject
+  end
+end

data/lib/cfc/objects/record.rb

@@ -1,9 +1,7 @@
+require_relative 'object'
+
 module CFC
   class Record < CFC::APIObject
-    def initialize(data)
-      super(data)
-    end
-
     def proxy
       set_proxied(true)
     end
@@ -14,7 +12,7 @@ module CFC
 
     private
 
-    def set_proxied(to)
+    def set_proxied(to) # rubocop:disable Naming/AccessorMethodName
       @api.patch_to_json("zones/#{zone_id}/dns_records/#{id}", { proxied: to })
     end
   end

data/lib/cfc/objects/user.rb

@@ -2,8 +2,23 @@ require_relative 'object'
 
 module CFC
   class User < CFC::APIObject
-    def initialize(data)
-      super(data)
+    @api = CFC::API.new
+
+    # Get full details of the current user.
+    def self.details
+      new(@api.get_json('user')['result'])
+    end
+
+    # Update part of the current user's details as permitted.
+    #
+    # @param first_name [String]
+    # @param last_name [String]
+    # @param telephone [String]
+    # @param country [String]
+    # @param zipcode [String]
+    def self.edit(first_name: nil, last_name: nil, telephone: nil, country: nil, zipcode: nil)
+      data = opts(binding)
+      @api.patch_to_json('user', data)
     end
   end
 end

data/lib/cfc/objects/user_api_token.rb

@@ -0,0 +1,39 @@
+require_relative 'object'
+require_relative 'api_token_policy'
+
+module CFC
+  class UserAPIToken < CFC::APIObject
+    relationship :policies, CFC::APITokenPolicy, multiple: true
+
+    @api = CFC::API.new
+
+    def self.list(page: nil, per_page: nil, direction: nil)
+      params = opts(binding).compact
+      @api.get_json('user/tokens', params: params)['result'].map { |o| new(o) }
+    end
+
+    def self.details(identifier)
+      new(@api.get_json("user/tokens/#{identifier}")['result'])
+    end
+
+    def self.delete(identifier)
+      @api.delete_to_json("user/tokens/#{identifier}")
+    end
+
+    def self.roll(identifier)
+      @api.put_to_json("user/tokens/#{identifier}/value", {})
+    end
+
+    def details
+      CFC::UserAPIToken.details(id)
+    end
+
+    def delete
+      CFC::UserAPIToken.delete(id)
+    end
+
+    def roll
+      CFC::UserAPIToken.roll(id)
+    end
+  end
+end

data/lib/cfc/objects/zone.rb

@@ -15,10 +15,6 @@ module CFC
       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

data/lib/cfc/version.rb

@@ -1,3 +1,3 @@
 module CFC
-  VERSION = '0.1.2'
-end
+  VERSION = '0.1.3'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - The Codidact Foundation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-01-02 00:00:00.000000000 Z
 dependencies: []
 description: 'Simple API library for interacting with the Cloudflare API. See GitHub
   for usage details: https://github.com/codidact/cfc'
@@ -23,12 +23,16 @@ files:
 - lib/cfc/api.rb
 - lib/cfc/cache.rb
 - lib/cfc/config.rb
+- lib/cfc/errors/configuration_error.rb
 - lib/cfc/errors/http_error.rb
 - lib/cfc/errors/missing_property.rb
 - lib/cfc/objects/account.rb
+- lib/cfc/objects/api_token_policy.rb
 - lib/cfc/objects/object.rb
+- lib/cfc/objects/permission_group.rb
 - lib/cfc/objects/record.rb
 - lib/cfc/objects/user.rb
+- lib/cfc/objects/user_api_token.rb
 - lib/cfc/objects/zone.rb
 - lib/cfc/version.rb
 homepage: https://github.com/codidact/cfc
@@ -43,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple API library for interacting with the Cloudflare API.