Skip to content

Ruby library for parsing and resolving W3C decentralized identifiers (DIDs)

License

Notifications You must be signed in to change notification settings

verdalabs/didx-ruby

Repository files navigation

DIDX

TODO: Delete this and the text below, and describe your gem

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/did. To experiment with that code, run bin/console for an interactive prompt.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add didx

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install didx

Usage

Create new DID

# Parse a did:web DID
did_string = 'did:web:identity.foundation'

did = DIDX(did_string)
=> #<DIDX::Web:0x000000010bb1ad30 @id="did:web:identity.foundation", @method="web", @method_id="identity.foundation", @prefix="did"> 

# Resolve to a did:web's DID Document 
did.document
=> #<DIDX::Document:0x000000010aa597d0 @assertion_method=nil, @authentication=nil, @context=["https://www.w3.org/ns/did/v1"], @document={"@context"=>["https://www.w3.org/ns/did/v1"], "id"=>"did:web:identity.foundation"}, @id="did:web:identity.foundation", @service=nil, @verification_method=nil>

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/did. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 DID project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Ruby library for parsing and resolving W3C decentralized identifiers (DIDs)

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published