Dnkey
Put your Ruby code in the file lib/dnkey
. To experiment with that code, run bin/console
for an interactive prompt.
Installation
Add this line to your application's Gemfile:
gem 'dnkey'
And then execute:
$ bundle
Or install it yourself as:
$ gem install dnkey
Usage
Generic API usage
Dnkey::API.get('mark.neuroware.io', :key => :btc, :nameservers => ['8.8.8.8'])
Domain Specifc Language
We have a number of baked-in classes to help out in the more common use cases (like getting a bitcoin key).
For example, if you'd like to get the bitcoin key from the domain mark.neuroware.io
you can call:
Dnkey::Bitcoin.get('mark.neuroware.io) # => ["1M4VYf837vbKc9mJxqGdM2w1xPmZNDXdGa", "33aaehx6p4QrTHMvQUZy3dTEevXr4Wprap"]
We have built-in support for the following dnkeys:
- Bitcoin (:btc)
- Litecoin (:lite)
- Dogecoin (:doge)
- Dashcoin (:dash)
- Email (:email)
We'll be adding more dnkey-specific classes later on, PRs are welcome!
You can also get all dnkeys from the domain using:
Dnkey::API.get_all('mark.neuroware.io')
#=> {
:btc => ["1M4VYf837vbKc9mJxqGdM2w1xPmZNDXdGa", "13aaehx6p4QrTHMvQUZy3dTEevXr4Wprap"],
:email => ["[email protected]"],
:ltc => ["LMUN5ZPQCym1sz2XxbunhWsfwJc5nKfANN"],
:doge => ["DNvyxwdSTuzhXmHye6PbGvGWk5EEEZvXpF"],
:dash => ["XeRsLXWVjdnc92AC16zh2segmAbyBZ5Qkt"]
}
It will return a hash with the dnkey as the key and the value as an array of the values.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, 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
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/Neuroware-IO/dnkey/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request