Base

Gem Version

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:

# Sending an email
email =
  client.emails.send(
    from: "[email protected]",
    to: "[email protected]",
    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:

# Create a user with email / password
user =
  client.users.create(
    email: "[email protected]",
    confirmation: "12345",
    password: "12345")

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

# 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: "[email protected]",
    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: "[email protected]")

# 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:

# Create a file
file =
  client.files.create(file: File.open("/path/to/file"))

# 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:

# Create an image
image =
  client.images.create(image: File.open("/path/to/image"))

# 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)

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