wip-ruby 0.2.0

data/test_examples.rb

@@ -0,0 +1,435 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "logger"
+require "tempfile"
+require "securerandom"
+require "wip-ruby"
+require 'chunky_png'
+
+# -----------------------------------------------------------------------------
+# Configuration
+# -----------------------------------------------------------------------------
+
+# Set your API key via the WIP_API_KEY environment variable.
+Wip.configure do |config|
+  config.api_key = ENV.fetch("WIP_API_KEY") { raise "WIP_API_KEY environment variable is required" }
+  config.base_url = "https://api.wip.co"
+  config.logger = Logger.new($stdout)
+  config.logger.level = Logger::DEBUG
+end
+
+# Initialize the main API client.
+client = Wip::Client.new
+
+# -----------------------------------------------------------------------------
+# Helper to run tests
+# -----------------------------------------------------------------------------
+
+def run_test(test_name)
+  puts "\n=== #{test_name} ==="
+  yield
+  puts "✅ #{test_name} passed"
+rescue => e
+  puts "❌ #{test_name} failed: #{e.class} - #{e.message}"
+  e.backtrace.each { |line| puts "  #{line}" }
+end
+
+# -----------------------------------------------------------------------------
+# Test: Configuration Validation
+# -----------------------------------------------------------------------------
+
+run_test("Configuration Validation") do
+  # Test missing API key
+  invalid_config = Wip::Configuration.new
+  begin
+    Wip::Client.new(invalid_config)
+    raise "Expected ConfigurationError, but none was raised"
+  rescue Wip::Error::ConfigurationError
+    # Expected error
+  end
+
+  # Test invalid timeout
+  invalid_timeout_config = Wip::Configuration.new
+  invalid_timeout_config.api_key = "test_key"
+  invalid_timeout_config.timeout = 0
+  begin
+    Wip::Client.new(invalid_timeout_config)
+    raise "Expected ConfigurationError for invalid timeout"
+  rescue Wip::Error::ConfigurationError
+    # Expected error
+  end
+
+  # Test invalid max_retries
+  invalid_retries_config = Wip::Configuration.new
+  invalid_retries_config.api_key = "test_key"
+  invalid_retries_config.max_retries = -1
+  begin
+    Wip::Client.new(invalid_retries_config)
+    raise "Expected ConfigurationError for invalid max_retries"
+  rescue Wip::Error::ConfigurationError
+    # Expected error
+  end
+
+  # Test invalid logger
+  invalid_logger_config = Wip::Configuration.new
+  invalid_logger_config.api_key = "test_key"
+  invalid_logger_config.logger = Object.new # Object without logger methods
+  begin
+    Wip::Client.new(invalid_logger_config)
+    raise "Expected ConfigurationError for invalid logger"
+  rescue Wip::Error::ConfigurationError
+    # Expected error
+  end
+end
+
+# -----------------------------------------------------------------------------
+# Test: Todos Endpoints
+# -----------------------------------------------------------------------------
+
+run_test("Todos Endpoints") do
+  # Create a todo with a simple body
+  todo_body = "Test todo from manual script at #{Time.now.to_i}"
+  new_todo = client.todos.create(body: todo_body, attachments: [])
+  raise "Todo creation failed" unless new_todo["id"]
+
+  # Fetch and verify the created todo
+  fetched_todo = client.todos.find(new_todo["id"])
+  raise "Fetched todo body mismatch" unless fetched_todo["body"] == todo_body
+  raise "Todo URL missing" unless fetched_todo["url"].is_a?(String)
+  raise "Todo creator_id missing" unless fetched_todo["creator_id"].is_a?(String)
+  raise "Todo projects not an array" unless fetched_todo["projects"].is_a?(Array)
+  raise "Todo attachments not an array" unless fetched_todo["attachments"].is_a?(Array)
+
+  # Test todo with markdown formatting
+  markdown_body = "# Test Todo\n\n- Item 1\n- Item 2\n\n**Bold** and *italic*"
+  markdown_todo = client.todos.create(body: markdown_body, attachments: [])
+  raise "Markdown todo creation failed" unless markdown_todo["id"]
+
+  # List todos with pagination
+  first_page = client.viewer.todos(limit: 5)
+  raise "First page data missing" unless first_page["data"].is_a?(Array)
+  raise "First page missing total_count" unless first_page["total_count"].is_a?(Integer)
+  raise "First page missing has_more" unless [true, false].include?(first_page["has_more"])
+
+  if first_page["has_more"]
+    second_page = client.viewer.todos(limit: 5, starting_after: first_page["data"].last["id"])
+    raise "Second page data missing" unless second_page["data"].is_a?(Array)
+    raise "Second page todos overlap with first page" if (second_page["data"].map { |t| t["id"] } & first_page["data"].map { |t| t["id"] }).any?
+  end
+
+  # Test todos for specific user
+  user_todos = client.users.todos("rameerez", limit: 5)
+  raise "User todos data missing" unless user_todos["data"].is_a?(Array)
+  puts "Found #{user_todos["data"].size} todos for user 'rameerez'"
+
+  # Test todos for specific project
+  if first_page["data"].any? && first_page["data"].first["projects"].any?
+    project_id = first_page["data"].first["projects"].first["id"]
+    project_todos = client.projects.todos(project_id, limit: 5)
+    raise "Project todos data missing" unless project_todos["data"].is_a?(Array)
+    puts "Found #{project_todos["data"].size} todos for project #{project_id}"
+  end
+end
+
+# -----------------------------------------------------------------------------
+# Test: Users Endpoints
+# -----------------------------------------------------------------------------
+
+run_test("Users Endpoints") do
+  # Test finding a known user
+  user = client.users.find("rameerez")
+  raise "User not found" unless user["username"] == "rameerez"
+  raise "User ID missing" unless user["id"].is_a?(String)
+  raise "User streak not a number" unless user["streak"].is_a?(Integer)
+  raise "User todos_count not a number" unless user["todos_count"].is_a?(Integer)
+  raise "User avatar missing" unless user["avatar"].is_a?(Hash)
+  raise "User avatar URLs missing" unless user["avatar"]["small"].is_a?(String) &&
+                                        user["avatar"]["medium"].is_a?(String) &&
+                                        user["avatar"]["large"].is_a?(String)
+
+  # Test authenticated user endpoints
+  auth_user1 = client.viewer.me
+  auth_user2 = client.viewer.me
+  raise "Authenticated user mismatch" unless auth_user1["id"] == auth_user2["id"]
+  raise "Authenticated user missing username" unless auth_user1["username"].is_a?(String)
+
+  # Test user's projects with pagination
+  user_projects = client.users.projects("rameerez", limit: 5)
+  raise "User projects data missing" unless user_projects["data"].is_a?(Array)
+  if user_projects["has_more"]
+    next_projects = client.users.projects("rameerez",
+                                        limit: 5,
+                                        starting_after: user_projects["data"].last["id"])
+    raise "Next page projects data missing" unless next_projects["data"].is_a?(Array)
+  end
+
+  # Test user's todos with pagination
+  user_todos = client.users.todos("rameerez", limit: 5)
+  raise "User todos data missing" unless user_todos["data"].is_a?(Array)
+  if user_todos["has_more"]
+    next_todos = client.users.todos("rameerez",
+                                  limit: 5,
+                                  starting_after: user_todos["data"].last["id"])
+    raise "Next page todos data missing" unless next_todos["data"].is_a?(Array)
+  end
+
+  puts "User 'rameerez' has #{user_projects['data'].size} projects and #{user_todos['data'].size} todos"
+end
+
+# -----------------------------------------------------------------------------
+# Test: Projects Endpoints
+# -----------------------------------------------------------------------------
+
+run_test("Projects Endpoints") do
+  # Test authenticated user's projects
+  my_projects = client.viewer.projects(limit: 5)
+  raise "My projects data missing" unless my_projects["data"].is_a?(Array)
+
+  if my_projects["data"].any?
+    project = my_projects["data"].first
+
+    # Test fetching single project
+    proj_details = client.projects.find(project["id"])
+    raise "Project name missing" unless proj_details["name"].is_a?(String)
+    raise "Project URL missing" unless proj_details["url"].is_a?(String)
+    raise "Project owner missing" unless proj_details["owner"].is_a?(Hash)
+    raise "Project makers not an array" unless proj_details["makers"].is_a?(Array)
+    raise "Project logo missing" unless proj_details["logo"].is_a?(Hash)
+
+    # Test project todos with pagination
+    proj_todos = client.projects.todos(project["id"], limit: 5)
+    raise "Project todos data missing" unless proj_todos["data"].is_a?(Array)
+    if proj_todos["has_more"]
+      next_todos = client.projects.todos(project["id"],
+                                       limit: 5,
+                                       starting_after: proj_todos["data"].last["id"])
+      raise "Next page project todos missing" unless next_todos["data"].is_a?(Array)
+    end
+    puts "Project '#{proj_details['name']}' has #{proj_todos['data'].size} todos"
+  else
+    puts "No projects found for authenticated user"
+  end
+
+  # Test listing projects for a specific user with pagination
+  user_projects = client.users.projects("rameerez", limit: 5)
+  raise "User projects data missing" unless user_projects["data"].is_a?(Array)
+  if user_projects["has_more"]
+    next_projects = client.users.projects("rameerez",
+                                           limit: 5,
+                                           starting_after: user_projects["data"].last["id"])
+    raise "Next page user projects missing" unless next_projects["data"].is_a?(Array)
+  end
+  puts "User 'rameerez' has #{user_projects['data'].size} projects"
+end
+
+# -----------------------------------------------------------------------------
+# Test: Uploads Endpoints
+# -----------------------------------------------------------------------------
+
+run_test("Uploads Endpoints") do
+  # Test uploading different file types
+  [
+    # Test PNG image
+    {
+      ext: ".png",
+      content_type: "image/png",
+      create: ->(file) {
+        png = ChunkyPNG::Image.new(100, 100, ChunkyPNG::Color.rgb(255, 0, 0))
+        png.rect(0, 0, 99, 99, ChunkyPNG::Color.rgb(0, 0, 0), ChunkyPNG::Color.rgb(255, 0, 0))
+        png.save(file.path)
+      }
+    },
+    # Test text file
+    {
+      ext: ".md",
+      content_type: "text/markdown",
+      create: ->(file) {
+        file.write("# Test Markdown\n\nThis is a test file for wip-ruby uploads.")
+      }
+    }
+  ].each do |test_file|
+    Tempfile.create(["wip_test", test_file[:ext]]) do |file|
+      # Create test file
+      test_file[:create].call(file)
+      file.flush
+
+      # Upload file and verify signed ID
+      signed_id = client.uploads.upload(file.path)
+      raise "Upload did not return a signed_id" unless signed_id && !signed_id.empty?
+      puts "Successfully uploaded #{test_file[:ext]} file with signed_id: #{signed_id}"
+
+      # Create todo with attachment
+      todo_body = "Todo with #{test_file[:ext]} attachment from test at #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}"
+      todo = client.todos.create(
+        body: todo_body,
+        attachments: [signed_id]
+      )
+      raise "Todo creation failed" unless todo["id"]
+
+      # Verify todo and attachment
+      fetched_todo = client.todos.find(todo["id"])
+      raise "Todo body mismatch" unless fetched_todo["body"] == todo_body
+      raise "Attachment missing" if fetched_todo["attachments"].empty?
+      raise "Attachment ID mismatch" unless fetched_todo["attachments"].any? { |a| a["signed_id"] == signed_id }
+      puts "Successfully verified todo has the correct #{test_file[:ext]} attachment"
+    end
+  end
+
+  # Test invalid file type
+  Tempfile.create(["wip_test", ".invalid"]) do |file|
+    file.write("Invalid file type test")
+    file.flush
+
+    begin
+      client.uploads.upload(file.path)
+      raise "Expected ValidationError for invalid file type"
+    rescue Wip::Error::ValidationError => e
+      puts "Caught expected ValidationError for invalid file type: #{e.message}"
+    end
+  end
+end
+
+# -----------------------------------------------------------------------------
+# Test: Error Handling
+# -----------------------------------------------------------------------------
+
+run_test("Error Handling - Not Found") do
+  # Test non-existent user
+  non_existent_user = "nonexistent_user_#{SecureRandom.hex(4)}"
+  begin
+    client.users.find(non_existent_user)
+    raise "Expected NotFoundError but none was raised"
+  rescue Wip::Error::NotFoundError => e
+    puts "Caught expected NotFoundError: #{e.message}"
+  end
+
+  # Test non-existent project
+  begin
+    client.projects.find("non_existent_project_#{SecureRandom.hex(4)}")
+    raise "Expected NotFoundError but none was raised"
+  rescue Wip::Error::NotFoundError => e
+    puts "Caught expected NotFoundError for project: #{e.message}"
+  end
+
+  # Test non-existent todo
+  begin
+    client.todos.find("non_existent_todo_#{SecureRandom.hex(4)}")
+    raise "Expected NotFoundError but none was raised"
+  rescue Wip::Error::NotFoundError => e
+    puts "Caught expected NotFoundError for todo: #{e.message}"
+  end
+end
+
+run_test("Error Handling - Unauthorized") do
+  # Test invalid API key
+  bad_config = Wip::Configuration.new.tap { |c| c.api_key = "invalid_key" }
+  bad_client = Wip::Client.new(bad_config)
+
+  # Test different endpoints with invalid key
+  [
+    -> { bad_client.viewer.me },
+    -> { bad_client.viewer.todos },
+    -> { bad_client.viewer.projects },
+    -> { bad_client.viewer.me }
+  ].each do |endpoint|
+    begin
+      endpoint.call
+      raise "Expected UnauthorizedError but none was raised"
+    rescue Wip::Error::UnauthorizedError => e
+      puts "Caught expected UnauthorizedError: #{e.message}"
+    end
+  end
+end
+
+run_test("Error Handling - Validation") do
+  # Test creating todo without body
+  begin
+    client.todos.create(body: "", attachments: [])
+    raise "Expected ValidationError but none was raised"
+  rescue Wip::Error::ValidationError => e
+    puts "Caught expected ValidationError for empty todo body: #{e.message}"
+  end
+
+  # Test upload with invalid content type
+  begin
+    client.uploads.request_upload_url(
+      filename: "test.xyz",
+      byte_size: 100,
+      checksum: "invalid",
+      content_type: "application/invalid"
+    )
+    raise "Expected ValidationError but none was raised"
+  rescue Wip::Error::ValidationError => e
+    puts "Caught expected ValidationError for invalid content type: #{e.message}"
+  end
+end
+
+# -----------------------------------------------------------------------------
+# Test: Pagination
+# -----------------------------------------------------------------------------
+
+run_test("Pagination") do
+  # Test todos pagination
+  page1 = client.viewer.todos(limit: 2)
+  raise "Page1 data missing" unless page1["data"].is_a?(Array)
+  puts "Page1 contains #{page1['data'].size} items"
+
+  if page1["has_more"] && page1["data"].any?
+    page2 = client.viewer.todos(limit: 2, starting_after: page1["data"].last["id"])
+    raise "Page2 data missing" unless page2["data"].is_a?(Array)
+    puts "Page2 contains #{page2['data'].size} items"
+
+    # Verify no overlap between pages
+    page1_ids = page1["data"].map { |t| t["id"] }
+    page2_ids = page2["data"].map { |t| t["id"] }
+    raise "Page IDs overlap" unless (page1_ids & page2_ids).empty?
+
+    if page2["has_more"] && page2["data"].any?
+      page3 = client.viewer.todos(limit: 2, starting_after: page2["data"].last["id"])
+      raise "Page3 data missing" unless page3["data"].is_a?(Array)
+      puts "Page3 contains #{page3['data'].size} items"
+    end
+  end
+
+  # Test projects pagination
+  projects_page1 = client.viewer.projects(limit: 2)
+  raise "Projects page1 data missing" unless projects_page1["data"].is_a?(Array)
+  puts "Projects page1 contains #{projects_page1['data'].size} items"
+
+  if projects_page1["has_more"] && projects_page1["data"].any?
+    projects_page2 = client.viewer.projects(
+      limit: 2,
+      starting_after: projects_page1["data"].last["id"]
+    )
+    raise "Projects page2 data missing" unless projects_page2["data"].is_a?(Array)
+    puts "Projects page2 contains #{projects_page2['data'].size} items"
+  end
+end
+
+# -----------------------------------------------------------------------------
+# Test: Rate Limiting
+# -----------------------------------------------------------------------------
+
+run_test("Rate Limiting") do
+  rate_limit_triggered = false
+  requests_made = 0
+
+  # Make rapid requests to try to trigger rate limiting
+  20.times do |i|
+    begin
+      client.viewer.me
+      requests_made += 1
+      sleep(0.1) # Small delay between requests
+    rescue Wip::Error::RateLimitError => e
+      puts "Rate limit triggered after #{requests_made} requests: #{e.message}"
+      rate_limit_triggered = true
+      break
+    end
+  end
+
+  puts "Rate limiting test: #{rate_limit_triggered ? 'Rate limit was triggered' : 'No rate limit encountered'}"
+  puts "Completed #{requests_made} requests"
+end
+
+puts "\nAll manual tests completed!"

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: wip-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Javi R
+bindir: exe
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: WIP.co API wrapper for Ruby on Rails apps. WIP (wip.co) is a community
+  of makers who share what they're working on. wip-ruby provides an elegant, intuitive,
+  no-frills interface for interacting with the WIP API.
+email:
+- rubygems@rameerez.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".simplecov"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wip-ruby.rb
+- lib/wip.rb
+- lib/wip/client.rb
+- lib/wip/configuration.rb
+- lib/wip/error.rb
+- lib/wip/http_client.rb
+- lib/wip/models/base.rb
+- lib/wip/models/collection.rb
+- lib/wip/models/comment.rb
+- lib/wip/models/concerns/reactable.rb
+- lib/wip/models/project.rb
+- lib/wip/models/reaction.rb
+- lib/wip/models/todo.rb
+- lib/wip/models/user.rb
+- lib/wip/resources/base.rb
+- lib/wip/resources/comments.rb
+- lib/wip/resources/projects.rb
+- lib/wip/resources/reactions.rb
+- lib/wip/resources/todos.rb
+- lib/wip/resources/uploads.rb
+- lib/wip/resources/users.rb
+- lib/wip/resources/viewer.rb
+- lib/wip/version.rb
+- sig/wip/ruby.rbs
+- test_examples.rb
+homepage: https://github.com/rameerez/wip-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rameerez/wip-ruby
+  source_code_uri: https://github.com/rameerez/wip-ruby
+  changelog_uri: https://github.com/rameerez/wip-ruby/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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: WIP.co API wrapper for Ruby / Rails.
+test_files: []