passageidentity 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa261c90ca10b6232e6b70dc1e76ec98742f203852f2288db411390aaf8cd824
-  data.tar.gz: 195611e6726801ac07538472c70f438b71d43c667f56bfcf6bc9cb7dd1a8772b
+  metadata.gz: 04e31805b3eb522f8677f9c249abc99f8daf02f807fbe8855702b97656e0371b
+  data.tar.gz: 1d3e7b0d52b180bf880c0e988e035e6d393aaa856a3ff01b8c04b76567266950
 SHA512:
-  metadata.gz: aab149a0b1256d1dfe525d31915098a4a1c6b9b362ddb6c7be039ed9eec960c4b174ec42ffd65fe0f87117e472ec0359690752de371f60bf025ad01aac8c408e
-  data.tar.gz: 4c510ab7268ad4fd4cdef05c1769a5242a72e8238b3f807b6adf1592ab0118a5b0506c0aa6012af72b7d3c914c542f021395298082036a817ec60eb410ec41d7
+  metadata.gz: ea2498dd8f07d7a7f8bd5434635ef43e643611656bce4e71afa0a63d1eb4b29df1ed58b1bcd78e4dc348c8826b0ca16ba55f4ce37085b746685c0252be285195
+  data.tar.gz: f67a7631241795a30209c65caff48b624175bb5c181a0ac67b0c8cbba38e202c26d2c143d2d94a6e2436fcaae38cd0581a5d5323d4800aa613dddb3a75d33ce1

data/lib/passageidentity/auth.rb

@@ -19,8 +19,11 @@ module Passage
         response = @connection.get("/v1/apps/#{@app_id}")
         return response.body["app"]
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to get Passage App. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                message: "failed to fetch passage app",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
       end
     end
 
@@ -52,14 +55,16 @@ module Passage
       # Get the token based on the strategy
       if @auth_strategy === Passage::COOKIE_STRATEGY
         unless request.cookies["psg_auth_token"].present?
-          raise PassageError,
-                `missing authentication token: expected "psg_auth_token" cookie`
+          raise PassageError.new(
+                  message:
+                    `missing authentication token: expected "psg_auth_token" cookie`
+                )
         end
         @token = request.cookies["psg_auth_token"]
       else
         headers = request.headers
         unless headers["Authorization"].present?
-          raise PassageError, "no authentication token in header"
+          raise PassageError.new(message: "no authentication token in header")
         end
         @token = headers["Authorization"].split(" ").last
       end
@@ -68,7 +73,7 @@ module Passage
       if @token
         return authenticate_token(@token)
       else
-        raise PassageError, "no authentication token"
+        raise PassageError.new(message: "no authentication token")
       end
       nil
     end
@@ -98,15 +103,15 @@ module Passage
           )
         return claims[0]["sub"]
       rescue JWT::InvalidIssuerError => e
-        raise Passage::PassageError, e.message
+        raise PassageError.new(message: e.message)
       rescue JWT::InvalidAudError => e
-        raise Passage::PassageError, e.message
+        raise PassageError.new(e.message)
       rescue JWT::ExpiredSignature => e
-        raise Passage::PassageError, e.message
+        raise PassageError.new(e.message)
       rescue JWT::IncorrectAlgorithm => e
-        raise Passage::PassageError, e.message
+        raise PassageError.new(e.message)
       rescue JWT::DecodeError => e
-        raise Passage::PassageError, e.message
+        raise PassageError.new(e.message)
       end
     end
   end

data/lib/passageidentity/client.rb

@@ -3,6 +3,7 @@
 require_relative "auth"
 require_relative "user_api"
 require_relative "error"
+require "rubygems"
 
 module Passage
   App =
@@ -77,7 +78,7 @@ module Passage
 
       # check for valid auth strategy
       unless [COOKIE_STRATEGY, HEADER_STRATEGY].include? auth_strategy
-        raise PassageError, "invalid auth strategy."
+        raise PassageError.new(message: "invalid auth strategy.")
       end
       @auth_strategy = auth_strategy
 
@@ -92,30 +93,19 @@ module Passage
     end
 
     def get_connection
