talon_one_sdk 26.01

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e041b11bc137396491e1ed6b5baed08bf79c2d25aa950d8c768c32b76abc84c1
+  data.tar.gz: 9dc7004a3e6f8750f5189ff4d2d6dfdfe560916bacf6795c328da1ec9902a622
+SHA512:
+  metadata.gz: 7984369552b778480fcd427e69dc645dc6591fbbb904e46a78d51ef68cbe2a5b81a989baed703b7a0338fa1cab788fba1059d09e63863f0f43ab7e474afb29e3
+  data.tar.gz: 579ccdce0f3b1437362327d0d93adc0e7b562d0de5c2c07b0428a35398ac74bba6fd94cd3babc74f3cbd87419c613dab56246eae3f2e755205cd31747a42b71d

data/.github/.example/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "typhoeus"
+gem "bundler"
+
+gem "talon_one_sdk", path: "../.."

data/.github/.example/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: ../..
+  specs:
+    talon_one_sdk (6.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
+    json (2.8.2)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bundler
+  talon_one!
+  typhoeus
+
+BUNDLED WITH
+   2.5.23

data/.github/.example/example.rb

@@ -0,0 +1,85 @@
+# Load the gem
+require 'talon_one_sdk'
+
+# Setup authorization
+TalonOne.configure do |config|
+  # Configure the API host destination while explicitly using HTTPS as the default is HTTP.
+  config.scheme = 'http'
+  config.host = 'localhost:9000'
+
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = ENV["TALON_API_KEY"]
+  config.api_key_prefix['Authorization'] = 'ApiKey-v1'
+end
+
+# Integration API example to send a session update
+integration_api = TalonOne::IntegrationApi.new
+
+session_integration_id = '8fb7129e-68e6-4464-9631-09b588391619' # String | The integration identifier of the session
+
+# NewCustomerSessionV2 object
+customer_session_v2 = TalonOne::NewCustomerSessionV2.new(
+  profile_id: 'Some_1',
+  state: 'open',
+  cart_items: [
+    TalonOne::CartItem.new(
+      name: 'Nigiri Sake',
+      sku: 'sush1',
+      quantity: 2,
+      price: 3.7,
+      category: 'Sushi'
+    ),
+    TalonOne::CartItem.new(
+      name: 'Rainbow Roll I/O',
+      sku: 'sush2',
+      quantity: 1,
+      price: 6.5,
+      category: 'Sushi'
+    ),
+    TalonOne::CartItem.new(
+      name: 'Kirin',
+      sku: 'k1r',
+      quantity: 2,
+      price: 2.2,
+      category: 'Beverages'
+    ),
+  ],
+  coupon_codes: [
+    'Cool-Stuff!'
+  ]
+)
+
+# Instantiating a new IntegrationRequest object
+integration_request = TalonOne::IntegrationRequest.new(
+  customer_session: customer_session_v2,
+  # Optional list of requested information to be present on the response.
+  # See docs/IntegrationRequest.md for full list
+  # response_content: [
+  #  'customerSession'
+  # ]
+)
+
+begin
+  # Create/update a customer session using `update_customer_session_v2` function
+  result = integration_api.update_customer_session_v2(session_integration_id, integration_request)
+
+  # Prints response to the console
+  puts result
+
+  # Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding properties
+  result.effects.each do |effect|
+    if effect.effect_type == 'setDiscount'
+      # Initiating right props instance according to the effect type
+      props = TalonOne::SetDiscountEffectProps.build_from_hash(effect.props)
+
+      # Access the specific effect's properties
+      puts "Set a discount '#{props.name}' of #{props.value}"
+    elsif effect.effect_type == 'rejectCoupon'
+      # Initiating right props instance according to the effect type
+      props = TalonOne::RejectCouponEffectProps.build_from_hash(effect.props)
+
+      # Work with AcceptCouponEffectProps' properties
+      # ...
+    end
+  end
+end

data/.github/workflows/autorelease.yml

@@ -0,0 +1,135 @@
+name: Auto-release on main
+
+on:
+  pull_request:
+    branches: [ main ]
+    types: [ closed ]
+  workflow_dispatch:
+    inputs:
+      SDK_VERSION:
+        required: true
+        type: string
+        description: the release version to create
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # get full history so we can diff
+
+      - name: Extract version from PR title or use input
+        id: get_version
+        run: |
+          if [ -n "${{ inputs.SDK_VERSION }}" ]; then
+            echo "version=${{ inputs.SDK_VERSION }}" >> $GITHUB_OUTPUT
+          else
+            msg='${{ github.event.pull_request.title }}'
+            if [[ "$msg" =~ [Uu]pdate.*[Tt]o[[:space:]]+([0-9]+\.[0-9]+(\.[0-9]+)?) ]]; then
+              ver="${BASH_REMATCH[1]}"
+              echo "version=$ver" >> $GITHUB_OUTPUT
+            else
+              echo "PR title does not match pattern - skipping release."
+              echo "version=" >> $GITHUB_OUTPUT
+            fi
+          fi
+
+      - name: Skip when no version
+        if: ${{ steps.get_version.outputs.version == '' }}
+        run: echo "Nothing to do."
+
+      - name: Get diff of README endpoint section
+        if: ${{ steps.get_version.outputs.version != '' }}
+        id: get_diff
+        run: |
+          # Get section from old commit
+          git show HEAD^:README.md | awk '/^## Documentation for API endpoints/ {f=1; next} /^## / && f {exit} f' > old.txt || true
+
+          # Get section from current commit
+          awk '/^## Documentation for API endpoints/ {f=1; next} /^## / && f {exit} f' README.md > new.txt || true
+
+          # Normalize and diff
+          diff -u old.txt new.txt > endpoints.diff || true
+
+          echo "diff written"
+          cat endpoints.diff
+
+      - name: Generate release notes
+        if: ${{ steps.get_version.outputs.version != '' }}
+        id: relnotes
+        run: |
+          ADD=()
+          REMOVE=()
+
+          # Extract only meaningful +/- lines (skip diff headers)
+          while IFS= read -r line; do
+            clean="${line:1}"  # strip leading + or -
+            clean="${clean#*ManagementApi* | }"  # strip the prefix
+            if [[ "$line" == +* ]]; then
+              ADD+=("$clean")
+            elif [[ "$line" == -* ]]; then
+              REMOVE+=("$clean")
+            fi
+          done < <(grep '^[+-]' endpoints.diff | grep -v '^+++' | grep -v '^---')
+
+          {
+            echo "## Summary"
+            echo "### Added endpoints"
+            if [ ${#ADD[@]} -eq 0 ]; then
+              echo "- None"
+            else
+              printf -- "- %s\n" "${ADD[@]}"
+            fi
+
+            echo ""
+            echo "### Removed endpoints"
+            if [ ${#REMOVE[@]} -eq 0 ]; then
+              echo "- None"
+            else
+              printf -- "- %s\n" "${REMOVE[@]}"
+            fi
+          } > release-notes.md
+
+          echo "notes_file=release-notes.md" >> "$GITHUB_OUTPUT"
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3"
+
+      - name: publish gem
+        if: ${{ steps.get_version.outputs.version != '' }}
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEM_PUBLISHING_KEY }}
+        run: |
+          bundle install
+          gem build talon_one_sdk.gemspec
+          gem push talon_one_sdk-*.gem
+
+      - name: Create Git tag
+        if: ${{ steps.get_version.outputs.version != '' }}
+        run: |
+          ver="${{ steps.get_version.outputs.version }}"
+          git tag -f "$ver" "$GITHUB_SHA"
+          git push -f origin "refs/tags/$ver"
+
+      - name: Create GitHub release
+        if: ${{ steps.get_version.outputs.version != '' }}
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          ver="${{ steps.get_version.outputs.version }}"
+          notes_file="${{ steps.relnotes.outputs.notes_file }}"
+
+          if gh release view "$ver" &>/dev/null; then
+            gh release delete "$ver" --yes
+          fi
+
+          gh release create "$ver" \
+            --title "$ver" \
+            --notes-file "$notes_file" \
+            --target "$GITHUB_SHA"

data/.github/workflows/test.yml

@@ -0,0 +1,75 @@
+name: run tests
+
+on: [push]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        permissions:
+          contents: 'read'
+          id-token: 'write'
+
+        steps:
+        - uses: actions/checkout@v4
+        - name: Authenticate to Google Cloud
+          id: auth
+          uses: google-github-actions/auth@v1
+          with:
+            token_format: access_token
+            workload_identity_provider: projects/949875736540/locations/global/workloadIdentityPools/external-pool/providers/github-provider
+            service_account: artifact-pusher@talon-artifacts.iam.gserviceaccount.com
+        - name: Login to GAR
+          uses: docker/login-action@v3
+          with:
+            registry: europe-west3-docker.pkg.dev
+            username: oauth2accesstoken
+            password: ${{ steps.auth.outputs.access_token }}
+        - uses: hoverkraft-tech/compose-action@v2.0.2
+        - uses: ruby/setup-ruby@v1
+          with:
+            ruby-version: '3'
+        - name: Install dependencies
+          working-directory: .github/.example
+          run: |
+            bundle config set local.talon_one ../..
+            bundle install
+            sudo apt-get install jq curl
+        - name: Run example
+          working-directory: .github/.example
+          run: |
+            ACCOUNT_RESPONSE=$(curl -s --location "http://localhost:9000/v1/accounts" \
+              --header "Content-Type: application/json" \
+              --data-raw '{
+                  "companyName": "demo",
+                  "email": "integrationtest@talon.one",
+                  "password": "Password1234!"
+              }');
+            export TALON_USER_ID=$(echo $ACCOUNT_RESPONSE | jq ".userId");
+            export TALON_USER_TOKEN=$(echo $ACCOUNT_RESPONSE | jq ".token" | tr -d '"');
+            USER_RESPONSE=$(curl -s --location "http://localhost:9000/v1/users/$TALON_USER_ID" \
+              --header "Authorization: Bearer $TALON_USER_TOKEN");
+            export TALON_ACCOUNT_ID=$(echo $USER_RESPONSE | jq ".accountId");
+            echo "User with ID $TALON_USER_ID and Token $TALON_USER_TOKEN was created for application $TALON_ACCOUNT_ID";
+            APPLICATION_RESPONSE=$(curl -s --location "http://localhost:9000/v1/applications" \
+              --header "Content-Type: application/json" \
+              --header "Authorization: Bearer $TALON_USER_TOKEN" \
+              --data-raw '{
+                  "name": "demo",
+                  "currency": "EUR",
+                  "timezone": "Europe/Berlin",
+                  "enableFlattenedCartItems": false
+              }');
+            export TALON_APPLICATION_ID=$(echo $USER_RESPONSE | jq ".id");
+            echo "Application with ID $TALON_APPLICATION_ID was created"
+            API_KEY_RESPONSE=$(curl -s -v --location "http://localhost:9000/v1/applications/$TALON_APPLICATION_ID/apikeys" \
+              --header "Content-Type: application/json" \
+              --header "Authorization: Bearer $TALON_USER_TOKEN" \
+              --data-raw '{
+                  "title": "Application HIT KEY",
+                  "expires": "2099-01-01T0:00:00Z"
+              }');
+            echo "Api-Key-Response: $API_KEY_RESPONSE";
+            export TALON_API_KEY=$(echo $API_KEY_RESPONSE | jq ".key" | tr -d '"');
+            echo "Api-Key $TALON_API_KEY created"
+
+            bundle exec ruby example.rb;

data/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end