RubyGems - kcppayments_rails - Versions diffs - 0.1.0 - Mend

kcppayments_rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (130) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +5 -0
data/README.md +49 -0
data/Rakefile +4 -0
data/lib/generators/kcppayments_rails/install/install_generator.rb +21 -0
data/lib/generators/kcppayments_rails/install/templates/kcp_controller.js +54 -0
data/lib/generators/kcppayments_rails/install/templates/kcppayments_rails.rb +14 -0
data/lib/kcppayments_rails/client.rb +49 -0
data/lib/kcppayments_rails/configuration.rb +24 -0
data/lib/kcppayments_rails/engine.rb +21 -0
data/lib/kcppayments_rails/helpers/kcp_helper.rb +33 -0
data/lib/kcppayments_rails/version.rb +5 -0
data/lib/kcppayments_rails.rb +26 -0
data/sig/kcppayments_rails.rbs +4 -0
data/test_app/.dockerignore +51 -0
data/test_app/.github/dependabot.yml +12 -0
data/test_app/.github/workflows/ci.yml +55 -0
data/test_app/.gitignore +87 -0
data/test_app/.kamal/hooks/docker-setup.sample +3 -0
data/test_app/.kamal/hooks/post-app-boot.sample +3 -0
data/test_app/.kamal/hooks/post-deploy.sample +14 -0
data/test_app/.kamal/hooks/post-proxy-reboot.sample +3 -0
data/test_app/.kamal/hooks/pre-app-boot.sample +3 -0
data/test_app/.kamal/hooks/pre-build.sample +51 -0
data/test_app/.kamal/hooks/pre-connect.sample +47 -0
data/test_app/.kamal/hooks/pre-deploy.sample +122 -0
data/test_app/.kamal/hooks/pre-proxy-reboot.sample +3 -0
data/test_app/.kamal/secrets +17 -0
data/test_app/.rubocop.yml +8 -0
data/test_app/.ruby-version +1 -0
data/test_app/Dockerfile +72 -0
data/test_app/Gemfile +60 -0
data/test_app/Gemfile.lock +370 -0
data/test_app/README.md +181 -0
data/test_app/Rakefile +6 -0
data/test_app/app/assets/images/.keep +0 -0
data/test_app/app/assets/stylesheets/application.css +10 -0
data/test_app/app/controllers/application_controller.rb +4 -0
data/test_app/app/controllers/concerns/.keep +0 -0
data/test_app/app/controllers/orders_controller.rb +31 -0
data/test_app/app/controllers/payments_controller.rb +120 -0
data/test_app/app/helpers/application_helper.rb +2 -0
data/test_app/app/helpers/orders_helper.rb +2 -0
data/test_app/app/helpers/payments_helper.rb +2 -0
data/test_app/app/javascript/application.js +3 -0
data/test_app/app/javascript/controllers/application.js +9 -0
data/test_app/app/javascript/controllers/hello_controller.js +7 -0
data/test_app/app/javascript/controllers/index.js +4 -0
data/test_app/app/javascript/controllers/kcp_controller.js +310 -0
data/test_app/app/jobs/application_job.rb +7 -0
data/test_app/app/mailers/application_mailer.rb +4 -0
data/test_app/app/models/application_record.rb +3 -0
data/test_app/app/models/concerns/.keep +0 -0
data/test_app/app/models/order.rb +67 -0
data/test_app/app/views/layouts/application.html.erb +28 -0
data/test_app/app/views/layouts/mailer.html.erb +13 -0
data/test_app/app/views/layouts/mailer.text.erb +1 -0
data/test_app/app/views/orders/create.html.erb +2 -0
data/test_app/app/views/orders/index.html.erb +41 -0
data/test_app/app/views/orders/new.html.erb +44 -0
data/test_app/app/views/orders/show.html.erb +36 -0
data/test_app/app/views/payments/_receipt_links.html.erb +31 -0
data/test_app/app/views/payments/callback.html.erb +2 -0
data/test_app/app/views/payments/create.html.erb +2 -0
data/test_app/app/views/payments/failure.html.erb +20 -0
data/test_app/app/views/payments/new.html.erb +145 -0
data/test_app/app/views/payments/receipt.html.erb +156 -0
data/test_app/app/views/payments/success.html.erb +34 -0
data/test_app/app/views/pwa/manifest.json.erb +22 -0
data/test_app/app/views/pwa/service-worker.js +26 -0
data/test_app/bin/brakeman +7 -0
data/test_app/bin/dev +2 -0
data/test_app/bin/docker-entrypoint +14 -0
data/test_app/bin/importmap +4 -0
data/test_app/bin/jobs +6 -0
data/test_app/bin/kamal +16 -0
data/test_app/bin/rails +4 -0
data/test_app/bin/rake +4 -0
data/test_app/bin/rubocop +8 -0
data/test_app/bin/setup +65 -0
data/test_app/bin/thrust +5 -0
data/test_app/config/application.rb +42 -0
data/test_app/config/boot.rb +4 -0
data/test_app/config/cable.yml +17 -0
data/test_app/config/cache.yml +16 -0
data/test_app/config/credentials.yml.enc +1 -0
data/test_app/config/database.yml +41 -0
data/test_app/config/deploy.yml +116 -0
data/test_app/config/environment.rb +5 -0
data/test_app/config/environments/development.rb +74 -0
data/test_app/config/environments/production.rb +90 -0
data/test_app/config/environments/test.rb +53 -0
data/test_app/config/importmap.rb +7 -0
data/test_app/config/initializers/assets.rb +7 -0
data/test_app/config/initializers/content_security_policy.rb +25 -0
data/test_app/config/initializers/filter_parameter_logging.rb +8 -0
data/test_app/config/initializers/inflections.rb +16 -0
data/test_app/config/initializers/kcppayments_rails.rb +29 -0
data/test_app/config/locales/en.yml +31 -0
data/test_app/config/master.key +1 -0
data/test_app/config/puma.rb +41 -0
data/test_app/config/queue.yml +18 -0
data/test_app/config/recurring.yml +15 -0
data/test_app/config/routes.rb +29 -0
data/test_app/config/storage.yml +34 -0
data/test_app/config.ru +6 -0
data/test_app/db/cable_schema.rb +11 -0
data/test_app/db/cache_schema.rb +14 -0
data/test_app/db/migrate/20250827075913_create_orders.rb +16 -0
data/test_app/db/migrate/20250827121258_add_kcp_fields_to_orders.rb +6 -0
data/test_app/db/queue_schema.rb +129 -0
data/test_app/db/schema.rb +28 -0
data/test_app/db/seeds.rb +80 -0
data/test_app/lib/tasks/.keep +0 -0
data/test_app/log/.keep +0 -0
data/test_app/public/.well-known/appspecific/com.chrome.devtools.json +1 -0
data/test_app/public/400.html +114 -0
data/test_app/public/404.html +114 -0
data/test_app/public/406-unsupported-browser.html +114 -0
data/test_app/public/422.html +114 -0
data/test_app/public/500.html +114 -0
data/test_app/public/icon.png +0 -0
data/test_app/public/icon.svg +3 -0
data/test_app/public/robots.txt +1 -0
data/test_app/script/.keep +0 -0
data/test_app/tmp/.keep +0 -0
data/test_app/tmp/restart.txt +0 -0
data/test_app/vendor/.keep +0 -0
data/test_app/vendor/javascript/.keep +0 -0
metadata +184 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7026a79427dd30b522920128a591957439895f19d06776aab7e96766ee05d596
+  data.tar.gz: b9d7886e466d486c3921c29dac75abebd0922ef9391712d49e5ad52abfc5c2cc
+SHA512:
+  metadata.gz: 426bb8883a6ea59ba25631ee2afe05dd5d3464ceb617086fef2e1c1d48576dd441ccb533db677b715eaf89426f0e43e54410670abc68288026d7eb82df2ca46c
+  data.tar.gz: 50098b2c35b0d1cf665a37bd7ed1314a54f2b21435a53d720906f8cf2163caf6cbf40172eaba17a0a2fd1020bc186a89abfa00ec8ce7a64f006aa45b01eaac0f

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,5 @@
+## [Unreleased]
+## [0.1.0] - 2025-08-24
+- Initial release

