imgwire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 465414c80dd7d88016d6e156b188ed81c5c074836000087e4e47d11baed5a8ae
+  data.tar.gz: 8de6fcd2da02b947376eb73d9021eeb35bb62109133acecee8ad8f361c992ab8
+SHA512:
+  metadata.gz: 6ee90396ef5802259a36e17740a2c5b7e7e103b029b3f7eae3bb5966d613dc1a546a00ba2cfe1c0ea564bcab0e43938d7643be9387727a6d2b296d194a26a209
+  data.tar.gz: 169a27d84d24340b998692974e8d4ec9f1c8248def2c14d0bcee3475cebc7e321c4cff6f8583090dd2eaabf90dd7160e6ea0c2c16024b586eecf0bad0316e9bd

data/AGENTS.md

@@ -0,0 +1,8 @@
+# imgwire-ruby Agent Notes
+
+- `generated/` is disposable output from OpenAPI Generator. Do not hand-edit generated files.
+- Use `yarn generate` to refresh `openapi/sdk.openapi.json`, `generated/`, and `CODEGEN_VERSION`.
+- `@imgwire/codegen-core` is the source of truth for OpenAPI shaping.
+- Yarn Classic is used for codegen tooling. Ruby packaging uses Bundler and RubyGems.
+- Handwritten SDK behavior belongs in `lib/`, `spec/`, and `docs/`.
+- CI runs `yarn verify-generated` and fails when generated artifacts or `CODEGEN_VERSION` are stale.

data/CODEGEN_VERSION

