Skip to content
Ruby Gem for communicating with the Duo Api
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
gemfiles
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Duo-License
Gemfile
LICENSE.txt
README.md
Rakefile
duo-api.gemspec

README.md

DuoApi Build Status

A thin, zero depedency library for connecting to the Duo API.

Installation

Add this line to your application's Gemfile:

gem 'duo-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install duo-api

If you're for some reason using REE or 1.8.7, you must also install the json Gem.

Configuration

During app initialization:

require 'duo-api'
DuoApi.config do |config|
  # Found on Duo Admin panel for the application you've set up
  config.hostname = "api-xxxxx.duosecurity.com"
  config.integration_key = "asdf"
  config.secret_key = "asdf"

  # ONLY for Duo Web
  # Generate a somewhat long secret token (40+ characters).
  # If you're using Rails, `Rails.application.secret_token` should suffice
  # can also run `duo-api app_secret`
  config.app_secret = "Long app secret"
end

For Rails this would go in something like config/initializers/duo.rb. Keep in mind, you likely don't want to store these keys in your repository.

Configuration Caveat

If you're using more than one Duo API, you may want to instead use DuoApi::Clients more directly. See usage below.

Usage

For Duo Web documentation check out our example in the wiki.

response = DuoApi.get("/auth/v2/check")
response.success? # => true
response.body["response"]["time"] # => 1357020061

response = DuoApi.post("/auth/v2/preauth", :params => { :username => "jphenow" })
response.success? # => true
response.code # => "200"
response.body["response"]["result"] # => "auth"
response.message # => "Account is active"

response = DuoApi.post("/auth/v2/preauth")
response.success? # => false
response.code # => "400"
response.message # => "Missing required request parameters"

See the Duo API documentation for a full list of available endpoints.

Client Usage

If you're using more than one Duo API, you may want to instead use DuoApi::Clients more directly:

client = DuoApi::Client.new :hostname => "api-xxxxx.duosecurity.com",
  :integration_key => "asdf",
  :secret_key => "asdf"

response = client.get("/auth/v2/check")
response.success? # => true
response.body["response"]["time"] # => 1357020061

response = client.post("/auth/v2/preauth", :params => { :username => "jphenow" })
response.success? # => true
response.code # => "200"
response.body["response"]["result"] # => "auth"
response.message # => "Account is active"

response = client.post("/auth/v2/preauth")
response.success? # => false
response.code # => "400"
response.message # => "Missing required request parameters"

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/highrisehq/duo-api. 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.

You can’t perform that action at this time.