civic_sip_sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0bd1376818c98094308f2fd2953cebfddc315c2d746275abc037afd40c9401a
-  data.tar.gz: 0d75e9c2820fb3ae474c6cf134d97754235a9d2374edc06701f439ff5275baf9
+  metadata.gz: 6b2350a52d62754bbc492a61ad0de623918776b60a4a674ef5edc0890959dc92
+  data.tar.gz: 0f5739eec7f397120b709a63e990d727285347c8ee6cf9437d5897a74aa9fbce
 SHA512:
-  metadata.gz: 24ac13f796a0f8f7fdf021b019e4706c411f7a9ed8c49c49d54036cb7e340572cadf1b9dad979425d49e4091567f5835e30ddb4eb523a94046910a5fb874ed77
-  data.tar.gz: e41c2363ab2ce5b6cd29cda8089e3a3b2e64d91e3b7333784dc3bd411cb3a0bdf945bef69f86aa7826159b68ccb3c883448e71a2538893e6676466edd3d47941
+  metadata.gz: 89facb51ccee9b4fba488a774335c42109058687e9158e87a37e7745ddd9ab83a75d3bc0baa689012cd7709cc58ff0ca6dc5aa86136577d0f3ae3ad435daa656
+  data.tar.gz: 6f03a906b21e25f6e1b54b3c2059b5bf464e68805c3fa7249d99eb5002f6bf2b3f7197f3cd2b5b6e122df08e27f135533d0d01425942275a552d705f40caf006

data/lib/civic_sip_sdk/app_config.rb

@@ -11,16 +11,15 @@ module CivicSIPSdk
       { name: :secret, error: 'Civic application secret is missing!' }
     ].freeze
 
-    # Creates a new instance of <tt>CivicSIPSdk::AppConfig</tt>.
+    # Creates a new instance of +CivicSIPSdk::AppConfig+.
     # This is used to configure the SDK connection parameters to the Civic SIP service.
     #
     # It raises an ArgumentError if any argument is nil.
     #
-    # Args:
-    #   * <tt>id</tt> - The application id.
-    #   * <tt>env</tt> - The application environment. Defaults to +:prod+ if the value is incorrect.
-    #   * <tt>private_key</tt> - The application's private signing key.
-    #   * <tt>secret</tt> - The application secret
+    # @param id [String] The application id.
+    # @param env [Symbol] The application environment. Defaults to +:prod+ if the value is incorrect.
+    # @param private_key [String] The application's private signing key.
+    # @param secret [String] The application secret
     def initialize(id:, env:, private_key:, secret:)
       @id = id
       @env = VALID_ENVS.include?(env.to_sym) ? env.to_sym : VALID_ENVS.last

data/lib/civic_sip_sdk/client.rb

@@ -20,8 +20,7 @@ module CivicSIPSdk
 
     # Creates a client
     #
-    # Args:
-    #   * <tt>config</tt> - an instance of CivicSIPSdk::AppConfig
+    # @param config [CivicSIPSdk::AppConfig] app_config that sets all the parameters of the client
     def initialize(config:)
       @config = config
       @test_env = ENV[ENV_VAR] == TEST_ENV
@@ -30,8 +29,8 @@ module CivicSIPSdk
     # Exchange authorization code in the form of a JWT Token for the user data
     # requested in the scope request.
     #
-    # Args:
-    #   * <tt>jwt_token</tt> - a JWT token that contains the authorization code
+    # @param jwt_token [String] a JWT token that contains the authorization code
+    # @return [CivicSIPSdk::UserData] user data returned from SIP
     def exchange_code(jwt_token:)
       json_body_str = JSON.generate('authToken' => jwt_token)
 

data/lib/civic_sip_sdk/crypto.rb

@@ -16,9 +16,8 @@ module CivicSIPSdk
 
     # Create encrypted text using AES-128-CBC with a IV of 16 bytes
     #
-    # Args:
-    #   * <tt>text</tt> - the plain text to be encrypted
-    #   * <tt>secret</tt> - the Civic application secret in HEX format
+    # @param text [String] the plain text to be encrypted
+    # @param secret [String] the Civic application secret in HEX format
     def self.encrypt(text:, secret:)
       cipher = OpenSSL::Cipher.new(CIPHER_ALGO)
       cipher.encrypt
@@ -32,9 +31,8 @@ module CivicSIPSdk
 
     # Decrypt the encrypted text using AES-128-CBC with a IV of 32 bytes
     #
-    # Args:
-    #   * <tt>text</tt> - the encrypted text to be decrypted
-    #   * <tt>secret</tt> - the Civic application secret in HEX format
+    # @param text [String] the encrypted text to be decrypted
+    # @param secret [String] the Civic application secret in HEX format
     def self.decrypt(text:, secret:)
       cipher = OpenSSL::Cipher.new(CIPHER_ALGO)
       cipher.decrypt

data/lib/civic_sip_sdk/user_data.rb

@@ -9,10 +9,9 @@ module CivicSIPSdk
     # Creates a UserData insteance, which creates a list of UserDataItem instances from
     # +data_items+.
     #
-    # Args:
-    #   * <tt>user_id</tt> - user id
-    #   * <tt>data_items</tt> - a list of Hash that contains the key-value pairs for
-    #                           instantiating CivicSIPSdk::UserDataItem instances
+    # @param user_id [String] user id
+    # @param data_items [List] a list of Hash that contains the key-value pairs
+    #   for instantiating CivicSIPSdk::UserDataItem instances
     def initialize(user_id:, data_items:)
       @user_id = user_id
       @data_items = data_items

data/lib/civic_sip_sdk/user_data_item.rb

@@ -6,12 +6,11 @@ module CivicSIPSdk
 
     # Creates an instance of UserDataItem.
     #
-    # Args:
-    #   * <tt>label</tt> - Descriptive value identifier.
-    #   * <tt>value</tt> - Item value of requested user data.
-    #   * <tt>is_valid</tt> - Indicates whether or not the data is still considered valid on the blockchain.
-    #   * <tt>is_owner</tt> - Civic SIP service challenges the user during scope request approval to ensure
-    #                         the user is in control of the private key originally used in the issuance of the data attestation.
+    # @param label [String] Descriptive value identifier.
+    # @param value [String] Item value of requested user data.
+    # @param is_valid [String] Indicates whether or not the data is still considered valid on the blockchain.
+    # @param is_owner [String] Civic SIP service challenges the user during scope request approval to ensure
+    #   the user is in control of the private key originally used in the issuance of the data attestation.
     def initialize(label:, value:, is_valid:, is_owner:)
       @label = label
       @value = value

data/lib/civic_sip_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CivicSIPSdk
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/civic_sip_sdk.rb

@@ -8,6 +8,13 @@ require 'civic_sip_sdk/client'
 module CivicSIPSdk
   module_function
 
+  # Creates an instance of +CivicSIPSdk::Client+
+  #
+  # @param id [String] the Civic application id
+  # @param env [Symbol] the Civic application environment
+  # @param private_key [String] the Civic private signing key
+  # @param secret [String] the Civic application secret
+  # @return [CivicSIPSdk::Client] the client to exchange the JWT code for user data
   def new_client(id, env, private_key, secret)
     app_config = AppConfig.new(
       id: id,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civic_sip_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Han Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.16
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement