getimg_client 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df68c244073fbc74c6cb913c4b9208c40a2d136d226a1974dec6addae2bc4682
-  data.tar.gz: 641715c9f551b30eb44f06252be3ded05df990676e5260cff8e89893d3b0ca77
+  metadata.gz: 49df7df20de9d97f5bc96e06eb517c007f55101e61b56c6d33d4878687f13249
+  data.tar.gz: 4dc36a54730384489acb5068e24e55fd272186f1c6cafb610272f05b777e522c
 SHA512:
-  metadata.gz: 5249e227172db1f03aeced82d4a8f6429b1ad75c6eaa2c51d0285000e0f324b9b14ef833bc638949dd35e3aef03d1ab99c93049a0de65bebe57c58d8f9d35f97
-  data.tar.gz: dec0e93875f2d227ac3a7128b57d7e65f7f3d8b334f7f4c379f7a4cb87b1c6aa0672789979b950a65cd5f96bc6fabb2fb0cf9f613d8596147b8449dffbb7b9dd
+  metadata.gz: c2a3a252131ecfca467e4ca97704a6d1d86d3ac4d0f8840a9f18c03a2686b5bdff4322ddf09e697d6cc765e5cd743579580c6be70c2b6a6a0df0c1c51aa9781d
+  data.tar.gz: 586153f30ac2646900cd7e0ad87d531ec1151ea53c5a7dd3271f0120774531f1df2f6ad1ee608a47ab8020a9e223ed42171932a0e66f3845725dfff1e790271e

data/README.md

@@ -1,4 +1,4 @@
-# GetimgClient
+# GetimgClient [![Gem Version](https://badge.fury.io/rb/getimg_client.svg)](https://badge.fury.io/rb/getimg_client)
 
 ## Introduction
 GetimgClient is a Ruby gem designed to interact with the Getimg.ai API, enabling users to generate, manipulate, and enhance images using various AI models. This gem simplifies the process of making API requests to Getimg.ai, allowing for seamless integration of image generation and manipulation capabilities into your Ruby applications.
@@ -83,7 +83,7 @@ If an HTTP error occurs, the error message will include both the HTTP status and
 The provided `model` option will determine the model use, and contribute to the client's inference of the desired endpoint. Models can be the string `id` listed online at [the GetImg dashboard](https://dashboard.getimg.ai/models) or retrieved using the `GetimgClient.models` method. Equally, you can use symbols instead. For example, `:realistic_vision_v5_1` will translate to `'realistic-vision-v5-1'`
 
 ## Essential
-Getimg offers the "essential" checkpoints, which perform more abstract Stable Diffusion operations based on the provided prompt. Note that *:essential* and *:essential_v2* will *not* be listed in the model listing, as these are not in fact actual models, nor valid "model" value at the API's end.
+Getimg offers the "essential" checkpoints, which perform more abstract Stable Diffusion operations based on the provided prompt. Note that *:essential* and *:essential_v2* will *not* be listed in the model listing, as these are not in fact actual models, nor valid "model" values at the API's end.
 In order to route a request to Essential or Essential V2 however, you can provide *:essential* or *:essential_v2* as a model argument in *#generate_image*.
 
 ## Latent Consistency Models (LCM)
