booqable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c084014d612e3e317590f31144911c3a3907a85075a17b3172edd2f6eb8c7d9f
+  data.tar.gz: 23836e46596f37b74175cd45f4e6ee04ee17eb7b0254bb53395972bc801a55aa
+SHA512:
+  metadata.gz: 0a2eb78b9a78a239bec1fda211b177533102e78e4cdd95470692cb5a21132180827d2339caadf723564de9d8091d15c4e6160489f5a4694dfe40fc8bd4a630c2
+  data.tar.gz: 7210d24c6985facb00617c0949abe55c0b9034acb53b3120039c7d78e1da3ecd763875ff54c69672e39701049a3ab46f46024c1c6511251840891163a19518c0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.4
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+inherit_gem: { rubocop-37signals: rubocop-ruby.yml }

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-27
+
+- 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
+[INSERT CONTACT METHOD].
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Booqable
+
+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,403 @@
+# Booqable.rb
+
+Ruby toolkit for the [Booqable API](https://developers.booqable.com/).
+
+[Booqable](https://booqable.com) is a rental management platform that helps businesses manage their rental inventory, customers, and orders. This gem provides a Ruby interface to interact with all Booqable API endpoints.
+
+## Table of Contents
+- [Installation](#installation)
+- [Making requests](#making-requests)
+- [Authentication](#authentication)
+- [Configuration](#configuration)
+- [Pagination](#pagination)
+- [Rate limiting](#rate-limiting)
+- [Resources](#resources)
+- [Advanced usage](#advanced-usage)
+- [Development](#development)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'booqable'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install booqable
+```
+
+## Making requests
+
+API methods are available as module methods (consuming module-level configuration) or as client instance methods.
+
+```ruby
+# Provide authentication credentials
+Booqable.configure do |c|
+  c.api_key = 'your_api_key_here'
+  c.company_id = 'your_company_id'
+end
+
+# Fetch orders
+orders = Booqable.orders.list
+```
+
+or
+
+```ruby
+# Create a client instance
+client = Booqable::Client.new(
+  api_key: 'your_api_key_here',
+  company_id: 'your_company_id'
+)
+
+# Fetch orders
+orders = client.orders.list
+```
+
+## Authentication
+
+Booqable supports several authentication methods to suit different use cases:
+
+### API Key Authentication (Recommended)
+
+The simplest way to authenticate is with an API key:
+
+```ruby
+Booqable.configure do |c|
+  c.api_key = 'your_api_key_here'
+  c.company_id = 'your_company_id'
+end
+```
+
+Generate your API key from your Booqable account settings. [Learn more about API keys](https://developers.booqable.com/#authentication-access-token).
+
+### OAuth2 Authentication
+
+For applications that need to act on behalf of multiple users:
+
+```ruby
+client = Booqable::Client.new(
+  client_id: 'your_oauth_client_id',
+  client_secret: 'your_oauth_client_secret',
+  company_id: 'your_company_id',
+  read_token: -> { 
+    # Return stored token hash
+    JSON.parse(File.read('token.json'))
+  },
+  write_token: ->(token) { 
+    # Store token hash
+    File.write('token.json', token.to_json)
+  }
+)
+
+# Complete OAuth flow
+client.authenticate_with_code(params[:code])
+```
+
+### Single-Use Token Authentication
+
+For server-to-server communication requiring enhanced security:
+
+```ruby
+client = Booqable::Client.new(
+  single_use_token: 'your_token_id',
+  single_use_token_algorithm: 'HS256',
+  single_use_token_secret: 'your_signing_secret',
+  single_use_token_company_id: 'company_uuid',
+  single_use_token_user_id: 'user_uuid',
+  company_id: 'your_company_id'
+)
+```
+
+Supports HS256 (HMAC), RS256 (RSA), and ES256 (ECDSA) algorithms. [Learn more about request signing](https://developers.booqable.com/#authentication-request-signing).
+
+### Environment Variables
+
+All authentication options can be configured via environment variables:
+
+```bash
+export BOOQABLE_API_KEY="your_api_key_here"
+export BOOQABLE_COMPANY="your_company_id"
+export BOOQABLE_CLIENT_ID="your_oauth_client_id"
+export BOOQABLE_CLIENT_SECRET="your_oauth_client_secret"
+```
+
+## Configuration
+
+Booqable is highly configurable to suit different environments and use cases:
+
+```ruby
+Booqable.configure do |c|
+  c.api_key = 'your_api_key_here'
+  c.company_id = 'your_company_id'
+  c.api_domain = 'booqable.com'        # Default
+  c.api_version = 4                    # Default
+  c.per_page = 25                      # Default pagination size
+  c.auto_paginate = true               # Auto-fetch all pages
+end
+```
+
+### Per-client configuration
+
+```ruby
+client = Booqable::Client.new(
+  api_key: 'your_api_key_here',
+  company_id: 'your_company_id',
+  per_page: 50,
+  auto_paginate: false
+)
+```
+
+## Pagination
+
+The Booqable API uses cursor-based pagination. Booqable provides several ways to handle paginated responses:
+
+### Manual pagination
+
+```ruby
+# Fetch first page
+orders = Booqable.orders.list(page: { size: 25, number: 1 })
+
+# Fetch next page
+next_orders = Booqable.orders.list(page: { size: 25, number: 2 })
+```
+
+### Auto-pagination
+
+```ruby
+# Configure auto-pagination
+Booqable.auto_paginate = true
+
+# This will automatically fetch ALL orders across all pages
+all_orders = Booqable.orders.list
+```
+
+## Rate limiting
+
+Booqable automatically handles rate limiting and provides access to rate limit information:
+
+```ruby
+orders = Booqable.orders.list
+
+# Check rate limit status
+rate_limit = Booqable.rate_limit
+puts "Remaining requests: #{rate_limit.remaining}"
+puts "Reset time: #{rate_limit.reset_at}"
+puts "Limit: #{rate_limit.limit}"
+```
+
+### Automatic retries
+
+Booqable includes automatic retry logic so every request will be retried two times
+by default if it fails due to a server error.
+
+To disable automatic retries, you can configure it globally:
+
+```ruby
+Booqable.configure do |c|
+  c.no_retries = true # Disable automatic retries
+end
+```
+
+## Resources
+
+Booqable provides access to all Booqable API resources through a consistent interface:
+
+### Orders
+
+```ruby
+# List orders with filtering and includes
+orders = Booqable.orders.list(
+  include: 'customer,items',
+  filter: { status: 'reserved' },
+  sort: '-created_at'
+)
+
+# Find specific order
+order = Booqable.orders.find('order_id', include: 'customer,items')
+order.items.count
+order.customer.name
+
+# Create order
+new_order = Booqable.orders.create(
+  starts_at: '2024-01-01T00:00:00Z',
+  stops_at: '2024-01-02T00:00:00Z',
+  status: 'draft'
+)
+new_order.status  # => 'draft'
+
+# Update order
+updated_order = Booqable.orders.update('order_id', status: 'reserved')
+updated_order.status  # => 'reserved'
+
+# Delete order
+deleted_order = Booqable.orders.delete('order_id')
+deleted_order.id  # => 'order_id'
+```
+
+### Customers
+
+```ruby
+# List customers
+customers = Booqable.customers.list(
+  filter: { name: 'John' },
+  sort: 'created_at'
+)
+
+# Create customer
+customer = Booqable.customers.create(
+  name: 'John Doe',
+  email: 'john@example.com'
+)
+
+# Update customer
+Booqable.customers.update('customer_id', name: 'Jane Doe')
+
+# Delete customer
+deleted_customer = Booqable.customers.delete('customer_id')
+deleted_customer.id  # => 'customer_id'
+```
+
+### Products
+
+```ruby
+# List products with inventory information
+products = Booqable.products.list(
+  include: 'inventory_levels',
+  filter: { type: 'trackable' }
+)
+
+# Find product
+product = Booqable.products.find('product_id', include: 'properties')
+
+# Create product
+product = Booqable.products.create(
+  name: 'Camera',
+  type: 'trackable',
+  base_price_in_cents: 50000
+)
+
+# Delete product
+deleted_product = Booqable.products.delete('product_id')
+deleted_product.id  # => 'product_id'
+```
+
+### Available resources
+
+Booqable provides access to all Booqable API resources:
+
+**Core Resources:**
+- `orders`, `customers`, `products`, `items`
+- `employees`, `companies`, `locations`
+- `payments`, `invoices`, `documents`
+
+**Inventory Management:**
+- `inventory_levels`, `stock_items`, `stock_adjustments`
+- `transfers`, `plannings`, `clusters`
+
+**Configuration:**
+- `settings`, `properties`, `tax_rates`
+- `payment_methods`, `email_templates`
+
+**And many more...** See the [full resource list](lib/booqable/resources.json) for all available endpoints.
+
+## Advanced usage
+
+### Custom middleware
+
+Booqable uses Faraday for HTTP requests. You can customize the middleware stack:
+
+```ruby
+Booqable.configure do |c|
+  c.middleware = Faraday::RackBuilder.new do |builder|
+    builder.use MyCustomMiddleware
+    builder.use Booqable::Middleware::RaiseError
+    builder.adapter Faraday.default_adapter
+  end
+end
+```
+
+### Connection options
+
+```ruby
+Booqable.configure do |c|
+  c.connection_options = {
+    headers: { 'X-Custom-Header' => 'value' },
+    ssl: { verify: false },
+    timeout: 30
+  }
+end
+```
+
+### Proxy support
+
+```ruby
+Booqable.configure do |c|
+  c.proxy = 'http://proxy.example.com:8080'
+end
+```
+
+### Custom serialization
+
+```ruby
+# Access raw response data
+response = Booqable.orders.list
+puts response.class  # => Sawyer::Resource
+
+# Get response metadata
+puts Booqable.last_response.status
+puts Booqable.last_response.headers
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Running tests
+
+```bash
+# Run all tests
+bundle exec rake spec
+
+# Run specific test file
+bundle exec rspec spec/booqable/client_spec.rb
+```
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/booqable/booqable.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/booqable/booqable.rb/blob/master/CODE_OF_CONDUCT.md).
+
+## Versioning
+
+This library aims to support and is [tested against](https://github.com/booqable/booqable.rb/actions) the following Ruby versions:
+
+- Ruby 3.2
+- Ruby 3.3
+- Ruby 3.4
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions, however support will only be provided for the versions listed above.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Booqable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/booqable/booqable.rb/blob/master/CODE_OF_CONDUCT.md).
+
+---
+
+**Questions?** Check out the [Booqable API documentation](https://developers.booqable.com/) or [open an issue](https://github.com/booqable/booqable.rb/issues/new).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]