fizzy-api-client 0.1.0

data/examples/demo.rb

@@ -0,0 +1,636 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Comprehensive demo script to test every feature of fizzy-api-client
+#
+# Usage:
+#   FIZZY_API_TOKEN=xxx FIZZY_ACCOUNT=yyy ruby examples/demo.rb
+#   Or for self-hosted:
+#   FIZZY_BASE_URL=https://fizzy.mycompany.com FIZZY_API_TOKEN=xxx ruby examples/demo.rb
+#
+# Options:
+#   SKIP_DESTRUCTIVE=1  - Skip operations that modify existing data (deactivate_user, etc.)
+#   VERBOSE=1           - Show full response data
+
+require_relative "../lib/fizzy_api_client"
+require "tempfile"
+
+class Demo
+  def initialize
+    @passed = 0
+    @failed = 0
+    @skipped = 0
+    @verbose = ENV["VERBOSE"] == "1"
+    @skip_destructive = ENV["SKIP_DESTRUCTIVE"] == "1"
+  end
+
+  def run
+    print_banner
+    check_configuration
+
+    @client = FizzyApiClient::Client.new
+
+    # Run all tests
+    test_identity
+    test_boards
+    test_columns
+    test_cards
+    test_steps
+    test_comments
+    test_reactions
+    test_tags
+    test_users
+    test_notifications
+    test_direct_uploads
+    test_pagination
+    test_error_handling
+
+    cleanup
+    print_summary
+  end
+
+  private
+
+  def print_banner
+    puts "=" * 60
+    puts "Fizzy API Client - Comprehensive Demo"
+    puts "=" * 60
+    puts "Version: #{FizzyApiClient::VERSION}"
+    puts "Base URL: #{ENV['FIZZY_BASE_URL'] || 'https://app.fizzy.do'}"
+    puts "Skip destructive: #{@skip_destructive}"
+    puts "=" * 60
+  end
+
+  def check_configuration
+    unless ENV["FIZZY_API_TOKEN"]
+      puts "\nError: FIZZY_API_TOKEN environment variable required"
+      puts "Usage: FIZZY_API_TOKEN=xxx FIZZY_ACCOUNT=yyy ruby examples/demo.rb"
+      exit 1
+    end
+  end
+
+  def print_header(text)
+    puts "\n#{text}"
+    puts "-" * text.length
+  end
+
+  def pass(text, data = nil)
+    @passed += 1
+    puts "  ✓ #{text}"
+    puts "    #{data.inspect}" if @verbose && data
+  end
+
+  def fail(text, error)
+    @failed += 1
+    puts "  ✗ #{text}"
+    puts "    Error: #{error.message}"
+  end
+
+  def skip(text, reason = nil)
+    @skipped += 1
+    puts "  ○ #{text} (skipped#{reason ? ": #{reason}" : ''})"
+  end
+
+  def test(description)
+    result = yield
+    pass(description, result)
+    result
+  rescue => e
+    fail(description, e)
+    nil
+  end
+
+  # ============================================================
+  # IDENTITY
+  # ============================================================
+  def test_identity
+    print_header "1. IDENTITY"
+
+    @identity = test("Get identity") { @client.identity }
+
+    if @identity && @identity["accounts"]&.any?
+      accounts = @identity["accounts"].map { |a| a["slug"] }
+      puts "    Accounts: #{accounts.join(', ')}"
+
+      unless @client.account_slug
+        first_account = @identity["accounts"].first["slug"]
+        @client.account_slug = first_account
+        puts "    Using account: #{@client.account_slug}"
+      end
+    else
+      puts "    No accounts found - cannot continue"
+      exit 1
+    end
+  end
+
+  # ============================================================
+  # BOARDS
+  # ============================================================
+  def test_boards
+    print_header "2. BOARDS"
+
+    # List boards
+    @boards = test("List boards") { @client.boards }
+    return unless @boards&.any?
+
+    @board = @boards.first
+    puts "    Using board: #{@board['name']} (#{@board['id']})"
+
+    # Get single board
+    test("Get single board") { @client.board(@board["id"]) }
+
+    # Create board
+    @test_board = test("Create board") do
+      @client.create_board(name: "API Demo Test Board")
+    end
+
+    if @test_board
+      # Update board
+      test("Update board name") do
+        @client.update_board(@test_board["id"], name: "API Demo Test Board (Updated)")
+      end
+
+      test("Update board settings") do
+        @client.update_board(@test_board["id"], auto_postpone_period: 14)
+      end
+    end
+  end
+
+  # ============================================================
+  # COLUMNS
+  # ============================================================
+  def test_columns
+    print_header "3. COLUMNS"
+
+    return skip("Columns tests", "no test board") unless @test_board
+
+    # List columns
+    columns = test("List columns") { @client.columns(@test_board["id"]) }
+
+    # Create column with named color (NEW FEATURE!)
+    @test_column = test("Create column with named color :lime") do
+      @client.create_column(board_id: @test_board["id"], name: "In Progress", color: :lime)
+    end
+
+    if @test_column
+      # Get single column
+      test("Get single column") do
+        @client.column(@test_board["id"], @test_column["id"])
+      end
+
+      # Update column with named color
+      test("Update column with named color :purple") do
+        @client.update_column(@test_board["id"], @test_column["id"], color: :purple)
+      end
+
+      # Update column name
+      test("Update column name") do
+        @client.update_column(@test_board["id"], @test_column["id"], name: "Review")
+      end
+
+      # Test all named colors
+      test("Create column with :blue (default)") do
+        @client.create_column(board_id: @test_board["id"], name: "Blue Column", color: :blue)
+      end
+
+      test("Create column with :pink") do
+        @client.create_column(board_id: @test_board["id"], name: "Pink Column", color: :pink)
+      end
+
+      test("Create column with CSS variable (backwards compat)") do
+        @client.create_column(board_id: @test_board["id"], name: "Yellow Column", color: "var(--color-card-3)")
+      end
+    end
+  end
+
+  # ============================================================
+  # CARDS
+  # ============================================================
+  def test_cards
+    print_header "4. CARDS"
+
+    return skip("Cards tests", "no board") unless @board
+
+    # List cards
+    test("List cards") { @client.cards }
+
+    test("List cards with board filter") do
+      @client.cards(board_ids: [@board["id"]])
+    end
+
+    # Create card
+    @test_card = test("Create card") do
+      @client.create_card(board_id: @board["id"], title: "API Demo Test Card")
+    end
+
+    return unless @test_card
+
+    @card_number = @test_card["number"]
+    puts "    Created card ##{@card_number}"
+
+    # Get single card
+    test("Get single card") { @client.card(@card_number) }
+
+    # Update card
+    test("Update card title") do
+      @client.update_card(@card_number, title: "API Demo Test Card (Updated)")
+    end
+
+    test("Update card description") do
+      @client.update_card(@card_number, description: "This card was created by the API demo script.")
+    end
+
+    # Card state changes
+    test("Close card") { @client.close_card(@card_number) }
+    test("Reopen card") { @client.reopen_card(@card_number) }
+    test("Postpone card (not_now)") { @client.postpone_card(@card_number) }
+
+    # Triage - need a column on the same board as the card
+    # Create a column on @board for triage testing
+    triage_column = test("Create column for triage test") do
+      @client.create_column(board_id: @board["id"], name: "Triage Test Column", color: :aqua)
+    end
+
+    if triage_column
+      test("Triage card to column") do
+        @client.triage_card(@card_number, column_id: triage_column["id"])
+      end
+      test("Untriage card") { @client.untriage_card(@card_number) }
+      # Clean up triage column
+      @client.delete_column(@board["id"], triage_column["id"]) rescue nil
+    end
+
+    # Watch/unwatch
+    test("Watch card") { @client.watch_card(@card_number) }
+    test("Unwatch card") { @client.unwatch_card(@card_number) }
+
+    # Toggle tag - create a tag by toggling with a new title
+    test("Toggle tag on card (creates tag if needed)") do
+      @client.toggle_tag(@card_number, tag_title: "demo-test-tag")
+    end
+
+    # Toggle it off
+    test("Toggle tag off card") do
+      @client.toggle_tag(@card_number, tag_title: "demo-test-tag")
+    end
+
+    # Toggle assignment - use current user from identity
+    if @identity && @identity["user"]
+      current_user_id = @identity["user"]["id"]
+      test("Toggle assignment on card") do
+        @client.toggle_assignment(@card_number, assignee_id: current_user_id)
+      end
+      test("Toggle assignment off card") do
+        @client.toggle_assignment(@card_number, assignee_id: current_user_id)
+      end
+    else
+      skip("Toggle assignment on card", "no current user in identity")
+    end
+
+    # Card with image upload using sydney.jpg
+    image_path = File.expand_path("sydney.jpg", __dir__)
+    if File.exist?(image_path)
+      @image_card = test("Create card with background image (sydney.jpg)") do
+        card = @client.create_card(board_id: @board["id"], title: "Card with Sydney Image", image: image_path)
+        @cards_to_cleanup ||= []
+        @cards_to_cleanup << card["number"]
+        card
+      end
+
+      # Verify card has image_url
+      if @image_card && @image_card["image_url"]
+        puts "    Image URL: #{@image_card['image_url'][0..60]}..."
+      end
+    else
+      skip("Create card with background image", "sydney.jpg not found")
+    end
+
+    # Golden ticket (gild/ungild)
+    test("Make card a golden ticket") { @client.gild_card(@card_number) }
+
+    # Verify card is now golden
+    gilded_card = test("Verify card is golden") do
+      card = @client.card(@card_number)
+      raise "Card is not golden!" unless card["golden"]
+      card
+    end
+
+    test("Remove golden ticket status") { @client.ungild_card(@card_number) }
+
+    # Verify card is no longer golden
+    test("Verify card is not golden") do
+      card = @client.card(@card_number)
+      raise "Card is still golden!" if card["golden"]
+      card
+    end
+  end
+
+  # ============================================================
+  # STEPS
+  # ============================================================
+  def test_steps
+    print_header "5. STEPS"
+
+    return skip("Steps tests", "no test card") unless @card_number
+
+    # Create step
+    @test_step = test("Create step") do
+      @client.create_step(@card_number, content: "Demo step from API client")
+    end
+
+    return unless @test_step
+
+    step_id = @test_step["id"]
+
+    # Get single step
+    test("Get single step") { @client.step(@card_number, step_id) }
+
+    # Update step
+    test("Update step content") do
+      @client.update_step(@card_number, step_id, content: "Updated step content")
+    end
+
+    # Complete/incomplete step
+    test("Complete step") { @client.complete_step(@card_number, step_id) }
+    test("Incomplete step") { @client.incomplete_step(@card_number, step_id) }
+
+    # Create another step for deletion test
+    step2 = test("Create step for deletion") do
+      @client.create_step(@card_number, content: "Step to delete")
+    end
+
+    if step2
+      test("Delete step") { @client.delete_step(@card_number, step2["id"]) }
+    end
+  end
+
+  # ============================================================
+  # COMMENTS
+  # ============================================================
+  def test_comments
+    print_header "6. COMMENTS"
+
+    return skip("Comments tests", "no test card") unless @card_number
+
+    # Create comment
+    @test_comment = test("Create comment") do
+      @client.create_comment(@card_number, body: "This is a test comment from the API demo.")
+    end
+
+    return unless @test_comment
+
+    comment_id = @test_comment["id"]
+
+    # List comments
+    test("List comments") { @client.comments(@card_number) }
+
+    # Get single comment
+    test("Get single comment") { @client.comment(@card_number, comment_id) }
+
+    # Update comment
+    test("Update comment") do
+      @client.update_comment(@card_number, comment_id, body: "Updated comment body")
+    end
+
+    # Create another comment for deletion test
+    comment2 = test("Create comment for deletion") do
+      @client.create_comment(@card_number, body: "Comment to delete")
+    end
+
+    if comment2
+      test("Delete comment") { @client.delete_comment(@card_number, comment2["id"]) }
+    end
+  end
+
+  # ============================================================
+  # REACTIONS
+  # ============================================================
+  def test_reactions
+    print_header "7. REACTIONS"
+
+    return skip("Reactions tests", "no test comment") unless @test_comment
+
+    comment_id = @test_comment["id"]
+
+    # Add reaction
+    @test_reaction = test("Add reaction") do
+      @client.add_reaction(@card_number, comment_id, content: ":+1:")
+    end
+
+    return unless @test_reaction
+
+    # List reactions
+    test("List reactions") { @client.reactions(@card_number, comment_id) }
+
+    # Remove reaction
+    test("Remove reaction") do
+      @client.remove_reaction(@card_number, comment_id, @test_reaction["id"])
+    end
+  end
+
+  # ============================================================
+  # TAGS
+  # ============================================================
+  def test_tags
+    print_header "8. TAGS"
+
+    # List tags
+    test("List tags") { @client.tags }
+
+    # List tags with pagination
+    test("List tags page 1") { @client.tags(page: 1) }
+  end
+
+  # ============================================================
+  # USERS
+  # ============================================================
+  def test_users
+    print_header "9. USERS"
+
+    # List users
+    @users = test("List users") { @client.users }
+
+    return unless @users&.any?
+
+    user = @users.first
+    puts "    First user: #{user['name']} (#{user['id']})"
+
+    # Get single user
+    test("Get single user") { @client.user(user["id"]) }
+
+    # Update user (skip in destructive mode to avoid changing real data)
+    if @skip_destructive
+      skip("Update user", "destructive operation")
+      skip("Update user with avatar", "destructive operation")
+      skip("Deactivate user", "destructive operation")
+    else
+      # These would modify real user data, so we skip them by default
+      skip("Update user", "would modify real data - use SKIP_DESTRUCTIVE=0 to enable")
+      skip("Update user with avatar", "would modify real data")
+      skip("Deactivate user", "would modify real data")
+    end
+  end
+
+  # ============================================================
+  # NOTIFICATIONS
+  # ============================================================
+  def test_notifications
+    print_header "10. NOTIFICATIONS"
+
+    # List notifications
+    notifications = test("List notifications") { @client.notifications }
+
+    if notifications&.any?
+      notification = notifications.first
+      notification_id = notification["id"]
+
+      test("Mark notification read") { @client.mark_notification_read(notification_id) }
+      test("Mark notification unread") { @client.mark_notification_unread(notification_id) }
+    else
+      skip("Mark notification read", "no notifications")
+      skip("Mark notification unread", "no notifications")
+    end
+
+    # Mark all read (always works, even with no notifications)
+    test("Mark all notifications read") { @client.mark_all_notifications_read }
+  end
+
+  # ============================================================
+  # DIRECT UPLOADS
+  # ============================================================
+  def test_direct_uploads
+    print_header "11. DIRECT UPLOADS"
+
+    test("Create direct upload") do
+      content = "test file content"
+      checksum = Base64.strict_encode64(Digest::MD5.digest(content))
+
+      @client.create_direct_upload(
+        filename: "test.txt",
+        byte_size: content.bytesize,
+        checksum: checksum,
+        content_type: "text/plain"
+      )
+    end
+
+    test("Upload file helper") do
+      Tempfile.create(["test", ".txt"]) do |f|
+        f.write("Hello from Fizzy API Client demo!")
+        f.rewind
+        @client.upload_file(f.path)
+      end
+    end
+  end
+
+  # ============================================================
+  # PAGINATION
+  # ============================================================
+  def test_pagination
+    print_header "12. PAGINATION"
+
+    test("List boards with auto_paginate") do
+      @client.boards(auto_paginate: true)
+    end
+
+    test("List cards with auto_paginate") do
+      @client.cards(auto_paginate: true)
+    end
+
+    test("List tags with auto_paginate") do
+      @client.tags(auto_paginate: true)
+    end
+
+    test("List users with auto_paginate") do
+      @client.users(auto_paginate: true)
+    end
+  end
+
+  # ============================================================
+  # ERROR HANDLING
+  # ============================================================
+  def test_error_handling
+    print_header "13. ERROR HANDLING"
+
+    test("NotFoundError for invalid card") do
+      begin
+        @client.card(999_999_999)
+        raise "Should have raised NotFoundError"
+      rescue FizzyApiClient::NotFoundError => e
+        "Correctly raised NotFoundError: #{e.message}"
+      end
+    end
+
+    test("NotFoundError for invalid board") do
+      begin
+        @client.board("invalid_board_id_xyz")
+        raise "Should have raised NotFoundError"
+      rescue FizzyApiClient::NotFoundError => e
+        "Correctly raised NotFoundError: #{e.message}"
+      end
+    end
+
+    test("ValidationError for invalid color") do
+      begin
+        FizzyApiClient::Colors.resolve(:invalid_color)
+        raise "Should have raised ArgumentError"
+      rescue ArgumentError => e
+        "Correctly raised ArgumentError: #{e.message}"
+      end
+    end
+  end
+
+  # ============================================================
+  # CLEANUP
+  # ============================================================
+  def cleanup
+    print_header "14. CLEANUP"
+
+    # Delete test card
+    if @card_number
+      test("Delete test card ##{@card_number}") do
+        @client.delete_card(@card_number)
+      end
+    end
+
+    # Delete any additional cards created during testing
+    (@cards_to_cleanup || []).each do |card_number|
+      test("Delete card ##{card_number}") do
+        @client.delete_card(card_number)
+      end
+    end
+
+    # Delete test column
+    if @test_column && @test_board
+      test("Delete test column") do
+        @client.delete_column(@test_board["id"], @test_column["id"])
+      end
+    end
+
+    # Delete test board
+    if @test_board
+      test("Delete test board") do
+        @client.delete_board(@test_board["id"])
+      end
+    end
+  end
+
+  def print_summary
+    puts "\n" + "=" * 60
+    puts "DEMO SUMMARY"
+    puts "=" * 60
+    puts "  Passed:  #{@passed}"
+    puts "  Failed:  #{@failed}"
+    puts "  Skipped: #{@skipped}"
+    puts "=" * 60
+
+    if @failed > 0
+      puts "Some tests failed!"
+      exit 1
+    else
+      puts "All tests passed!"
+    end
+  end
+end
+
+# Run the demo
+Demo.new.run

data/fizzy-api-client.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/fizzy_api_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fizzy-api-client"
+  spec.version = FizzyApiClient::VERSION
+  spec.authors = ["Fizzy Team"]
+  spec.email = ["support@fizzy.do"]
+
+  spec.summary = "Ruby client for the Fizzy API"
+  spec.description = "A clean, idiomatic Ruby interface to the Fizzy API with minimal dependencies"
+  spec.homepage = "https://github.com/robzolkos/fizzy-api-client"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.glob("{lib,examples}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) } +
+               %w[LICENSE.txt README.md CHANGELOG.md fizzy-api-client.gemspec]
+  spec.require_paths = ["lib"]
+
+  # Required for Ruby 3.4+ (moved from stdlib to bundled gems)
+  spec.add_dependency "base64"
+
+  # Required for Ruby 3.5+ (will be moved from stdlib to bundled gems)
+  spec.add_dependency "ostruct"
+  spec.add_dependency "logger"
+end