cfc 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820b83bedc1e954528d342f7060a43f05e1ca108293a0a6ec180604f1afbfa6b
-  data.tar.gz: 6425fb5bade05ada6d104b10d6ef5bbf6817c9a10a7336645dcdb39bdb7486f3
+  metadata.gz: 3f5f2aefe1d6f36747241422a791bfa619b4d6dc53b9ef5e93a191b3162eed1a
+  data.tar.gz: 3a0d745cdc585a8290ab9bd0623299968e70fc344a638586115bc16cc35008ad
 SHA512:
-  metadata.gz: af74f88b7fa189a2ff33a4ed8ca365e6fcfd3fc89711da0b5db369c07f1df9f1a17d08093e333c9651520c7dcf611f0a620bca49a8519e5c1083b5d028d97077
-  data.tar.gz: 0d0440c563e99d4bd6e36f2801c7cec242df6aa1b870229169f08d112cb7f518654f714fae3c38a6acc5a526ffa5235a74c9872032f4ca4ba5776602f33f7e03
+  metadata.gz: e0d898e56d580631ab901c37453419d54d7a079378932af2518220294769122f3803d0db4b65b90f99fc1671294edc0973fcf244aee7c854be62ec5a4d37ba21
+  data.tar.gz: 66859b84c931ec9519afe931edb9ec48662607c886a030151dbc82f633056245b5a269a7e7c861745fdca1733da86e21d62bca7fa8ff07e177a2e96aeb9bad01

data/README.md

@@ -19,10 +19,39 @@ CFC::Config.configure do |config|
 end
 ```
 
+Alternatively, you can authenticate with your API key and email address:
+
+```ruby
+CFC::Config.configure do |config|
+  config.api_key = 'your_api_key_here'
+  config.api_email = 'your_email_here'
+end
+```
+
 You can then 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 with `CFC::Zone` objects.
+or, 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. For instance, to list DNS records in all zones you
+administer (assuming you've already configured the gem as above):
+
+```ruby
+CFC::Zone.list.each do |zone|
+  puts zone.records
+end
+```
+
+Or if you need to roll all of your current API tokens:
+
+```ruby
+new_tokens = CFC::UserAPIToken.list.each do |token|
+  token.roll['result']
+end
+
+# Once you've rolled tokens, of course, your existing token won't work, so you
+# probably want to update that.
+CFC::Config.configure do |config|
+  config.token = new_tokens[0]
+end
+```
 
 ## Contributing
 As with all Codidact projects, contributions are welcome and must adhere to the

data/lib/cfc/objects/api_token_policy.rb

@@ -1,8 +1,17 @@
+require 'json'
 require_relative 'object'
 require_relative 'permission_group'
 
 module CFC
   class APITokenPolicy < CFC::APIObject
     relationship :permission_groups, CFC::PermissionGroup, multiple: true
+
+    def self.build(effect:, resources:, permission_groups:)
+      new(JSON.parse(JSON.dump({
+        effect: effect,
+        resources: resources&.map { |k, v| [k.to_json, v] }&.to_h,
+        permission_groups: permission_groups
+      }.compact)))
+    end
   end
 end

data/lib/cfc/objects/object.rb

@@ -34,6 +34,16 @@ module CFC
 
     alias to_s inspect
 
+    def to_h
+      @data
+    end
+
+    alias as_json to_h
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+
     def self.relationship(property, cls, multiple: false)
       unless defined?(@relationships)
         @relationships = []

data/lib/cfc/objects/permission_group.rb

@@ -1,6 +1,16 @@
+require 'json'
 require_relative 'object'
 
 module CFC
   class PermissionGroup < CFC::APIObject
+    @api = CFC::API.new
+
+    def self.list
+      @api.get_json('user/tokens/permission_groups')['result'].map { |pg| new(pg) }
+    end
+
+    def to_json(*_args)
+      JSON.dump({ id: id, name: name })
+    end
   end
 end

data/lib/cfc/objects/user_api_token.rb

@@ -24,6 +24,12 @@ module CFC
       @api.put_to_json("user/tokens/#{identifier}/value", {})
     end
 
+    def self.create(name:, policies:, not_before: nil, expires_on: nil, condition: nil)
+      data = { name: name, policies: policies, not_before: not_before, expires_on: expires_on, condition: condition }
+      data = data.compact
+      new(@api.post_to_json('user/tokens', data)['result'])
+    end
+
     def details
       CFC::UserAPIToken.details(id)
     end

data/lib/cfc/objects/zone.rb

@@ -1,3 +1,4 @@
+require 'json'
 require_relative 'object'
 require_relative 'user'
 require_relative 'account'
@@ -23,5 +24,9 @@ module CFC
       data = @api.get_json("zones/#{id}/dns_records")['result']
       data.map { |r| CFC::Record.new(r) }
     end
+
+    def to_json(*_args)
+      "com.cloudflare.api.account.zone.#{id}"
+    end
   end
 end

data/lib/cfc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - The Codidact Foundation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-01-07 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'