@@ -0,0 +1 @@
+213554905f77b6ffb7a29c020c632196bf0d7567b10d10f40a0a59839008d248

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Blackhawk Software, LLC
+
+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,159 @@
+# `imgwire`
+
+[![RubyGems version](https://img.shields.io/gem/v/imgwire.svg)](https://rubygems.org/gems/imgwire)
+[![CI](https://github.com/Blackhawk-Software/imgwire-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/Blackhawk-Software/imgwire-ruby/actions/workflows/ci.yml)
+[![Release](https://github.com/Blackhawk-Software/imgwire-ruby/actions/workflows/release.yml/badge.svg)](https://github.com/Blackhawk-Software/imgwire-ruby/actions/workflows/release.yml)
+
+`imgwire` is the server-side Ruby SDK for the imgwire API.
+
+Use it in Rails apps, workers, jobs, and other backend runtimes to authenticate with a Server API Key, upload files from Ruby IO objects, manage server-side resources, and generate image transformation URLs without rebuilding imgwire request plumbing yourself.
+
+## Installation
+
+```bash
+gem install imgwire
+```
+
+Or with Bundler:
+
+```ruby
+gem "imgwire"
+```
+
+## Quick Start
+
+```ruby
+require "imgwire"
+
+client = Imgwire::Client.new(api_key: "sk_...")
+
+File.open("hero.jpg", "rb") do |file|
+  image = client.images.upload(file: file)
+
+  puts image.id
+  puts image.url(preset: "thumbnail", width: 300, height: 300)
+end
+```
+
+## Client Setup
+
+```ruby
+client = Imgwire::Client.new(api_key: "sk_...")
+```
+
+Optional configuration:
+
+```ruby
+client = Imgwire::Client.new(
+  api_key: "sk_...",
+  base_url: "https://api.imgwire.dev",
+  environment_id: "env_123",
+  timeout: 10,
+  max_retries: 2,
+  backoff_factor: 0.25
+)
+```
+
+## Resources
+
+The handwritten Ruby surface currently wraps these generated server resources:
+
+- `client.images`
+- `client.custom_domain`
+- `client.cors_origins`
+- `client.metrics`
+
+### Uploads
+
+The image upload helper accepts `File`, `IO`, `StringIO`, and `Tempfile` inputs:
+
+```ruby
+file = File.open("file.jpg", "rb")
+image = client.images.upload(file: file)
+```
+
+Explicit metadata is also supported:
+
+```ruby
+image = client.images.upload(
+  file: StringIO.new(binary_data),
+  file_name: "file.png",
+  mime_type: "image/png",
+  content_length: binary_data.bytesize
+)
+```
+
+### Pagination
+
+```ruby
+page = client.images.list(page: 1, limit: 25)
+
+client.images.list_pages(limit: 100).each do |result|
+  puts result.pagination.page
+  puts result.data.length
+end
+
+client.images.list_all(limit: 100).each do |image|
+  puts image.id
+end
+```
+
+### Image URL Transformations
+
+Image-returning endpoints return `Imgwire::Image` values with a `url(...)` helper:
+
+```ruby
+image = client.images.retrieve("img_123")
+
+puts image.url(
+  preset: "thumbnail",
+  width: 300,
+  height: 300,
+  format: "webp",
+  quality: 80
+)
+```
+
+## Generation
+
+From a clean checkout:
+
+```bash
+yarn install --frozen-lockfile
+yarn generate
+bundle install
+bundle exec rspec
+```
+
+Or with the repository `Makefile`:
+
+```bash
+make install
+make generate
+make lint
+make test
+```
+
+For handwritten Ruby code only, autoformat with:
+
+```bash
+make format-ruby
+```
+
+To prepare a release version bump:
+
+```bash
+make release-set VERSION=0.2.0
+```
+
+The generation pipeline:
+
+```text
+raw OpenAPI
+-> @imgwire/codegen-core target "ruby"
+-> openapi/sdk.openapi.json
+-> OpenAPI Generator ruby client
+-> generated/
+-> postprocess cleanup
+-> CODEGEN_VERSION update
+```

data/generated/lib/imgwire-generated/api/cors_origins_api.rb

@@ -0,0 +1,355 @@
+=begin
+#imgwire.dev Backend API development
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module ImgwireGenerated
+  class CorsOriginsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create CORS Origin
+    # @param cors_origin_create_schema [CorsOriginCreateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [CorsOriginSchema]
+    def cors_origins_create(cors_origin_create_schema, opts = {})
+      data, _status_code, _headers = cors_origins_create_with_http_info(cors_origin_create_schema, opts)
+      data
+    end
+
+    # Create CORS Origin
+    # @param cors_origin_create_schema [CorsOriginCreateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CorsOriginSchema, Integer, Hash)>] CorsOriginSchema data, response status code and response headers
+    def cors_origins_create_with_http_info(cors_origin_create_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CorsOriginsApi.cors_origins_create ...'
+      end
+      # verify the required parameter 'cors_origin_create_schema' is set
+      if @api_client.config.client_side_validation && cors_origin_create_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'cors_origin_create_schema' when calling CorsOriginsApi.cors_origins_create"
+      end
+      # resource path
+      local_var_path = '/api/v1/cors_origins/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(cors_origin_create_schema)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CorsOriginSchema'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CorsOriginsApi.cors_origins_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CorsOriginsApi#cors_origins_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, String>]
+    def cors_origins_delete(cors_origin_id, opts = {})
+      data, _status_code, _headers = cors_origins_delete_with_http_info(cors_origin_id, opts)
+      data
+    end
+
+    # Delete CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, String>, Integer, Hash)>] Hash<String, String> data, response status code and response headers
+    def cors_origins_delete_with_http_info(cors_origin_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CorsOriginsApi.cors_origins_delete ...'
+      end
+      # verify the required parameter 'cors_origin_id' is set
+      if @api_client.config.client_side_validation && cors_origin_id.nil?
+        fail ArgumentError, "Missing the required parameter 'cors_origin_id' when calling CorsOriginsApi.cors_origins_delete"
+      end
+      # resource path
+      local_var_path = '/api/v1/cors_origins/{cors_origin_id}'.sub('{' + 'cors_origin_id' + '}', CGI.escape(cors_origin_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, String>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CorsOriginsApi.cors_origins_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CorsOriginsApi#cors_origins_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List CORS Origins
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 20)
+    # @option opts [Integer] :page  (default to 1)
+    # @return [Array<CorsOriginSchema>]
+    def cors_origins_list(opts = {})
+      data, _status_code, _headers = cors_origins_list_with_http_info(opts)
+      data
+    end
+
+    # List CORS Origins
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 20)
+    # @option opts [Integer] :page  (default to 1)
+    # @return [Array<(Array<CorsOriginSchema>, Integer, Hash)>] Array<CorsOriginSchema> data, response status code and response headers
+    def cors_origins_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CorsOriginsApi.cors_origins_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CorsOriginsApi.cors_origins_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CorsOriginsApi.cors_origins_list, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CorsOriginsApi.cors_origins_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/cors_origins/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CorsOriginSchema>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CorsOriginsApi.cors_origins_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CorsOriginsApi#cors_origins_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CorsOriginSchema]
+    def cors_origins_retrieve(cors_origin_id, opts = {})
+      data, _status_code, _headers = cors_origins_retrieve_with_http_info(cors_origin_id, opts)
+      data
+    end
+
+    # Get CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CorsOriginSchema, Integer, Hash)>] CorsOriginSchema data, response status code and response headers
+    def cors_origins_retrieve_with_http_info(cors_origin_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CorsOriginsApi.cors_origins_retrieve ...'
+      end
+      # verify the required parameter 'cors_origin_id' is set
+      if @api_client.config.client_side_validation && cors_origin_id.nil?
+        fail ArgumentError, "Missing the required parameter 'cors_origin_id' when calling CorsOriginsApi.cors_origins_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v1/cors_origins/{cors_origin_id}'.sub('{' + 'cors_origin_id' + '}', CGI.escape(cors_origin_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CorsOriginSchema'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CorsOriginsApi.cors_origins_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CorsOriginsApi#cors_origins_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param cors_origin_update_schema [CorsOriginUpdateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [CorsOriginSchema]
+    def cors_origins_update(cors_origin_id, cors_origin_update_schema, opts = {})
+      data, _status_code, _headers = cors_origins_update_with_http_info(cors_origin_id, cors_origin_update_schema, opts)
+      data
+    end
+
+    # Update CORS Origin By ID
+    # @param cors_origin_id [String] 
+    # @param cors_origin_update_schema [CorsOriginUpdateSchema] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CorsOriginSchema, Integer, Hash)>] CorsOriginSchema data, response status code and response headers
+    def cors_origins_update_with_http_info(cors_origin_id, cors_origin_update_schema, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CorsOriginsApi.cors_origins_update ...'
+      end
+      # verify the required parameter 'cors_origin_id' is set
+      if @api_client.config.client_side_validation && cors_origin_id.nil?
+        fail ArgumentError, "Missing the required parameter 'cors_origin_id' when calling CorsOriginsApi.cors_origins_update"
+      end
+      # verify the required parameter 'cors_origin_update_schema' is set
+      if @api_client.config.client_side_validation && cors_origin_update_schema.nil?
+        fail ArgumentError, "Missing the required parameter 'cors_origin_update_schema' when calling CorsOriginsApi.cors_origins_update"
+      end
+      # resource path
+      local_var_path = '/api/v1/cors_origins/{cors_origin_id}'.sub('{' + 'cors_origin_id' + '}', CGI.escape(cors_origin_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(cors_origin_update_schema)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CorsOriginSchema'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CorsOriginsApi.cors_origins_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CorsOriginsApi#cors_origins_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end