silkey-sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151c068dbbeccc6d242140bbf755dbc2d7ac783de3c0fa9f8bed08828c875011
-  data.tar.gz: '09c21b562b50c1a66c9d72d2fd0042e6a30549941017e1e7fff4e4644bbdcfef'
+  metadata.gz: e6905b7c46f40f54b67f37962aee0984faa1bc00d33220540f4909a00c937189
+  data.tar.gz: a143d094709149a251762ed15b6f815cb45695d62da680480283996ec8c51f5d
 SHA512:
-  metadata.gz: f7505da37a916d4e26d7ebd896a432ff901ae3ee805707e924e34a832643d52fe6ddb7a52f3a0676d7170976a6cdfeb469327b8c99fd8292136313324cbfba08
-  data.tar.gz: 1f346357fc4623f9cfb54c93cbd68e000a2a4597374a3f5c39f037907da4aa1d4003611e09a6b52386816a27d481bd200b644472416e6db9adb48fcc96e01c92
+  metadata.gz: b5452fc0da4eb1c489dc27e39539181f994203ccb1e90099abb668d50284c753093863bfc8e19bb2132c12a2e04daa1b61b5c53953beb40924aa10696d8c5816
+  data.tar.gz: bb5305fcb440828ffcd8547af8d10776579d933a10056f98504d7ba69bf7ae3ddb3a3752c5727436ec0308f3a0d1aa10477f506be2f3b7971e8eb5552fc6cda0

data/.yardopts

