altcha 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec9e3706caf746807ebb7349d3ab202eb6601b9fed628fe6b5176c5a81ef6118
-  data.tar.gz: 6d6ddbb904cde1fed358bf6b36e11207c49604d0ecfed0646558c05f9d3e6ad0
+  metadata.gz: 26bd90d5f8f25ec3b565a8686fe424421326163149ce34e2fe94d9b335815394
+  data.tar.gz: d8a48c54a34721b77847b765c428b1068c1c6f611c4a133c5da6e77074c6e6c2
 SHA512:
-  metadata.gz: feed3cad4fe038420c0e1701751d362408b64ef61e3fcb2d09640dcfef9b4566e2b486a3b3ddb8710ec5c4303948cc63eda072032797d5d1def90bd011b22a14
-  data.tar.gz: cd3a752cdb06111293a949d31fcb5988080d69d779d9db735e2420d9fdf57e0bde82734c0fa38e253f7c46ef30ed16b2707cbe0f39cd664fd9a7fe2a41d2fa83
+  metadata.gz: 646c34c483cfbb68003e149b0ccf297d0b57072f6a1df6df3fbae555fd714a1a37dd3c8333e5dec61c024ef92655ba1983333b79984372775559291c2b635db0
+  data.tar.gz: 8670ab596f21009624bc1808fc7f952de9431df58a2752b5c2170d34fb8970d953550e35566bdfba7d383a27be09b17fbdecd6b4946becf7fd1b2eac49be98bf

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/Gemfile.lock

@@ -1,25 +1,13 @@
 PATH
   remote: .
   specs:
-    altcha (0.1.0)
+    altcha (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
     diff-lcs (1.5.1)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.25.1)
-    parser (3.3.4.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.8.1)
-    rainbow (3.1.1)
     rake (10.5.0)
-    regexp_parser (2.9.2)
-    rexml (3.3.4)
-      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -33,22 +21,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.65.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    ruby-progressbar (1.13.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-23
@@ -59,7 +31,6 @@ DEPENDENCIES
   bundler (~> 2.5)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 1.65)
 
 BUNDLED WITH
    2.5.11

data/README.md

@@ -17,7 +17,7 @@ This library is compatible with:
 To install the ALTCHA Ruby Library, add it to your Gemfile:
 
 ```ruby
-gem 'altcha', git: 'https://github.com/altcha-org/altcha-lib-rb'
+gem 'altcha'
 ```
 
 Then run:
@@ -42,10 +42,10 @@ require 'altcha'
 hmac_key = 'secret hmac key'
 
 # Create a new challenge
-options = Altcha::ChallengeOptions.new.tap do |opts|
-  opts.hmac_key = hmac_key
-  opts.max_number = 100000 # the maximum random number
-end
+options = Altcha::ChallengeOptions.new(
+  hmac_key: hmac_key,
+  max_number: 100000 # the maximum random number
+)
 
 challenge = Altcha.create_challenge(options)
 

data/lib/altcha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Altcha
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/altcha.rb

@@ -23,12 +23,31 @@ module Altcha
   # Class representing options for generating a challenge.
   class ChallengeOptions
     attr_accessor :algorithm, :max_number, :salt_length, :hmac_key, :salt, :number, :expires, :params
+
+    def initialize(algorithm: nil, max_number: nil, salt_length: nil, hmac_key:, salt: nil, number: nil, expires: nil, params: nil)
+      @algorithm = algorithm
+      @max_number = max_number
+      @salt_length = salt_length
+      @hmac_key = hmac_key
+      @salt = salt
+      @number = number
+      @expires = expires
+      @params = params
+    end
   end
 
   # Class representing a challenge with its attributes.
   class Challenge
     attr_accessor :algorithm, :challenge, :maxnumber, :salt, :signature
 
+    def initialize(algorithm:, challenge:, maxnumber: nil, salt:, signature:)
+      @algorithm = algorithm
+      @challenge = challenge
+      @maxnumber = maxnumber
+      @salt = salt
+      @signature = signature
+    end
+
     # Converts the Challenge object to a JSON string.
     # @param options [Hash] options to customize JSON encoding.
     # @return [String] JSON representation of the Challenge object.
@@ -41,20 +60,20 @@ module Altcha
         signature: @signature
       }.to_json(options)
     end
-
-    # Creates a Challenge object from a JSON string.
-    # @param string [String] JSON string to parse.
-    # @return [Challenge] Parsed Challenge object.
-    def from_json(string)
-      data = JSON.parse(string)
-      new data['algorithm'], data['challenge'], data['maxnumber'], data['salt'], data['signature']
-    end
   end
 
   # Class representing the payload of a challenge.
   class Payload
     attr_accessor :algorithm, :challenge, :number, :salt, :signature
 
+    def initialize(algorithm:, challenge:, number:, salt:, signature:)
+      @algorithm = algorithm
+      @challenge = challenge
+      @number = number
+      @salt = salt
+      @signature = signature
+    end
+
     # Converts the Payload object to a JSON string.
     # @param options [Hash] options to customize JSON encoding.
     # @return [String] JSON representation of the Payload object.
@@ -71,9 +90,15 @@ module Altcha
     # Creates a Payload object from a JSON string.
     # @param string [String] JSON string to parse.
     # @return [Payload] Parsed Payload object.
-    def from_json(string)
+    def self.from_json(string)
       data = JSON.parse(string)
-      new data['algorithm'], data['verificationData'], data['signature'], data['verified']
+      new(
+        algorithm: data['algorithm'],
+        challenge: data['challenge'],
+        number: data['number'],
+        salt: data['salt'],
+        signature: data['signature']
+      )
     end
   end
 
@@ -81,6 +106,13 @@ module Altcha
   class ServerSignaturePayload
     attr_accessor :algorithm, :verification_data, :signature, :verified
 
+    def initialize(algorithm:, verification_data:, signature:, verified:)
+      @algorithm = algorithm
+      @verification_data = verification_data
+      @signature = signature
+      @verified = verified
+    end
+
     # Converts the ServerSignaturePayload object to a JSON string.
     # @param options [Hash] options to customize JSON encoding.
     # @return [String] JSON representation of the ServerSignaturePayload object.
@@ -96,9 +128,14 @@ module Altcha
     # Creates a ServerSignaturePayload object from a JSON string.
     # @param string [String] JSON string to parse.
     # @return [ServerSignaturePayload] Parsed ServerSignaturePayload object.
-    def from_json(string)
+    def self.from_json(string)
       data = JSON.parse(string)
-      new data['algorithm'], data['verificationData'], data['signature'], data['verified']
+      new(
+        algorithm: data['algorithm'],
+        verification_data: data['verificationData'],
+        signature: data['signature'],
+        verified: data['verified']
+      )
     end
   end
 
@@ -106,6 +143,26 @@ module Altcha
   class ServerSignatureVerificationData
     attr_accessor :classification, :country, :detected_language, :email, :expire, :fields, :fields_hash,
                   :ip_address, :reasons, :score, :time, :verified
+
+    # Converts the ServerSignatureVerificationData object to a JSON string.
+    # @param options [Hash] options to customize JSON encoding.
+    # @return [String] JSON representation of the ServerSignatureVerificationData object.
+    def to_json(options = {})
+      {
+        classification: @classification,
+        country: @country,
+        detectedLanguage: @detected_language,
+        email: @email,
+        expire: @expire,
+        fields: @fields,
+        fieldsHash: @fields_hash,
+        ipAddress: @ip_address,
+        reasons: @reasons,
+        score: @score,
+        time: @time,
+        verified: @verified
+      }.to_json(options)
+    end
   end
 
   # Class representing the solution to a challenge.
@@ -204,13 +261,13 @@ module Altcha
     challenge = hash_hex(algorithm, challenge_str)
     signature = hmac_hex(algorithm, challenge, options.hmac_key)
 
-    Challenge.new.tap do |c|
-      c.algorithm = algorithm
-      c.challenge = challenge
-      c.maxnumber = max_number
-      c.salt = salt
-      c.signature = signature
-    end
+    Challenge.new(
+      algorithm: algorithm,
+      challenge: challenge,
+      maxnumber: max_number,
+      salt: salt,
+      signature: signature,
+    )
   end
 
   # Verifies the solution provided by the client.
@@ -224,7 +281,17 @@ module Altcha
     # Decode and parse base64 JSON string if it's a String
     if payload.is_a?(String)
       decoded_payload = Base64.decode64(payload)
-      payload = JSON.parse(decoded_payload, object_class: Payload)
+      payload = Payload.from_json(decoded_payload)
+    
+    # Convert payload from hash to Payload if it's a plain object
+    elsif payload.is_a?(Hash)
+      payload = Payload.new(
+        algorithm: payload[:algorithm],
+        challenge: payload[:challenge],
+        number: payload[:number],
+        salt: payload[:salt],
+        signature: payload[:signature]
+      )
     end
 
     # Ensure payload is an instance of Payload
@@ -243,12 +310,12 @@ module Altcha
     end
 
     # Convert payload to ChallengeOptions
-    challenge_options = ChallengeOptions.new.tap do |co|
-      co.algorithm = payload.algorithm
-      co.hmac_key = hmac_key
-      co.number = payload.number
-      co.salt = payload.salt
-    end
+    challenge_options = ChallengeOptions.new(
+      algorithm: payload.algorithm,
+      hmac_key: hmac_key,
+      number: payload.number,
+      salt: payload.salt
+    )
 
     # Create expected challenge and compare with the provided payload
     expected_challenge = create_challenge(challenge_options)
@@ -272,7 +339,7 @@ module Altcha
   # @param algorithm [String] The hashing algorithm to use.
   # @return [Boolean] True if the fields hash matches, false otherwise.
   def self.verify_fields_hash(form_data, fields, fields_hash, algorithm)
-    lines = fields.map { |field| form_data[field].to_a.first.to_s }
+    lines = fields.map { |field| form_data[field].to_s }
     joined_data = lines.join("\n")
     computed_hash = hash_hex(algorithm, joined_data)
     computed_hash == fields_hash
@@ -286,7 +353,16 @@ module Altcha
     # Decode and parse base64 JSON string if it's a String
     if payload.is_a?(String)
       decoded_payload = Base64.decode64(payload)
-      payload = JSON.parse(decoded_payload, object_class: ServerSignaturePayload)
+      payload = ServerSignaturePayload.from_json(decoded_payload)
+
+    # Convert payload from hash to ServerSignaturePayload if it's a plain object
+    elsif payload.is_a?(Hash)
+      payload = ServerSignaturePayload.new(
+        algorithm: payload[:algorithm],
+        verification_data: payload[:verification_data],
+        signature: payload[:signature],
+        verified: payload[:verified]
+      )
     end
 
     # Ensure payload is an instance of ServerSignaturePayload
@@ -300,7 +376,7 @@ module Altcha
 
     hash_data = hash(payload.algorithm, payload.verification_data)
     expected_signature = hmac_hex(payload.algorithm, hash_data, hmac_key)
-
+    
     params = URI.decode_www_form(payload.verification_data).to_h
     verification_data = ServerSignatureVerificationData.new.tap do |v|
       v.classification = params['classification'] || nil
@@ -309,6 +385,8 @@ module Altcha
       v.email = params['email'] || nil
       v.expire = params['expire'] ? params['expire'].to_i : nil
       v.fields = params['fields'] ? params['fields'].split(',') : nil
+      v.fields_hash = params['fieldsHash'] || nil
+      v.ip_address = params['ipAddress'] || nil
       v.reasons = params['reasons'] ? params['reasons'].split(',') : nil
       v.score = params['score'] ? params['score'].to_f : nil
       v.time = params['time'] ? params['time'].to_i : nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altcha
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Regeci