labnocturne 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c22619ebcde6bea55bc871e925c79661506e9f64c122e7f5b0a5edddef062efb
+  data.tar.gz: 73c5e715acc5221b8228faf9d440d0c8a64d5b652784acf4ecd3448b3d32e6d6
+SHA512:
+  metadata.gz: '08adb6d061294c0e56c2667758129bebda060ac685b744f17d41e02809068e4b8e65a1a9ebe0df8f30edfc569e8ee88f3ab471070e99544500891eca6ac626fd'
+  data.tar.gz: eaaa2cc0abfb8684c29407b3ef2530ecfe59edb24666f9e17cca6666e18f3a399853a852f67db71008aaa9436876961baf3edabd18f959d90b93c5c8d3766ad6

data/README.md

@@ -0,0 +1,236 @@
+# Lab Nocturne Images - Ruby Client
+
+Ruby client library for the [Lab Nocturne Images API](https://images.labnocturne.com).
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'labnocturne',
+    git: 'https://github.com/jjenkins/labnocturne-image-client',
+    glob: 'ruby/*.gemspec'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Requirements
+
+- Ruby 2.7+
+- No external dependencies (uses standard library only)
+
+## Quick Start
+
+```ruby
+require 'labnocturne'
+
+# Generate a test API key
+api_key = LabNocturne::Client.generate_test_key
+puts "API Key: #{api_key}"
+
+# Create client
+client = LabNocturne::Client.new(api_key)
+
+# Upload an image
+result = client.upload('photo.jpg')
+puts "Image URL: #{result['url']}"
+puts "Image ID: #{result['id']}"
+
+# List files
+files = client.list_files(limit: 10)
+puts "Total files: #{files['pagination']['total']}"
+
+# Get usage stats
+stats = client.get_stats
+puts "Storage: #{stats['storage_used_mb'].round(2)} MB / #{stats['quota_mb']} MB"
+
+# Delete a file
+client.delete_file(result['id'])
+puts "File deleted"
+```
+
+## API Reference
+
+### `LabNocturne::Client.new(api_key, base_url = 'https://images.labnocturne.com')`
+
+Create a new client instance.
+
+**Parameters:**
+- `api_key` (String): Your API key
+- `base_url` (String, optional): Base URL for the API
+
+### Class Methods
+
+#### `.generate_test_key(base_url = 'https://images.labnocturne.com')`
+
+Generate a test API key for development.
+
+**Returns:** API key string
+
+**Example:**
+```ruby
+api_key = LabNocturne::Client.generate_test_key
+```
+
+### Instance Methods
+
+#### `#upload(file_path)`
+
+Upload an image file.
+
+**Parameters:**
+- `file_path` (String): Path to the image file
+
+**Returns:** Hash with `:id`, `:url`, `:size`, `:mime_type`, `:created_at`
+
+**Example:**
+```ruby
+result = client.upload('photo.jpg')
+puts result['url']
+```
+
+#### `#list_files(page: 1, limit: 50, sort: 'created_desc')`
+
+List uploaded files with pagination.
+
+**Parameters:**
+- `page` (Integer): Page number (default: 1)
+- `limit` (Integer): Files per page (default: 50)
+- `sort` (String): Sort order - `created_desc`, `created_asc`, `size_desc`, `size_asc`, `name_asc`, `name_desc`
+
+**Returns:** Hash with `files` array and `pagination` info
+
+**Example:**
+```ruby
+files = client.list_files(page: 1, limit: 10, sort: 'size_desc')
+files['files'].each do |file|
+  puts "#{file['id']}: #{file['size']} bytes"
+end
+```
+
+#### `#get_stats`
+
+Get usage statistics for your account.
+
+**Returns:** Hash with `storage_used_bytes`, `storage_used_mb`, `file_count`, `quota_bytes`, `quota_mb`, `usage_percent`
+
+**Example:**
+```ruby
+stats = client.get_stats
+puts "Using #{stats['usage_percent'].round(1)}% of quota"
+```
+
+#### `#delete_file(image_id)`
+
+Delete an image (soft delete).
+
+**Parameters:**
+- `image_id` (String): The image ID
+
+**Returns:** Hash with success status
+
+**Example:**
+```ruby
+client.delete_file('img_01jcd8x9k2n...')
+```
+
+## Error Handling
+
+```ruby
+begin
+  result = client.upload('photo.jpg')
+  puts "Success: #{result['url']}"
+rescue Errno::ENOENT
+  puts "Error: File not found"
+rescue StandardError => e
+  case e.message
+  when /file_too_large/
+    puts "Error: File is too large for your account tier"
+  when /unauthorized/
+    puts "Error: Invalid API key"
+  else
+    puts "Error: #{e.message}"
+  end
+end
+```
+
+## Complete Example
+
+```ruby
+require 'labnocturne'
+
+# Generate test API key
+puts "Generating test API key..."
+api_key = LabNocturne::Client.generate_test_key
+puts "API Key: #{api_key}\n\n"
+
+# Create client
+client = LabNocturne::Client.new(api_key)
+
+begin
+  # Upload an image
+  puts "Uploading image..."
+  upload_result = client.upload('photo.jpg')
+  puts "Uploaded: #{upload_result['url']}"
+  puts "Image ID: #{upload_result['id']}"
+  puts "Size: #{(upload_result['size'] / 1024.0).round(2)} KB\n\n"
+
+  # List all files
+  puts "Listing files..."
+  files_result = client.list_files(limit: 10)
+  puts "Total files: #{files_result['pagination']['total']}"
+  files_result['files'].each do |file|
+    puts "  - #{file['id']}: #{(file['size'] / 1024.0).round(2)} KB"
+  end
+  puts
+
+  # Get usage stats
+  puts "Usage statistics:"
+  stats = client.get_stats
+  puts "  Storage: #{stats['storage_used_mb'].round(2)} MB / #{stats['quota_mb']} MB"
+  puts "  Files: #{stats['file_count']}"
+  puts "  Usage: #{stats['usage_percent'].round(2)}%\n\n"
+
+  # Delete the uploaded file
+  puts "Deleting image..."
+  client.delete_file(upload_result['id'])
+  puts "Deleted successfully"
+
+rescue StandardError => e
+  puts "Error: #{e.message}"
+end
+```
+
+## Development
+
+Install development dependencies:
+
+```bash
+bundle install
+```
+
+Run tests:
+
+```bash
+rspec
+```
+
+Lint code:
+
+```bash
+rubocop
+```
+
+## License
+
+MIT License - See [LICENSE](../LICENSE) for details.
+
+## Links
+
+- [Main Repository](https://github.com/jjenkins/labnocturne-image-client)
+- [API Documentation](https://images.labnocturne.com/docs)
+- [Other Language Clients](https://github.com/jjenkins/labnocturne-image-client#readme)

data/lib/labnocturne/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module LabNocturne
+  # Client for Lab Nocturne Images API
+  class Client
+    attr_reader :api_key, :base_url
+
+    def initialize(api_key, base_url = 'https://images.labnocturne.com')
+      @api_key = api_key
+      @base_url = base_url
+    end
+
+    # Upload an image file
+    def upload(file_path)
+      uri = URI.parse("#{@base_url}/upload")
+
+      request = Net::HTTP::Post.new(uri)
+      request['Authorization'] = "Bearer #{@api_key}"
+
+      form_data = [['file', File.open(file_path)]]
+      request.set_form form_data, 'multipart/form-data'
+
+      response = make_request(uri, request)
+      handle_response(response)
+    end
+
+    # List uploaded files
+    def list_files(page: 1, limit: 50, sort: 'created_desc')
+      uri = URI.parse("#{@base_url}/files")
+      uri.query = URI.encode_www_form(page: page, limit: limit, sort: sort)
+
+      request = Net::HTTP::Get.new(uri)
+      request['Authorization'] = "Bearer #{@api_key}"
+
+      response = make_request(uri, request)
+      handle_response(response)
+    end
+
+    # Get usage statistics
+    def get_stats
+      uri = URI.parse("#{@base_url}/stats")
+
+      request = Net::HTTP::Get.new(uri)
+      request['Authorization'] = "Bearer #{@api_key}"
+
+      response = make_request(uri, request)
+      handle_response(response)
+    end
+
+    # Delete an image (soft delete)
+    def delete_file(image_id)
+      uri = URI.parse("#{@base_url}/i/#{image_id}")
+
+      request = Net::HTTP::Delete.new(uri)
+      request['Authorization'] = "Bearer #{@api_key}"
+
+      response = make_request(uri, request)
+      handle_response(response)
+    end
+
+    # Generate a test API key
+    def self.generate_test_key(base_url = 'https://images.labnocturne.com')
+      uri = URI.parse("#{base_url}/key")
+      response = Net::HTTP.get_response(uri)
+
+      raise "Failed to generate key: #{response.code}" unless response.code == '200'
+
+      result = JSON.parse(response.body)
+      result['api_key']
+    end
+
+    private
+
+    def make_request(uri, request)
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.request(request)
+      end
+    end
+
+    def handle_response(response)
+      unless response.code.start_with?('2')
+        error_data = JSON.parse(response.body) rescue {}
+        error_msg = error_data.dig('error', 'message') || 'Unknown error'
+        raise "API Error: #{error_msg}"
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/labnocturne/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LabNocturne
+  VERSION = '1.0.0'
+end

data/lib/labnocturne.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'labnocturne/version'
+require_relative 'labnocturne/client'
+
+# Lab Nocturne Images API Client
+module LabNocturne
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: labnocturne
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lab Nocturne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: A simple Ruby client library for uploading and managing images with the
+  Lab Nocturne Images API
+email:
+- support@labnocturne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/labnocturne.rb
+- lib/labnocturne/client.rb
+- lib/labnocturne/version.rb
+homepage: https://github.com/jjenkins/labnocturne-image-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jjenkins/labnocturne-image-client
+  source_code_uri: https://github.com/jjenkins/labnocturne-image-client/tree/main/ruby
+  bug_tracker_uri: https://github.com/jjenkins/labnocturne-image-client/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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 client for Lab Nocturne Images API
+test_files: []