invoiceai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c346c3ad76415ebfaa9a01eef9af43ffa5f536c0fd0cd5a760df580c58e70af
+  data.tar.gz: 3e77b7e098ea6c4eda21346f95c62518ea8c8c58264d6deaf41faeb2a5e8166b
+SHA512:
+  metadata.gz: 44f65228fdb35fb8fb66d68f1769b1aa49dd847a5a719c2023e1473ab38987d46b0a75b38e747cb22825128e016ff367f92e984e8486646682dc36546a080ba1
+  data.tar.gz: 15d6493174c6300d2fd5ba2308ecf6897f3e722264a12693a1cdbda89dc02dc86f0ba268670fedd1599742710ea4227348aac746b58a5e656749e337530152ce

data/README.md

@@ -0,0 +1,41 @@
+# InvoiceAI Ruby SDK
+
+Official Ruby SDK for the InvoiceAI API. Manage invoices, clients, products, quotes, and more.
+
+## Installation
+
+```bash
+gem install invoiceai
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'invoiceai'
+```
+
+## Quick Start
+
+```ruby
+require 'invoiceai'
+
+# Initialize with your API key
+client = InvoiceAI::Client.new(api_key: 'your_api_key_here')
+
+# List all invoices
+invoices = client.invoices.list
+puts invoices['invoices']
+
+# Create a client
+new_client = client.clients.create(
+  name: 'John Doe',
+  email: 'john@example.com',
+  company: 'Acme Inc',
+  address: '123 Main St, Johannesburg'
+)
+```
+
+## Support
+
+- Documentation: https://invoiceai.co.za/api-docs
+- Email: support@invoiceai.co.za

data/lib/invoiceai/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  class Client
+    attr_reader :invoices, :clients, :products, :quotes, :profile, :stats
+
+    def initialize(api_key: nil, jwt_token: nil, base_url: nil, timeout: nil)
+      @api_key = api_key
+      @jwt_token = jwt_token
+      @base_url = base_url || "https://invoiceai.co.za/api/v1"
+      @timeout = timeout || 30
+
+      @invoices = Resources::Invoices.new(self)
+      @clients = Resources::Clients.new(self)
+      @products = Resources::Products.new(self)
+      @quotes = Resources::Quotes.new(self)
+      @profile = Resources::Profile.new(self)
+      @stats = Resources::Stats.new(self)
+    end
+
+    def request(method:, path:, body: nil, params: nil)
+      response = connection.send(method) do |req|
+        req.url path
+        req.params = params if params
+        req.body = body.to_json if body
+      end
+
+      handle_response(response)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: @base_url) do |conn|
+        conn.headers["Content-Type"] = "application/json"
+        conn.headers["Accept"] = "application/json"
+        
+        if @api_key
+          conn.headers["X-API-Key"] = @api_key
+        elsif @jwt_token
+          conn.headers["Authorization"] = "Bearer #{@jwt_token}"
+        end
+
+        conn.options.timeout = @timeout
+        conn.request :retry, max: 2, interval: 0.5
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def handle_response(response)
+      body = response.body.empty? ? {} : JSON.parse(response.body)
+
+      case response.status
+      when 200..299
+        body
+      when 401
+        raise AuthenticationError.new("Authentication failed", status: response.status, body: body)
+      when 404
+        raise NotFoundError.new("Resource not found", status: response.status, body: body)
+      when 422
+        raise ValidationError.new(body["message"] || "Validation failed", status: response.status, body: body)
+      when 429
+        raise RateLimitError.new("Rate limit exceeded", status: response.status, body: body)
+      when 500..599
+        raise ServerError.new("Server error", status: response.status, body: body)
+      else
+        raise Error.new("Request failed", status: response.status, body: body)
+      end
+    end
+  end
+end

data/lib/invoiceai/error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  class Error < StandardError
+    attr_reader :status, :body
+
+    def initialize(message = nil, status: nil, body: nil)
+      @status = status
+      @body = body
+      super(message)
+    end
+  end
+
+  class AuthenticationError < Error; end
+  class NotFoundError < Error; end
+  class ValidationError < Error; end
+  class RateLimitError < Error; end
+  class ServerError < Error; end
+end