-      if @api_key == ""
-        @connection =
-          Faraday.new(url: @api_url) do |f|
-            f.request :json
-            f.request :retry
-            f.response :raise_error
-            f.response :json
-            f.adapter :net_http
-          end
-      else
-        @connection =
-          Faraday.new(
-            url: @api_url,
-            headers: {
-              "Authorization" => "Bearer #{@api_key}"
-            }
-          ) do |f|
-            f.request :json
-            f.request :retry
-            f.response :raise_error
-            f.response :json
-            f.adapter :net_http
-          end
-      end
+      gemspec = File.join(__dir__, "../../passageidentity.gemspec")
+      spec = Gem::Specification.load(gemspec)
+      headers = { "Passage-Version" => "passage-ruby #{spec.version}" }
+      headers["Authorization"] = "Bearer #{@api_key}" if @api_key != ""
+
+      @connection =
+        Faraday.new(url: @api_url, headers: headers) do |f|
+          f.request :json
+          f.request :retry
+          f.response :raise_error
+          f.response :json
+          f.adapter :net_http
+        end
     end
 
     def get_app()
@@ -165,8 +155,10 @@ module Passage
 
       # check to see if the channel specified is valid before sending it off to the server
       unless [PHONE_CHANNEL, EMAIL_CHANNEL].include? channel
-        raise PassageError,
-              "channel: must be either Passage::EMAIL_CHANNEL or Passage::PHONE_CHANNEL"
+        raise PassageError.new(
+                message:
+                  "channel: must be either Passage::EMAIL_CHANNEL or Passage::PHONE_CHANNEL"
+              )
       end
       magic_link_req["channel"] = channel unless channel.empty?
       magic_link_req["send"] = send
@@ -195,8 +187,11 @@ module Passage
           )
         )
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to create Passage Magic Link. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                message: "failed to create Passage Magic Link",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
       end
     end
   end

data/lib/passageidentity/error.rb

@@ -1,4 +1,24 @@
+require "net/http"
+
 module Passage
   class PassageError < StandardError
+    attr_reader :status_code
+    attr_reader :status_text
+    attr_reader :message
+    attr_reader :error
+
+    def initialize(message:, status_code: nil, body: nil)
+      @message = message
+      @status_code = status_code
+      @status_text =
+        (
+          if status_code.nil?
+            nil
+          else
+            Net::HTTPResponse::CODE_TO_OBJ[status_code.to_s]
+          end
+        )
+      @error = body.nil? ? nil : body["error"]
+    end
   end
 end

data/lib/passageidentity/user_api.rb

@@ -10,7 +10,8 @@ module Passage
     end
 
     def get(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       begin
         response = @connection.get("/v1/apps/#{@app_id}/users/#{user_id}")
         user = response.body["user"]
@@ -35,17 +36,24 @@ module Passage
         )
       rescue Faraday::Error => e
         if e.is_a? Faraday::ResourceNotFound
