bunny-ruby
Ruby SDK for Bunny
Installation
Run bundle add bunny_app or add this line to your application's Gemfile:
gem 'bunny_app'And then execute:
$ bundleOr install it yourself as:
$ gem install bunny_appGetting Started
You can use this gem to send customized graphql queries to Bunny or use the built in convience methods.
First configure the Bunny client.
require 'bunny_app'
# We recommend using the client_id/secret of your Bunny client app
# this will enable automatic retries when the access token expires
BunnyApp.config do |c|
c.client_id = 'xxx'
c.client_secret = 'xxx'
c.scope = 'standard:read standard:write'
c.base_uri = 'https://<subdomain>.bunny.com'
end
# Alternately you can generate the access token outside of this sdk
# be aware that if your access_token expires an exception will be raised
BunnyApp.config do |c|
c.access_token = 'xxx'
c.base_uri = 'https://<subdomain>.bunny.com'
endRemember! Don't commit secrets to source control!
Generate rails config
Create a config file at config/initializers/bunny_app.rb
> bin/rails g bunny_app:installCreate a subscription
response = BunnyApp::Subscription.create(
price_list_code: 'starter',
options: {
account_name: "Superdesk",
first_name: "Meg",
last_name: "La Don",
email: "meg@example.com",
trial: true,
tenant_code: "123456",
tenant_name: "Superdesk"
}
)Get a portal session token for use with Bunny.js
response = BunnyApp::PortalSession.create(
tenant_code: "123456"
)Track feature usage
If you have usage based billing or just want to track feature usage then use this method.
# Usage is tracked as if it just happened
response = BunnyApp::FeatureUsage.create(
quantity: 5, feature_code: 'products', tenant_code: '2')
# Usage is tracked using the date supplied
response = BunnyApp::FeatureUsage.create(
quantity: 5, feature_code: 'products', tenant_code: '2', usage_at: '2022-03-10')Custom queries & mutations
Alternately you can build and send your own custom graphql queries or mutations
query = <<-'GRAPHQL'
mutation featureUsageCreate ($attributes: FeatureUsageAttributes!) {
featureUsageCreate (attributes: $attributes) {
errors
featureUsage {
id
quantity
usageAt
tenant {
id
code
name
}
feature {
id
code
name
}
}
}
}
GRAPHQL
variables = {
attributes: {
quantity: 1,
usageAt: "2022-03-10",
tenantCode: "123456",
featureCode: "users"
}
}
response = BunnyApp.query(query, variables)Verify webhook signature
Bunny can send webhooks for key actions like a subscription change. When you get a webhook from Bunny you should verify the signature that is supplied in the x-bunny-signature header matches the payload.
payload = '{"type":"SubscriptionProvisioningChange","payload":{"subscription":{"id":27,"state":"trial","trial_start_date":"2022-06-04","trial_end_date":"2022-06-18","start_date":null,"end_date":null,"auto_renew":false,"account":{"id":33,"name":"Ondricka, Flatley and Kessler"},"tenant":null,"product":{"code":"stealth","name":"Stealth","description":null,"sku":null},"features":[{"code":"users","quantity":1},{"code":"crm","quantity":null}]}}}'
BunnyApp::Webhook.verify("8bd5aa9c6a96fbce9fc3065af6e9871ac19a1d0a", payload, "secret-key")Requirements
This gem requires Ruby 2.5+
Development
Run bundle install to install dependencies.
Run bundle exec rake spec to run the tests.
You can also run bin/console for an interactive prompt that will allow you to experiment.
Set IGNORE_SSL when running locally to ignore ssl warnings.
> IGNORE_SSL=true bin/consolePublish to Ruby gems
Update version.rb with a new version number then build the gem
gem buildThen publish using the new build number
gem push bunny_app-x.x.x.gemThe rubygems account for publishing is protected by MFA and currently managed by @richet