data/README.md ADDED Viewed

@@ -0,0 +1,49 @@
+# KCP Payments Rails
+Rails 7/8에서 KCP 표준결제 연동을 간편하게 도와주는 Rails Engine + Stimulus 래퍼 젬입니다.
+## 설치
+```ruby
+gem "kcppayments_rails", github: "luciuschoi/kcppayments_rails"
+```
+```bash
+bundle install
+bin/rails g kcppayments_rails:install
+```
+## 초기화 설정
+`config/initializers/kcppayments_rails.rb` 파일을 열어 KCP 상점 정보를 설정하세요.
+## 뷰 사용 예시 (ERB)
+```erb
+<%= kcp_script_tag %>
+<%= form_with url: checkout_payments_path, method: :post, **kcp_form_attrs(
+  order_id: @order.number,
+  amount: @order.total_price,
+  buyer_name: current_user.name,
+  buyer_email: current_user.email,
+  product_name: @order.summary,
+  return_url: payment_complete_url
+) do |f| %>
+  <button data-controller="kcp" data-action="click->kcp#requestPayment">결제하기</button>
+<% end %>
+```
+## 서버 처리
+승인/취소 등의 서버-서버 통신은 `KcppaymentsRails::Client`를 사용하세요.
+```ruby
+client = KcppaymentsRails::Client.new
+result = client.approve({ # KCP 요구 파라미터 })
+```
+## 주의사항
+- KCP 표준결제는 레거시 스크립트를 로드합니다. `kcp_script_tag`를 `<head>` 혹은 `<body>` 상단에서 불러오세요.
+- 상점코드(`site_cd`)와 키(`site_key`)는 환경변수 또는 이니셜라이저에서 설정하세요.

