nuid-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77fc98b1337b47b0be5eb21ee7ff594b0debb6810712cfa898766bb36756c613
+  data.tar.gz: a5e97a583efa1a33afcd05a6946c0f6af49f74f536628feef0de294d45c25531
+SHA512:
+  metadata.gz: 594d9c967068b6e5044022b14b12a50f34dcc5c563498eba0218d7ede6e6102c2f495ecf58b48aac2e99aaf0fbf9e5e8ddb5f393c996218df635ecc73bbea3e0
+  data.tar.gz: 9271877573ed17b00843b0f8cf4c1cb56e56b67e6ba4bbcf1417f5801fff9f65bdc4ffe6facf2d3454616597b66ac34962f8b11d7dbb65736988d1a4dded50cb

data/.env.sample

@@ -0,0 +1 @@
+NUID_API_KEY=

data/.gitignore

@@ -0,0 +1 @@
+.env

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.7-alpine3.13
+LABEL maintainer="NuID Developers <dev@nuid.io>"
+WORKDIR /nuid/sdk-ruby
+ADD . .
+RUN apk add git nodejs npm
+RUN gem install bundler
+RUN bundle install
+RUN npm install
+ENV PATH=$PATH:/nuid/sdk-ruby/node_modules/.bin
+CMD /bin/sh

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nuid-sdk.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    nuid-sdk (0.1.0)
+      httparty (~> 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.3)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  nuid-sdk!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 BJ Neilsen
+
+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/Makefile

@@ -0,0 +1,27 @@
+image=nuid/sdk-ruby
+container=nuid-sdk-ruby
+
+build:
+	docker build -t "$(image):latest" .
+
+clean: stop rm rmi
+
+rm:
+	docker rm $(container)
+
+rmi:
+	docker rmi $(image)
+
+run:
+	docker run -v $$PWD:/nuid/sdk-ruby -it -d --env-file .env --name $(container) $(image) /bin/sh
+
+shell:
+	docker exec -it $(container) /bin/sh
+
+stop:
+	docker stop $(container)
+
+test:
+	docker exec -it $(container) rake test
+
+.PHONY: test

data/README.md

