RubyBranch

Ruby client for https://branch.io API

Installation

Add this line to your application's Gemfile:

gem 'ruby_branch'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby_branch

Usage

Configuration:

RubyBranch.configure do |config|
  config.api_key = 'YOUR_API_KEY'
  config.secret_key = 'YOUR_SECRET_KEY'
  config.branch_domain = 'YOUR_BRANCH_DOMAIN'
  # for fallback in case link creation has been failed
  config.link_to_homepage = 'https://yourdomain.com' # optional
end

Methods:

Links

link = RubyBranch::API::Resources::Link.new

# Create link without api forcing
link.create_safely(analytics: {}, data: {}, settings: {})

# Create link through branch api
link.create(analytics: {}, data: {}, settings: {})

# Update existing link without api forcing
link.update_safely(url: url, analytics: {}, data: {}, settings: {})

# Update existing link through branch api
link.update(url: url, analytics: {}, data: {}, settings: {})

# Delete link
link.delete(url: url)

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.