data/Rakefile ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/generators/kcppayments_rails/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require "rails/generators"
+module KcppaymentsRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      def copy_stimulus_controller
+        template "kcp_controller.js", "app/javascript/controllers/kcp_controller.js"
+      end
+      def create_initializer
+        template "kcppayments_rails.rb", "config/initializers/kcppayments_rails.rb"
+      end
+    end
+  end
+end

data/lib/generators/kcppayments_rails/install/templates/kcp_controller.js ADDED Viewed

@@ -0,0 +1,54 @@
+import { Controller } from "@hotwired/stimulus";
+// data-controller="kcp"
+// Values:
+//   data-kcp-order-id-value
+//   data-kcp-amount-value
+//   data-kcp-buyer-name-value
+//   data-kcp-buyer-email-value
+//   data-kcp-product-name-value
+//   data-kcp-return-url-value
+//   data-kcp-escrow-value
+//   data-kcp-tax-free-amount-value
+export default class extends Controller {
+  static values = {
+    orderId: String,
+    amount: Number,
+    buyerName: String,
+    buyerEmail: String,
+    productName: String,
+    returnUrl: String,
+    escrow: Boolean,
+    taxFreeAmount: Number,
+  };
+  connect() {
+    // KCP 스크립트는 서버에서 include되어야 함 (kcp_script_tag)
+  }
+  requestPayment(event) {
+    event?.preventDefault();
+    if (typeof window.KCP_Pay_Execute !== "function") {
+      console.error(
+        "KCP_Pay_Execute is not loaded. Make sure kcp_script_tag is included."
+      );
+      return;
+    }
+    // 결제 실행 (KCP 페이지의 form name/id 관례를 따를 수 있음)
+    const form = this.element.closest("form");
+    if (!form) {
+      console.error("No form element found for KCP payment.");
+      return;
+    }
+    // KCP_Pay_Execute(form) 같은 레거시 호출을 래핑
+    try {
+      window.KCP_Pay_Execute(form);
+    } catch (e) {
+      console.error("KCP_Pay_Execute failed:", e);
+    }
+  }
+}