@@ -0,0 +1,14 @@
+--no-private
+--title "Silkey SDK for Ruby"
+--exclude Gemfile
+--exclude Gemfile.lock
+--exclude registry_contract_abi.json
+--exclude setup
+--exclude Rakefile
+--exclude DEVELOPMENT.md
+--exclude lib/silkey/factories/*
+--exclude lib/silkey/registry_contract/*
+--exclude lib/silkey/services/*
+--exclude lib/silkey/contract.rb
+--exclude lib/silkey/utils.rb
+--exclude lib/silkey/version.rb

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.0.2] 2020-11-23
+### Added
+- add support for `redirectMethod`
+
+### Changed
+- `generate_sso_request_params` raises error when missing required params
+
+### Removed
+- html doc files from repo
+
+## [0.0.1] 2020-11-20
 ### Added:
 - initial version

data/DEVELOPMENT.md

@@ -13,7 +13,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 ```
 rm -rf doc/
-bundle exec rdoc --main README.rdoc -x Gemfile -x Gemfile.lock -x registry_contract_abi.json -x setup -x Rakefile -x DEVELOPMENT.md
+bundle exec yardoc 
 
 bundle exec gem build
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    silkey-sdk (0.0.1)
+    silkey-sdk (0.0.2)
       activesupport (~> 6.0)
       eth (~> 0.4.12)
       ethereum.rb (~> 2.5)
@@ -108,6 +108,7 @@ GEM
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
     virtus_convert (0.1.0)
+    yard (0.9.25)
     zeitwerk (2.4.1)
 
 PLATFORMS
@@ -123,6 +124,7 @@ DEPENDENCIES
   rubocop (~> 1.3)
   rubocop-performance (~> 1.8)
   silkey-sdk!
+  yard (~> 0.9.25)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -4,37 +4,43 @@
 
 [slogan]
 
-
 ## Integration
 
 ### Configuration
 
 ```rb
 Silkey::Configuration.setup do |config|
-  config.client_url =  'http://localhost:8545'              # for local development
-  config.client_url =  'https://kovan.infura.io/v3/:id'     # for real
-  config.registry_contract_address =  '--silky-registry-contrract-address--'
+  config.client_url =  'http://localhost:8545'                # for local development
+  config.client_url =  'https://rinkeby.infura.io/v3/:id'     # for real
+  config.registry_contract_address =  '--silky-registry-contract-address--'
   config.enable_logs = false
 end
 ```
 
-[List of Silkey contract address.](https://github.com/Silkey-Team/silkey-sdk#silkey-sdk) 
+[List of Silkey smart contract addresses.](https://github.com/Silkey-Team/silkey-sdk#smart-contracts) 
 
 ### Sign In with Silkey
 
 #### Making request
 
-[List of request parameters.](https://github.com/Silkey-Team/silkey-sdk#silkey-sdk) 
-
+| Parameter        | Required  | Type     | Desc 
+| ---------------- |:---------:| -------- | ----- 
+| signature        | yes       | string   | Domain owner signature
+| ssoTimestamp     | yes       | number   | Time of signing SSO request
+| redirectUrl      | yes       | string   | Where to redirect user with token after sign in
+| redirectMethod   | no        | GET/POST | How to redirect user after sign in, default is POST
+| cancelUrl        | yes       | string   | Where to redirect user on error
+| refId            | no        | string   | It will be return with user token, you may use it to identify request
+| scope            | no        | string   | Scope of data to return in a token payload: `id` (default) returns only user address, `email` returns address + email
 
 ```rb
-- Silkey::SDK.message_to_sign({params})
-- Silkey::SDK.generate_sso_request_params(private_key, hash)
+params = { :redirectUrl => 'https://your-website', :refId => '12ab' }
+sso_params = Silkey::SDK.generate_sso_request_params(private_key, params)
 ```
 
 #### On request callback page
 
-`token` - get if from request params (it can be send either via POST or GET) 
+`token` - get if from request params (it can be send via POST or GET, based on `redirectMethod`) 
 
 ```rb
 silkey_public_key = Silkey::SDK.fetch_silkey_public_key

data/lib/silkey/sdk.rb

@@ -3,29 +3,28 @@
 module Silkey
   class SDK
     class << self
-
       ##
       # Generates message to sign based on plain object data (keys => values)
       #
-      # @param [Hash]
+      # @param to_sign [Hash] hash object
       #
-      # @return [string]
+      # @return [string] message to sign
       #
       # @example:
       #
-      #   Silkey::SDK.message_to_sign({ redirectUrl: 'http://silkey.io', refId: 1 });
+      #   Silkey::SDK.message_to_sign({ :redirectUrl => 'http://silkey.io', :refId => 1 });
       #
       # returns
       #
       #   'redirectUrl=http://silkey.io::refId=1'
       #
-      def message_to_sign(hash = {})
+      def message_to_sign(to_sign = {})
         msg = []
-        hash.keys.sort.each do |k|
-          if Silkey::Utils.empty?(hash[k])
+        to_sign.keys.sort.each do |k|
+          if Silkey::Utils.empty?(to_sign[k])
             msg.push("#{k}=")
           else
-            msg.push("#{k}=#{hash[k]}")
+            msg.push("#{k}=#{to_sign[k]}")
           end
         end
 
@@ -35,40 +34,53 @@ module Silkey
       ##
       # Generates all needed parameters (including signature) for requesting Silkey SSO
       #
-      # @param [string] private key of domain owner
+      # @param private_key [string] secret private key of domain owner
       #
-      # @param [Hash] Hash with data: {redirectUrl*, cancelUrl*, refId, scope, ssoTimestamp*}
-      # marked with * are required by Silkey SSO
+      # @param params [Hash] Hash object with parameters:
+      #   - redirectUrl*,
+      #   - redirectMethod*,
+      #   - cancelUrl*,
+      #   - refId,
+      #   - scope,
+      #   - ssoTimestamp*
+      #   marked with * are required by Silkey
       #
-      # @return [Hash] {{signature, ssoTimestamp, redirectUrl, refId, scope}}
+      # @return [Hash] parameters for SSO as key -> value, they all need to be set in URL
       #
       # @example
       #
+      #   data = { :redirectUrl => 'https://your-website', :refId => '12ab' }
       #   Silkey::SDK.generate_sso_request_params(private_key, data)
       #
-      def generate_sso_request_params(private_key, hash)
-        redirect_url = hash[:redirectUrl] || ''
-        cancel_url = hash[:cancelUrl] || ''
-        sso_timestamp = hash[:ssoTimestamp] || Silkey::Utils.current_timestamp
-        ref_id = hash[:refId] || ''
-        scope = hash[:scope] || ''
-
-        message = message_to_sign({
-                                    redirectUrl: redirect_url,
-                                    cancelUrl: cancel_url,
-                                    ssoTimestamp: sso_timestamp,
-                                    refId: ref_id,
-                                    scope: scope
-                                  })
-
-        {
-          signature: Silkey::Utils.sign_message(private_key, message),
-          ssoTimestamp: sso_timestamp,
-          redirectUrl: redirect_url,
-          cancelUrl: cancel_url,
-          refId: ref_id,
-          scope: scope
-        }
+      def generate_sso_request_params(private_key, params)
+        raise "params[:redirectUrl] is empty" if Silkey::Utils.empty?(params[:redirectUrl])
+
+        raise "params[:cancelUrl] is empty" if Silkey::Utils.empty?(params[:cancelUrl])
+
+        keys = %w(redirectUrl redirectMethod cancelUrl ssoTimestamp refId scope)
+
+        data_to_sign = keys.reduce({}) do |acc, k|
+          if Silkey::Utils.empty?(params[k.to_sym])
+            case k
+            when 'ssoTimestamp'
+              acc[k.to_sym] = Silkey::Utils.current_timestamp
+            when 'scope'
+              acc[k.to_sym] = 'id'
+            else
+              # type code here
+            end
+          else
+            acc[k.to_sym] = params[k.to_sym]
+          end
+
+          acc
+        end
+
+        puts data_to_sign
+        message = message_to_sign(data_to_sign)
+        data_to_sign['signature'] = Silkey::Utils.sign_message(private_key, message)
+
+        data_to_sign
       end
 
       ##
@@ -76,9 +88,9 @@ module Silkey
       #
       # @see https://jwt.io/ for details about token payload data
       #
-      # @param [string] JWT token returned by Silkey
+      # @param token [string] JWT token returned by Silkey
       #
-      # @param [string] silkeyPublicKey public ethereum address of Silkey
+      # @param silkey_public_key [string] public ethereum address of Silkey
       #
       # @return [JwtPayload|null] null when signature(s) are invalid, otherwise token payload
       #
@@ -87,7 +99,8 @@ module Silkey
       # @example
       #
       #   Silkey::SDK.token_payload_verifier(
-      #     'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
+      #     'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG'\
+      #     '9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
       #     Silkey::SDK.fetch_silkey_public_key
       #   )
       #
@@ -108,12 +121,6 @@ module Silkey
       # Fetches public ethereum Silkey address (directly from blockchain).
       # This address can be used for token verification
       #
-      # @param [string] providerUri ie: 'https://infura.io/v3/:infuraId' register to infura.io to get infuraId
-      #
-      # @param [string] address of silkey smart contract registry
-      #
-      # @return [string] public ethereum address of silkey signer
-      #
       # @see List of Silkey contracts addresses: https://github.com/Silkey-Team/silkey-sdk#silkey-sdk
       #
       def fetch_silkey_public_key

data/lib/silkey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Silkey
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/silkey-sdk.gemspec

@@ -12,8 +12,20 @@ Gem::Specification.new do |spec|
   spec.email = ['dariusz@silkey.io']
 
   spec.summary = 'Silkey SDK for Ruby.'
+  spec.description = 'Silkey SDK for Ruby.'
   spec.homepage = 'https://github.com/Silkey-Team/ruby-sdk'
-  spec.license = 'MIT'
+  spec.licenses = ['MIT']
+
+  # spec.files       = ["lib/sdk.rb"]
+
+  # spec.metadata = {
+  #   "bug_tracker_uri"   => "https://github.com/Silkey-Team/ruby-sdk/issues",
+  #   "changelog_uri"     => "https://github.com/Silkey-Team/ruby-sdk/issues/CHANGELOG.md",
+  #   "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
+  #   "homepage_uri"      => "https://silkey.io",
+  #   "source_code_uri"   => "https://github.com/Silkey-Team/ruby-sdk",
+  #   "wiki_uri"          => "https://example.com/user/bestgemever/wiki"
+  # }
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -38,6 +50,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'virtus', '~> 1.0'
   spec.add_dependency 'virtus_convert', '~> 0.1'
   spec.add_development_dependency 'rdoc', '~> 6.2', '>= 6.2.1'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'factory_bot', '~> 6.1'
   spec.add_development_dependency 'pry', '~> 0.13'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: silkey-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - silkey.io
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +226,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-description:
+description: Silkey SDK for Ruby.
 email:
 - dariusz@silkey.io
 executables: []
@@ -222,6 +236,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yardopts"
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Gemfile
@@ -231,66 +246,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- doc/CHANGELOG_md.html
-- doc/LICENSE_txt.html
-- doc/Object.html
-- doc/README_md.html
-- doc/Silkey.html
-- doc/Silkey/ClientFactory.html
-- doc/Silkey/Configuration.html
-- doc/Silkey/Contract.html
-- doc/Silkey/Contract/FrozenArray.html
-- doc/Silkey/ContractFactory.html
-- doc/Silkey/LoggerService.html
-- doc/Silkey/Models.html
-- doc/Silkey/Models/JwtPayload.html
-- doc/Silkey/RegistryContract.html
-- doc/Silkey/SDK.html
-- doc/Silkey/Utils.html
-- doc/created.rid
-- doc/css/fonts.css
-- doc/css/rdoc.css
-- doc/fonts/Lato-Light.ttf
-- doc/fonts/Lato-LightItalic.ttf
-- doc/fonts/Lato-Regular.ttf
-- doc/fonts/Lato-RegularItalic.ttf
-- doc/fonts/SourceCodePro-Bold.ttf
-- doc/fonts/SourceCodePro-Regular.ttf
-- doc/images/add.png
-- doc/images/arrow_up.png
-- doc/images/brick.png
-- doc/images/brick_link.png
-- doc/images/bug.png
-- doc/images/bullet_black.png
-- doc/images/bullet_toggle_minus.png
-- doc/images/bullet_toggle_plus.png
-- doc/images/date.png
-- doc/images/delete.png
-- doc/images/find.png
-- doc/images/loadingAnimation.gif
-- doc/images/macFFBgHack.png
-- doc/images/package.png
-- doc/images/page_green.png
-- doc/images/page_white_text.png
-- doc/images/page_white_width.png
-- doc/images/plugin.png
-- doc/images/ruby.png
-- doc/images/tag_blue.png
-- doc/images/tag_green.png
-- doc/images/transparent.png
-- doc/images/wrench.png
-- doc/images/wrench_orange.png
-- doc/images/zoom.png
-- doc/index.html
-- doc/js/darkfish.js
-- doc/js/navigation.js
-- doc/js/navigation.js.gz
-- doc/js/search.js
-- doc/js/search_index.js
-- doc/js/search_index.js.gz
-- doc/js/searcher.js
-- doc/js/searcher.js.gz
-- doc/table_of_contents.html
 - lib/silkey-sdk.rb
 - lib/silkey.rb
 - lib/silkey/abi/registry_contract_abi.json

data/doc/CHANGELOG_md.html

@@ -1,112 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta charset="UTF-8">
-
-<title>CHANGELOG - RDoc Documentation</title>
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-  var index_rel_prefix = "./";
-</script>
-
-<script src="./js/navigation.js" defer></script>
-<script src="./js/search.js" defer></script>
-<script src="./js/search_index.js" defer></script>
-<script src="./js/searcher.js" defer></script>
-<script src="./js/darkfish.js" defer></script>
-
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-
-
-
-
-<body id="top" role="document" class="file">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-
-  </div>
-
-  
-<div class="nav-section">
-  <h3>Table of Contents</h3>
-
-  <ul class="link-list" role="directory">
-    <li><a href="#label-Changelog">Changelog</a>
-    <li><a href="#label-5BUnreleased-5D">[Unreleased]</a>
-    <li><a href="#label-Added-3A">Added:</a>
-  </ul>
-</div>
-
-
-  <div id="project-metadata">
-    <div id="fileindex-section" class="nav-section">
-  <h3>Pages</h3>
-
-  <ul class="link-list">
-  
-    <li><a href="./CHANGELOG_md.html">CHANGELOG</a>
-  
-    <li><a href="./LICENSE_txt.html">LICENSE</a>
-  
-    <li><a href="./README_md.html">README</a>
-  
-  </ul>
-</div>
-
-  </div>
-</nav>
-
-<main role="main" aria-label="Page CHANGELOG.md">
-
-<h1 id="label-Changelog">Changelog<span><a href="#label-Changelog">&para;</a> <a href="#top">&uarr;</a></span></h1>
-
-<p>All notable changes to this project will be documented in this file.</p>
-
-<p>The format is based on <a href="http://keepachangelog.com/en/1.0.0/">Keep a Changelog</a> and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
-
-<h2 id="label-5BUnreleased-5D">[Unreleased]<span><a href="#label-5BUnreleased-5D">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<h3 id="label-Added-3A">Added:<span><a href="#label-Added-3A">&para;</a> <a href="#top">&uarr;</a></span></h3>
-<ul><li>
-<p>initial version</p>
-</li></ul>
-
-</main>
-
-
-
-<footer id="validator-badges" role="contentinfo">
-  <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>
-