voucherify 8.1.1 → 8.2.0

data/__tests__/LOYALTY_V2_COVERAGE.md

@@ -0,0 +1,161 @@
+# Loyalty v2 e2e coverage (Ruby SDK)
+
+Migration map for a future release that publishes admin Loyalty v2 operations on the Ruby SDK. Until then, unpublished admin setup uses `Net::HTTP` in `loyalty_v2_http.rb`; member and runtime flows use generated `LV2*Api` clients.
+
+`npm run generate-sdk-ruby` deletes `lib/`, `docs/`, and root `spec/`. E2e lives only under `__tests__/`, so this file and the suite survive regeneration.
+
+## Files
+
+| File | Role |
+|------|------|
+| `__tests__/spec/15_loyalty_v2_spec.rb` | RSpec suite |
+| `__tests__/lib/loyalty_v2_fixture.rb` | Setup / teardown orchestration |
+| `__tests__/lib/loyalty_v2_http.rb` | Authenticated `Net::HTTP` helper for unpublished admin paths |
+| `__tests__/lib/config.rb` | Credentials + `LV2*Api` helpers |
+| `__tests__/LOYALTY_V2_COVERAGE.md` | This map |
+
+## Depth legend
+
+| Depth | Meaning |
+|-------|---------|
+| **setup only** | Called from the fixture; no dedicated example assertion beyond setup ids |
+| **Smoke** | Call succeeds; body is present |
+| **Basic** | Smoke + field checks (status, id, list contains created id) |
+| **Flow** | Multi-step happy path |
+
+Do not add endpoints to `scripts/shared/get-take-list.ts` from this suite. When an operation is allowlisted later, switch the matching HTTP helper to the SDK method named below and drop the HTTP wrapper if unused.
+
+---
+
+## HTTP helpers → future SDK methods
+
+| Helper | Method + path | Why HTTP today | Future SDK (when allowlisted) | Depth |
+|--------|---------------|----------------|-------------------------------|-------|
+| `create_program` | `POST /v2/loyalties/programs` | Not on allowlist | Programs create API (e.g. `LV2ProgramsApi#create_program`) | setup only |
+| `get_program` | `GET /v2/loyalties/programs/{programId}` | Not on allowlist | `LV2ProgramsApi#get_program` | unused in suite |
+| `update_program` | `PUT /v2/loyalties/programs/{programId}` | Not on allowlist | `LV2ProgramsApi#update_program` | unused in suite |
+| `activate_program` | `POST /v2/loyalties/programs/{programId}/activate` | Not on allowlist | `LV2ProgramsApi#activate_program` | setup only |
+| `deactivate_program` | `POST /v2/loyalties/programs/{programId}/deactivate` | Not on allowlist | `LV2ProgramsApi#deactivate_program` | setup only (teardown) |
+| `delete_program` | `DELETE /v2/loyalties/programs/{programId}` | Not on allowlist | `LV2ProgramsApi#delete_program` | setup only (teardown) |
+| `create_card_definition` | `POST /v2/loyalties/card-definitions` | Not on allowlist | Card definitions create API | setup only |
+| `activate_card_definition` | `POST /v2/loyalties/card-definitions/{id}/activate` | Not on allowlist | Card definitions activate API | setup only |
+| `draft_card_definition` | `POST /v2/loyalties/card-definitions/{id}/draft` | Not on allowlist | Card definitions draft API | unused (no deactivate path) |
+| `delete_card_definition` | `DELETE /v2/loyalties/card-definitions/{id}` | Not on allowlist | Card definitions delete API | setup only (teardown) |
+| `create_earning_rule` | `POST /v2/loyalties/earning-rules` | Not on allowlist | Earning rules create API | setup only |
+| `activate_earning_rule` | `POST /v2/loyalties/earning-rules/{id}/activate` | Not on allowlist | Earning rules activate API | setup only |
+| `deactivate_earning_rule` | `POST /v2/loyalties/earning-rules/{id}/deactivate` | Not on allowlist | Earning rules deactivate API | setup only (teardown) |
+| `delete_earning_rule` | `DELETE /v2/loyalties/earning-rules/{id}` | Not on allowlist | Earning rules delete API | setup only (teardown) |
+| `create_reward` | `POST /v2/loyalties/rewards` | Not on allowlist | Rewards create API | setup only |
+| `activate_reward` | `POST /v2/loyalties/rewards/{id}/activate` | Not on allowlist | Rewards activate API | setup only |
+| `deactivate_reward` | `POST /v2/loyalties/rewards/{id}/deactivate` | Not on allowlist | Rewards deactivate API | setup only (teardown) |
+| `delete_reward` | `DELETE /v2/loyalties/rewards/{id}` | Not on allowlist | Rewards delete API | setup only (teardown) |
+| `batch_assign_card_definitions` | `POST /v2/loyalties/programs/{id}/card-definitions/batch` | Not on allowlist | Program card-definitions batch API | setup only |
+| `batch_assign_earning_rules` | `POST /v2/loyalties/programs/{id}/earning-rules/batch` | Not on allowlist | Program earning-rules batch API | setup only |
+| `batch_assign_rewards` | `POST /v2/loyalties/programs/{id}/rewards/batch` | Not on allowlist | Program rewards batch API | setup only |
+
+Exact generated Ruby method names will follow OpenAPI operationIds once those paths are published; keep this table in sync when switching helpers.
+
+---
+
+## Covered via published SDK
+
+### Members (`LV2ProgramsApi`)
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `create_program_member` | Flow | Customer id identification |
+| `get_program_member` | Basic | Id match; cards present |
+| `list_program_members` | Basic | Created member in `data` |
+| `get_program_membership` | Smoke | Response present |
+| `activate_program_member` | Basic | Status `ACTIVE` |
+| `deactivate_program_member` | Basic | Status not `ACTIVE` |
+| `delete_program_member` | Smoke | Cleanup only |
+
+Not covered: batch create, update member, member activities.
+
+### Cards / points (`LV2ProgramsApi`)
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `adjust_card_points` | Flow | +100; poll until balance visible |
+| `list_card_transactions` | Basic | Non-empty after adjust |
+| `list_card_pending_points` | Smoke | Skipped activate/cancel when empty (`IMMEDIATE` pending) |
+
+Not covered: pending activate/cancel when buckets exist, expiring points, card activities.
+
+### Order payments (`LV2ProgramsApi` + `OrdersApi`)
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `OrdersApi#create_order` | Smoke | Fixture order |
+| `create_member_order_payment` | Flow | `DRY_RUN` + `CARD_BALANCE` |
+| `list_member_order_payments` | Smoke | Response present |
+
+Not covered: real `TRANSACTION` payments.
+
+### Reward purchases (`LV2ProgramsApi`)
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `purchase_member_reward` | Flow | Dry-run then `TRANSACTION` |
+| `list_member_reward_purchases` | Basic | Poll until `APPROVED` |
+| `refund_reward_purchase` | Flow | `policies.refund = ALLOW` |
+
+### Examine (`LV2ExamineApi`)
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `examine_earning_rules` | Smoke | Specific `customer.order.paid` |
+| `examine_rewards` | Smoke | Member id |
+
+### Reports (`LV2ProgramsApi`) — subset
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `list_program_members_summary_reports` | Smoke | Empty `data` is a pass |
+| `list_program_rewards_summary_reports` | Smoke | Same |
+| `list_program_members_daily_reports` | Smoke | `start_date` strictly before `end_date` |
+| `list_member_card_daily_reports` | Smoke | Same date rule |
+
+Not covered: other daily/summary report families.
+
+### Allowlisted GETs
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `LV2EarningRulesApi#get_earning_rule` | Basic | Fixture earning rule id |
+| `LV2RewardsApi#get_reward` | Basic | Fixture reward id |
+
+Not covered: `LV2BenefitsApi`, list program earning rules / rewards.
+
+### Customers
+
+| Method | Depth | Notes |
+|--------|-------|-------|
+| `CustomersApi#create_customer` | Smoke | Unique `source_id` |
+| permanent delete helper | Smoke | Cleanup; ignore 404 |
+
+---
+
+## Cleanup matrix
+
+1. SDK: deactivate member (if active) → delete member → delete customer (ignore 404).
+2. HTTP: deactivate + delete program (drops assignments).
+3. HTTP: deactivate + delete earning rule and reward.
+4. HTTP: delete card definitions last (423 if a non-draft program/reward still references them).
+
+Failed assertions still run `after(:all)` cleanup via `cleanup_loyalty_v2!`.
+
+## How to run
+
+From the OpenAPI repo root:
+
+```bash
+npm run test-ruby-sdk
+```
+
+Or in the Ruby image:
+
+```bash
+rspec ./spec/15_loyalty_v2_spec.rb
+```

data/__tests__/lib/config.rb

@@ -76,6 +76,26 @@ module Config
       return VoucherifySdk::VouchersApi.new()
     end
 
+    def self.lv2_programs_api_instance
+      return VoucherifySdk::LV2ProgramsApi.new()
+    end
+
+    def self.lv2_examine_api_instance
+      return VoucherifySdk::LV2ExamineApi.new()
+    end
+
+    def self.lv2_earning_rules_api_instance
+      return VoucherifySdk::LV2EarningRulesApi.new()
+    end
+
+    def self.lv2_rewards_api_instance
+      return VoucherifySdk::LV2RewardsApi.new()
+    end
+
+    def self.lv2_benefits_api_instance
+      return VoucherifySdk::LV2BenefitsApi.new()
+    end
+
     def self.management_api_instance
       management_config = VoucherifySdk::Configuration.new
       management_config.api_key['X-Management-Id'] = ENV['X_MANAGEMENT_ID']

data/__tests__/lib/loyalty_v2_fixture.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require_relative 'loyalty_v2_http'
+
+# HTTP-only setup and teardown for Loyalty v2 e2e tests.
+module LoyaltyV2Fixture
+  Context = Struct.new(
+    :suffix,
+    :program_id,
+    :card_definition_id,
+    :reward_card_definition_id,
+    :earning_rule_id,
+    :reward_id,
+    :program_name,
+    keyword_init: true
+  )
+
+  module_function
+
+  def unique_suffix
+    "#{Time.now.to_i.to_s(36)}_#{rand(1_000_000)}"
+  end
+
+  def build_card_definition_body(name, enable_pay_with_points: false)
+    {
+      name: name,
+      type: 'INDIVIDUAL',
+      status: 'DRAFT',
+      points_expiration: { type: 'NO_EXPIRATION' },
+      pending_points: { type: 'IMMEDIATE' },
+      spending_limits: {
+        global: { type: 'NO_LIMIT', limits: nil },
+        transactions: { type: 'NO_LIMIT', limits: nil }
+      },
+      # Order payments require EXCHANGE_RATIO; default is NO_PAYMENTS (423).
+      pay_with_points: if enable_pay_with_points
+                         {
+                           type: 'EXCHANGE_RATIO',
+                           exchange_ratio: { formula: 1 }
+                         }
+                       else
+                         { type: 'NO_PAYMENTS' }
+                       end
+    }
+  end
+
+  def setup
+    suffix = unique_suffix
+    program_name = "ruby_sdk_lv2_program_#{suffix}"
+    card_name = "ruby_sdk_lv2_card_#{suffix}"
+    earning_rule_name = "ruby_sdk_lv2_earn_#{suffix}"
+    reward_name = "ruby_sdk_lv2_reward_#{suffix}"
+
+    program = LoyaltyV2Http.create_program(name: program_name)
+    program_id = program && program['id']
+    raise "create_program returned no id: #{program.inspect}" if program_id.nil?
+
+    card_definition = LoyaltyV2Http.create_card_definition(
+      build_card_definition_body(card_name, enable_pay_with_points: true)
+    )
+    card_definition_id = card_definition && card_definition['id']
+    raise "create_card_definition returned no id: #{card_definition.inspect}" if card_definition_id.nil?
+
+    LoyaltyV2Http.activate_card_definition(card_definition_id)
+
+    # Reward spend source and credit target must be different card definitions.
+    reward_card_definition = LoyaltyV2Http.create_card_definition(
+      build_card_definition_body("ruby_sdk_lv2_reward_card_#{suffix}")
+    )
+    reward_card_definition_id = reward_card_definition && reward_card_definition['id']
+    if reward_card_definition_id.nil?
+      raise "create_card_definition (reward target) returned no id: #{reward_card_definition.inspect}"
+    end
+
+    LoyaltyV2Http.activate_card_definition(reward_card_definition_id)
+
+    earning_rule = LoyaltyV2Http.create_earning_rule(
+      name: earning_rule_name,
+      status: 'DRAFT',
+      trigger: {
+        event: 'customer.order.paid'
+      },
+      earnings: [
+        {
+          effects: [
+            {
+              type: 'POINTS',
+              points: {
+                value: 100,
+                card_definition_id: card_definition_id
+              }
+            }
+          ]
+        }
+      ]
+    )
+    earning_rule_id = earning_rule && earning_rule['id']
+    raise "create_earning_rule returned no id: #{earning_rule.inspect}" if earning_rule_id.nil?
+
+    LoyaltyV2Http.activate_earning_rule(earning_rule_id)
+
+    reward = LoyaltyV2Http.create_reward(
+      name: reward_name,
+      type: 'DIGITAL',
+      status: 'DRAFT',
+      material: nil,
+      digital: {
+        type: 'LOYALTY_CARD_POINTS',
+        discount_coupons: nil,
+        gift_vouchers: nil,
+        loyalty_card_points: {
+          points: 5,
+          card_definition_id: reward_card_definition_id
+        }
+      },
+      costs: [
+        {
+          spending: [
+            {
+              points: 10,
+              card_definition_id: card_definition_id
+            }
+          ]
+        }
+      ]
+    )
+    reward_id = reward && reward['id']
+    raise "create_reward returned no id: #{reward.inspect}" if reward_id.nil?
+
+    LoyaltyV2Http.activate_reward(reward_id)
+
+    LoyaltyV2Http.batch_assign_card_definitions(
+      program_id,
+      assign: [{ id: card_definition_id }, { id: reward_card_definition_id }]
+    )
+    LoyaltyV2Http.batch_assign_earning_rules(
+      program_id,
+      assign: [{ id: earning_rule_id }]
+    )
+    LoyaltyV2Http.batch_assign_rewards(
+      program_id,
+      assign: [{ id: reward_id, stock: { type: 'UNLIMITED' } }]
+    )
+
+    LoyaltyV2Http.activate_program(program_id)
+
+    Context.new(
+      suffix: suffix,
+      program_id: program_id,
+      card_definition_id: card_definition_id,
+      reward_card_definition_id: reward_card_definition_id,
+      earning_rule_id: earning_rule_id,
+      reward_id: reward_id,
+      program_name: program_name
+    )
+  end
+
+  # Cleanup matrix (what the API allows):
+  # - Program: deactivate → delete (delete soft-removes assignments).
+  # - Earning rule / reward: deactivate → delete.
+  # - Card definitions: delete after program + reward are gone.
+  #   Drafting while still assigned to a non-draft program/reward returns 423.
+  def teardown(ctx)
+    return if ctx.nil?
+
+    ignore('deactivate_program') { LoyaltyV2Http.deactivate_program(ctx.program_id) } if ctx.program_id
+    ignore('delete_program') { LoyaltyV2Http.delete_program(ctx.program_id) } if ctx.program_id
+
+    if ctx.earning_rule_id
+      ignore('deactivate_earning_rule') { LoyaltyV2Http.deactivate_earning_rule(ctx.earning_rule_id) }
+    end
+    if ctx.reward_id
+      ignore('deactivate_reward') { LoyaltyV2Http.deactivate_reward(ctx.reward_id) }
+    end
+
+    sleep 0.5
+
+    if ctx.earning_rule_id
+      ignore('delete_earning_rule') { LoyaltyV2Http.delete_earning_rule(ctx.earning_rule_id) }
+    end
+    if ctx.reward_id
+      ignore('delete_reward') { LoyaltyV2Http.delete_reward(ctx.reward_id) }
+    end
+    [ctx.card_definition_id, ctx.reward_card_definition_id].each do |card_id|
+      next if card_id.nil?
+
+      ignore("delete_card_definition #{card_id}") { LoyaltyV2Http.delete_card_definition(card_id) }
+    end
+  end
+
+  def ignore(label)
+    yield
+  rescue LoyaltyV2Http::Error => e
+    return if e.status == 404
+
+    warn "Loyalty v2 teardown #{label}: #{e.message}"
+  end
+  private_class_method :ignore
+end