data/lib/generators/kcppayments_rails/install/templates/kcppayments_rails.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# KcpPaymentsRails 초기화 설정
+KcppaymentsRails.configure do |config|
+  # 테스트/운영 계정에 맞게 설정하세요
+  # config.site_cd = ENV["KCP_SITE_CD"]
+  # config.site_key = ENV["KCP_SITE_KEY"]
+  # config.gateway_url = "https://testpaygw.kcp.co.kr"
+  # config.js_url = "https://testpay.kcp.co.kr/plugin/payplus_web.jsp"
+  # config.escrow = false
+  # config.tax_free_amount_field = :tax_free_amount
+end

data/lib/kcppayments_rails/client.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "net/http"
+require "uri"
+require "json"
+module KcppaymentsRails
+  class Client
+    # 서버-서버 통신용 기본 클라이언트 (승인/취소 등)
+    def initialize(site_cd: KcppaymentsRails.configuration.site_cd, site_key: KcppaymentsRails.configuration.site_key, gateway_url: KcppaymentsRails.configuration.gateway_url)
+      @site_cd = site_cd
+      @site_key = site_key
+      @gateway_url = gateway_url
+    end
+    def approve(params)
+      post("/center/pp_ax_hub.jsp", params)
+    end
+    def cancel(params)
+      post("/center/pp_ax_hub.jsp", params.merge(type: "cancel"))
+    end
+    private
+    def post(path, params)
+      uri = URI.join(@gateway_url, path)
+      req = Net::HTTP::Post.new(uri)
+      req.set_form_data(params.merge(site_cd: @site_cd, site_key: @site_key))
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      res = http.request(req)
+      parse_response(res)
+    end
+    def parse_response(res)
+      content_type = res["Content-Type"]
+      if content_type&.include?("json")
+        JSON.parse(res.body)
+      else
+        # KCP는 key=value\n 형태도 반환함
+        res.body.to_s.split(/\r?\n/).map { |l| l.split("=", 2) }.to_h
+      end
+    end
+  end
+end

data/lib/kcppayments_rails/configuration.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module KcppaymentsRails
+  class Configuration
+    # KCP 표준결제 기본 설정 값들
+    attr_accessor :site_cd, :site_key, :gateway_url, :js_url, :escrow, :tax_free_amount_field
+    def initialize
+      @site_cd = ENV["KCP_SITE_CD"]
+      @site_key = ENV["KCP_SITE_KEY"]
+      @gateway_url = ENV["KCP_GATEWAY_URL"] || "https://testpaygw.kcp.co.kr"
+      @js_url = ENV["KCP_JS_URL"] || "https://testpay.kcp.co.kr/plugin/payplus_web.jsp"
+      # @target_url = if Rails.env.production? # 운영서버
+      #     "https://spl.kcp.co.kr"
+      #   else # Rails.env.development? || Rails.env.staging? # 개발서버 또는 스테이징서버
+      #     "https://stg-spl.kcp.co.kr"
+      #   end
+      @escrow = false
+      @tax_free_amount_field = :tax_free_amount
+    end
+  end
+end

data/lib/kcppayments_rails/engine.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require "rails/engine"
+module KcppaymentsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace KcppaymentsRails
+    initializer "kcppayments_rails.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include KcppaymentsRails::KcpHelper
+      end
+      ActiveSupport.on_load(:action_controller) do
+        helper KcppaymentsRails::KcpHelper
+      end
+    end
+  end
+end

data/lib/kcppayments_rails/helpers/kcp_helper.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module KcppaymentsRails
+  module KcpHelper
+    # KCP 표준결제 스크립트 로더
+    def kcp_script_tag
+      src = KcppaymentsRails.configuration.js_url
+      # KCP는 전통적으로 jsp 경로를 로드합니다 (ex: payplus_web.jsp)
+      # 레거시 리소스이므로 async/defer 없이 삽입하는 것을 권장합니다.
+      javascript_include_tag(src)
+    end
+    # 결제 폼에 필요한 hidden 필드 및 data-controller 속성을 부여
+    # form_with 등의 블록 내부에서 사용
+    def kcp_form_attrs(order_id:, amount:, buyer_name:, buyer_email:, product_name:, return_url: nil, escrow: nil, tax_free_amount: nil)
+      {
+        data: {
+          controller: "kcp",
+          kcp_order_id_value: order_id,
+          kcp_amount_value: amount,
+          kcp_buyer_name_value: buyer_name,
+          kcp_buyer_email_value: buyer_email,
+          kcp_product_name_value: product_name,
+          kcp_return_url_value: return_url,
+          kcp_escrow_value: (escrow.nil? ? KcppaymentsRails.configuration.escrow : escrow),
+          kcp_tax_free_amount_value: tax_free_amount
+        }
+      }
+    end
+  end
+end

data/lib/kcppayments_rails/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module KcppaymentsRails
+  VERSION = "0.1.0"
+end

data/lib/kcppayments_rails.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative "kcppayments_rails/version"
+require_relative "kcppayments_rails/configuration"
+require_relative "kcppayments_rails/client"
+require_relative "kcppayments_rails/helpers/kcp_helper"
+begin
+  require_relative "kcppayments_rails/engine"
+rescue LoadError
+  # Rails가 아닌 환경에서는 엔진을 로드하지 않습니다.
+end
+module KcppaymentsRails
+  class Error < StandardError; end
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sig/kcppayments_rails.rbs ADDED Viewed

@@ -0,0 +1,4 @@
+module KcppaymentsRails
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test_app/.dockerignore ADDED Viewed

@@ -0,0 +1,51 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+# Ignore git directory.
+/.git/
+/.gitignore
+# Ignore bundler config.
+/.bundle
+# Ignore all environment files.
+/.env*
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+# Ignore CI service files.
+/.github
+# Ignore Kamal files.
+/config/deploy*.yml
+/.kamal
+# Ignore development files
+/.devcontainer
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*

data/test_app/.github/dependabot.yml ADDED Viewed

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/test_app/.github/workflows/ci.yml ADDED Viewed

@@ -0,0 +1,55 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+jobs:
+  scan_ruby:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Scan for common Rails security vulnerabilities using static analysis
+        run: bin/brakeman --no-pager
+  scan_js:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Scan for security vulnerabilities in JavaScript dependencies
+        run: bin/importmap audit
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Lint code for consistent style
+        run: bin/rubocop -f github

data/test_app/.gitignore ADDED Viewed

@@ -0,0 +1,87 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+# Ignore bundler config.
+/.bundle
+# Ignore all environment files (dotenv).
+/.env*
+!/.env*.enc
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+/tmp/cache/*
+!/tmp/cache/
+!/tmp/cache/.keep
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+/public/assets
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+# Ignore database files
+/db/*.sqlite3
+/db/*.sqlite3-*
+# Ignore test files
+/coverage/
+# Ignore node_modules
+/node_modules
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+# Ignore editor and system files
+.DS_Store
+*~
+.*.sw?
+.#*
+\#*#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+# Ignore RubyMine files
+/.idea
+# Ignore Sublime Text files
+/*.sublime*
+# Ignore VS Code files
+.vscode/
+# Ignore vim swap files
+*.swp
+*.swo
+# Ignore generated files
+/public/packs
+/public/packs-test
+/public/vite*
+/app/assets/builds/*
+!/app/assets/builds/.keep

data/test_app/.kamal/hooks/docker-setup.sample ADDED Viewed

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "Docker set up on $KAMAL_HOSTS..."

data/test_app/.kamal/hooks/post-app-boot.sample ADDED Viewed

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..."

data/test_app/.kamal/hooks/post-deploy.sample ADDED Viewed

@@ -0,0 +1,14 @@
+#!/bin/sh
+# A sample post-deploy hook
+#
+# These environment variables are available:
+# KAMAL_RECORDED_AT
+# KAMAL_PERFORMER
+# KAMAL_VERSION
+# KAMAL_HOSTS
+# KAMAL_ROLES (if set)
+# KAMAL_DESTINATION (if set)
+# KAMAL_RUNTIME
+echo "$KAMAL_PERFORMER deployed $KAMAL_VERSION to $KAMAL_DESTINATION in $KAMAL_RUNTIME seconds"

data/test_app/.kamal/hooks/post-proxy-reboot.sample ADDED Viewed

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "Rebooted kamal-proxy on $KAMAL_HOSTS"

data/test_app/.kamal/hooks/pre-app-boot.sample ADDED Viewed

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..."

data/test_app/.kamal/hooks/pre-build.sample ADDED Viewed

@@ -0,0 +1,51 @@
+#!/bin/sh
+# A sample pre-build hook
+#
+# Checks:
+# 1. We have a clean checkout
+# 2. A remote is configured
+# 3. The branch has been pushed to the remote
+# 4. The version we are deploying matches the remote
+#
+# These environment variables are available:
+# KAMAL_RECORDED_AT
+# KAMAL_PERFORMER
+# KAMAL_VERSION
+# KAMAL_HOSTS
+# KAMAL_ROLES (if set)
+# KAMAL_DESTINATION (if set)
+if [ -n "$(git status --porcelain)" ]; then
+  echo "Git checkout is not clean, aborting..." >&2
+  git status --porcelain >&2
+  exit 1
+fi
+first_remote=$(git remote)
+if [ -z "$first_remote" ]; then
+  echo "No git remote set, aborting..." >&2
+  exit 1
+fi
+current_branch=$(git branch --show-current)
+if [ -z "$current_branch" ]; then
+  echo "Not on a git branch, aborting..." >&2
+  exit 1
+fi
+remote_head=$(git ls-remote $first_remote --tags $current_branch | cut -f1)
+if [ -z "$remote_head" ]; then
+  echo "Branch not pushed to remote, aborting..." >&2
+  exit 1
+fi
+if [ "$KAMAL_VERSION" != "$remote_head" ]; then
+  echo "Version ($KAMAL_VERSION) does not match remote HEAD ($remote_head), aborting..." >&2
+  exit 1
+fi
+exit 0

data/test_app/.kamal/hooks/pre-connect.sample ADDED Viewed

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# A sample pre-connect check
+#
+# Warms DNS before connecting to hosts in parallel
+#
+# These environment variables are available:
+# KAMAL_RECORDED_AT
+# KAMAL_PERFORMER
+# KAMAL_VERSION
+# KAMAL_HOSTS
+# KAMAL_ROLES (if set)
+# KAMAL_DESTINATION (if set)
+# KAMAL_RUNTIME
+hosts = ENV["KAMAL_HOSTS"].split(",")
+results = nil
+max = 3
+elapsed = Benchmark.realtime do
+  results = hosts.map do |host|
+    Thread.new do
+      tries = 1
+      begin
+        Socket.getaddrinfo(host, 0, Socket::AF_UNSPEC, Socket::SOCK_STREAM, nil, Socket::AI_CANONNAME)
+      rescue SocketError
+        if tries < max
+          puts "Retrying DNS warmup: #{host}"
+          tries += 1
+          sleep rand
+          retry
+        else
+          puts "DNS warmup failed: #{host}"
+          host
+        end
+      end
+      tries
+    end
+  end.map(&:value)
+end
+retries = results.sum - hosts.size
+nopes = results.count { |r| r == max }
+puts "Prewarmed %d DNS lookups in %.2f sec: %d retries, %d failures" % [ hosts.size, elapsed, retries, nopes ]