Vufer logo

Vufer Build Status

A Ruby Gem to Interact with Vuforia Web Service API.

Installation

Add this line to your application's Gemfile:

gem 'vufer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vufer

Usage

Configure your access and secret keys from Vuforia.

Vufer.configure do |config|
  config.access_key = 'MY_ACCESS_KEY'
  config.secret_key = 'MY_SECRET_KEY'
end

If you have VWS_ACCESS_KEY and VWS_SECRET_KEY set in your environment, Vufer will try to get these keys from the environment.

Use the docs to see on how to manage targets, view database and target summary.

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/rands0n/vufer. 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.

Code of Conduct

Everyone interacting in the Vufer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.