data/__tests__/lib/loyalty_v2_http.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+# Authenticated HTTP helper for Loyalty v2 paths that are not published in the
+# Ruby SDK. Runtime member flows should use LV2*Api.
+# Credentials come from ENV (Config loads dotenv in the RSpec suite).
+module LoyaltyV2Http
+  class Error < StandardError
+    attr_reader :status, :body
+
+    def initialize(message, status:, body: nil)
+      super(message)
+      @status = status
+      @body = body
+    end
+  end
+
+  module_function
+
+  def base_url
+    (ENV['VOUCHERIFY_HOST'] || 'https://api.voucherify.io')
+      .to_s
+      .strip
+      .sub(%r{/+\z}, '')
+      .sub(%r{/v1\z}i, '')
+  end
+
+  def auth_headers
+    app_id = ENV['X_APP_ID']
+    app_token = ENV['X_APP_TOKEN']
+    if app_id.to_s.empty? || app_token.to_s.empty?
+      raise 'X-App-Id and X-App-Token are required for Loyalty v2 HTTP calls.'
+    end
+
+    {
+      'X-App-Id' => app_id,
+      'X-App-Token' => app_token,
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
+    }
+  end
+
+  def build_uri(path, query = nil)
+    absolute = path.start_with?('http') ? path : "#{base_url}#{path.start_with?('/') ? path : "/#{path}"}"
+    uri = URI(absolute)
+    if query.is_a?(Hash) && !query.empty?
+      params = []
+      query.each do |key, value|
+        next if value.nil?
+
+        if value.is_a?(Array)
+          value.each { |item| params << [key.to_s, item.to_s] }
+        else
+          params << [key.to_s, value.to_s]
+        end
+      end
+      uri.query = URI.encode_www_form(params) unless params.empty?
+    end
+    uri
+  end
+
+  # CI app keys allow 100 calls per hour. Setup needs headroom after the rest of the suite.
+  def rate_limit_remaining
+    uri = URI("#{base_url}/v1/products?limit=1")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.scheme == 'https'
+    req = Net::HTTP::Get.new(uri)
+    auth_headers.each { |key, value| req[key] = value }
+    response = http.request(req)
+    response['x-rate-limit-remaining'].to_i
+  end
+
+  def request(method, path, body = nil, query = nil)
+    uri = build_uri(path, query)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.scheme == 'https'
+
+    verb = method.to_s.upcase
+    req_class = {
+      'GET' => Net::HTTP::Get,
+      'POST' => Net::HTTP::Post,
+      'PUT' => Net::HTTP::Put,
+      'DELETE' => Net::HTTP::Delete,
+      'PATCH' => Net::HTTP::Patch
+    }.fetch(verb) { raise ArgumentError, "Unsupported HTTP method: #{verb}" }
+
+    req = req_class.new(uri)
+    auth_headers.each { |key, value| req[key] = value }
+    req.body = JSON.generate(body) unless body.nil?
+
+    response = http.request(req)
+    text = response.body.to_s
+    data =
+      if text.empty?
+        nil
+      else
+        begin
+          JSON.parse(text)
+        rescue JSON::ParserError
+          text
+        end
+      end
+
+    code = response.code.to_i
+    unless (200..299).cover?(code)
+      excerpt =
+        if data.is_a?(String)
+          data[0, 500]
+        else
+          JSON.generate(data)[0, 500]
+        end
+      raise Error.new(
+        "Loyalty v2 HTTP #{verb} #{path} failed: #{code} #{excerpt}",
+        status: code,
+        body: data
+      )
+    end
+
+    data
+  end
+
+  def create_program(body)
+    request('POST', '/v2/loyalties/programs', body)
+  end
+
+  def get_program(program_id)
+    request('GET', "/v2/loyalties/programs/#{program_id}")
+  end
+
+  def update_program(program_id, body)
+    request('PUT', "/v2/loyalties/programs/#{program_id}", body)
+  end
+
+  def activate_program(program_id)
+    request('POST', "/v2/loyalties/programs/#{program_id}/activate")
+  end
+
+  def deactivate_program(program_id)
+    request('POST', "/v2/loyalties/programs/#{program_id}/deactivate")
+  end
+
+  def delete_program(program_id)
+    request('DELETE', "/v2/loyalties/programs/#{program_id}")
+  end
+
+  def create_card_definition(body)
+    request('POST', '/v2/loyalties/card-definitions', body)
+  end
+
+  def activate_card_definition(card_definition_id)
+    request('POST', "/v2/loyalties/card-definitions/#{card_definition_id}/activate")
+  end
+
+  # Card definitions have no deactivate path; draft returns them to editable state.
+  def draft_card_definition(card_definition_id)
+    request('POST', "/v2/loyalties/card-definitions/#{card_definition_id}/draft")
+  end
+
+  def delete_card_definition(card_definition_id)
+    request('DELETE', "/v2/loyalties/card-definitions/#{card_definition_id}")
+  end
+
+  def create_earning_rule(body)
+    request('POST', '/v2/loyalties/earning-rules', body)
+  end
+
+  def activate_earning_rule(earning_rule_id)
+    request('POST', "/v2/loyalties/earning-rules/#{earning_rule_id}/activate")
+  end
+
+  def deactivate_earning_rule(earning_rule_id)
+    request('POST', "/v2/loyalties/earning-rules/#{earning_rule_id}/deactivate")
+  end
+
+  def delete_earning_rule(earning_rule_id)
+    request('DELETE', "/v2/loyalties/earning-rules/#{earning_rule_id}")
+  end
+
+  def create_reward(body)
+    request('POST', '/v2/loyalties/rewards', body)
+  end
+
+  def activate_reward(reward_id)
+    request('POST', "/v2/loyalties/rewards/#{reward_id}/activate")
+  end
+
+  def deactivate_reward(reward_id)
+    request('POST', "/v2/loyalties/rewards/#{reward_id}/deactivate")
+  end
+
+  def delete_reward(reward_id)
+    request('DELETE', "/v2/loyalties/rewards/#{reward_id}")
+  end
+
+  def batch_assign_card_definitions(program_id, body)
+    request('POST', "/v2/loyalties/programs/#{program_id}/card-definitions/batch", body)
+  end
+
+  def batch_assign_earning_rules(program_id, body)
+    request('POST', "/v2/loyalties/programs/#{program_id}/earning-rules/batch", body)
+  end
+
+  def batch_assign_rewards(program_id, body)
+    request('POST', "/v2/loyalties/programs/#{program_id}/rewards/batch", body)
+  end
+end

data/__tests__/spec/13_management_spec.rb

@@ -14,7 +14,12 @@ RSpec.describe 'Management API', :order => :defined do
 
   it 'list projects', :order => :first do
     projects_response = @management_api_instance.list_projects()
-    project_from_response = projects_response.data&.first
+    project_from_response =
+      if ENV['PROJECT_ID'].to_s != ''
+        projects_response.data&.find { |project| project.id == ENV['PROJECT_ID'] }
+      end
+    project_from_response ||= projects_response.data&.find { |project| project.cluster_id == 'dev2' }
+    project_from_response ||= projects_response.data&.first
 
     $management_project_id = project_from_response&.id