cloudflare-artifacts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e001f93d20a3cf60111cea996305c7bc401684ef024cac193dd695023ee2857a
+  data.tar.gz: b3c0ee6a77510a5f9235996419bfe30bdd0feee632ccbc71c5a000c6d72f8b44
+SHA512:
+  metadata.gz: 603c1d9c7b1b4f192baa60ba3e48fe2b1cd13f8b8395c09f6388af271f90467c5e92be9a8c0a77b19d7a978c1665aa17c7b9143bb64808921252035a47422765
+  data.tar.gz: 8693ccd430f7db54de68c7bcdb9721daca763947e772927f335d52607f22de9690fcdad542f605055618c12c14e80f3532c6f5e48f9231cb81c649786eccb5a1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 songji.zeng
+
+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,185 @@
+# Cloudflare::Artifacts
+
+A Ruby client for the [Cloudflare Artifacts](https://developers.cloudflare.com/artifacts/) REST API, built on [Faraday](https://github.com/lostisland/faraday).
+
+Manage Artifacts repositories and tokens from Ruby — create, list, fork, import, and mint short-lived Git credentials.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "cloudflare-artifacts"
+```
+
+Or install directly:
+
+```bash
+gem install cloudflare-artifacts
+```
+
+## Usage
+
+### Configure once, use everywhere
+
+```ruby
+require "cloudflare/artifacts"
+
+Cloudflare::Artifacts.configure do |c|
+  c.account_id = ENV.fetch("CLOUDFLARE_ACCOUNT_ID")
+  c.api_token  = ENV.fetch("CLOUDFLARE_API_TOKEN")
+  c.namespace  = "default" # optional, defaults to "default"
+  c.timeout    = 30        # optional
+end
+
+client = Cloudflare::Artifacts::Client.new
+```
+
+### Or pass options per client
+
+```ruby
+client = Cloudflare::Artifacts::Client.new(
+  account_id: ENV.fetch("CLOUDFLARE_ACCOUNT_ID"),
+  api_token:  ENV.fetch("CLOUDFLARE_API_TOKEN"),
+  namespace:  "ci"
+)
+```
+
+### Or supply an explicit Configuration
+
+```ruby
+config = Cloudflare::Artifacts::Configuration.new(
+  account_id: "...",
+  api_token:  "...",
+  namespace:  "ci"
+)
+client = Cloudflare::Artifacts::Client.new(config)
+```
+
+### Or load from environment / file
+
+```ruby
+# From ENV — reads:
+#   CLOUDFLARE_ACCOUNT_ID, CLOUDFLARE_API_TOKEN,
+#   CLOUDFLARE_ARTIFACTS_NAMESPACE, CLOUDFLARE_API_BASE_URL,
+#   CLOUDFLARE_ARTIFACTS_TIMEOUT, CLOUDFLARE_ARTIFACTS_USER_AGENT
+Cloudflare::Artifacts.configuration = Cloudflare::Artifacts::Configuration.from_env
+
+# From a YAML or JSON file
+Cloudflare::Artifacts.configuration =
+  Cloudflare::Artifacts::Configuration.from_file("config/cloudflare.yml")
+```
+
+Keyword overrides also work when a `Configuration` is passed — they're merged, leaving the original untouched:
+
+```ruby
+Cloudflare::Artifacts::Client.new(config, namespace: "staging")
+```
+
+Every call returns a `Cloudflare::Artifacts::Response` (a `Data` object) exposing `result`, `errors`, `messages`, and `result_info` from the standard Cloudflare v4 envelope.
+
+### Repos
+
+```ruby
+# Create a repo
+resp = client.repos.create(
+  name: "starter-repo",
+  description: "Repository for automation experiments",
+  default_branch: "main"
+)
+remote = resp.result["remote"]
+token  = resp.result["token"]
+
+# List repos (supports limit, cursor, search, sort, direction)
+client.repos.list(limit: 50, sort: "updated_at", direction: "desc")
+
+# Get a repo
+client.repos.get("starter-repo")
+
+# Delete a repo
+client.repos.delete("starter-repo")
+
+# Fork a repo
+client.repos.fork("starter-repo",
+                  name: "starter-repo-copy",
+                  default_branch_only: true)
+
+# Import a public HTTPS remote
+client.repos.import("react-mirror",
+                    url: "https://github.com/facebook/react",
+                    branch: "main",
+                    depth: 100)
+
+# List tokens for a repo
+client.repos.tokens("starter-repo", state: "active")
+```
+
+### Tokens
+
+```ruby
+# Mint a short-lived token (TTL in seconds, 60..31_536_000)
+resp = client.tokens.create(repo: "starter-repo", scope: "read", ttl: 3600)
+plaintext = resp.result["plaintext"]
+
+# Revoke a token
+client.tokens.revoke("tok_123")
+```
+
+### Per-call namespace override
+
+Override the default namespace per call by passing `namespace:`:
+
+```ruby
+client.repos.get("starter-repo", namespace: "ci")
+```
+
+### Error handling
+
+Non-2xx responses raise typed errors. All inherit from `Cloudflare::Artifacts::APIError`:
+
+```ruby
+begin
+  client.repos.get("missing")
+rescue Cloudflare::Artifacts::NotFoundError => e
+  e.status # => 404
+  e.errors # => [{ "code" => 1000, "message" => "Repo not found" }]
+end
+```
+
+Available subclasses: `BadRequestError`, `AuthenticationError`, `ForbiddenError`, `NotFoundError`, `ConflictError`, `UnprocessableEntityError`, `RateLimitError`, `ServerError`.
+
+### Customizing Faraday
+
+`Configuration` exposes `adapter`, `timeout`, `base_url`, and `user_agent`:
+
+```ruby
+Cloudflare::Artifacts.configure do |c|
+  c.adapter = :net_http_persistent
+  c.timeout = 60
+  c.user_agent = "myapp/1.0"
+end
+```
+
+For tests, use the Faraday test adapter — the adapter value can be `[symbol, *args]`:
+
+```ruby
+stubs = Faraday::Adapter::Test::Stubs.new
+client = Cloudflare::Artifacts::Client.new(
+  account_id: "acct", api_token: "tok",
+  adapter: [:test, stubs]
+)
+```
+
+## Development
+
+```bash
+bundle exec rake # run tests + rubocop
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/songjiz/cloudflare-artifacts.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/cloudflare/artifacts/client.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Cloudflare
+  module Artifacts
+    class Client
+      attr_reader :config, :connection
+
+      def initialize(config = nil, **opts)
+        @config = resolve_config(config, opts)
+        @config.validate!
+        @connection = build_connection
+      end
+
+      def account_id
+        @config.account_id
+      end
+
+      def api_token
+        @config.api_token
+      end
+
+      def namespace
+        @config.namespace
+      end
+
+      def repos
+        @repos ||= Repos.new(self)
+      end
+
+      def tokens
+        @tokens ||= Tokens.new(self)
+      end
+
+      def get(path, params: nil, namespace: nil)
+        request(:get, path, params: params, namespace: namespace)
+      end
+
+      def post(path, body: nil, params: nil, namespace: nil)
+        request(:post, path, body: body, params: params, namespace: namespace)
+      end
+
+      def delete(path, params: nil, namespace: nil)
+        request(:delete, path, params: params, namespace: namespace)
+      end
+
+      def request(method, path, params: nil, body: nil, namespace: nil)
+        ns = namespace || @config.namespace
+        raise ArgumentError, "namespace is required" if ns.nil? || ns.empty?
+
+        full_path = "/client/v4/accounts/#{@config.account_id}/artifacts/namespaces/#{ns}#{path}"
+        response = @connection.public_send(method, full_path) do |req|
+          req.params.update(params) if params && !params.empty?
+          req.body = body if body
+        end
+        handle_response(response)
+      end
+
+      private
+        def resolve_config(config, opts)
+          case config
+          when Configuration then opts.empty? ? config : config.merge(**opts)
+          when nil           then Artifacts.configuration.merge(**opts)
+          else raise ArgumentError, "expected Cloudflare::Artifacts::Configuration, got #{config.class}"
+          end
+        end
+
+        def build_connection
+          Faraday.new(url: @config.base_url) do |f|
+            apply_middleware(f)
+            apply_adapter(f)
+          end
+        end
+
+        def apply_middleware(faraday)
+          faraday.request :authorization, "Bearer", @config.api_token
+          faraday.request :json
+          faraday.response :json, content_type: /\bjson$/
+          faraday.headers["User-Agent"] = @config.user_agent
+          faraday.options.timeout = @config.timeout if @config.timeout
+        end
+
+        def apply_adapter(faraday)
+          if @config.adapter.is_a?(Array)
+            faraday.adapter(*@config.adapter)
+          else
+            faraday.adapter @config.adapter
+          end
+        end
+
+        def handle_response(response)
+          body = response.body
+          ok = response.success? && body.is_a?(Hash) && body["success"]
+          raise Artifacts.error_for(response.status, body) unless ok
+
+          Response.new(status: response.status, body: body)
+        end
+    end
+  end
+end

data/lib/cloudflare/artifacts/configuration.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    class Configuration
+      DEFAULT_BASE_URL = "https://api.cloudflare.com"
+      DEFAULT_NAMESPACE = "default"
+      DEFAULT_TIMEOUT = 30
+
+      attr_accessor :account_id, :api_token, :namespace, :base_url,
+                    :adapter, :timeout, :user_agent
+
+      class << self
+        def from_env
+          new(
+            base_url: ENV.fetch("CLOUDFLARE_API_BASE_URL", DEFAULT_BASE_URL),
+            namespace: ENV.fetch("CLOUDFLARE_ARTIFACTS_NAMESPACE", DEFAULT_NAMESPACE),
+            timeout: ENV.fetch("CLOUDFLARE_ARTIFACTS_TIMEOUT", DEFAULT_TIMEOUT).to_i,
+            account_id: ENV.fetch("CLOUDFLARE_ACCOUNT_ID", nil),
+            api_token: ENV.fetch("CLOUDFLARE_API_TOKEN", nil)
+          )
+        end
+
+        def from_file(path)
+          data = load_file(path)
+          raise ArgumentError, "expected a hash in #{path}, got #{data.class}" unless data.is_a?(Hash)
+
+          new(**symbolize_keys(data))
+        end
+
+        private
+          def load_file(path)
+            case File.extname(path).downcase
+            when ".yml", ".yaml"
+              require "yaml"
+              YAML.safe_load_file(path, permitted_classes: [Symbol], aliases: true)
+            when ".json"
+              require "json"
+              JSON.parse(File.read(path))
+            else
+              raise ArgumentError, "unsupported file format: #{path} (expected .yml, .yaml, or .json)"
+            end
+          end
+
+          def symbolize_keys(hash)
+            hash.transform_keys(&:to_sym)
+          end
+      end
+
+      def initialize(base_url: DEFAULT_BASE_URL, namespace: DEFAULT_NAMESPACE, timeout: DEFAULT_TIMEOUT, **options)
+        @base_url   = base_url
+        @namespace  = namespace
+        @timeout    = timeout
+        @adapter    = Faraday.default_adapter
+        @user_agent = "cloudflare-artifacts-ruby/#{VERSION}"
+        assign(options)
+      end
+
+      def assign(options)
+        options.each do |key, value|
+          setter = "#{key}="
+          raise ArgumentError, "unknown configuration option: #{key}" unless respond_to?(setter)
+
+          public_send(setter, value)
+        end
+        self
+      end
+
+      def merge(**options)
+        dup.assign(options)
+      end
+
+      def to_h
+        {
+          account_id: account_id,
+          api_token: api_token,
+          namespace: namespace,
+          base_url: base_url,
+          adapter: adapter,
+          timeout: timeout,
+          user_agent: user_agent
+        }
+      end
+
+      def validate!
+        raise ArgumentError, "account_id is required" if blank?(account_id)
+        raise ArgumentError, "api_token is required" if blank?(api_token)
+        raise ArgumentError, "namespace is required" if blank?(namespace)
+        raise ArgumentError, "timeout must be positive" unless timeout.is_a?(Numeric) && timeout.positive?
+
+        self
+      end
+
+      private
+        def blank?(value)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+    end
+  end
+end

data/lib/cloudflare/artifacts/error.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    class Error < StandardError; end
+
+    class APIError < Error
+      attr_reader :status, :body, :errors
+
+      def initialize(message = nil, status: nil, body: nil)
+        super(message)
+        @status = status
+        @body = body
+        @errors = (body.is_a?(Hash) && body["errors"]) || []
+      end
+    end
+
+    class BadRequestError < APIError; end
+    class AuthenticationError < APIError; end
+    class ForbiddenError < APIError; end
+    class NotFoundError < APIError; end
+    class ConflictError < APIError; end
+    class UnprocessableEntityError < APIError; end
+    class RateLimitError < APIError; end
+    class ServerError < APIError; end
+
+    STATUS_ERRORS = {
+      400 => BadRequestError,
+      401 => AuthenticationError,
+      403 => ForbiddenError,
+      404 => NotFoundError,
+      409 => ConflictError,
+      422 => UnprocessableEntityError,
+      429 => RateLimitError
+    }.freeze
+
+    def self.error_for(status, body)
+      klass = STATUS_ERRORS[status] || (status >= 500 ? ServerError : APIError)
+      message = extract_message(body) || "HTTP #{status}"
+      klass.new(message, status: status, body: body)
+    end
+
+    def self.extract_message(body)
+      return unless body.is_a?(Hash)
+
+      errors = body["errors"]
+      return unless errors.is_a?(Array) && !errors.empty?
+
+      errors.filter_map { |e| e.is_a?(Hash) ? e["message"] : nil }.join("; ").then do |msg|
+        msg.empty? ? nil : msg
+      end
+    end
+  end
+end

data/lib/cloudflare/artifacts/repos.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    class Repos
+      def initialize(client)
+        @client = client
+      end
+
+      def create(name:, namespace: nil, **attrs)
+        @client.post("/repos", body: { name: name, **attrs }, namespace: namespace)
+      end
+
+      def list(namespace: nil, **params)
+        @client.get("/repos", params: params, namespace: namespace)
+      end
+
+      def get(name, namespace: nil)
+        @client.get("/repos/#{name}", namespace: namespace)
+      end
+
+      def delete(name, namespace: nil)
+        @client.delete("/repos/#{name}", namespace: namespace)
+      end
+
+      def fork(name, namespace: nil, **attrs)
+        @client.post("/repos/#{name}/fork", body: attrs, namespace: namespace)
+      end
+
+      def import(name, url:, namespace: nil, **attrs)
+        @client.post("/repos/#{name}/import", body: { url: url, **attrs }, namespace: namespace)
+      end
+
+      def tokens(name, namespace: nil, **params)
+        @client.get("/repos/#{name}/tokens", params: params, namespace: namespace)
+      end
+    end
+  end
+end

data/lib/cloudflare/artifacts/response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    Response = Data.define(:status, :body) do
+      def initialize(status:, body:)
+        super(status: status, body: body.is_a?(Hash) ? body : {})
+      end
+
+      def result
+        body["result"]
+      end
+
+      def errors
+        body["errors"] || []
+      end
+
+      def messages
+        body["messages"] || []
+      end
+
+      def result_info
+        body["result_info"]
+      end
+
+      def success?
+        body["success"] == true
+      end
+    end
+  end
+end

data/lib/cloudflare/artifacts/tokens.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    class Tokens
+      def initialize(client)
+        @client = client
+      end
+
+      def create(repo:, scope:, ttl:, namespace: nil)
+        @client.post("/tokens", body: { repo: repo, scope: scope, ttl: ttl }, namespace: namespace)
+      end
+
+      def revoke(id, namespace: nil)
+        @client.delete("/tokens/#{id}", namespace: namespace)
+      end
+    end
+  end
+end

data/lib/cloudflare/artifacts/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cloudflare
+  module Artifacts
+    VERSION = "0.1.0"
+  end
+end

data/lib/cloudflare/artifacts.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+require_relative "artifacts/version"
+require_relative "artifacts/error"
+require_relative "artifacts/response"
+require_relative "artifacts/configuration"
+require_relative "artifacts/repos"
+require_relative "artifacts/tokens"
+require_relative "artifacts/client"
+
+module Cloudflare
+  module Artifacts
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+        configuration
+      end
+
+      def reset_configuration!
+        @configuration = Configuration.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare-artifacts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- songji.zeng
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Faraday-based Ruby client for managing Cloudflare Artifacts repositories
+  and tokens.
+email:
+- songji.zeng@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cloudflare/artifacts.rb
+- lib/cloudflare/artifacts/client.rb
+- lib/cloudflare/artifacts/configuration.rb
+- lib/cloudflare/artifacts/error.rb
+- lib/cloudflare/artifacts/repos.rb
+- lib/cloudflare/artifacts/response.rb
+- lib/cloudflare/artifacts/tokens.rb
+- lib/cloudflare/artifacts/version.rb
+homepage: https://github.com/songjiz/cloudflare-artifacts
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/songjiz/cloudflare-artifacts
+  source_code_uri: https://github.com/songjiz/cloudflare-artifacts
+  changelog_uri: https://github.com/songjiz/cloudflare-artifacts/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for the Cloudflare Artifacts REST API.
+test_files: []