promptjoy-ruby 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310a49711f3259ee888236d1e463e7dbe800d9e984da38c22050f3e98dd8293d
-  data.tar.gz: ba442e4c722d1cb91be33204590bf532dccb8e72a2caf70c796d1c8cb66d3508
+  metadata.gz: b5cbf24cd878b9fd62c664a1033aa5961b8768e06069d40f85234e1e25d4210c
+  data.tar.gz: '0958ab3a92dc55778900be7a785b2d32818dd5b0b8eca6414b27b00a901039e7'
 SHA512:
-  metadata.gz: beda92c16b2d6f34955f2ff2bb85ebe0c17dae1dd4dfb9dc05ae95ca1d3ea2ee1201c387658794d36115416a15ab400fd139f3c5aa1586f2ce88e677be1067fd
-  data.tar.gz: a9c24e4fba7592862c0acddaff3fc67c4eaf8d035e02cb4b0f7b88603c1060a36e154ab00dd74540a0dc62f90a12a7b8c78e50edc8ff75611e1f047ac700ecff
+  metadata.gz: a6d4d61af49df233f084f955ff22fa58df79f61e4d533613b94f80fb8ac64443c98863088356b130b71f4dd8fa7ef7af0bc5475b4b9917e26d3805c69afb6b4d
+  data.tar.gz: 1500f2211ce37c87d590a26810dcdc0cf8341a4019ca5340d51141ff9cb19590106a3913d8096522d1b70a67e61cdc20cacbf9965265584f8c0c21a7c63bd621

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promptjoy-ruby (0.1.1)
+    promptjoy-ruby (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,7 +2,14 @@
 
 Welcome to the official Ruby client for the [PromptJoy](https://promptjoy.com).
 
-PromptJoy is a platform that enables you to build scalable APIs by simply describing what you want. This client helps you interact with PromptJoy in a Ruby-friendly way.
+[PromptJoy](https://promptjoy.com) is a platform that enables you to build scalable APIs by simply describing what you want. 
+
+Example APIs built on [PromptJoy](https://promptjoy.com):
+* Travel recommendation https://promptjoy.com/apis/mPBCOr
+* TV show -> podcast recommendation: https://promptjoy.com/apis/mxqCWW
+* Schema transformation: https://promptjoy.com/apis/jn8Cep
+* Book search engine: https://promptjoy.com/apis/mVMCpq
+  
 
 ## Installation
 
@@ -36,12 +43,16 @@ client = PromptjoyRuby::Client.new('your_api_key')
 
 ```
 
-You can find the API you want to interact with by using its URL:
+You can find the API you want to interact with by using its URL. You can find the URL in the endpoint field of the API's page:
 
 ```ruby
-api = client.find_by_api_url('https://api.promptjoy.com/test-endpoint')
+api = client.find_by_api_url('https://api.promptjoy.com/api/id')
 ```
 
+You can also just find the API by its id:
+```ruby
+api = client.find('id')
+```
 
 
 To call the API, pass in the data as a Hash:
@@ -53,6 +64,20 @@ response = api.call({
 })
 ```
 
+## Example
+
+The following example uses PromptJoy to build an API that recommends an open-source software package based on a problem to be solved: https://promptjoy.com/apis/jNqC7A
+
+``` ruby
+> require 'promptjoy-ruby'
+> client = PromptjoyRuby::Client.new('***********************')
+> api = client.find_by_api_url('https://api.promptjoy.com/api/jNqC7A')
+> response = api.call({problem: "queue processing in ruby"})
+> puts response
+
+{"software"=>"Sidekiq", "reason"=>"Efficient and reliable background processing 
+for Ruby", "github_url"=>"https://github.com/mperham/sidekiq"}
+```
 
 
 ## Error Handling

data/lib/promptjoy-ruby/version.rb

@@ -1,3 +1,3 @@
 module PromptjoyRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/promptjoy-ruby.rb

@@ -10,7 +10,9 @@ module PromptjoyRuby
   class Error < StandardError; end
 
   class Client
-    def initialize(api_key = nil, logger: Logger.new(STDOUT))
+    BASE_API_URL = "https://api.promptjoy.com"
+
+    def initialize(api_key = nil, logger: Logger.new(STDOUT), timeout: 120)
       @api_key = api_key
       @logger = logger
     end
@@ -18,12 +20,17 @@ module PromptjoyRuby
     def find_by_api_url(url, api_key: nil)
       Api.new(api_key || @api_key, url, logger: @logger)
     end
+
+    def find(id)
+      url = "#{BASE_API_URL}/api/#{id}"
+      Api.new(@api_key, url, logger: @logger)
+    end
   end
 
   class Api
     USER_AGENT = "PromptjoyRubyGem/#{PromptjoyRuby::VERSION}"
 
-    def initialize(api_key, url, logger: Logger.new(STDOUT))
+    def initialize(api_key, url, logger: Logger.new(STDOUT), timeout: 120)
       @api_key = api_key
       @url = url
       @logger = logger
@@ -32,7 +39,9 @@ module PromptjoyRuby
     def call(api_data, client_ip = nil, referrer = nil)
       uri = URI(@url)
       http = Net::HTTP.new(uri.host, uri.port)
-      
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+
       if uri.scheme == 'https'
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promptjoy-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - PromptJoy Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec