magic-admin 0.0.0 → 0.1.0

data/test/resource/token_test.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe MagicAdmin::Resource::Token do
+  describe "instance methods" do
+    describe "public methods" do
+      it "#validate" do
+        claim = { "ext" => 1000, "nbf" => "nbf" }
+        rec_address = double("rec_address")
+        proof = double("proof")
+        time_now = 1_202_020
+        allow(Time).to receive(:now).and_return(time_now)
+
+        expect(subject).to receive(:decode).and_return([proof, claim])
+        expect(subject).to receive(:validate_claim_fields!).with(claim)
+
+        expect(subject).to receive(:rec_pub_address)
+          .with(claim, proof)
+          .and_return(rec_address)
+
+        expect(subject).to receive(:validate_public_address!)
+          .with(rec_address, spec_did_token)
+
+        expect(subject).to receive(:validate_claim_ext!)
+          .with(time_now, claim["ext"])
+
+        expect(subject).to receive(:validate_claim_nbf!)
+          .with(time_now, claim["nbf"])
+
+        subject.validate(spec_did_token)
+      end
+
+      context "#decode" do
+        it "with valid token" do
+          clam_hash = {
+            "iat" => 1_234_512_345,
+            "ext" => 1_234_512_345,
+            "iss" => "did:ethr:0xtest0000test0000test0000test0000test0000",
+            "sub" => "00abcdefghijklmnopqrstuvwxyz123456789000000=",
+            "aud" => "did:magic:testtest-test-test-test-testtesttest",
+            "nbf" => 1_234_512_345,
+            "tid" => "testtest-test-test-test-testtesttest",
+            "add" => "0x00test0000test0000test0000test0000test0000"\
+                     "test0000test0000test0000test0000test0000test"\
+                     "0000test0000test0000test0000test0000test0000"
+          }
+
+          proof_str = "0xtest0000test0000test0000test0000test0000"\
+                      "test0000test0000test0000test0000test0000test"\
+                      "0000test0000test0000test0000test0000test000000"
+
+          decode_val = [proof_str, clam_hash]
+
+          expect(subject.decode(spec_did_token)).to eq(decode_val)
+        end
+
+        it "with invalid token" do
+          allow(subject).to receive(:base64_decode)
+            .with(spec_did_token)
+            .and_return("")
+
+          expect do
+            subject.decode(spec_did_token)
+          end .to raise_error(MagicAdmin::DIDTokenError,
+                              "DID Token is malformed")
+        end
+      end
+
+      context "#construct_issuer_with_public_address" do
+        it "return format" do
+          public_address = subject.construct_issuer_with_public_address("test_address")
+          expected = "did:ethr:test_address"
+          expect(public_address).to eq(expected)
+        end
+      end
+
+      context "#get_issuer" do
+        it "return format" do
+          issuer = subject.get_issuer(spec_did_token)
+          expected = "did:ethr:0xtest0000test0000test0000test0000test0000"
+          expect(issuer).to eq(expected)
+        end
+      end
+
+      context "#get_public_address" do
+        it "return format" do
+          public_address = subject.get_public_address(spec_did_token)
+          expected = "0xtest0000test0000test0000test0000test0000"
+          expect(public_address).to eq(expected)
+        end
+      end
+    end
+
+    describe "private methods" do
+      it "#claim_fields" do
+        fields = subject.send(:claim_fields)
+        expect(fields).to eq(%w[iat ext iss sub aud nbf tid])
+      end
+
+      context "#validate_claim_fields!" do
+        it "return true when claim keys match with claim_fields " do
+          allow(subject).to receive(:claim_fields).and_return([])
+
+          expect(subject.send(:validate_claim_fields!, {})).to be_truthy
+        end
+
+        it "raise error when claim keys does not match with claim_fields " do
+          fields = %w[iat ext iss sub aud nbf tid]
+          msg = "DID Token missing required fields: "
+          msg += fields.join(", ")
+          expect do
+            subject.send(:validate_claim_fields!, { invalid: nil })
+          end .to raise_error(MagicAdmin::DIDTokenError, msg)
+        end
+      end
+
+      context "#validate_public_address!" do
+        it "return true when rec_address eq did_token public_address" do
+          allow(subject).to receive(:get_public_address)
+            .with(spec_did_token)
+            .and_return("test_123")
+
+          expect(subject.send(:validate_public_address!,
+                              "test_123",
+                              spec_did_token)).to be_truthy
+        end
+
+        it "raise error when rec_address not eq did_token public_address" do
+          msg = "Signature mismatch between 'proof' and 'claim'."
+          expect do
+            subject.send(:validate_public_address!,
+                         "test_123",
+                         spec_did_token)
+          end .to raise_error(MagicAdmin::DIDTokenError, msg)
+        end
+      end
+
+      context "#validate_claim_ext!" do
+        it "return true when time is not grater claim_ext" do
+          time = Time.now.to_i
+          claim_ext = time + 100
+
+          expect(subject.send(:validate_claim_ext!,
+                              time,
+                              claim_ext)).to be_truthy
+        end
+
+        it "raise error when time is grater claim_ext" do
+          time = Time.now.to_i
+          claim_ext = time - 100
+          msg = "Given DID token has expired. Please generate a new one."
+          expect do
+            subject.send(:validate_claim_ext!, time, claim_ext)
+          end .to raise_error(MagicAdmin::DIDTokenError, msg)
+        end
+      end
+
+      context "#validate_claim_nbf using apply_nbf_grace_period claim_nbf" do
+        it "when time is not less then return true" do
+          time = Time.now.to_i
+          claim_nbf = double("claim_nbf")
+          allow(subject).to receive(:apply_nbf_grace_period)
+            .with(claim_nbf)
+            .and_return(time - 100)
+
+          expect(subject.send(:validate_claim_nbf!,
+                              time,
+                              claim_nbf)).to be_truthy
+        end
+
+        it "when time is less then raise error" do
+          time = Time.now.to_i
+          claim_nbf = double("claim_nbf")
+          msg = "Given DID token cannot be used at this time."
+          allow(subject).to receive(:apply_nbf_grace_period)
+            .with(claim_nbf)
+            .and_return(time + 100)
+
+          expect do
+            subject.send(:validate_claim_nbf!, time, claim_nbf)
+          end .to raise_error(MagicAdmin::DIDTokenError, msg)
+        end
+      end
+    end
+  end
+end

data/test/resource/user_test.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe MagicAdmin::Resource::User do
+  let(:magic) { Magic.new(api_secret_key: spec_api_secret_key) }
+  let(:public_address) do
+    MagicAdmin::Resource::Token.new.get_public_address(spec_did_token)
+  end
+
+  let(:issuer) do
+    MagicAdmin::Resource::Token.new.get_issuer(spec_did_token)
+  end
+
+  let(:construct_issuer_with_public_address) do
+    MagicAdmin::Resource::Token.new.construct_issuer_with_public_address(public_address)
+  end
+
+  let(:stub_response_body) do
+    { "data" => {}, "error_code" => "", "message" => "", "status" => "ok" }
+  end
+
+  subject { described_class.new(magic) }
+
+  it "present attr readers" do
+    expect(subject).to respond_to(:magic)
+  end
+
+  context "#get_metadata_by_issuer" do
+    it "send request with options" do
+      allow(MagicAdmin::Util).to receive(:headers)
+        .with(magic.secret_key)
+        .and_return({})
+      expect(magic.http_client).to receive(:call)
+        .with(:get,
+              "/v1/admin/auth/user/get",
+              {
+                params: { issuer: issuer }, headers: {}
+              })
+
+      subject.get_metadata_by_issuer(issuer)
+    end
+  end
+
+  context "#get_metadata_by_public_address" do
+    it "return response" do
+      url = "https://api.magic.link/v1/admin/auth/user/get?issuer="
+      url += construct_issuer_with_public_address
+      stub_request(:get, url)
+        .to_return(status: 200, body: stub_response_body.to_json, headers: {})
+      reps = subject.get_metadata_by_public_address(public_address)
+      expect(reps.status_code).to eq(200)
+    end
+  end
+
+  context "#get_metadata_by_token" do
+    it "return response" do
+      url = "https://api.magic.link/v1/admin/auth/user/get?issuer="
+      url += issuer
+      stub_request(:get, url)
+        .to_return(status: 200, body: stub_response_body.to_json, headers: {})
+      reps = subject.get_metadata_by_token(spec_did_token)
+
+      expect(reps.status_code).to eq(200)
+    end
+  end
+
+  context "#logout_by_issuer" do
+    it "return response" do
+      url = "https://api.magic.link/v2/admin/auth/user/logout"
+      stub_request(:post, url)
+        .to_return(status: 200, body: stub_response_body.to_json, headers: {})
+      reps = subject.logout_by_issuer(issuer)
+
+      expect(reps.status_code).to eq(200)
+    end
+  end
+
+  context "#logout_by_public_address" do
+    it "return response" do
+      url = "https://api.magic.link/v2/admin/auth/user/logout"
+      stub_request(:post, url)
+        .to_return(status: 200, body: stub_response_body.to_json, headers: {})
+      reps = subject.logout_by_public_address(public_address)
+      expect(reps.status_code).to eq(200)
+    end
+  end
+
+  context "#logout_by_token" do
+    it "return response" do
+      url = "https://api.magic.link/v2/admin/auth/user/logout"
+      stub_request(:post, url)
+        .to_return(status: 200, body: stub_response_body.to_json, headers: {})
+      reps = subject.logout_by_token(spec_did_token)
+      expect(reps.status_code).to eq(200)
+    end
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.start
+
+require "magic-admin"
+require "webmock/rspec"
+
+RSpec.configure do |config|
+  # Add custom RSpec configuration here
+end
+
+# Description:
+#   Method provide sample did_token for configure specs
+#
+# Returns:
+#   did_token
+#
+
+def spec_did_token
+  "WyIweHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDA"\
+  "wMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMH"\
+  "Rlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwMDAiLCJ7XCJpYXRcIjoxMjM0N"\
+  "TEyMzQ1LFwiZXh0XCI6MTIzNDUxMjM0NSxcImlzc1wiOlwiZGlkOmV0aHI6MHh0ZXN0"\
+  "MDAwMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwXCIsXCJzdWJcIjpcIjA"\
+  "wYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY3ODkwMDAwMDA9XCIsXCJhdW"\
+  "RcIjpcImRpZDptYWdpYzp0ZXN0dGVzdC10ZXN0LXRlc3QtdGVzdC10ZXN0dGVzdHRlc"\
+  "3RcIixcIm5iZlwiOjEyMzQ1MTIzNDUsXCJ0aWRcIjpcInRlc3R0ZXN0LXRlc3QtdGVz"\
+  "dC10ZXN0LXRlc3R0ZXN0dGVzdFwiLFwiYWRkXCI6XCIweDAwdGVzdDAwMDB0ZXN0MDA"\
+  "wMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMH"\
+  "Rlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc3QwMDAwdGVzdDAwMDB0ZXN0MDAwMHRlc"\
+  "3QwMDAwdGVzdDAwMDBcIn0iXQ=="
+end
+
+# Description:
+#   Method provide sample api_secret_key for configure specs
+#
+# Returns:
+#   api_secret_key
+#
+
+def spec_api_secret_key
+  "sk_test_TESTTESTTESTTEST"
+end
+

data/test/util_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe MagicAdmin::Util, type: :module do
+  context ".platform_info" do
+    it "return respond" do
+      expect(described_class.platform_info).to be_kind_of(Hash)
+    end
+
+    it "include keys" do
+      expect(described_class.platform_info).to include(:platform,
+                                                       :language,
+                                                       :language_version,
+                                                       :user_name)
+    end
+  end
+
+  context ".user_agent" do
+    it "return respond" do
+      expect(described_class.user_agent).to be_kind_of(Hash)
+    end
+
+    it "include keys" do
+      expect(described_class.user_agent).to include(:sdk_version,
+                                                    :publisher,
+                                                    :platform)
+    end
+  end
+
+  context ".headers" do
+    it "return respond" do
+      expect(described_class.headers(spec_api_secret_key)).to be_kind_of(Hash)
+    end
+
+    it "include keys" do
+      expect(described_class.headers(spec_api_secret_key)).to include(
+        :"content-type", :"X-Magic-Secret-Key", :"User-Agent"
+      )
+    end
+  end
+end

metadata

@@ -1,27 +1,144 @@
 --- !ruby/object:Gem::Specification
 name: magic-admin
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
-- Troll Goat
-autorequire: 
+- Magic Labs Inc.
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
-dependencies: []
-description: Magic
-email: arthur@fortmatic.com
-executables: []
+date: 2020-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: The Magic Admin Ruby provides convenient ways for developers to interact
+  with Magic API endpointsand an array of utilities to handle DID Token.
+email: support@magic.link
+executables:
+- magic-console
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/question.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/magic-console
 - lib/magic-admin.rb
-homepage: 
+- lib/magic-admin/config.rb
+- lib/magic-admin/errors.rb
+- lib/magic-admin/http/client.rb
+- lib/magic-admin/http/request.rb
+- lib/magic-admin/http/response.rb
+- lib/magic-admin/resource/token.rb
+- lib/magic-admin/resource/user.rb
+- lib/magic-admin/util.rb
+- lib/magic-admin/version.rb
+- magic-admin.gemspec
+- test/http/client_test.rb
+- test/http/request_test.rb
+- test/http/response_test.rb
+- test/magic_test.rb
+- test/resource/token_test.rb
+- test/resource/user_test.rb
+- test/spec_helper.rb
+- test/util_test.rb
+homepage: https://docs.magic.link/admin-sdk/ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -29,15 +146,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Magic
-test_files: []
+summary: Ruby bindings for the Magic Admin API
+test_files:
+- test/http/client_test.rb
+- test/http/request_test.rb
+- test/http/response_test.rb
+- test/magic_test.rb
+- test/resource/token_test.rb
+- test/resource/user_test.rb
+- test/spec_helper.rb
+- test/util_test.rb