Project

dock-api

0.0
No release in over a year
dock-apirobinbortlik/dock-apiHomepageDocumentationSource CodeBug TrackerWiki
Ruby client for Dock network API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,533
Stars
3
Forks
0
Watchers
3
 Releases
Current version
0.2.0
Total releases
2
First release
2022-01-04
Latest release
2022-01-04
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
3
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-01-19
Reverse Dependencies
0

 Dependencies

Runtime

faraday
>= 2.0.0.alpha.pre.4
httpx
>= 0.18
 Project Readme

Build Scheduled Build

dock-api

Ruby client for Dock network API .

Installation

Add this line to your application's Gemfile:

gem 'dock-api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install dock-api

Configuration

In order to connect to dock API you firs need to generate API token, which can be done on https://console.api.dock.io/ .

Dock::Api.configure do |conf|
  conf.auth_token = ENV.fetch("DOCK_API_TOKEN")
  conf.host = "https://api.dock.io"
  conf.log_requests = true # useful for debugging
  conf.request_retry_count = 3 # default 1
end

Usage

# Anchors

Dock::Api::Anchors.list
Dock::Api::Anchors.find
Dock::Api::Anchors.create
Dock::Api::Anchors.verify

# Credentials

Dock::Api::Credentials.find
Dock::Api::Credentials.destroy
Dock::Api::Credentials.create

# Dids

Dock::Api::Dids.list
Dock::Api::Dids.find
Dock::Api::Dids.create
Dock::Api::Dids.update
Dock::Api::Dids.destroy

# Jobs

Dock::Api::Jobs.find

# Presentations

Dock::Api::Presentations.create

# Profiles

Dock::Api::Profiles.list
Dock::Api::Profiles.find
Dock::Api::Profiles.create
Dock::Api::Profiles.update
Dock::Api::Profiles.destroy

# Registries

Dock::Api::Registries.list
Dock::Api::Registries.find
Dock::Api::Registries.create
Dock::Api::Registries.destroy
Dock::Api::Registries.revoke
Dock::Api::Registries.unrevoke

# RevocationStatus

Dock::Api::RevocationStatus.find

# Schemas

Dock::Api::Schemas.list
Dock::Api::Schemas.find
Dock::Api::Schemas.create

# Verify

Dock::Api::Verify.verify

Documentations

Gem documentation: https://www.rubydoc.info/github/robinbortlik/dock-api/main

Official Dock API documentation: https://docs.api.dock.io/#the-dock-api

Swagger console: https://swagger.api.dock.io/

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/robinbortlik/dock-api.

License

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