data/lib/invoiceai/resources/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Base
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def get(path, params: nil)
+        @client.request(method: :get, path: path, params: params)
+      end
+
+      def post(path, body: nil)
+        @client.request(method: :post, path: path, body: body)
+      end
+
+      def put(path, body: nil)
+        @client.request(method: :put, path: path, body: body)
+      end
+
+      def delete(path)
+        @client.request(method: :delete, path: path)
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/clients.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Clients < Base
+      def list(page: 1, limit: 20)
+        get("/clients", params: { page: page, limit: limit })
+      end
+
+      def get(id)
+        super("/clients/#{id}")
+      end
+
+      def create(data)
+        post("/clients", body: data)
+      end
+
+      def update(id, data)
+        put("/clients/#{id}", body: data)
+      end
+
+      def delete(id)
+        super("/clients/#{id}")
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/invoices.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Invoices < Base
+      def list(page: 1, limit: 20, status: nil)
+        params = { page: page, limit: limit }
+        params[:status] = status if status
+        get("/invoices", params: params)
+      end
+
+      def get(id)
+        super("/invoices/#{id}")
+      end
+
+      def create(data)
+        post("/invoices", body: data)
+      end
+
+      def update(id, data)
+        put("/invoices/#{id}", body: data)
+      end
+
+      def delete(id)
+        super("/invoices/#{id}")
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/products.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Products < Base
+      def list(page: 1, limit: 20)
+        get("/products", params: { page: page, limit: limit })
+      end
+
+      def get(id)
+        super("/products/#{id}")
+      end
+
+      def create(data)
+        post("/products", body: data)
+      end
+
+      def update(id, data)
+        put("/products/#{id}", body: data)
+      end
+
+      def delete(id)
+        super("/products/#{id}")
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/profile.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Profile < Base
+      def get
+        super("/profile")
+      end
+
+      def update(data)
+        put("/profile", body: data)
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/quotes.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Quotes < Base
+      def list(page: 1, limit: 20, status: nil)
+        params = { page: page, limit: limit }
+        params[:status] = status if status
+        get("/quotes", params: params)
+      end
+
+      def get(id)
+        super("/quotes/#{id}")
+      end
+
+      def create(data)
+        post("/quotes", body: data)
+      end
+
+      def update(id, data)
+        put("/quotes/#{id}", body: data)
+      end
+
+      def delete(id)
+        super("/quotes/#{id}")
+      end
+    end
+  end
+end

data/lib/invoiceai/resources/stats.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module InvoiceAI
+  module Resources
+    class Stats < Base
+      def get
+        super("/stats")
+      end
+    end
+  end
+end

data/lib/invoiceai/version.rb

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

data/lib/invoiceai.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+require_relative "invoiceai/version"
+require_relative "invoiceai/error"
+require_relative "invoiceai/client"
+require_relative "invoiceai/resources/base"
+require_relative "invoiceai/resources/invoices"
+require_relative "invoiceai/resources/clients"
+require_relative "invoiceai/resources/products"
+require_relative "invoiceai/resources/quotes"
+require_relative "invoiceai/resources/profile"
+require_relative "invoiceai/resources/stats"
+
+module InvoiceAI
+  class << self
+    attr_accessor :api_key, :jwt_token, :base_url, :timeout
+
+    def configure
+      self.base_url ||= "https://invoiceai.co.za/api/v1"
+      self.timeout ||= 30
+      yield self if block_given?
+    end
+
+    def client
+      @client ||= Client.new(
+        api_key: api_key,
+        jwt_token: jwt_token,
+        base_url: base_url,
+        timeout: timeout
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: invoiceai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- InvoiceAI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: A Ruby client library for the InvoiceAI API. Create and manage invoices,
+  clients, products, and quotes programmatically.
+email:
+- support@invoiceai.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/invoiceai.rb
+- lib/invoiceai/client.rb
+- lib/invoiceai/error.rb
+- lib/invoiceai/resources/base.rb
+- lib/invoiceai/resources/clients.rb
+- lib/invoiceai/resources/invoices.rb
+- lib/invoiceai/resources/products.rb
+- lib/invoiceai/resources/profile.rb
+- lib/invoiceai/resources/quotes.rb
+- lib/invoiceai/resources/stats.rb
+- lib/invoiceai/version.rb
+homepage: https://invoiceai.co.za/api-docs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://invoiceai.co.za/api-docs
+  source_code_uri: https://invoiceai.co.za/api-docs
+  changelog_uri: https://invoiceai.co.za/api-docs
+  documentation_uri: https://invoiceai.co.za/api-docs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Official Ruby SDK for the InvoiceAI API
+test_files: []