postfinancecheckout-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4350f23c542a383696267a7d8e0543fe3b49a860a219829524b54b3cad896b19
+  data.tar.gz: c18ac8b2c1f7d121561fd294b70f8827a593d042ee3c18849bf3a774a955a9e7
+SHA512:
+  metadata.gz: f61316645b66338e0e4d394393e71b2573180b890ca21547a61575a4466a1294136f540df5daedad8b67ad2482773021744ed0502e90175cd4468aaf89cd326f
+  data.tar.gz: 2c74972d00713039eb5acb6d5f2c5d1ca60220dd6a4f903ce66402c9013daffef6fbe57d63c7f5a9e6db093e3abd4f042934c3cd70b54b2bc5e298c0b7ea0d64

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Lukas_Skywalker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Postfinance Checkout
+Short description and motivation.
+
+## Usage
+
+Add a `transaction_id` field to your orders model:
+
+```bash
+rails generate migration AddTransactionIdToOrders transaction_id:string
+```
+
+Configure the gem and set the callbacks:
+
+```ruby
+Postfinancecheckout.configure do |config|
+  config.space_id = 12345
+  config.app_user_id = 56789
+  config.app_user_key = "my_secret_key"
+
+  config.on_success = -> (transaction_id) do
+    order = Order.find_by(transaction_id: transaction_id)
+    order.update(status: :paid)
+
+    PaymentSuccessMailer.deliver_later(order)
+  end
+
+  config.on_failure = -> (transaction_id) do
+    order = Order.find_by(transaction_id: transaction_id)
+    order.update(status: :failed)
+
+    PaymentFailedMailer.deliver_later(order)
+  end
+end
+```
+
+Create a transaction and store the transaction ID:
+
+```ruby
+transaction = Postfinancecheckout::Transaction.new(
+  amount: 34.5,
+  order_number: '1234',
+  email: 'test@example.com',
+  address: {
+    first_name: 'Testbenutzer',
+    last_name: 'Muster',
+    street: 'Hauptstrasse 123',
+    post_code: 3019,
+    city: 'Chäs und Brot',
+    state: 'BE',
+    country_code: 'CH'
+  }
+)
+transaction.save
+
+@order.update(transaction_id: transaction.id)
+```
+
+Once you have saved the transaction, generate the payment URL and redirect the user:
+
+```ruby
+redirect_to transaction.payment_url
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "postfinancecheckout-rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install postfinancecheckout-rails
+```
+
+## Development
+
+Build the gem:
+
+```bash
+rake build
+```
+
+Push it to rubygems.org:
+
+```bash
+rake release
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/postfinancecheckout_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/postfinancecheckout .css

data/app/assets/stylesheets/postfinancecheckout/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/postfinancecheckout/application_controller.rb

@@ -0,0 +1,4 @@
+module Postfinancecheckout
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/postfinancecheckout/webhooks_controller.rb

@@ -0,0 +1,18 @@
+module Postfinancecheckout
+  class WebhooksController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    def create
+      transaction_id = params[:entityId]
+
+      transaction = Postfinancecheckout::Transaction.find(transaction_id)
+      if transaction.status == 'FULFILL'
+        Postfinancecheckout.config.on_success.call(transaction_id)
+      elsif transaction.status == 'FAILED' || transaction.status == 'VOIDED' || transaction.status == 'DECLINE'
+        Postfinancecheckout.config.on_failure.call(transaction_id)
+      end
+
+      head :ok
+    end
+  end
+end

data/app/helpers/postfinancecheckout/application_helper.rb

@@ -0,0 +1,4 @@
+module Postfinancecheckout
+  module ApplicationHelper
+  end
+end

data/app/jobs/postfinancecheckout/application_job.rb

@@ -0,0 +1,4 @@
+module Postfinancecheckout
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/postfinancecheckout/application_mailer.rb

@@ -0,0 +1,6 @@
+module Postfinancecheckout
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/postfinancecheckout/application_record.rb

@@ -0,0 +1,5 @@
+module Postfinancecheckout
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/postfinancecheckout/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Postfinancecheckout</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "postfinancecheckout/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Postfinancecheckout::Engine.routes.draw do
+  post :webhook, to: 'webhooks#create'
+end

data/lib/postfinancecheckout/engine.rb

@@ -0,0 +1,5 @@
+module Postfinancecheckout
+  class Engine < ::Rails::Engine
+    isolate_namespace Postfinancecheckout
+  end
+end

data/lib/postfinancecheckout/transaction.rb

@@ -0,0 +1,142 @@
+require 'postfinancecheckout-ruby-sdk'
+
+module Postfinancecheckout
+  class Transaction
+    attr_reader :id
+
+    def initialize(amount: 0, email: '', address: {}, order_number: '', id: nil, success_url: '', failure_url: '')
+      @amount = amount
+      @email = email
+      @address = address
+      @order_number = order_number
+      @id = id
+      @success_url = success_url
+      @failure_url = failure_url
+
+      PostFinanceCheckout.configure do |config|
+        config.user_id = app_user_id
+        config.authentication_key = app_user_key
+      end
+    end
+
+    def save
+      existing = transaction_service.search(space_id, {
+        filter: {
+          fieldName: "merchantReference",
+          operator: "EQUALS",
+          type: "LEAF",
+          value: "order-#{@order_number}"
+        }
+      })
+      if existing.any?
+        @id = existing.first.id
+      else
+        tx = transaction_service.create(space_id, transaction_object)
+        @id = tx.id
+      end
+      self
+    end
+
+    def self.create(amount: 0, email: '', address: {}, order_number: '')
+      transaction = self.new(amount: amount, email: email, address: address, order_number: order_number)
+      transaction.save
+      transaction
+    end
+
+    def self.find(transaction_id)
+      transaction = self.new(amount: nil, email: nil, address: {}, order_number: nil, id: transaction_id)
+      transaction
+    end
+
+    def payment_url
+      ensure_id!
+      transaction_payment_page_service.payment_page_url(space_id, @id)
+    end
+
+    def status
+      ensure_id!
+      transaction = transaction_service.read(space_id, @id)
+      transaction.state
+    end
+
+    private
+
+    def space_id
+      Postfinancecheckout.config.space_id
+    end
+
+    def app_user_id
+      Postfinancecheckout.config.app_user_id
+    end
+
+    def app_user_key
+      Postfinancecheckout.config.app_user_key
+    end
+
+    def ensure_id!
+      raise StandardError, "Transaction must be saved" if @id.nil?
+    end
+
+    def ensure_not_id!
+      raise StandardError, "Transaction already saved" if @id
+    end
+
+    def address_object
+      PostFinanceCheckout::AddressCreate.new({
+        emailAddress: @email,
+        givenName: @address[:first_name],
+        familyName: @address[:last_name],
+        street: @address[:street],
+        postCode: @address[:post_code],
+        city: @address[:city],
+        postalState: @address[:state],
+        country: @address[:country_code],
+      })
+    end
+
+    def line_item_object
+      PostFinanceCheckout::LineItemCreate.new({
+        amountIncludingTax: @amount,
+        name: "Bestellung #{@order_number}",
+        quantity: 1,
+        shippingRequired: true,
+        #sku: "test-product",
+        #taxes: [
+        #    PostFinanceCheckout::TaxCreate.new({
+        #        rate: 8,
+        #        title: "VAT"
+        #    })
+        #],
+        type: PostFinanceCheckout::LineItemType::PRODUCT,
+        uniqueId: "order-#{@order_number}",
+      })
+    end
+
+    def transaction_object
+      PostFinanceCheckout::TransactionCreate.new({
+        billingAddress: address_object,
+        currency: 'CHF',
+        customerEmailAddress: @email,
+        customerPresence: PostFinanceCheckout::CustomersPresence::VIRTUAL_PRESENT,
+        invoiceMerchantReference: "Bestellung-#{@order_number}",
+        language: "de_CH",
+        lineItems: [
+          line_item_object
+        ],
+        merchantReference: "order-#{@order_number}",
+        shippingAddress: address_object,
+        #shippingMethod: "Test Shipping",
+        successUrl: @success_url,
+        failedUrl: @failure_url,
+      })
+    end
+
+    def transaction_service
+      @transaction_service ||= PostFinanceCheckout::TransactionService.new
+    end
+
+    def transaction_payment_page_service
+      @transaction_payment_page_service ||= PostFinanceCheckout::TransactionPaymentPageService.new
+    end
+  end
+end

data/lib/postfinancecheckout/version.rb

@@ -0,0 +1,3 @@
+module Postfinancecheckout
+  VERSION = "0.1.0"
+end

data/lib/postfinancecheckout.rb

@@ -0,0 +1,15 @@
+require 'dry-configurable'
+require "postfinancecheckout/version"
+require "postfinancecheckout/engine"
+require "postfinancecheckout/transaction"
+
+module Postfinancecheckout
+  extend Dry::Configurable
+
+  setting :on_success
+  setting :on_failure
+
+  setting :space_id
+  setting :app_user_id
+  setting :app_user_key
+end

data/lib/tasks/postfinancecheckout_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :postfinancecheckout do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: postfinancecheckout-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukas_Skywalker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+- !ruby/object:Gem::Dependency
+  name: postfinancecheckout-ruby-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Simple integration of Postfinance Checkout for Rails applications
+email:
+- lukas.diener@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/postfinancecheckout_manifest.js
+- app/assets/stylesheets/postfinancecheckout/application.css
+- app/controllers/postfinancecheckout/application_controller.rb
+- app/controllers/postfinancecheckout/webhooks_controller.rb
+- app/helpers/postfinancecheckout/application_helper.rb
+- app/jobs/postfinancecheckout/application_job.rb
+- app/mailers/postfinancecheckout/application_mailer.rb
+- app/models/postfinancecheckout/application_record.rb
+- app/views/layouts/postfinancecheckout/application.html.erb
+- config/routes.rb
+- lib/postfinancecheckout.rb
+- lib/postfinancecheckout/engine.rb
+- lib/postfinancecheckout/transaction.rb
+- lib/postfinancecheckout/version.rb
+- lib/tasks/postfinancecheckout_tasks.rake
+homepage: https://github.com/code-fabrik/postfinancecheckout
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/code-fabrik/postfinancecheckout
+  source_code_uri: https://github.com/code-fabrik/postfinancecheckout
+  changelog_uri: https://raw.githubusercontent.com/code-fabrik/postfinancecheckout/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Postfinance Checkout for Rails
+test_files: []