contentzen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 861f6ced90b23184f35f33b8adb9e62c589c42c37ddeefe6b5956765eccba18d
+  data.tar.gz: 65db4772b48ff42ffb929079218ea8025e8d0ba88580fd2407ac958f080b074d
+SHA512:
+  metadata.gz: 299d2f7cfd12808e80e2904c3aa3d77590e1c1ac792c44b1a21542ec0e0cbfad98e93515462aba914c9d19195696e2781de2d8f47b7ee4d8b37b4cdf822b73fd
+  data.tar.gz: 1a91006e9d498bf6b6f4334d09250101020ca455b605611147d9f19a2b04ee6b256301c114535a50ccc8f653d4c9907c9ec1a1a9f7fe14744534b09b3a014d9c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Name
+
+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,120 @@
+# ContentZen Ruby SDK
+
+Ruby SDK for ContentZen, designed for Rails and other Ruby-based stacks. Includes ActiveRecord-style queries for structured content.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contentzen'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install contentzen
+
+## Usage
+
+```ruby
+require 'contentzen'
+
+client = ContentZen::Client.new(api_token: 'your_api_token')
+
+# Fetch public documents
+client.public_documents(collection_uuid: 'your_collection_uuid')
+
+# Fetch a specific document (public)
+client.public_document(collection_uuid: 'your_collection_uuid', document_uuid: 'your_document_uuid')
+
+# Fetch private documents (requires api_token)
+client.documents(collection_uuid: 'your_collection_uuid')
+
+# ... more usage examples ...
+```
+
+## Collections
+
+```ruby
+# Get all collections
+client.collections
+
+# Get a specific collection
+client.collection(collection_uuid: 'your_collection_uuid')
+
+# Create a collection
+client.create_collection({
+  name: 'products',
+  display_name: 'Products',
+  description: 'Product catalog',
+  is_public: false,
+  fields: [
+    { name: 'title', type: 'string', display_name: 'Product Title', required: true },
+    { name: 'price', type: 'number', display_name: 'Price', required: true }
+  ]
+})
+
+# Update a collection
+client.update_collection(collection_uuid: 'your_collection_uuid', payload: { display_name: 'Updated Products' })
+
+# Delete a collection
+client.delete_collection(collection_uuid: 'your_collection_uuid')
+
+# Get collection schema
+client.collection_schema(collection_uuid: 'your_collection_uuid')
+
+# Get collection fields
+client.collection_fields(collection_uuid: 'your_collection_uuid')
+
+# Get available field types
+client.field_types
+```
+
+## Media
+
+```ruby
+# List all media files
+client.list_media
+
+# Upload a media file
+client.upload_media('/path/to/file.jpg')
+
+# Get media file details
+client.media_file(media_uuid: 'your_media_uuid')
+
+# Update media file metadata
+client.update_media(media_uuid: 'your_media_uuid', payload: { alt_text: 'Updated alt text' })
+
+# Delete a media file
+client.delete_media(media_uuid: 'your_media_uuid')
+
+# Download a media file (returns file data)
+client.download_media(media_uuid: 'your_media_uuid')
+```
+
+## Webhooks
+
+```ruby
+# List all webhooks
+client.list_webhooks
+
+# Create a webhook
+client.create_webhook({
+  name: 'My Webhook',
+  url: 'https://example.com/webhook',
+  events: ['document.created', 'document.updated'],
+  method: 'POST'
+})
+
+# Update a webhook
+client.update_webhook(webhook_uuid: 'your_webhook_uuid', payload: { name: 'Updated Webhook' })
+
+# Delete a webhook
+client.delete_webhook(webhook_uuid: 'your_webhook_uuid')
+```
+
+See [ContentZen API Docs](https://www.postman.com/winter-meteor-7066631/contentzen/collection/9m7enab/contentzen-api) for full API details.

data/lib/contentzen/client.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module ContentZen
+  class Client
+    API_BASE_URL = 'https://api.contentzen.io'.freeze
+
+    attr_reader :api_token
+
+    def initialize(api_token: nil)
+      @api_token = api_token
+    end
+
+    # Public API: Get all published documents from a public collection
+    def public_documents(collection_uuid:, limit: 10, offset: 0, state: 'published')
+      get("/api/v1/documents/collection/#{collection_uuid}", params: { limit: limit, offset: offset, state: state })
+    end
+
+    # Public API: Get a specific document from a public collection
+    def public_document(collection_uuid:, document_uuid:)
+      get("/api/v1/documents/collection/#{collection_uuid}/#{document_uuid}")
+    end
+
+    # Private API: Get documents from a collection (requires API token)
+    def documents(collection_uuid:, limit: 10, offset: 0)
+      get("/api/v1/documents/#{collection_uuid}", auth: true, params: { limit: limit, offset: offset })
+    end
+
+    # Private API: Get a specific document (requires API token)
+    def document(collection_uuid:, document_uuid:)
+      get("/api/v1/documents/#{collection_uuid}/#{document_uuid}", auth: true)
+    end
+
+    # --- Collections ---
+
+    # Get all collections (requires API token)
+    def collections
+      get("/api/v1/collections", auth: true)
+    end
+
+    # Get a specific collection (requires API token)
+    def collection(collection_uuid:)
+      get("/api/v1/collections/#{collection_uuid}", auth: true)
+    end
+
+    # Create a new collection (requires API token)
+    def create_collection(payload)
+      post("/api/v1/collections", payload, auth: true)
+    end
+
+    # Update a collection (requires API token)
+    def update_collection(collection_uuid:, payload:)
+      put("/api/v1/collections/#{collection_uuid}", payload, auth: true)
+    end
+
+    # Delete a collection (requires API token)
+    def delete_collection(collection_uuid:)
+      delete("/api/v1/collections/#{collection_uuid}", auth: true)
+    end
+
+    # Get collection schema (requires API token)
+    def collection_schema(collection_uuid:)
+      get("/api/v1/collections/#{collection_uuid}/schema", auth: true)
+    end
+
+    # Get collection fields (requires API token)
+    def collection_fields(collection_uuid:)
+      get("/api/v1/collections/#{collection_uuid}/fields", auth: true)
+    end
+
+    # Get available field types (requires API token)
+    def field_types
+      get("/api/v1/collections/field-types", auth: true)
+    end
+
+    # --- Media ---
+
+    # List all media files (requires API token)
+    def list_media
+      get("/api/v1/media/ls", auth: true)
+    end
+
+    # Upload a media file (requires API token)
+    def upload_media(file_path)
+      uri = URI.join(API_BASE_URL, "/api/v1/media/upload")
+      request = Net::HTTP::Post.new(uri)
+      request['Authorization'] = "Bearer #{@api_token}" if @api_token
+      form_data = [['file', File.open(file_path)]]
+      request.set_form(form_data, 'multipart/form-data')
+      perform_request(uri, request)
+    end
+
+    # Get specific media file details (requires API token)
+    def media_file(media_uuid:)
+      get("/api/v1/media/#{media_uuid}", auth: true)
+    end
+
+    # Update media file metadata (requires API token)
+    def update_media(media_uuid:, payload:)
+      put("/api/v1/media/#{media_uuid}", payload, auth: true)
+    end
+
+    # Delete a media file (requires API token)
+    def delete_media(media_uuid:)
+      delete("/api/v1/media/#{media_uuid}", auth: true)
+    end
+
+    # Download a media file (requires API token)
+    def download_media(media_uuid:)
+      get("/api/v1/media/#{media_uuid}/download", auth: true)
+    end
+
+    # --- Webhooks ---
+
+    # List all webhooks (requires API token)
+    def list_webhooks
+      get("/api/v1/webhooks", auth: true)
+    end
+
+    # Create a new webhook (requires API token)
+    def create_webhook(payload)
+      post("/api/v1/webhooks", payload, auth: true)
+    end
+
+    # Update a webhook (requires API token)
+    def update_webhook(webhook_uuid:, payload:)
+      put("/api/v1/webhooks/#{webhook_uuid}", payload, auth: true)
+    end
+
+    # Delete a webhook (requires API token)
+    def delete_webhook(webhook_uuid:)
+      delete("/api/v1/webhooks/#{webhook_uuid}", auth: true)
+    end
+
+    # --- HTTP helpers ---
+    private
+
+    def get(path, auth: false, params: {})
+      uri = URI.join(API_BASE_URL, path)
+      uri.query = URI.encode_www_form(params) unless params.empty?
+      request = Net::HTTP::Get.new(uri)
+      request['Authorization'] = "Bearer #{@api_token}" if auth && @api_token
+      perform_request(uri, request)
+    end
+
+    def post(path, payload, auth: false)
+      uri = URI.join(API_BASE_URL, path)
+      request = Net::HTTP::Post.new(uri)
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = "Bearer #{@api_token}" if auth && @api_token
+      request.body = payload.to_json
+      perform_request(uri, request)
+    end
+
+    def put(path, payload, auth: false)
+      uri = URI.join(API_BASE_URL, path)
+      request = Net::HTTP::Put.new(uri)
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = "Bearer #{@api_token}" if auth && @api_token
+      request.body = payload.to_json
+      perform_request(uri, request)
+    end
+
+    def delete(path, auth: false)
+      uri = URI.join(API_BASE_URL, path)
+      request = Net::HTTP::Delete.new(uri)
+      request['Authorization'] = "Bearer #{@api_token}" if auth && @api_token
+      perform_request(uri, request)
+    end
+
+    def perform_request(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      response = http.request(request)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      response.body
+    end
+  end
+end

data/lib/contentzen/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ContentZen
+  VERSION = "0.1.0"
+end

data/lib/contentzen.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "contentzen/version"
+require_relative "contentzen/client"
+
+module ContentZen
+  # Main module for ContentZen Ruby SDK
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: contentzen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your Name
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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'
+description: Ruby SDK for ContentZen, designed for Rails and other Ruby-based stacks.
+  Includes ActiveRecord-style queries for structured content.
+email:
+- your@email.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/contentzen.rb
+- lib/contentzen/client.rb
+- lib/contentzen/version.rb
+homepage: https://contentzen.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://contentzen.io
+  source_code_uri: https://github.com/yourusername/contentzen-ruby
+  changelog_uri: https://github.com/yourusername/contentzen-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for ContentZen headless CMS.
+test_files: []