promptjoy-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 310a49711f3259ee888236d1e463e7dbe800d9e984da38c22050f3e98dd8293d
+  data.tar.gz: ba442e4c722d1cb91be33204590bf532dccb8e72a2caf70c796d1c8cb66d3508
+SHA512:
+  metadata.gz: beda92c16b2d6f34955f2ff2bb85ebe0c17dae1dd4dfb9dc05ae95ca1d3ea2ee1201c387658794d36115416a15ab400fd139f3c5aa1586f2ce88e677be1067fd
+  data.tar.gz: a9c24e4fba7592862c0acddaff3fc67c4eaf8d035e02cb4b0f7b88603c1060a36e154ab00dd74540a0dc62f90a12a7b8c78e50edc8ff75611e1f047ac700ecff

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in promptjoy-ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    promptjoy-ruby (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    public_suffix (5.0.3)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  promptjoy-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 PromptJoy
+
+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,81 @@
+# PromptJoy Ruby Gem
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'promptjoy-ruby'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install promptjoy-ruby
+```
+
+
+
+## Usage
+
+```ruby
+require 'promptjoy-ruby'
+
+client = PromptjoyRuby::Client.new('your_api_key')
+
+
+```
+
+You can find the API you want to interact with by using its URL:
+
+```ruby
+api = client.find_by_api_url('https://api.promptjoy.com/test-endpoint')
+```
+
+
+
+To call the API, pass in the data as a Hash:
+
+```ruby
+response = api.call({
+  key1: 'value1',
+  key2: 'value2'
+})
+```
+
+
+
+## Error Handling
+
+If an error occurs during an API call, an instance of PromptjoyRuby::Error is raised with a message indicating the nature of the error.
+
+```ruby
+begin
+  api.call(some_data)
+rescue PromptjoyRuby::Error => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+
+
+
+## More about PromptJoy
+
+Please email any feedback to team@promptjoy.com.
+
+
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "promptjoy-ruby"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+

data/lib/promptjoy-ruby/version.rb

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

data/lib/promptjoy-ruby.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "promptjoy-ruby/version"
+require 'net/http'
+require 'json'
+require 'uri'
+require 'logger'
+
+module PromptjoyRuby
+  class Error < StandardError; end
+
+  class Client
+    def initialize(api_key = nil, logger: Logger.new(STDOUT))
+      @api_key = api_key
+      @logger = logger
+    end
+
+    def find_by_api_url(url, api_key: nil)
+      Api.new(api_key || @api_key, url, logger: @logger)
+    end
+  end
+
+  class Api
+    USER_AGENT = "PromptjoyRubyGem/#{PromptjoyRuby::VERSION}"
+
+    def initialize(api_key, url, logger: Logger.new(STDOUT))
+      @api_key = api_key
+      @url = url
+      @logger = logger
+    end
+
+    def call(api_data, client_ip = nil, referrer = nil)
+      uri = URI(@url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+      
+      @logger.debug "URI: #{uri}"
+      @logger.debug "API Data: #{api_data}"
+      
+      request = Net::HTTP::Post.new(uri)
+      
+      request['Authorization'] = "Bearer #{@api_key}"
+      request['Client-Ip'] = client_ip if client_ip
+      request['User-Agent'] = USER_AGENT
+      request['Referrer'] = referrer if referrer
+      request.body = api_data.to_json
+      request['Content-Type'] = 'application/json'
+      
+      response = http.request(request)
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      when Net::HTTPUnauthorized
+        raise Error.new("API call failed due to unauthorized access. Check your API key.")
+      else
+        raise Error.new("API call failed with HTTP #{response.code} #{response.message}")
+      end
+    end
+  end
+end

data/promptjoy-ruby.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/promptjoy-ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "promptjoy-ruby"
+  spec.version = PromptjoyRuby::VERSION
+  spec.authors = ["PromptJoy Team"]
+  spec.email = ["team@promptjoy.com"]
+
+  spec.summary = "Official PromptJoy Ruby Gem."
+  spec.description = %q{The PromptJoy ruby gem provides a simple and efficient way to interact with the PromptJoy API in Ruby. It handles the API authentication, request formation, and response parsing, providing the users with an intuitive interface to make API calls and retrieve the data.}
+
+  spec.homepage = "https://promptjoy.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata = {
+    "homepage_uri" => "https://promptjoy.com",
+    "bug_tracker_uri" => "https://github.com/promptjoy/promptjoy-ruby/issues",
+    "documentation_uri" => "https://docs.promptjoy.com",
+    "changelog_uri" => "https://github.com/promptjoy/promptjoy-ruby/blob/main/Changes.md",
+    "source_code_uri" => "https://github.com/promptjoy/promptjoy-ruby",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.*\.gem$)/}) }
+  
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Add rspec and webmock as development dependencies
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: promptjoy-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- PromptJoy Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The PromptJoy ruby gem provides a simple and efficient way to interact
+  with the PromptJoy API in Ruby. It handles the API authentication, request formation,
+  and response parsing, providing the users with an intuitive interface to make API
+  calls and retrieve the data.
+email:
+- team@promptjoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/promptjoy-ruby.rb
+- lib/promptjoy-ruby/version.rb
+- promptjoy-ruby.gemspec
+homepage: https://promptjoy.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://promptjoy.com
+  bug_tracker_uri: https://github.com/promptjoy/promptjoy-ruby/issues
+  documentation_uri: https://docs.promptjoy.com
+  changelog_uri: https://github.com/promptjoy/promptjoy-ruby/blob/main/Changes.md
+  source_code_uri: https://github.com/promptjoy/promptjoy-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Official PromptJoy Ruby Gem.
+test_files: []