dock-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b2d8dbfadbcc5cfb8a38a080f8ab47689fe0de13a108f95ce1560735672f90d
+  data.tar.gz: '0460937cfd6cd14517ccbc4f4633bb6e9039d0205788e7d1321f0ea16fd3fdc4'
+SHA512:
+  metadata.gz: da2480f9b19c951e0ddc93e76781dbc347c8c2978430b5bdfe2e0c5f1b4c703e76abafb7f7b5e2f94e8156d1bf821d9c07716979168b6b64160672110dfe8576
+  data.tar.gz: 3f2232e85226c00be8909173db6406ece2d430b11d0da51dc23b9abed674bbbf0807045c56eed7ca761840f1980621f30c198a645c26bd44a00f890326262d68

data/.github/workflows/build.yml

@@ -0,0 +1,11 @@
+name: Build
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: DOCK_API_TOKEN=${{ secrets.DOCK_API_TOKEN }} bundle exec rspec

data/.github/workflows/scheduled_build.yml

@@ -0,0 +1,14 @@
+name: Scheduled Build
+on:
+  schedule:
+    - cron: "15 0 * * *"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: VCR=all DOCK_API_TOKEN=${{ secrets.DOCK_API_TOKEN }} bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dock-api.gemspec
+gemspec
+
+gem 'pry'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rspec-retry'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'vcr'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    dock-api (0.1.0)
+      faraday (>= 2.0.0.alpha.pre.4)
+      httpx (>= 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    faraday (2.0.0.alpha.pre.4)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    http-2-next (0.5.0)
+    httpx (0.18.3)
+      http-2-next (>= 0.4.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-retry (0.6.2)
+      rspec-core (> 3.3)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+    vcr (6.0.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dock-api!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-retry
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  vcr
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Robin Bortlik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+[![Build](https://github.com/robinbortlik/dock-api/actions/workflows/build.yml/badge.svg)](https://github.com/robinbortlik/dock-api/actions/workflows/build.yml)
+[![Scheduled Build](https://github.com/robinbortlik/dock-api/actions/workflows/scheduled_build.yml/badge.svg)](https://github.com/robinbortlik/dock-api/actions/workflows/scheduled_build.yml)
+
+# dock-api
+
+Ruby client for [Dock network](https://dock.io/) API .
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dock-api'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ 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/ .
+
+```ruby
+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
+
+```ruby
+# 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
+
+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](https://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](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dock/api'
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dock-api.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dock/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dock-api'
+  spec.version       = Dock::Api::VERSION
+  spec.authors       = ['Robin Bortlik']
+  spec.email         = ['robinbortlik@gmail.com']
+
+  spec.summary       = 'Ruby client for Dock network API'
+  # spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/robinbortlik/dock-api'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/robinbortlik/dock-api'
+  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 2.0.0.alpha.pre.4'
+  spec.add_dependency 'httpx', '>= 0.18'
+end

data/lib/dock/api/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Configuration
+      attr_accessor :auth_token, :host, :log_requests, :request_retry_count
+
+      def initialize
+        @auth_token = nil
+        @host = nil
+        @log_requests = nil
+        @request_retry_count = nil
+      end
+
+      def request_retry_count
+        @request_retry_count || 1
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/anchors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Anchors < Dock::Api::Base
+      NAMESPACE = '/anchors'
+
+      class << self
+        def list
+          get(NAMESPACE)
+        end
+
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+
+        def verify(attrs = {})
+          post("#{NAMESPACE}/verify", attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Base
+      class << self
+        def connection
+          Dock::Api.connection
+        end
+
+        def get(url)
+          connection.get(url).body
+        end
+
+        def delete(url)
+          connection.delete(url).body
+        end
+
+        def post(url, data)
+          connection.post(url, data).body
+        end
+
+        def patch(url, data)
+          connection.patch(url, data).body
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/credentials.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Credentials < Dock::Api::Base
+      NAMESPACE = '/credentials'
+
+      class << self
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def destroy(id)
+          delete("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/dids.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Dids < Dock::Api::Base
+      NAMESPACE = '/dids'
+
+      class << self
+        def list
+          get(NAMESPACE)
+        end
+
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def destroy(id)
+          delete("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+
+        def update(id, attrs = {})
+          patch("#{NAMESPACE}/#{id}", attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/jobs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Jobs < Dock::Api::Base
+      NAMESPACE = '/jobs'
+
+      class << self
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/presentations.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Presentations < Dock::Api::Base
+      NAMESPACE = '/presentations'
+
+      class << self
+        def create(**attrs)
+          post(NAMESPACE.to_s, attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/profiles.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Profiles < Dock::Api::Base
+      NAMESPACE = '/profiles'
+
+      class << self
+        def list
+          get(NAMESPACE)
+        end
+
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def destroy(id)
+          delete("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+
+        def update(id, attrs = {})
+          patch("#{NAMESPACE}/#{id}", attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/registries.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Registries < Dock::Api::Base
+      NAMESPACE = '/registries'
+
+      class << self
+        def list
+          get(NAMESPACE)
+        end
+
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def destroy(id)
+          delete("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+
+        def revoke(id, credential_ids:)
+          post("#{NAMESPACE}/#{id}", action: :revoke, credentialIds: credential_ids)
+        end
+
+        def unrevoke(id, credential_ids:)
+          post("#{NAMESPACE}/#{id}", action: :unrevoke, credentialIds: credential_ids)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/revocation_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class RevocationStatus < Dock::Api::Base
+      NAMESPACE = '/revocationStatus'
+
+      class << self
+        def find(reg_id:, rev_id:)
+          get("#{NAMESPACE}/#{reg_id}/#{rev_id}")
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/schemas.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Schemas < Dock::Api::Base
+      NAMESPACE = '/schemas'
+
+      class << self
+        def list
+          get(NAMESPACE)
+        end
+
+        def find(id)
+          get("#{NAMESPACE}/#{id}")
+        end
+
+        def create(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/endpoints/verify.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    class Verify < Dock::Api::Base
+      NAMESPACE = '/verify'
+
+      class << self
+        def verify(attrs = {})
+          post(NAMESPACE, attrs)
+        end
+      end
+    end
+  end
+end

data/lib/dock/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dock
+  module Api
+    VERSION = '0.1.0'
+  end
+end

data/lib/dock/api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# require "dock/api/version"
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'httpx'
+require 'httpx/adapters/faraday'
+require 'faraday'
+require 'api/configuration'
+require 'api/endpoints/base'
+require 'api/endpoints/anchors'
+require 'api/endpoints/credentials'
+require 'api/endpoints/dids'
+require 'api/endpoints/jobs'
+require 'api/endpoints/presentations'
+require 'api/endpoints/profiles'
+require 'api/endpoints/registries'
+require 'api/endpoints/revocation_status'
+require 'api/endpoints/schemas'
+require 'api/endpoints/verify'
+
+module Dock
+  module Api
+    class Error < StandardError; end
+
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield(config)
+      end
+
+      def connection
+        @conn ||= Faraday.new(url: config.host) do |f|
+          f.adapter :httpx
+          f.request :json
+          f.request :url_encoded
+          f.request :retry, max: config.request_retry_count
+          f.request :authorization, 'Bearer', config.auth_token
+          f.response :json
+          f.response :logger if config.log_requests
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: dock-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Bortlik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha.pre.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha.pre.4
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: 
+email:
+- robinbortlik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".github/workflows/scheduled_build.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dock-api.gemspec
+- lib/dock/api.rb
+- lib/dock/api/configuration.rb
+- lib/dock/api/endpoints/anchors.rb
+- lib/dock/api/endpoints/base.rb
+- lib/dock/api/endpoints/credentials.rb
+- lib/dock/api/endpoints/dids.rb
+- lib/dock/api/endpoints/jobs.rb
+- lib/dock/api/endpoints/presentations.rb
+- lib/dock/api/endpoints/profiles.rb
+- lib/dock/api/endpoints/registries.rb
+- lib/dock/api/endpoints/revocation_status.rb
+- lib/dock/api/endpoints/schemas.rb
+- lib/dock/api/endpoints/verify.rb
+- lib/dock/api/version.rb
+homepage: https://github.com/robinbortlik/dock-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/robinbortlik/dock-api
+  source_code_uri: https://github.com/robinbortlik/dock-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for Dock network API
+test_files: []