chatpdf 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a47d9b3731d5c619f7b0aa8098dc7e5a42540af691c88878d37b592e34425b0
+  data.tar.gz: cdf237a65af3119680f7d712f19b73f78d0456ec79d061b1da5d1bada0fe9b2d
+SHA512:
+  metadata.gz: fc300f54db07b7969ca5a0507fe6f2d34c6ce62f0eb4d82f622c0155689841239dc3fa6e6a2de81be38cbd19b0272beccfd2d86298f0e35a9d36b32b2286bb1c
+  data.tar.gz: 64e146a96eb7a27b8e7fcd5ed1e46a2267413414fc7e85b4cdd416aba520f078108bc7da89f1ef0891e92a16905d1acb667efa8b9692d63329338ac5afc640b0

data/.github/workflows/release-gem.yml

@@ -0,0 +1,27 @@
+name: Release RubyGem
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write 
+      contents: write
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [Unreleased]
+- None
+
+## [1.0.1] - 2025-06-03
+- Bump version 1.0.1
+
+## [1.0.0] - 2025-06-03
+- Basic Chatpdf wrapper With Conversation Manager.
+
+## [0.1.0] - 2025-05-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+abhishekka3193@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    chatpdf (1.0.1)
+      httparty (~> 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    csv (3.3.4)
+    diff-lcs (1.6.2)
+    httparty (0.23.1)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    mini_mime (1.1.5)
+    multi_xml (0.6.0)
+    rake (13.2.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  chatpdf!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.5.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Abhishek Kanojia
+
+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,235 @@
+# ChatPDF Ruby Gem
+
+A Ruby gem for interacting with the ChatPDF API, allowing you to have conversations with your PDF documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chatpdf'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install chatpdf
+```
+
+## Usage
+
+## Creating The Config File
+
+Config file which contains the initializer for Chatpdf can be created manually or by running the following command:
+
+```ruby
+rails g chatpdf:install
+```
+
+This will generate the following file:
+
+```ruby
+# config/initializers/chatpdf_initializer.rb
+Chatpdf.config do |config|
+  config.api_key = ENV['CHATPDF_API_KEY']
+end
+```
+
+## Usage
+
+
+### Uploading The PDF file
+
+Files can be added in two ways as mentioned in the chatpdf api as well. 
+
+#### Adding File via upload
+```ruby
+client = Chatpdf::Client.new
+
+file_path = '/path/to/your/file'
+
+client.add_pdf(file_path)
+=>
+
+{"sourceId"=>"src_XXXXXXXXXXXXXXXX"}
+```
+#### Adding File via URL 
+
+```ruby
+client = Chatpdf::Client.new
+
+file_url = 'https://test.com/some/external/file.pdf'
+
+client.add_pdf_via_url(file_url)
+=>
+
+{"sourceId"=>"src_XXXXXXXXXXXXXXXX"}
+```
+
+### Chat With PDF
+
+#### Chat Message
+Before you could chat with PDF, using the `chat` method available on `Chatpdf::Client` instance.
+
+#### Create a Chat Message
+
+```ruby
+message = Chatpdf::Message.new('Your Question Here')
+
+message.to_h
+=>
+{
+  role: 'user',
+  content: 'Your Question Here'
+}
+```
+
+Once `Chatpdf::Message` is created you can now ask question as follows:
+
+```ruby
+client.chat(source_id, [message.to_h])
+=>
+{
+  'content' => 'Answer to your question'
+}
+```
+
+#### Chat with Reference
+
+This just returns the page references from the provided PDF along with the response from the chatpdf.
+
+```ruby
+client.chat_with_reference(source_id, [message.to_h])
+=>
+{
+  'content' => 'Answer to your question',
+  'references' => [{ "pageNumber" => 11 }]
+}
+```
+
+### Chat Stream
+Chatpdf also provides answers in form of stream, with this gem you can use that as well.
+
+```ruby
+client.chat_stream(source_id, [message.to_h]) do |response_chunks|
+  puts response_chunks
+end
+```
+
+### Delete Source
+The source can be deleted with `delete_source` method available on client
+
+```ruby
+client.delete_source([source_ids]) # array of source_ids to be deleted
+=>
+nil
+```
+
+### Extended Feature of Gem
+
+If you want to use easily use the chatpdf gem, extended classes will help you achieve so.
+
+### Creating a Chat Session
+
+```ruby
+file_path = '/path/to/file.pdf'
+
+# OR
+
+file_url = 'https://example.com/path/to/file.pdf'
+
+session = Chatpdf::Session::Conversation.new(file_path: file_path)
+
+# OR
+
+session = Chatpdf::Session::Conversation.new(file_url: file_url)
+
+# OR
+
+session = Chatpdf::Session::Conversation.new(source_id: source_id_of_already_uploaded_file)
+```
+> IMPORTANT: source_id cannot be provided if File path or File Url is provided. This will result in an error `Chatpdf::InvalidSessionInitialization`
+
+
+### Asking Questions
+
+```ruby
+session.ask('Your question here')
+=> "Your answer here"
+```
+
+With Reference
+
+```ruby
+session.ask('Your question here', references: true)
+=> "Your answer here"
+```
+
+
+### Accessing The Asked Questions
+Good thing about session is that it stores the asked questions in the instance itself, at a later point while using sesion, if you want to access the questions you have asked. You can do
+
+```ruby
+session.questions.map(&:to_s)
+=>
+["Your question here"]
+```
+
+#### Accessing The Asked Question's Answers
+
+```ruby
+session.questions.map { |question| question.answer.to_s }
+=>
+["Your answer here"]
+```
+
+### Serialise Questions
+```ruby
+session.questions.map(&:serialise)
+=>
+[{:id=>"0185bb65-c150-41c5-81a1-5f7f0532d8f2",
+  :question=>"Your Question Here",
+  :answer=>
+   {:id=>"e68c2463-88ed-4bcc-b3a8-00990d4c6cc8",
+    :content=>"Your Answer here",
+    :references=>[]}}]
+```
+
+### Serialise the Session
+
+```ruby
+session.serialise
+=>
+{:file_path=>"/Users/abhishekkanojia/Downloads/NAB-AGM.pdf",
+ :url=>nil,
+ :source_id=>"src_vSixL2t5LY4fNLF4iGZ8f",
+ :questions=>
+  [{:id=>"0185bb65-c150-41c5-81a1-5f7f0532d8f2",
+    :question=>"Your Question Here",
+    :answer=>
+     {:id=>"e68c2463-88ed-4bcc-b3a8-00990d4c6cc8",
+      :content=>
+       "Your Answer Here",
+      :references=>[]}}]}
+```
+
+## Error Handling
+
+The gem includes several error classes:
+
+- `Chatpdf::InvalidConfiguration`: Raised when API key is not set
+- `Chatpdf::InvalidSessionInitialization`: Raised when conversation parameters are invalid
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

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,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "chatpdf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chatpdf.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'chatpdf/version'
+
+Gem::Specification.new do |s|
+  s.name        = "chatpdf"
+  s.version     = Chatpdf::VERSION
+  s.summary     = "[WIP] ChatPDF ruby gem around the ChatPDF API"
+  s.description = "[WIP] Chatpdf is a ruby gem around the ChatPDF API"
+  s.authors     = ["Abhishek Kanojia"]
+  s.email       = "abhishek.kanojia3193@gmail.com" 
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir      = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.homepage    = "https://rubygems.org/gems/chatpdf"
+  s.license       = "MIT"
+
+  s.add_development_dependency "rspec", "~> 3.12.0"
+  
+  s.add_dependency "httparty", '~> 0.23.1'
+end

data/lib/chatpdf/api/base.rb

@@ -0,0 +1,11 @@
+module Chatpdf
+  module Api
+    class Base
+      attr_reader :client
+      
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/chatpdf/api/chat.rb

@@ -0,0 +1,27 @@
+module Chatpdf
+  module Api
+    class Chat < Chatpdf::Api::Base
+      def chat(source_id, messages = [])
+        response = client.request("/chats/message", {
+          body: {
+            sourceId: source_id,
+            messages: messages
+          }
+        })
+
+        ResponseHandler.new(response).response_body
+      end
+
+      def chat_with_reference(source_id, messages = [])
+        response = client.request("/chats/message", {
+          body: {
+            referenceSources: true,
+            sourceId: source_id,
+            messages: messages
+          }
+        })
+        ResponseHandler.new(response).response_body
+      end
+    end
+  end
+end

data/lib/chatpdf/api/chat_stream.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Chatpdf
+  module Api
+    class ChatStream < Chatpdf::Api::Base
+      def chat_stream(source_id, messages = [])
+        uri = URI.parse(client.endpoint("/chats/message"))
+        request = Net::HTTP::Post.new(uri, client.headers)
+        request.body = {
+          sourceId: source_id,
+          messages: messages,
+          stream: true
+        }.to_json
+        
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request) do |response|
+            response.read_body do |chunk|
+              yield chunk
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chatpdf/api/delete_source.rb

@@ -0,0 +1,15 @@
+module Chatpdf
+  module Api
+    class DeleteSource < Chatpdf::Api::Base
+      def delete_source(source_ids = [])
+        response = client.request("/sources/delete", {
+          body: {
+            sources: source_ids
+          }
+        })
+
+        ResponseHandler.new(response).response_body
+      end
+    end
+  end
+end

data/lib/chatpdf/api/file_upload.rb

@@ -0,0 +1,27 @@
+module Chatpdf
+  module Api
+    class FileUpload < Chatpdf::Api::Base
+      def add_pdf_via_upload(file_path)
+        file = File.new(file_path ,'rb')
+        response = client.upload_file("/sources/add-file", {
+          body: {
+            file: file
+          }
+        })
+        file.close
+
+        ResponseHandler.new(response).response_body
+      end
+
+      def add_pdf_via_url(url)
+        response = client.request("/sources/add-url", {
+          body: {
+            url: url
+          }
+        })
+        
+        ResponseHandler.new(response).response_body
+      end
+    end
+  end
+end

data/lib/chatpdf/chatpdf.rb

@@ -0,0 +1,2 @@
+module Chatpdf
+end

data/lib/chatpdf/client.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+
+module Chatpdf
+  class Client
+    BASE_URL = "https://api.chatpdf.com/v1".freeze
+    
+    include Chatpdf::Actionable
+    
+    def initialize
+      @api_key = api_key_or_raise
+    end
+
+    def request(path, options = {})
+      HTTParty.post(
+        endpoint(path),
+        headers: headers,
+        body: options[:body].to_json
+      )
+    end
+
+    def upload_file(path, options = {})
+      HTTParty.post(
+        endpoint(path),
+        headers: { "x-api-key" => @api_key },
+        body: options[:body]
+      )
+    end
+
+    def endpoint(path)
+      BASE_URL + path
+    end
+
+    def headers
+      { "x-api-key" => @api_key, "Content-Type" => "application/json" }
+    end
+
+    def api_key_or_raise
+      Chatpdf.configuration.api_key || raise(Chatpdf::InvalidConfiguration, "API key is not set")
+    end
+  end
+end

data/lib/chatpdf/concerns/actionable.rb

@@ -0,0 +1,41 @@
+module Chatpdf
+  module Actionable
+    module InstanceMethods
+      def add_pdf(file_path)
+        Chatpdf::Api::FileUpload.new(self).add_pdf_via_upload(file_path)
+      end
+
+      def add_pdf_via_url(url)
+        Chatpdf::Api::FileUpload.new(self).add_pdf_via_url(url)
+      end
+
+      def chat(source_id, messages)
+        Chatpdf::Api::Chat.new(self).chat(
+          source_id,
+          messages
+        )
+      end
+
+      def chat_with_reference(source_id, messages)
+        Chatpdf::Api::Chat.new(self).chat_with_reference(
+          source_id,
+          messages
+        )
+      end
+
+      def delete_source(source_ids = [])
+        Chatpdf::Api::DeleteSource.new(self).delete_source(source_ids)
+      end
+
+      def chat_stream(source_id, messages)
+        Chatpdf::Api::ChatStream.new(self).chat_stream(source_id, messages) do |chunk|
+          yield chunk
+        end
+      end
+    end
+
+    def self.included(klass)
+      klass.send(:include, InstanceMethods)
+    end
+  end
+end

data/lib/chatpdf/configuration.rb

@@ -0,0 +1,9 @@
+module Chatpdf
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/chatpdf/exceptions/invalid_configuration.rb

@@ -0,0 +1,7 @@
+module Chatpdf
+  class InvalidConfiguration < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/chatpdf/exceptions/invalid_session_initialization.rb

@@ -0,0 +1,7 @@
+module Chatpdf
+  class InvalidSessionInitialization < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/chatpdf/message.rb

@@ -0,0 +1,15 @@
+module Chatpdf
+  class Message
+    def initialize(content, role: "user")
+      @content = content
+      @role = role
+    end
+
+    def to_h
+      {
+        role: @role,
+        content: @content,
+      }
+    end
+  end
+end

data/lib/chatpdf/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module Chatpdf
+  class Railtie < ::Rails::Railtie
+    generators do
+      require 'generators/chatpdf/install/install_generator'
+    end
+  end
+end

data/lib/chatpdf/response_handler.rb

@@ -0,0 +1,15 @@
+module Chatpdf
+  class ResponseHandler
+    def initialize(response)
+      @response = response
+    end
+
+    def success?
+      @response.ok?
+    end
+
+    def response_body
+      @response.parsed_response
+    end
+  end
+end

data/lib/chatpdf/session/answer.rb

@@ -0,0 +1,35 @@
+module Chatpdf
+  module Session
+    class Answer
+      PAGE_NUMBER_KEY = "pageNumber".freeze
+      @@_id = 0
+
+      attr_reader :id, :content
+
+      def initialize(response = {})
+        @content = response["content"]
+        @references = response["references"]
+        @@_id = Random.uuid
+        @id = @@_id
+      end
+
+      def to_s
+        @content
+      end
+
+      def references
+        return [] if @references.nil?
+        
+        @references.map { |reference| reference[PAGE_NUMBER_KEY] }
+      end
+
+      def serialise
+        {
+          id: id,
+          content: content,
+          references: references
+        }
+      end
+    end
+  end
+end

data/lib/chatpdf/session/conversation.rb

@@ -0,0 +1,73 @@
+module Chatpdf
+  module Session
+    class Conversation
+      attr_reader :file_path, :url, :source_id, :questions
+
+      def initialize(file_path: nil, url: nil, source_id: nil)
+        @file_path = file_path
+        @url = url
+        @questions = []
+        @source_id = source_id
+        validate_params
+      end
+
+      def ask(question, references: false)
+        add_pdf if source_id.nil?
+
+        question = Question.new(question)
+        @questions << question
+
+        response = client.chat(source_id, [Chatpdf::Message.new("#{question}").to_h]) unless references
+        response = client.chat_with_reference(source_id, [Chatpdf::Message.new("#{question}").to_h]) if references
+
+        question.answer = Answer.new(response)
+
+        question.answer.to_s
+      end
+
+      def delete_source
+        return unless source_id
+
+        client.delete_source([source_id])
+      end
+
+      def serialise
+        {
+          file_path: file_path,
+          url: url,
+          source_id: source_id,
+          questions: questions.map(&:serialise)
+        }
+      end
+
+      private
+
+      def client
+        @client ||= Chatpdf::Client.new
+      end
+
+      def add_pdf
+        if file_path
+          response = client.add_pdf(file_path)
+        elsif url
+          response = client.add_pdf_via_url(url)
+        else
+          raise Chatpdf::InvalidSessionInitialization, "Either file_path or url or source_id must be provided"
+        end
+
+        @source_id = response["sourceId"]
+        @source_id
+      end
+
+      def validate_params
+        if !@source_id.nil? && (!@file_path.nil? || !@url.nil?)
+          raise Chatpdf::InvalidSessionInitialization, "Invalid parameters: source_id cannot be provided if file_path or url is provided"
+        end
+
+        if @file_path.nil? && @url.nil? && @source_id.nil?
+          raise Chatpdf::InvalidSessionInitialization, "Either file_path or url or source_id must be provided"
+        end
+      end
+    end
+  end
+end

data/lib/chatpdf/session/question.rb

@@ -0,0 +1,29 @@
+module Chatpdf
+  module Session
+    class Question
+      @@_id = 0
+
+      attr_reader :id
+      attr_accessor :answer
+
+      def initialize(question)
+        @question = question
+        @@_id = Random.uuid
+        @id = @@_id
+        @answer = nil
+      end
+
+      def to_s
+        @question
+      end
+
+      def serialise
+        {
+          id: id,
+          question: @question,
+          answer: answer.serialise
+        }
+      end
+    end
+  end
+end

data/lib/chatpdf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chatpdf
+  VERSION = "1.0.1"
+end

data/lib/chatpdf.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'chatpdf/configuration'
+require 'chatpdf/concerns/actionable'
+
+require 'chatpdf/client'
+require 'chatpdf/version'
+
+require 'chatpdf/api/base'
+require 'chatpdf/api/file_upload'
+require 'chatpdf/api/chat'
+require 'chatpdf/api/delete_source'
+require 'chatpdf/api/chat_stream'
+
+require 'chatpdf/exceptions/invalid_session_initialization'
+require 'chatpdf/exceptions/invalid_configuration'
+
+require 'chatpdf/session/question'
+require 'chatpdf/session/answer'
+require 'chatpdf/session/conversation'
+require 'chatpdf/message'
+
+require 'chatpdf/response_handler'
+
+Gem.find_files("chatpdf/**/*.rb").each { |path| require_relative path }
+
+require "chatpdf/railtie" if defined?(Rails)
+
+
+module Chatpdf
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/generators/chatpdf/install/install_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module Chatpdf
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def create_initializer_file
+        create_file "config/initializers/chatpdf_initializer.rb", <<~FILE
+          Chatpdf.config do |config|
+            config.api_key = ENV['CHATPDF_API_KEY']
+          end
+        FILE
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: chatpdf
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Abhishek Kanojia
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+description: "[WIP] Chatpdf is a ruby gem around the ChatPDF API"
+email: abhishek.kanojia3193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release-gem.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chatpdf.gemspec
+- lib/chatpdf.rb
+- lib/chatpdf/api/base.rb
+- lib/chatpdf/api/chat.rb
+- lib/chatpdf/api/chat_stream.rb
+- lib/chatpdf/api/delete_source.rb
+- lib/chatpdf/api/file_upload.rb
+- lib/chatpdf/chatpdf.rb
+- lib/chatpdf/client.rb
+- lib/chatpdf/concerns/actionable.rb
+- lib/chatpdf/configuration.rb
+- lib/chatpdf/exceptions/invalid_configuration.rb
+- lib/chatpdf/exceptions/invalid_session_initialization.rb
+- lib/chatpdf/message.rb
+- lib/chatpdf/railtie.rb
+- lib/chatpdf/response_handler.rb
+- lib/chatpdf/session/answer.rb
+- lib/chatpdf/session/conversation.rb
+- lib/chatpdf/session/question.rb
+- lib/chatpdf/version.rb
+- lib/generators/chatpdf/install/install_generator.rb
+homepage: https://rubygems.org/gems/chatpdf
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: "[WIP] ChatPDF ruby gem around the ChatPDF API"
+test_files: []