generate_image 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c82e0f5d7f1a2831ddf9cbac4eb7072476f7c9c258c3e3f68b79bcea1e17087
-  data.tar.gz: 591e2f4ee36d58271652eebe77a3bf42111fbfd39de61617fa5c3d65a9465b47
+  metadata.gz: 462b48a0798e5e6d50bffb2386d428b69d43b2c547a0e1bcc7ef01e1ada2fdb3
+  data.tar.gz: 9f6bf6aac0c92744f538aee95c82a64dab88200370891918a6406c77cb047e93
 SHA512:
-  metadata.gz: fa20658a7577013d65fc74cb67a706d34a8294cdec6b8d9566930b1411a4b41a9b6d94ee70b93a4c5d7b17e76fb0f5ed851bc47f2647d3c742400e1db11dba0a
-  data.tar.gz: 46a369f42d94f244f37de29acb10ac3495209f5a0593eee3cfc3a68c97207f4c217c5838f3c27d565df814a075c9c7a833170e7968276b6a18a833ceb9398ccb
+  metadata.gz: 3682a51b886ecf2808b6f826bb30243e0b08a2628e93b6011c241fa201ab8abaaecc2195f9f5e46423a347330dbab8286e28fd3795417fb2661c0cf23c939f46
+  data.tar.gz: 5426a9c7093f85c6078f9d6d3deaab45253ca5d538dabe5ffd01c53317e8c452e623f0b071f693367c29702990b313499023ec047c62513bd599996100f5ded7

data/README.md

@@ -1,39 +1,52 @@
 # GenerateImage
-The generate_image gem is a Ruby gem that provides a simple and easy-to-use interface for generating images using the DALL-E API. The gem is designed to be used in Ruby on Rails projects, but it can also be used in other Ruby projects.
+The GenerateImage gem is a Ruby gem that provides a simple and easy-to-use interface for generating images using the OpenAI DALL-E API. This gem can be used in Ruby on Rails projects or any other Ruby projects.
 
-The gem provides a generate_image method, which takes a text argument and returns the generated image binary data. The method makes a request to the DALL-E API to generate an image based on the text, and returns the image binary data.
+## Usage
+The gem provides a generate_image method, which takes a text argument and returns the generated image URL as a hash. The method makes a request to the DALL-E API to generate an image based on the provided text.
 
-The gem uses the Net::HTTP library to make the API request and it requires the API key to be set as an environment variable named DALL_E_API_KEY. The gem also includes error handling to ensure that the image generation is successful and raises an error if there's any issue.
+Before using the generate_image method, you must set your OpenAI API key as an environment variable named DALL_E_API_KEY. The gem uses the Net::HTTP library to make API requests and includes error handling to ensure successful image generation. In case of any errors, the method will return a hash with an error key and a message.
+
+## Setting the API Key
+
+Before you can use the generate_image method, you must set your OpenAI API key as an environment variable named DALL_E_API_KEY.
+
+Here's an example of how you can set the environment variable
+
+    DALL_E_API_KEY=your_api_key
+
+## Example Usage
+
+    result = GenerateImage.generate_image('A three-story castle made of ice cream')
+    if result[:error]
+      puts result[:error]
+    else
+      puts result[:image_url]
+    end
 
 ## Installation
-To install the gem, add this line to your application's Gemfile:
+### Add this line to your application's Gemfile:
 
     gem 'generate_image'
-### Then run:
-    
+### And then execute:
+
     bundle install
 ### Or install it directly by running:
 
-
     gem install generate_image
-
 ## Development
-### To contribute to the development of this gem, check out the repo and run the following commands to install dependencies and run the tests:
+To contribute to the development of this gem, clone the repository and run the following commands to install dependencies and run tests:
 
     bin/setup
     rake spec
 You can also run bin/console for an interactive prompt to experiment with the code.
 
-### To release a new version, update the version number in version.rb, then run:
+### To release a new version, update the version number in version.rb and run:
 
     bundle exec rake release
-This will create a git tag for the new version, push the git commits and tags, and upload the .gem file to rubygems.org.
+This will create a git tag for the new version, push the git commits and tags, and upload the .gem file to RubyGems.org.
 
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/merouaneamqor/generate_image. This project is intended to be a safe, welcoming space for collaboration, and all contributors are expected to adhere to the code of conduct.
+Bug reports and pull requests are welcome on the GitHub repository. This project is intended to be a safe and welcoming space for collaboration, and all contributors are expected to adhere to the code of conduct.
 
 ## License
-The gem is available as open source under the terms of the MIT License.
-
-## Code of Conduct
-Everyone interacting with the project is expected to follow the code of conduct.
+The GenerateImage gem is open source software, released under the terms of the MIT License.

data/lib/generate_image/version.rb

@@ -1,3 +1,3 @@
 module GenerateImage
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/generate_image.rb

@@ -3,15 +3,21 @@ require 'json'
 
 module GenerateImage
   class << self
+    API_ENDPOINT = 'https://api.openai.com/v1/images/generations'
+    MODEL_NAME = 'image-alpha-001'
+
     def generate_image(text)
       api_key = ENV['DALL_E_API_KEY']
+      unless api_key
+        raise StandardError, "API Key not set"
+      end
 
-      uri = URI('https://api.openai.com/v1/images/generations')
+      uri = URI(API_ENDPOINT)
       request = Net::HTTP::Post.new(uri)
       request['Content-Type'] = 'application/json'
       request['Authorization'] = "Bearer #{api_key}"
       request.body = {
-        model: 'image-alpha-001',
+        model: MODEL_NAME,
         prompt: text,
         num_images: 1
       }.to_json
@@ -24,7 +30,9 @@ module GenerateImage
         image_url = JSON.parse(response.body)['data'][0]['url']
         return { image_url: image_url }
       else
-        return { error: "Failed to generate image" }, 500
+        message = "Failed to generate image. Response code: #{response.code}. Response body: #{response.body}"
+        Rails.logger.error(message) if defined?(Rails)
+        return { error: message }, 500
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generate_image
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - AMQOR Merouane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http