Skip to content

Latest commit

 

History

History

ruby

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
public
public
 
 
views
views
 
 
.env.example
.env.example
 
 
.gitignore
.gitignore
 
 
Gemfile
Gemfile
 
 
README.md
README.md
 
 
oauth-flow.rb
oauth-flow.rb
 
 

README.md

Connect OAuth Flow Example (Ruby)

This example demonstrates a bare-bones Ruby implementation of the Square Connect OAuth flow. The application links merchants to the OAuth Permissions form and handles the result of the authorization, which is sent to the application's Redirect URL.

For more information, see OAuth Overview, along with the comments included in oauth-flow.rb.

Setup

Install Square SDK and Sinatra

First, edit the Gemfile to insert your desired Ruby SDK version. Latest version can be found here

This application requires gems for the Sinatra web framework and Square Connect. Install them with bundle install

Get your credentials and set the redirect URL:

  1. Open the Developer Dashboard.

  2. Choose Open on the card for an application.

  3. At the top of the page, set the dashboard mode to the environment that you want to work with by choosing Sandbox or Production.

  4. Choose OAuth in the left navigation pane. The OAuth page is shown.

  5. In the Redirect URL box, enter the URL for the callback you will implement to complete the OAuth flow: http://localhost:4567/callback

    You can use HTTP for localhost but an actual web server implementation must use HTTPS.

  6. In the Application ID box, copy the application ID.

  7. In the Application Secret box, choose Show, and then copy the application secret.

  8. Click Save.

  9. In your project directory, create a copy of the .env.example file and name it .env

  10. In the newly created .env file, replace the your-environment with either sandbox or production

  11. Replace the your-application-id and your-application-secret placeholders with the Sandbox or Production application ID and application secret, respectively.

    Note that OAuth Sandbox credentials begin with a sandbox prefix and that the base URL for calling Sandbox endpoints is https://connect.squareupsandbox.com. When you implement for production, you need production credentials and use https://connect.squareup.com as the base URL.

    WARNING: Never check your credentials/access_token into your version control system. We've added .env to the .gitignore file to help prevent uploading confidential information.

Running the example

To run the example, execute the following from the command line:

ruby oauth-flow.rb

You can then proceed through the OAuth flow by going to http://localhost:4567 in your web browser.

Feedback

Rate this sample app here!