jamm 1.0.12 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c2a575430d09f4af5bb3e2bf4053a8d4da34b3d14a4184ca18c352e17dae8de
-  data.tar.gz: c8288eb2af176ac471c6fbf76703c5defd444884bfe1061b495f2693f755b6cf
+  metadata.gz: fb43fe917ff242848502e64259836ae383f513b554bbb317c1581ac39b785f4c
+  data.tar.gz: d339b72e1412de5e5f7b64f23161433e29f1ce1e1bc7731bba76b0a81346a6a2
 SHA512:
-  metadata.gz: 33e200888db947536f6c81f0e7797784c6fcc9fd0c18cfb5cbedf22fe6717506aa15179532de2c003eaae24ca14783928523352554039b007092659f8e9923de
-  data.tar.gz: cc2dd1e86449dd40b5e601f7f2035500d1c0ead077024c79bb024d0973d64edc2f966c18af23045e90aec023dfeb411c07adc313f0d03350ca00d47428f7a173
+  metadata.gz: 6d7a6c70ccffc34ce75af7f3980bd1c56a297c67ee9b0c6b65d68a3d25b7d6b5cd74c089cd6c8b111cd62a3119ae165d26d5a686f8607b49869059ba60c4a563
+  data.tar.gz: 78b7b71a1f7dbddbb96f0de0f244fc6d7af2d113a474bbb949c6df00fc1fb0590472c5292b78184932985d63c43e5fa286196fbc2820e12388a4e3504c88d933

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jamm (1.0.12)
+    jamm (1.1.0)
       rest-client (~> 2.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/lib/jamm/api/models/v1_buyer.rb

@@ -22,6 +22,9 @@ module Api
     # A flag whether Jamm to force KYC for the customer.  初回購入時に購入者に対してKYCを強制するかどうかのフラグです。
     attr_accessor :force_kyc
 
+    # Phone number of the customer. You can update this value later through the UpdateCustomer endpoint.  e.g. - 09012345678  Customerの電話番号。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。
+    attr_accessor :phone
+
     # Name of the customer. You can update this value later through the UpdateCustomer endpoint.  e.g. - John Appleseed - 山田太郎  購入者の氏名。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。
     attr_accessor :name
 
@@ -51,6 +54,7 @@ module Api
       {
         :email => :email,
         :force_kyc => :forceKyc,
+        :phone => :phone,
         :name => :name,
         :katakana_last_name => :katakanaLastName,
         :katakana_first_name => :katakanaFirstName,
@@ -72,6 +76,7 @@ module Api
       {
         :email => :String,
         :force_kyc => :Boolean,
+        :phone => :String,
         :name => :String,
         :katakana_last_name => :String,
         :katakana_first_name => :String,
@@ -104,6 +109,8 @@ module Api
 
       self.force_kyc = attributes[:force_kyc] if attributes.key?(:force_kyc)
 
+      self.phone = attributes[:phone] if attributes.key?(:phone)
+
       self.name = attributes[:name] if attributes.key?(:name)
 
       self.katakana_last_name = attributes[:katakana_last_name] if attributes.key?(:katakana_last_name)
@@ -146,6 +153,7 @@ module Api
       self.class == other.class &&
         email == other.email &&
         force_kyc == other.force_kyc &&
+        phone == other.phone &&
         name == other.name &&
         katakana_last_name == other.katakana_last_name &&
         katakana_first_name == other.katakana_first_name &&
@@ -165,7 +173,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, force_kyc, name, katakana_last_name, katakana_first_name, address, birth_date, gender, expires_at, metadata].hash
+      [email, force_kyc, phone, name, katakana_last_name, katakana_first_name, address, birth_date, gender, expires_at, metadata].hash
     end
 
     # Builds the object from hash

data/lib/jamm/api/models/v1_charge.rb

@@ -16,7 +16,7 @@ require 'time'
 module Api
   # Charge represents a charge information for the customer.
   class Charge
-    # 決済ID (例: chg-1234567890)  @gotags: validate:\"required\"
+    # 決済ID (例: trx-1234567890)  @gotags: validate:\"required\"
     attr_accessor :id
 
     # Amount of the charge in Japanese Yen. The amount must be the total price of the product/service including tax.  決済金額。日本円で指定してください。 金額は商品/サービスの合計金額 (税込) を指定してください。  @gotags: validate:\"gte=1,lte=500000\"

data/lib/jamm/api/models/v1_charge_message_status.rb

@@ -20,9 +20,10 @@ module Api
     FAILURE = 'STATUS_FAILURE'
     WAITING_EKYC = 'STATUS_WAITING_EKYC'
     BLOCKING = 'STATUS_BLOCKING'
+    CANCELLED = 'STATUS_CANCELLED'
 
     def self.all_vars
-      @all_vars ||= [UNSPECIFIED, SUCCESS, FAILURE, WAITING_EKYC, BLOCKING].freeze
+      @all_vars ||= [UNSPECIFIED, SUCCESS, FAILURE, WAITING_EKYC, BLOCKING, CANCELLED].freeze
     end
 
     # Builds the enum from string

data/lib/jamm/api/models/v1_customer.rb

@@ -16,14 +16,13 @@ require 'time'
 module Api
   # Customer object.
   class Customer
-    attr_accessor :id, :email, :ekyc_completed, :activated, :created_at, :updated_at
+    attr_accessor :id, :email, :activated, :created_at, :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :id => :id,
         :email => :email,
-        :ekyc_completed => :ekycCompleted,
         :activated => :activated,
         :created_at => :createdAt,
         :updated_at => :updatedAt
@@ -40,7 +39,6 @@ module Api
       {
         :id => :String,
         :email => :String,
-        :ekyc_completed => :Boolean,
         :activated => :Boolean,
         :created_at => :Time,
         :updated_at => :Time
@@ -68,8 +66,6 @@ module Api
 
       self.email = attributes[:email] if attributes.key?(:email)
 
-      self.ekyc_completed = attributes[:ekyc_completed] if attributes.key?(:ekyc_completed)
-
       self.activated = attributes[:activated] if attributes.key?(:activated)
 
       self.created_at = attributes[:created_at] if attributes.key?(:created_at)
@@ -101,7 +97,6 @@ module Api
       self.class == other.class &&
         id == other.id &&
         email == other.email &&
-        ekyc_completed == other.ekyc_completed &&
         activated == other.activated &&
         created_at == other.created_at &&
         updated_at == other.updated_at
@@ -116,7 +111,7 @@ module Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, ekyc_completed, activated, created_at, updated_at].hash
+      [id, email, activated, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/jamm/api/models/v1_event_type.rb

@@ -20,11 +20,12 @@ module Api
     CHARGE_UPDATED = 'EVENT_TYPE_CHARGE_UPDATED'
     CHARGE_SUCCESS = 'EVENT_TYPE_CHARGE_SUCCESS'
     CHARGE_FAIL = 'EVENT_TYPE_CHARGE_FAIL'
+    CHARGE_CANCEL = 'EVENT_TYPE_CHARGE_CANCEL'
     CONTRACT_ACTIVATED = 'EVENT_TYPE_CONTRACT_ACTIVATED'
     TESTING = 'EVENT_TYPE_TESTING'
 
     def self.all_vars
-      @all_vars ||= [UNSPECIFIED, CHARGE_CREATED, CHARGE_UPDATED, CHARGE_SUCCESS, CHARGE_FAIL, CONTRACT_ACTIVATED, TESTING].freeze
+      @all_vars ||= [UNSPECIFIED, CHARGE_CREATED, CHARGE_UPDATED, CHARGE_SUCCESS, CHARGE_FAIL, CHARGE_CANCEL, CONTRACT_ACTIVATED, TESTING].freeze
     end
 
     # Builds the enum from string

data/lib/jamm/charge.rb

@@ -15,6 +15,8 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).add_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.create_without_redirect(customer:, charge:)
@@ -24,12 +26,16 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).withdraw(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(charge_id)
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).get_charge(charge_id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if e.code == 404
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.list(customer:, pagination: nil)

data/lib/jamm/contract.rb

@@ -15,6 +15,8 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).create_contract_with_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.create_without_charge(buyer:, redirect:)
@@ -24,12 +26,14 @@ module Jamm
       )
 
       Jamm::OpenAPI::PaymentApi.new(Jamm::Client.handler).create_contract_without_charge(request)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(customer_id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).get_contract(customer_id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      [404].include?(e.code) ? nil : Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/customer.rb

@@ -14,6 +14,8 @@ module Jamm
       )
 
       r.customer
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get(id_or_email)
@@ -27,23 +29,31 @@ module Jamm
 
       r.customer
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if [404].include?(e.code)
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.get_contract(id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).get_contract(id)
     rescue Jamm::OpenAPI::ApiError => e
-      [404].include?(e.code) ? nil : raise
+      return nil if [404].include?(e.code)
+
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.update(id, params)
       r = Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).update(id, params)
 
       r.customer
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
 
     def self.delete(id)
       Jamm::OpenAPI::CustomerApi.new(Jamm::Client.handler).delete(id)
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/errors.rb

@@ -23,4 +23,98 @@ module Jamm
   # OAuthError is raised when a request to AWS cognito failed
   class OAuthError < JammError
   end
+
+  class InvalidSignatureError < StandardError
+  end
+
+  # Purpose of this error handler is to normalize Jamm's custom error
+  # and OpenAPI's generated error, and enforce Jamm's custom error format.
+  #
+  # - Jamm:    code is string, message is string originating from Jamm's protobuf definition.
+  # - OpenAPI: code is integer, message is string originating from ConnectRPC error format.
+  class ApiError < StandardError
+    attr_reader :code, :error_code, :message, :headers, :body
+
+    # Add this class method to convert StandardError to ApiError
+    def self.from_error(e)
+      new(
+        code: e.code,
+        message: e.message,
+        response_headers: e.response_headers,
+        response_body: e.response_body
+      )
+    end
+
+    def initialize(args = {})
+      # Check code existence and convert to string if it's integer
+      @code = args[:code]
+      @message = args[:message]
+      @headers = args[:response_headers]
+
+      raw_body = if args[:response_body].nil?
+                   {}
+                 elsif args[:response_body].is_a?(Hash)
+                   args[:response_body]
+                 elsif args[:response_body].is_a?(String)
+                   begin
+                     JSON.parse(args[:response_body])
+                   rescue StandardError
+                     {}
+                   end
+                 else
+                   {}
+                 end
+
+      @body = {}
+      raw_body.each do |k, v|
+        next if k == 'code'
+
+        @body[k.to_sym] = v if k.respond_to?(:to_sym)
+      end
+
+      # Set human readable error type based on error code
+      # https://github.com/connectrpc/connect-go/blob/d7c0966751650b41a9f1794513592e81b9beed45/code.go#L34
+      @body[:error] = case raw_body['code']
+                      when 1
+                        'CANCELED'
+                      when 2
+                        'UNKNOWN'
+                      when 3
+                        'INVALID_ARGUMENT'
+                      when 4
+                        'DEADLINE_EXCEEDED'
+                      when 5
+                        'NOT_FOUND'
+                      when 6
+                        'ALREADY_EXISTS'
+                      when 7
+                        'PERMISSION_DENIED'
+                      when 8
+                        'RESOURCE_EXHAUSTED'
+                      when 9
+                        'FAILED_PRECONDITION'
+                      when 10
+                        'ABORTED'
+                      when 11
+                        'OUT_OF_RANGE'
+                      when 12
+                        'UNIMPLEMENTED'
+                      when 13
+                        'INTERNAL'
+                      when 14
+                        'UNAVAILABLE'
+                      when 15
+                        'DATA_LOSS'
+                      when 16
+                        'UNAUTHENTICATED'
+                      end
+
+      super(message)
+    end
+
+    def to_s
+      status_string = @code.nil? ? '' : "(Status #{@code}) "
+      "#{status_string}#{@message}"
+    end
+  end
 end

data/lib/jamm/healthcheck.rb

@@ -9,6 +9,8 @@ module Jamm
   module Healthcheck
     def self.ping
       Jamm::OpenAPI::HealthcheckApi.new(Jamm::Client.handler).ping
+    rescue Jamm::OpenAPI::ApiError => e
+      raise Jamm::ApiError.from_error(e)
     end
   end
 end

data/lib/jamm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jamm
-  VERSION = '1.0.12'
+  VERSION = '1.1.0'
 end

data/lib/jamm/webhook.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'openssl'
 require 'rest-client'
 require 'json'
 require 'base64'
@@ -10,37 +11,67 @@ module Jamm
     # Parse command is for parsing the received webhook message.
     # It does not call anything remotely, instead returns the suitable object.
     def self.parse(json)
-      out = {
-        id: json[:id],
-        signature: json[:signature],
-        event_type: json[:event_type],
-        content: nil,
-        created_at: json[:created_at]
-      }
+      out = Jamm::OpenAPI::MerchantWebhookMessage.new(json)
 
       case json[:event_type]
       when Jamm::OpenAPI::EventType::CHARGE_CREATED
-        out[:content] = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
       when Jamm::OpenAPI::EventType::CHARGE_UPDATED
-        out[:content] = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        return out
+
+      when Jamm::OpenAPI::EventType::CHARGE_CANCEL
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
       when Jamm::OpenAPI::EventType::CHARGE_SUCCESS
-        out[:content] = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
       when Jamm::OpenAPI::EventType::CHARGE_FAIL
-        out[:content] = Jamm::OpenAPI::ChargeMessage.new(json[:content])
+        out.content = Jamm::OpenAPI::ChargeMessage.new(json[:content])
         return out
 
       when Jamm::OpenAPI::EventType::CONTRACT_ACTIVATED
-        out[:content] = Jamm::OpenAPI::ContractMessage.new(json[:content])
+        out.content = Jamm::OpenAPI::ContractMessage.new(json[:content])
         return out
       end
 
       raise 'Unknown event type'
     end
+
+    # Verify message
+    def self.verify(data:, signature:)
+      raise ArgumentError, 'data cannot be nil' if data.nil?
+      raise ArgumentError, 'signature cannot be nil' if signature.nil?
+
+      # Convert the JSON to a string
+      json = JSON.dump(data)
+
+      digest = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), Jamm.client_secret, json)
+      given = "sha256=#{digest}"
+
+      return if secure_compare(given, signature)
+
+      raise Jamm::InvalidSignatureError, 'Digests do not match'
+    end
+
+    # Securely compare two strings of equal length.
+    # This method is a port of ActiveSupport::SecurityUtils.secure_compare
+    # which works on non-Rails platforms.
+    def self.secure_compare(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      # Unpack strings into arrays of bytes
+      a_bytes = a.unpack('C*')
+      b_bytes = b.unpack('C*')
+      result = 0
+
+      # XOR each byte and accumulate the result
+      a_bytes.zip(b_bytes) { |x, y| result |= x ^ y }
+      result.zero?
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jamm
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.1.0
 platform: ruby
 authors:
 - Jamm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client