Base

Ruby client for the Base API service, with it you can manage authentication, email sending, files and images of your application.

Installation

Using RubyGems

Just run this command: gem install base-api-io

Using Bundler

1. Add the dependency to your Gemfile:

   gem 'base-api-io', '~> 1.0.0'

1. Run bundle install

Usage

1. Sign up on www.base-api.io and create an application and copy its access token.

2. Require the shard:

   require 'base'

1. Create a client:

   client =
     Base::Client.new(access_token: 'your_access_token')

Sending email

Using the emails endpoint on the client you can send emails:

# List emails
emails = client.emails.list(page: 1, per_page: 10)
emails.items     # The array of emails
emails.metadata  # The metadata object containing the total count

# Sending an email
email =
  client.emails.send(
    from: 'from@example.com',
    to: 'to@example.com',
    subject: 'Test Email',
    html: '<b>Html message</b>',
    text: 'Text message')

Users

Using the users endpoint on the client you can create / get or delete users:

# List users
users = client.users.list(page: 1, per_page: 10)
users.items     # The array of users
users.metadata  # The metadata object containing the total count

# Create a user with email / password
user =
  client.users.create(
    email: 'test@user.com',
    confirmation: '12345',
    password: '12345',
    custom_data: {
      age: 32
    })

# Get a users details by the id
user =
  client.users.get('user_id')

# Update a users email or custom_data
user =
  client.users.update(
    id: 'user_id',
    email: 'test@user.com',
    custom_data: {
      age: 32
    })

# Delete a user by id
user =
  client.users.delete('user_id')

Sessions

Using the sessions endpoint on the client you can authenticate a user.

# Create a user with email / password
user =
  client.sessions.authenticate(
    email: 'test@user.com',
    password: '12345')

Forgot Password Flow

Using the passwords endpoint on the client you can perform a forgot password flow.

# Create an forgot password token for the user with the given email address.
token =
  client.passwords.forgot_password(email: 'test@user.com')

# Using that token set a new password.
user =
  client.passwords.set_password(
    forgot_password_token: token.forgot_password_token,
    confirmation: '123456',
    password: '123456')

Files

Using the files endpoint on the client you can create / get / delete or download files:

# List files
files = client.files.list(page: 1, per_page: 10)
files.items     # The array of files
files.metadata  # The metadata object containing the total count

# Create a file
file =
  client.files.create(
    path: '/path/to/file',
    filename: 'text.txt',
    type: 'text/plain')

# Get a file by id
file =
  client.files.get('file_id')

# Delete a file by id
file =
  client.files.delete('file_id')

# Get a download URL to the file by id
url =
  client.files.download_url('file_id')

# Download the file by id into an IO
io =
  client.files.download('file_id')

Images

Using the images endpoint on the client you can create / get / delete or process images:

# List images
images = client.images.list(page: 1, per_page: 10)
images.items     # The array of images
images.metadata  # The metadata object containing the total count

# Create an image
image =
  client.images.create(
    path: '/path/to/image',
    filename: 'image.png',
    type: 'image/png')

# Get a image by id
image =
  client.images.get('image_id')

# Delete a image by id
image =
  client.images.delete('image_id')

# Get a link to a prcessed version (crop & resize) of the image by id
url =
  client.images.image_url(i.id,
    crop: Base::Crop.new(width: 100, height: 100, top: 0, left: 0),
    resize: Base::Resize.new(width: 100, height: 100),
    format: 'jpg',
    quality: 10)

Mailing Lists

A project can have many mailing lists which can be managed from the interface.

The mailingLists endpoint allows you to programatically subscribe / unsubscribe emails to a mailing list and send emails to all subscribes using a single call.

# List mailing lists
lists = client.mailing_lists.list(page: 1, per_page: 10)
lists.items     # The array of mailing lists
lists.metadata  # The metadata object containing the total count

# Get a mailing list by id
list =
  client.mailing_lists.get('list_id')

# Subscribe an email to a mailing list.
list =
  client.mailing_lists.subscribe(id: 'mailing_list_id', email: 'test@user.com')

# Unsubscribe an email from a mailing list.
list =
  client.mailing_lists.unsubscribe(id: 'mailing_list_id', email: 'test@user.com')

# Get a public unsubscribe url for the given mailing list and email which
# when click unsubscribes a user from the mailing list and redirects to the
# unsubscribe_redirect_url of the list.
url =
  client.mailing_lists.unsubscribe_url(id: 'mailing_list_id', email: 'test@user.com')

# Send the same email to all of the subscribers
results =
  client.mailing_lists.send(
    from: 'from@example.com',
    id: 'mailing_list_id',
    subject: 'subject',
    html: 'HTML',
    text: 'Text')

Forms

A project can have many forms and those form can have many submissions.

The forms endpoint allows you to programatically create, submit and manage forms.

# List forms
forms = client.forms.list(page: 1, per_page: 10)
forms.items     # The array of forms
forms.metadata  # The metadata object containing the total count

# Create a form
form =
  client.forms.create(name: 'Form')

# Get a form
form =
  client.forms.get('form_id')

# Delete a form (and it's submissions)
form =
  client.forms.delete('form_id')

# Submit a form
submission =
  client.forms.submit(
    id: 'form_id',
    form: {
      file: File.open('description.txt'),
      key: 'value'
    })

# List form submissions
submissions = client.forms.submissions(id: 'form_id', page: 1, per_page: 10)
submissions.items     # The array of forms submissions
submissions.metadata  # The metadata object containing the total count

# Get a submission
submission =
  client.forms.get_submission('form_id', 'submission_id')

# Update a submission
submission =
  client.forms.update_submission(
    submission_id: 'submission_id',
    id: 'form_id',
    form: {
      file: File.open('description.txt'),
      key: 'value'
    })

# Delete a submission
submission =
  client.forms.delete_submission('form_id', 'submission_id')

Development

This library uses Faraday, you can run the specs locally with rspec.

Contributing

1. Fork it (https://github.com/base-api-io/base-cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Gusztav Szikszai - creator and maintainer