-          raise PassageError,
-                "passage User with ID \"#{user_id}\" does not exist"
+          raise PassageError.new(
+                  message: "Passage User with ID \"#{user_id}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         else
-          raise PassageError,
-                "failed to get Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+          raise PassageError.new(
+                  message: "failed to get Passage User.",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         end
       end
     end
 
     def activate(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       begin
         response =
           @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/activate")
@@ -70,17 +78,24 @@ module Passage
         )
       rescue Faraday::Error => e
         if e.is_a? Faraday::ResourceNotFound
-          raise PassageError,
-                "passage User with ID \"#{user_id}\" does not exist"
+          raise PassageError.new(
+                  message: "Passage User with ID \"#{user_id}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         else
-          raise PassageError,
-                "failed to activate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+          raise PassageError.new(
+                  message: "failed to activate Passage User.",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         end
       end
     end
 
     def deactivate(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       begin
         response =
           @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/deactivate")
@@ -105,17 +120,24 @@ module Passage
         )
       rescue Faraday::Error => e
         if e.is_a? Faraday::ResourceNotFound
-          raise PassageError,
-                "passage User with ID \"#{user_id}\" does not exist"
+          raise PassageError.new(
+                  message: "Passage User with ID \"#{user_id}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         else
-          raise PassageError,
-                "failed to deactivate Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+          raise PassageError.new(
+                  message: "failed to deactivate Passage User.",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         end
       end
     end
 
     def update(user_id:, email: "", phone: "", user_metadata: {})
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       updates = {}
       updates["email"] = email unless email.empty?
       updates["phone"] = phone unless phone.empty?
@@ -144,11 +166,17 @@ module Passage
         )
       rescue Faraday::Error => e
         if e.is_a? Faraday::ResourceNotFound
-          raise PassageError,
-                "passage User with ID \"#{user_id}\" does not exist"
+          raise PassageError.new(
+                  message: "Passage User with ID \"#{user_id}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         else
-          raise PassageError,
-                "failed to update Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+          raise PassageError.new(
+                  "failed to update Passage User",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         end
       end
     end
@@ -180,32 +208,41 @@ module Passage
           )
         )
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to create Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                "failed to create Passage User",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
       end
     end
 
     def delete(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       begin
         response = @connection.delete("/v1/apps/#{@app_id}/users/#{user_id}")
         return true
       rescue Faraday::Error => e
         if e.is_a? Faraday::ResourceNotFound
-          raise PassageError,
-                "passage User with ID \"#{user_id}\" does not exist"
+          raise PassageError.new(
+                  "passage User with ID \"#{user_id}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         else
-          raise PassageError,
-                "failed to delete Passage User. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+          raise PassageError.new(
+                  "failed to delete Passage User",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
         end
       end
     end
 
     def delete_device(user_id:, device_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
-      if device_id.to_s.empty?
-        raise PassageError, "must supply a valid device_id"
-      end
+      user_exists?(user_id)
+      device_exists?(device_id)
+
       begin
         response =
           @connection.delete(
@@ -213,13 +250,17 @@ module Passage
           )
         return true
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                "failed to delete Passage User Device",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
       end
     end
 
     def list_devices(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
+
       begin
         response =
           @connection.get("/v1/apps/#{@app_id}/users/#{user_id}/devices")
@@ -240,20 +281,40 @@ module Passage
         end
         return devices
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to delete Passage User Device. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                "failed to delete Passage User Device",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
       end
     end
 
     def signout(user_id:)
-      raise PassageError, "must supply a valid user_id" if user_id.to_s.empty?
+      user_exists?(user_id)
       begin
         response =
           @connection.delete("/v1/apps/#{@app_id}/users/#{user_id}/tokens/")
         return true
       rescue Faraday::Error => e
-        raise PassageError,
-              "failed to revoke user's refresh tokens. Http Status: #{e.response[:status]}. Response: #{e.response[:body]["error"]}"
+        raise PassageError.new(
+                "failed to revoke user's refresh tokens",
+                status_code: e.response[:status],
+                body: e.response[:body]
+              )
+      end
+    end
+
+    private
+
+    def user_exists?(user_id)
+      if user_id.to_s.empty?
+        raise PassageError.new(message: "must supply a valid user_id")
+      end
+    end
+
+    def device_exists?(device_id)
+      if device_id.to_s.empty?
+        raise PassageError.new(message: "must supply a valid device_id")
       end
     end
   end

data/passageidentity.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'passageidentity'
-  s.version = '0.1.2'
+  s.version = '0.2.1'
   s.summary = 'Passage SDK for biometric authentication'
   s.description =
     'Enables verification of server-side authentication and user management for applications using Passage'

data/tests/errors_test.rb

@@ -0,0 +1,30 @@
+require_relative "../lib/passageidentity/error"
+require "test/unit"
+require "net/http"
+
+class ErrorTest < Test::Unit::TestCase
+  def test_initialize
+    body = { "error" => "some error" }
+
+    error =
+      Passage::PassageError.new(
+        message: "some message",
+        status_code: 400,
+        body: body
+      )
+
+    assert_equal error.message, "some message"
+    assert_equal error.error, "some error"
+    assert_equal error.status_code, 400
+    assert_equal error.status_text, Net::HTTPBadRequest
+  end
+
+  def test_initialize_message_only
+    error = Passage::PassageError.new(message: "some message")
+
+    assert_equal error.message, "some message"
+    assert_equal error.error, nil
+    assert_equal error.status_code, nil
+    assert_equal error.status_text, nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Passage Identity
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,7 @@ files:
 - tests/all.rb
 - tests/app_test.rb
 - tests/auth_test.rb
+- tests/errors_test.rb
 - tests/magic_link_test.rb
 - tests/user_api_test.rb
 homepage: https://rubygems.org/gems/passageidentity