@@ -0,0 +1,84 @@
+<p align="right"><a href="https://nuid.io"><img src="https://nuid.io/svg/logo.svg" width="20%"></a></p>
+
+# NuID SDK for Ruby
+
+This repo provides a Ruby Gem for interacting with NuID APIs within Ruby
+applications.
+
+Read the latest [package
+docs](http://libdocs.s3-website-us-east-1.amazonaws.com/sdk-ruby/v0.1.0/) or
+checkout the [platform docs](https://portal.nuid.io/docs) for API docs, guides,
+video tutorials, and more.
+
+## Install
+
+From [rubygems](https://rubygems.org/gems/nuid-sdk):
+
+```sh
+gem install nuid-sdk -v "0.1.0"
+```
+
+Or with bundler:
+
+```ruby
+# Gemfile
+gem "nuid-sdk", "~> 0.1.0"
+```
+
+## Usage
+
+Example rails auth controller.
+
+For a more detailed example visit the [Integrating with
+NuID](https://portal.nuid.io/docs/guides/integrating-with-nuid) guide and its
+accompanying repository
+[node-example](https://github.com/NuID/node-example/tree/bj/client-server-apps).
+A ruby-specific code example is coming soon.
+
+```ruby
+require "nuid-sdk"
+
+class UsersController < ApplicationController
+  NUID_API = ::NuID::SDK::API::Auth.new(ENV["NUID_API_KEY"])
+
+  def register
+    credential_res = NUID_API.credential_create(params[:verified_credential])
+    if credential_res.ok?
+      user_params = params.require(:email, :first_name, :last_name)
+                          .merge({nuid: credential_res.body["nu/id"]})
+      @current_user = User.create(user_params)
+      render json: @current_user, status: :created
+    else
+      render status: :bad_request
+    end
+  end
+end
+```
+
+## Development
+
+You'll want to download docker to run the tests, as we depend on the
+`@nuid/cli` npm package to provide a CLI you can shell out to
+in the tests for generating zk crypto. After checking out the repo, run
+`bin/setup` to install dependencies and create the docker environment. Then, run
+`make test` to run the tests inside the running container. You can also run
+`bin/console` for an interactive prompt that will allow you to experiment, but
+you'll probably want to run that in the container (use `make shell` to get a
+prompt in the container).
+
+`make clean` will stop and destroy the container and image. `make build run`
+will rebuild the image and run the container.
+
+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/NuID/sdk-ruby.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nuid/sdk"
+
+# 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,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+make build run

data/lib/nuid/sdk.rb

@@ -0,0 +1,5 @@
+require "nuid/sdk/version"
+
+module NuID::SDK
+  class Error < StandardError; end
+end

data/lib/nuid/sdk/api/auth.rb

@@ -0,0 +1,47 @@
+require "httparty"
+
+module NuID::SDK::API
+  class Auth
+    include HTTParty
+    base_uri "https://auth.nuid.io"
+
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+      self.class.headers({
+        "X-API-Key" => @api_key,
+        "Accept"    => "application/json"
+      })
+    end
+
+    def challenge_get(credential)
+      _post("/challenge", {"nuid/credential" => credential})
+    end
+
+    def challenge_verify(challenge_jwt, proof)
+      _post("/challenge/verify", {
+        "nuid.credential.challenge/jwt" => challenge_jwt,
+        "nuid.credential/proof"         => proof
+      })
+    end
+
+    def credential_create(verified_credential)
+      _post("/credential", {"nuid.credential/verified" => verified_credential})
+    end
+
+    def credential_get(nuid)
+      self.class.get("/credential/#{nuid}")
+    end
+
+    private
+
+    def _post(path, body)
+      self.class.post(path, {
+        headers: {"Content-Type" => "application/json"},
+        body: body.to_json
+      })
+    end
+    
+  end
+end

data/lib/nuid/sdk/version.rb

@@ -0,0 +1,5 @@
+module NuID
+  module SDK
+    VERSION = "0.1.0"
+  end
+end

data/nuid-sdk.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/nuid/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nuid-sdk"
+  spec.version       = NuID::SDK::VERSION
+  spec.authors       = ["BJ Neilsen"]
+  spec.email         = ["bj.neilsen@gmail.com"]
+
+  spec.summary       = %q{SDK for interacting with NuID APIs in Ruby}
+  spec.homepage      = "https://portal.nuid.io/docs"
+  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/NuID/sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/NuID/sdk-ruby/blob/master/CHANGELOG.md"
+
+  spec.add_dependency "httparty", "~> 0.18.1"
+
+  # 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('..', __FILE__)) 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"]
+end

data/package-lock.json

@@ -0,0 +1,140 @@
+{
+  "name": "sdk-ruby",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@nuid/cli": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/@nuid/cli/-/cli-0.1.0.tgz",
+      "integrity": "sha512-tWQ3swq/ue9Bup9sGOtoPLWJksaDkrWYwFKYFdIffrWnkuOBycJXvFtIcBQJ8ZaP0fOzenKzdIpzzeO4obyz0w==",
+      "dev": true,
+      "requires": {
+        "@nuid/zk": "^0.1.1",
+        "commander": "^7.0.0"
+      }
+    },
+    "@nuid/zk": {
+      "version": "0.1.1",
+      "resolved": "https://registry.npmjs.org/@nuid/zk/-/zk-0.1.1.tgz",
+      "integrity": "sha512-05nk2K0lXNkRMJKny8gEEsVuAl1xz9xkrM55pjvCp6WrOpmYO2WO1nJ5tDWmkbqKrsZBEJUjVURyfJrF+boGkA==",
+      "dev": true,
+      "requires": {
+        "bn.js": "^5.1.1",
+        "brorand": "^1.1.0",
+        "buffer": "^5.6.0",
+        "elliptic": "^6.5.3",
+        "hash.js": "^1.1.7",
+        "scryptsy": "^2.1.0"
+      }
+    },
+    "base64-js": {
+      "version": "1.5.1",
+      "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+      "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+      "dev": true
+    },
+    "bn.js": {
+      "version": "5.1.3",
+      "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-5.1.3.tgz",
+      "integrity": "sha512-GkTiFpjFtUzU9CbMeJ5iazkCzGL3jrhzerzZIuqLABjbwRaFt33I9tUdSNryIptM+RxDet6OKm2WnLXzW51KsQ==",
+      "dev": true
+    },
+    "brorand": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/brorand/-/brorand-1.1.0.tgz",
+      "integrity": "sha1-EsJe/kCkXjwyPrhnWgoM5XsiNx8=",
+      "dev": true
+    },
+    "buffer": {
+      "version": "5.7.1",
+      "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz",
+      "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==",
+      "dev": true,
+      "requires": {
+        "base64-js": "^1.3.1",
+        "ieee754": "^1.1.13"
+      }
+    },
+    "commander": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-7.0.0.tgz",
+      "integrity": "sha512-ovx/7NkTrnPuIV8sqk/GjUIIM1+iUQeqA3ye2VNpq9sVoiZsooObWlQy+OPWGI17GDaEoybuAGJm6U8yC077BA==",
+      "dev": true
+    },
+    "elliptic": {
+      "version": "6.5.4",
+      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.4.tgz",
+      "integrity": "sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==",
+      "dev": true,
+      "requires": {
+        "bn.js": "^4.11.9",
+        "brorand": "^1.1.0",
+        "hash.js": "^1.0.0",
+        "hmac-drbg": "^1.0.1",
+        "inherits": "^2.0.4",
+        "minimalistic-assert": "^1.0.1",
+        "minimalistic-crypto-utils": "^1.0.1"
+      },
+      "dependencies": {
+        "bn.js": {
+          "version": "4.11.9",
+          "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-4.11.9.tgz",
+          "integrity": "sha512-E6QoYqCKZfgatHTdHzs1RRKP7ip4vvm+EyRUeE2RF0NblwVvb0p6jSVeNTOFxPn26QXN2o6SMfNxKp6kU8zQaw==",
+          "dev": true
+        }
+      }
+    },
+    "hash.js": {
+      "version": "1.1.7",
+      "resolved": "https://registry.npmjs.org/hash.js/-/hash.js-1.1.7.tgz",
+      "integrity": "sha512-taOaskGt4z4SOANNseOviYDvjEJinIkRgmp7LbKP2YTTmVxWBl87s/uzK9r+44BclBSp2X7K1hqeNfz9JbBeXA==",
+      "dev": true,
+      "requires": {
+        "inherits": "^2.0.3",
+        "minimalistic-assert": "^1.0.1"
+      }
+    },
+    "hmac-drbg": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/hmac-drbg/-/hmac-drbg-1.0.1.tgz",
+      "integrity": "sha1-0nRXAQJabHdabFRXk+1QL8DGSaE=",
+      "dev": true,
+      "requires": {
+        "hash.js": "^1.0.3",
+        "minimalistic-assert": "^1.0.0",
+        "minimalistic-crypto-utils": "^1.0.1"
+      }
+    },
+    "ieee754": {
+      "version": "1.2.1",
+      "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
+      "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==",
+      "dev": true
+    },
+    "inherits": {
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+      "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
+      "dev": true
+    },
+    "minimalistic-assert": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz",
+      "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==",
+      "dev": true
+    },
+    "minimalistic-crypto-utils": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/minimalistic-crypto-utils/-/minimalistic-crypto-utils-1.0.1.tgz",
+      "integrity": "sha1-9sAMHAsIIkblxNmd+4x8CDsrWCo=",
+      "dev": true
+    },
+    "scryptsy": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/scryptsy/-/scryptsy-2.1.0.tgz",
+      "integrity": "sha512-1CdSqHQowJBnMAFyPEBRfqag/YP9OF394FV+4YREIJX4ljD7OxvQRDayyoyyCk+senRjSkP6VnUNQmVQqB6g7w==",
+      "dev": true
+    }
+  }
+}

data/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "sdk-ruby",
+  "description": "Not an NPM Package",
+  "homepage": "https://portal.nuid.io/docs",
+  "version": "1.0.0",
+  "license": "MIT",
+  "repository": "https://github.com/NuID/sdk-ruby",
+  "devDependencies": {
+    "@nuid/cli": "^0.1.0"
+  }
+}

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: nuid-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BJ Neilsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: 
+email:
+- bj.neilsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nuid/sdk.rb
+- lib/nuid/sdk/api/auth.rb
+- lib/nuid/sdk/version.rb
+- nuid-sdk.gemspec
+- package-lock.json
+- package.json
+homepage: https://portal.nuid.io/docs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://portal.nuid.io/docs
+  source_code_uri: https://github.com/NuID/sdk-ruby
+  changelog_uri: https://github.com/NuID/sdk-ruby/blob/master/CHANGELOG.md
+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: SDK for interacting with NuID APIs in Ruby
+test_files: []