@@ -158,7 +158,21 @@ puts result["image"]
 ```
 
 ## Logging
-Request logging will automatically be enabled, if the **RAILS_ENV** environment variable is set to "development"
+GetimgClient supports logging request details for debugging and development purposes. The logging behavior depends on the environment and configuration:
+
+Rails Development Environment: If the **RAILS_ENV** environment variable is set to "development" and Rails is defined, logs will be sent to the Rails logger.
+
+**GETIMG_LOG** Environment Variable: If the GETIMG_LOG environment variable is set, logs will be printed to the standard output.
+
+#### Log output example
+```text
+Generating image with the following details:
+Prompt: A scenic landscape
+Model: stable-diffusion-v1-5
+Requested Pipeline: text-to-image
+Endpoint URI: https://api.getimg.ai/v1/stable-diffusion/text-to-image
+Options: {width: 512, height: 512}
+```
 
 ## Unit Testing
 The gem includes unit tests using Minitest. Integration tests make real API calls and will incur usage fees. Ensure your API key is set in the environment before running tests.

data/lib/getimg_client.rb

@@ -43,7 +43,7 @@ class GetimgClient
 
     # Convert model to appropriate ID format
     model_id = model.to_s.gsub('_', '-')
-    if model_id === 'essential' || model_id === 'essential-v2'
+    if %w[essential essential-v2].include?(model_id)
       model_info = models[model_id] || { name: model_id, pipelines: ['text-to-image'] }
     else
       model_info = models[model_id] || raise(ArgumentError, "Unknown model: #{model}")
@@ -75,16 +75,8 @@ class GetimgClient
     # Ensure scale is an integer if present
     options[:scale] = options[:scale].to_i if options[:scale]
 
-    # Logging request details in development environment
-    if ENV['RAILS_ENV'] == 'development'
-      puts "Generating image with the following details:"
-      puts "Prompt: #{prompt}"
-      puts "Model: #{model_id}"
-      puts "Requested Pipeline: #{requested_pipeline}"
-      puts "Endpoint URI: #{uri}"
-      truncated_options = options.transform_values { |v| v.is_a?(String) && v.length > 50 ? "#{v[0, 50]}..." : v }
-      puts "Options: #{truncated_options}"
-    end
+    # Log the request details
+    log_request_details(prompt, model_id, requested_pipeline, uri, options)
 
     # Create and send the request
     request = create_request(uri, prompt, model: model_id, **options)
@@ -105,6 +97,25 @@ class GetimgClient
 
   private
 
+  # Log request details
+  def self.log_request_details(prompt, model_id, requested_pipeline, uri, options)
+    log_message = <<~LOG
+      Generating image with the following details:
+      Prompt: #{prompt}
+      Model: #{model_id}
+      Requested Pipeline: #{requested_pipeline}
+      Endpoint URI: #{uri}
+      Options: #{options.transform_values { |v| v.is_a?(String) && v.length > 50 ? "#{v[0, 50]}..." : v }}
+    LOG
+
+    if ENV['RAILS_ENV'] === 'development' && defined?(Rails) && Rails.logger
+      Rails.logger.info(log_message)
+    end
+    if ENV['GETIMG_LOG']
+      puts log_message
+    end
+  end
+
   # Determine the requested method based on provided image paths, controlnet, and model_info
   def self.method_requested(base_image, mask_image_path, controlnet, model_info)
     return :controlnet if controlnet

data/test/integration/getimg_client_integration_test.rb

@@ -1,4 +1,5 @@
 require_relative "../test_helper"
+require 'stringio'
 
 class GetimgClientIntegrationTest < Minitest::Test
   def setup
@@ -63,6 +64,35 @@ class GetimgClientIntegrationTest < Minitest::Test
     save_image(result["image"], "test_generate_text_to_image_essential")
   end
 
+  def test_logging_to_rails_logger
+    skip "Rails not defined, skipping Rails logger test" unless defined?(Rails) && ENV['RAILS_ENV'] === 'development'
+
+    original_logger = Rails.logger
+    log_output = StringIO.new
+    Rails.logger = Logger.new(log_output)
+
+    GetimgClient.generate_image("A scenic landscape", model: :stable_diffusion_v1_5, width: 512, height: 512)
+
+    assert_includes log_output.string, "Generating image with the following details:"
+    assert_includes log_output.string, "Prompt: A scenic landscape"
+
+    Rails.logger = original_logger
+  end
+
+  def test_logging_to_puts
+    ENV['GETIMG_LOG'] = '1'
+    log_output = StringIO.new
+    $stdout = log_output
+
+    GetimgClient.generate_image("A scenic landscape", model: :stable_diffusion_v1_5, width: 512, height: 512)
+
+    assert_includes log_output.string, "Generating image with the following details:"
+    assert_includes log_output.string, "Prompt: A scenic landscape"
+
+    $stdout = STDOUT
+    ENV.delete('GETIMG_LOG')
+  end
+
   private
 
   def save_image(base64_image, filename)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: getimg_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Melvin Sommer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest