BarkboxClient

A Ruby API client for Barkbox.

Installation

Add this line to your application's Gemfile:

gem 'barkbox_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install barkbox_client

Usage

BarkboxClient requires several configuration variables to be set before usage. These variables can be set through the environment, or through the .configure method. Values set with .configure take precedence over values set through the environment.

require 'barkbox_client'

BarkboxClient.configure do |config|
	# Any object that implements the Ruby logger interface. Defaults to Logger.new(STDOUT)
	config.logger = Rails.logger
	# The application id to be used for requests to Barkbox. Defaults to ENV['BARKBOX_APP_ID']
	config.app_id = '12345'
	# The secret key to be used for requests to Barkbox. Defaults to ENV['BARKBOX_SECRET']
	config.barkbox_secret = 'XXXXXXXXXXX'
	# The URL to use for authorization with Barkbox. Defaults to ENV['BARKBOX_AUTH_URL']
	config.barkbox_auth_url = 'https://some.url'
	# The oAuth token for the application user. Defaults to ENV['BARKBOX_OAUTH_TOKEN']
	config.barkbox_oauth_token = 'SOMEREALLYLONGSTRING'
	# The class used to record oauth tokens.
	config.auth_class = Auth
end

Create a class for storing oauth tokens. It requires columns access_token, access_token_expires_at, refresh_token and barkbox_user_id. Note that a BarkBox user may have more than one valid oauth token so it is best to keep a 1:many relationship between users and authentications. An example migration:

class CreateAuth < ActiveRecord::Migration
  def change
    create_table :auths do |t|
      t.integer   :barkbox_user_id, null: false
      t.string    :access_token, null: false
      t.timestamp :access_token_expires_at
      t.string    :refresh_token
      t.timestamps null: false
    end
    add_index :auths, :barkbox_user_id
    add_index :auths, :access_token, unique: true
  end
end

Include BarkboxClient::AuthConcern in your auth model. If you want to customize the data saved about a user after authenticating, override update_from_barkbox_user_data in your model.

class Auth < ApplicationRecord
  include BarkboxClient::AuthConcern
end

Include BarkboxClient::AuthHelper in your controllers for helper methods to require authentication or login.

class ApplicationController < ActionController::Base
  include BarkboxClient::AuthHelper
end

class TestController < ApplicationController
  include BarkboxClient::AuthHelper

  before_action :login!, only: [:login]
  before_action :authenticate!, only: [:authenticated]

  def login
    head :ok
  end

  def authenticated
    head :ok
  end
end

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 gem_push=no bundle exec rake release, which will create a git tag for the version, push git commits and tags, and SKIP pushing the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/barkbox/barkbox_client.