Home Original page

GitHub - square/square-ruby-sdk: Ruby client library for the Square API

fern shield Gem version

The Square Ruby library provides convenient access to the Square API from Ruby.

Requirements

Use of the Square Ruby SDK requires:

  • Ruby 3.2+

Installation

The Square Ruby SDK version is managed through the gem version. To use a specific version:

Or in your Gemfile:

gem 'square.rb', '~> 44.0.0'

Usage

For more information, see Using the Square Ruby SDK.

require "square"

square = Square::Client.new(
  token: 'YOUR_API_KEY'
)

image_file = Square::FileParam.from_filepath(
  filepath: fixture_path("small.png"),
  content_type: "image/png"
)

response = square.invoices.create_invoice_attachment(
  invoice_id: "inv:0-ChA4-3sU9GPd-uOC3HgvFjMWEL4N",
  request: {
    idempotency_key: SecureRandom.uuid,
    description: "A test invoice attachment"
  },
  image_file: image_file
)

Legacy SDK

While the new SDK has a lot of improvements, we at Square understand that it takes time to upgrade when there are breaking changes. To make the migration easier, the new SDK also exports the legacy SDK as square_legacy. Here's an example of how you can use the legacy SDK alongside the new SDK inside a single file:

# Load both SDKs
require 'square'
require 'square_legacy'

# Initialize new SDK client
new_client = Square::Client.new(
  access_token: 'YOUR_SQUARE_ACCESS_TOKEN'
)

# Initialize legacy SDK client
legacy_client = SquareLegacy::Client.new(
  bearer_auth_credentials: {
    access_token: 'YOUR_SQUARE_ACCESS_TOKEN'
  }
)

# Use new SDK for newer features
locations = new_client.locations.get_locations.data.locations

# Use legacy SDK for specific legacy functionality
legacy_payment = legacy_client.payments_api.create_payment(
  body: {
    source_id: 'example_1234567890',
    idempotency_key: SecureRandom.uuid,
    amount_money: {
      amount: 100,
      currency: 'USD'
    }
  }
)

We recommend migrating to the new SDK using the following steps:

  1. Update your square.rb: gem update square.rb
  2. Search and replace all requires from 'square' to 'square_legacy'
  3. Update all client initializations from
client = Square::Client.new(access_token: 'token')

to

client = SquareLegacy::Client.new(
  bearer_auth_credentials: { access_token: 'token' }
)
  1. Gradually migrate over to the new SDK by importing it from the 'square' import.

Environments

This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.

Environments

require "square"

client = Square::Client.new(
    base_url: Square::Environment::PRODUCTION
)

Custom URL

require "square"

client = Square::Client.new(
    base_url: "https://custom-staging.com"
)

Request And Response Types

The SDK exports all request and response types as Ruby classes. Simply require them with the following namespace:

require 'square'

# Create a request object
request = Square::CreateMobileAuthorizationCodeRequest.new(
  location_id: 'YOUR_LOCATION_ID'
)

Errors

Failed API calls will raise errors that can be rescued from granularly.

require "square"

client = Square::Client.new(
  base_url: Square::Environment::PRODUCTION
)

begin
    result = client.payments.create
rescue Square::Errors::TimeoutError
    puts "API didn't respond before our timeout elapsed"
rescue Square::Errors::ServiceUnavailableError
    puts "API returned status 503, is probably overloaded, try again later"
rescue Square::Errors::ServerError
    puts "API returned some other 5xx status, this is probably a bug"
rescue Square::Errors::ResponseError => e
    puts "API returned an unexpected status other than 5xx: #{e.code} {e.message}"
rescue Square::Errors::ApiError => e
    puts "Some other error occurred when calling the API: {e.message}"
end

Pagination

List endpoints are paginated. The SDK provides methods to handle pagination:

require 'square'

client = Square::Client.new(access_token: "YOUR_TOKEN")

# Get all items using pagination
response = client.bank_accounts.list
all_bank_accounts = []

while response.data.bank_accounts.any?
  all_bank_accounts.concat(response.data.bank_accounts)
  
  # Check if there are more pages
  if response.cursor
    response = client.bank_accounts.list(cursor: response.cursor)
  else
    break
  end
end

puts "Total bank accounts: #{all_bank_accounts.length}"

Advanced

Additional Headers

If you would like to send additional headers as part of the request, use the headers request option.

response = client.payments.create(..., {
  headers: {
    'X-Custom-Header' => 'custom value'
  }
})

Receive Extra Properties

Every response includes any extra properties in the JSON response that were not specified in the type. This can be useful for API features not present in the SDK yet.

You can receive and interact with the extra properties by accessing the raw response data:

response = client.locations.create(...)

# Access the raw response data
location_data = response.data.to_h

# Then access the extra property by its name
undocumented_property = location_data['undocumentedProperty']

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

response = client.payments.create(..., {
  max_retries: 0 # override max_retries at the request level
})

Timeouts

The SDK defaults to a 60 second timeout. Use the timeout_in_seconds option to configure this behavior.

response = client.payments.create(..., {
  timeout_in_seconds: 30 # override timeout to 30s
})

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!