smartpay 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86faee4c994b67bdf3ff9d2454a85d09577b82475917e5048fdb3c373ba1fe30
-  data.tar.gz: 64babfa347d6f484ec3aea689bf735a3aa294e182c95cf80840fcc0632dca043
+  metadata.gz: fd9d36f1c0b628dcafc5308503663e63f628eb9467f237b750c03d7416e565d8
+  data.tar.gz: 2c8aa53f89d35801c11657357e1cd01c79a647dcb1adb9a58dbb912538506152
 SHA512:
-  metadata.gz: 1d4e5f3a352166fff345a6e6cc3b6e68125b74dae5d0913fc78e780aa37dbe754eb18274ceab76152a991dfd82a883b7d49f8ce93d0a26294d83590f9cb1deb1
-  data.tar.gz: b18f1f1c5602dca17d548e29f525b9238e9490b0340ed6dc69c8b29e8b22c3e300cecad3a6e658ecf31b333d2c0c2dca660bc1ffd2190d7d55a54e500c99c575
+  metadata.gz: 71e24b5936a52552e97675081d462154d527dd9effecf42cba3867dffe18640c6916b48cbffb7140e11c0b9fab50105821ee68271b7746685ad0021ba96b27a4
+  data.tar.gz: f2f84b245783023dad0bb44e203c427d5b57f5d9ce14826c7bec5a312535f735bba133295d7e962f2dec7d8400c9d4760b3ca9c3f62262dd18ae08159c504369

data/README.md

@@ -2,6 +2,11 @@
 
 The Smartpay Ruby library offers easy access to Smartpay API from applications written in Ruby.
 
+## Documentation
+
+- [Payment Flow](https://docs.smartpay.co/#payment_flow)
+- [API Document](https://api-doc.smartpay.co)
+
 ## Requirements
 
 - Ruby 2.6+
@@ -33,6 +38,66 @@ source 'https://rubygems.org'
 gem 'smartpay'
 ```
 
+## Usage
+
+The package needs to be configured with your own API keys, you can find them on your [dashboard](https://dashboard.smartpay.co/settings/credentials).
+
+```ruby
+Smartpay.configure do |config|
+  config.public_key = '<YOUR_PUBLIC_KEY>' # the one starts with pk_test_
+  config.secret_key = '<YOUR_SECRET_KEY>' # the one starts with sk_test_
+end
+```
+
+### Create Checkout session
+
+You can find the description and requirement for request payload in [API Document](https://api-doc.smartpay.co/#8a3538b1-530c-448c-8bae-4a41cdf0b8fd).
+
+```ruby
+payloaad = {
+  "customerInfo": {
+    "emailAddress": "success@smartpay.co",
+  },
+  "orderData": {
+    "amount": 250,
+    "currency": "JPY",
+    "shippingInfo": {
+      "address": {
+        "line1": "line1",
+        "locality": "locality",
+        "postalCode": "123",
+        "country": "JP"
+      },
+    },
+    "lineItemData": [{
+      "priceData": {
+        "productData": {
+          "name": "レブロン 18 LOW",
+        },
+        "amount": 250,
+        "currency": "JPY",
+      },
+      "quantity": 1
+    }]
+  },
+  "reference": "order_ref_1234567",
+  "successUrl": "https://docs.smartpay.co/example-pages/checkout-successful",
+  "cancelUrl": "https://docs.smartpay.co/example-pages/checkout-canceled"
+}
+```
+
+Create a checkout session by using `Smartpay::Api.create_checkout_session` with your request payload.
+
+```ruby
+session = Smartpay::Api.create_checkout_session(payload)
+```
+
+Then, you can redirect your customer to the session url by calling `redirect_url`:
+
+```ruby
+session.redirect_url
+```
+
 ## Use with your favorite frameworks
 
 ### Ruby on Rails (RoR)
@@ -76,7 +141,7 @@ Edit the keys with your own credentials in `config/initializers/smartpay.rb`.
 ```ruby
   ...
   config.public_key = '<YOUR_PUBLIC_KEY>' # the one starts with pk_test_
-  config.secret_key = '<YOUR_API_SECRET>' # the one starts with sk_test_
+  config.secret_key = '<YOUR_SECRET_KEY>' # the one starts with sk_test_
   ...
 ```
 

data/lib/generators/smartpay/templates/controller.rb

@@ -3,66 +3,27 @@ class SmartpaysController < ApplicationController
   end
 
   def create
-    session = Smartpay::Api.create_checkout_session(
-      {
-        "customerInfo": {
-          "emailAddress": "success@smartpay.co",
-          "firstName": nil,
-          "lastName": nil,
-          "firstNameKana": nil,
-          "lastNameKana": nil,
-          "address": nil,
-          "phoneNumber": nil,
-          "dateOfBirth": nil,
-          "legalGender": nil,
-          "reference": nil
+    session = Smartpay::Api.create_checkout_session({
+      items: [
+        {
+          name: "レブロン 18 LOW",
+          amount: 250,
+          currency: "JPY",
+          quantity: 1,
         },
-        "orderData": {
-          "amount": 250,
-          "currency": "JPY",
-          "captureMethod": nil,
-          "confirmationMethod": nil,
-          "coupons": nil,
-          "shippingInfo": {
-            "address": {
-              "line1": "line1",
-              "line2": nil,
-              "line3": nil,
-              "line4": nil,
-              "line5": nil,
-              "subLocality": nil,
-             "locality": "locality",
-              "administrativeArea": nil,
-              "postalCode": "123",
-              "country": "JP"},
-              "addressType": nil},
-              "lineItemData": [{
-                "price": nil,
-                "priceData": {
-                  "productData": {
-                    "name": "レブロン 18 LOW",
-                    "brand": nil,
-                    "categories": nil,
-                    "description": nil,
-                    "gtin": nil,
-                    "images": nil,
-                    "reference": nil,
-                    "url": nil,
-                    "metadata": nil},
-                    "amount": 250,
-                    "currency": "JPY",
-                    "metadata": nil},
-                    "quantity": 1,
-                    "description": nil,
-                    "metadata": nil
-              }]
-        },
-        "reference": "order_ref_1234567",
-        "metadata": nil,
-        "successUrl": "https://docs.smartpay.co/example-pages/checkout-successful",
-        "cancelUrl": "https://docs.smartpay.co/example-pages/checkout-canceled",
-        "test": true
-      })
+      ],
+
+      shipping: {
+        line1: "line1",
+        locality: "locality",
+        postalCode: "123",
+        country: "JP",
+      },
+      reference: "order_ref_1234567",
+      successURL: "https://docs.smartpay.co/example-pages/checkout-successful",
+      cancelURL: "https://docs.smartpay.co/example-pages/checkout-canceled",
+      test: true,
+    })
     redirect_to session.redirect_url
   end
 end

data/lib/smartpay/api.rb

@@ -4,7 +4,9 @@ module Smartpay
   class Api
     class << self
       def create_checkout_session(payload)
-        Responses::CheckoutSession.new(Client.post('/checkout/sessions', payload))
+        Responses::CheckoutSession.new(
+          Client.post('/checkout/sessions', Requests::CheckoutSession.new(payload).as_hash)
+        )
       end
     end
   end

data/lib/smartpay/errors/invalid_request_payload_error.rb

@@ -0,0 +1,16 @@
+module Smartpay
+  module Errors
+    class InvalidRequestPayloadError < ArgumentError
+      attr_accessor :key_name
+
+      def initialize(key_name)
+        @key_name = key_name
+        super
+      end
+
+      def message
+        "#{key_name} can't be blank."
+      end
+    end
+  end
+end

data/lib/smartpay/requests/checkout_session.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Smartpay
+  module Requests
+    class CheckoutSession
+      attr_accessor :payload
+
+      REQUIREMENT_KEY_NAME = [:successURL, :cancelURL, :customerInfo, :orderData].freeze
+      CAN_FALLBACK_KEYS = [:customerInfo, :orderData].freeze
+
+      def initialize(raw_payload)
+        @payload = raw_payload.transform_keys(&:to_sym)
+      end
+
+      def as_hash
+        check_requirement!
+        normalize_payload
+      end
+
+      private
+
+      def check_requirement!
+        REQUIREMENT_KEY_NAME.each do |key_name|
+          next if CAN_FALLBACK_KEYS.include?(key_name)
+          raise Errors::InvalidRequestPayloadError, key_name unless payload.include?(key_name)
+        end
+      end
+
+      def normalize_payload
+        currency = nil
+        total_amount = 0
+        items = payload.dig(:lineItemData) || payload.dig(:items)
+        if items.count > 0
+          total_amount = items.inject(0) { |sum, item| sum + (item[:amount] || 0) }
+          currency = items.first.dig(:currency)
+        end
+
+        {
+          customerInfo: normalize_customer_info(payload.dig(:customerInfo) || payload.dig(:customer) || {}),
+          orderData: normalize_order_data(payload.dig(:orderData) || {
+            amount: total_amount,
+            currency: currency,
+            captureMethod: payload.dig(:captureMethod),
+            confirmationMethod: payload.dig(:confirmationMethod),
+            coupons: payload.dig(:coupons),
+            shippingInfo: payload.dig(:shippingInfo) || normalize_shipping(payload.dig(:shipping)),
+            lineItemData: items,
+            description: payload.dig(:orderDescription),
+            metadata: payload.dig(:orderMetadata)
+          }),
+          reference: payload.dig(:reference),
+          metadata: payload.dig(:metadata),
+          successUrl: payload.dig(:successURL),
+          cancelUrl: payload.dig(:cancelURL),
+          test: payload.dig(:test) || false
+        }
+      end
+
+      def normalize_customer_info(info)
+        return if info.nil?
+        customer = info.transform_keys(&:to_sym)
+        {
+          accountAge: customer.dig(:accountAge),
+          emailAddress: customer.dig(:emailAddress) || customer.dig(:email),
+          firstName: customer.dig(:firstName),
+          lastName: customer.dig(:lastName),
+          firstNameKana: customer.dig(:firstNameKana),
+          lastNameKana: customer.dig(:lastNameKana),
+          address: customer.dig(:address),
+          phoneNumber: customer.dig(:phoneNumber) || customer.dig(:phone),
+          dateOfBirth: customer.dig(:dateOfBirth),
+          legalGender: customer.dig(:legalGender) || customer.dig(:gender),
+          reference: customer.dig(:reference)
+        }
+      end
+
+      def normalize_shipping(shipping)
+        return if shipping.nil?
+        {
+          address: shipping.dig(:address) || {
+            line1: shipping.dig(:line1),
+            line2: shipping.dig(:line2),
+            line3: shipping.dig(:line3),
+            line4: shipping.dig(:line4),
+            line5: shipping.dig(:line5),
+            subLocality: shipping.dig(:subLocality),
+            locality: shipping.dig(:locality),
+            administrativeArea: shipping.dig(:administrativeArea),
+            postalCode: shipping.dig(:postalCode),
+            country: shipping.dig(:country),
+          },
+          addressType: shipping.dig(:addressType)
+        }
+      end
+
+      def normalize_order_data(order)
+        return if order.nil?
+        order = order.transform_keys(&:to_sym)
+        {
+          amount: order.dig(:amount),
+          currency: order.dig(:currency),
+          captureMethod: order.dig(:captureMethod),
+          confirmationMethod: order.dig(:confirmationMethod),
+          coupons: order.dig(:coupons),
+          shippingInfo: order.dig(:shippingInfo),
+          lineItemData: normalize_line_items(order.dig(:lineItemData) || order.dig(:items))
+        }
+      end
+
+      def normalize_line_items(data)
+        return [] if data.nil?
+
+        data.map do |item|
+          line_item = item.transform_keys(&:to_sym)
+          {
+            price: line_item.dig(:price),
+            priceData: normalize_price_data(line_item.dig(:priceData) || {
+              productData: {
+                name: line_item.dig(:name),
+                brand: line_item.dig(:brand),
+                categories: line_item.dig(:categories),
+                gtin: line_item.dig(:gtin),
+                images: line_item.dig(:images),
+                reference: line_item.dig(:reference),
+                url: line_item.dig(:url),
+                description: line_item.dig(:productDescription),
+                metadata: line_item.dig(:productMetadata)
+              },
+              amount: line_item.dig(:amount),
+              currency: line_item.dig(:currency),
+              label: line_item.dig(:label),
+              description: line_item.dig(:priceDescription),
+              metadata: line_item.dig(:priceMetadata)
+            }),
+            quantity: line_item.dig(:quantity),
+            description: line_item.dig(:description),
+            metadata: line_item.dig(:metadata)
+          }
+        end
+      end
+
+      def normalize_price_data(data)
+        return if data.nil?
+        data = data.transform_keys(&:to_sym)
+        {
+          productData: normalize_product_data(data.dig(:productData) || {}),
+          amount: data.dig(:amount),
+          currency: data.dig(:currency),
+          metadata: data.dig(:metadata)
+        }
+      end
+
+      def normalize_product_data(product)
+        return if product.nil?
+        product = product.transform_keys(&:to_sym)
+        {
+          name: product.dig(:name),
+          brand: product.dig(:brand),
+          categories: product.dig(:categories),
+          description: product.dig(:description),
+          gtin: product.dig(:gtin),
+          images: product.dig(:images),
+          reference: product.dig(:reference),
+          url: product.dig(:url),
+          metadata: product.dig(:metadata)
+        }
+      end
+    end
+  end
+end

data/lib/smartpay/responses/checkout_session.rb

@@ -13,6 +13,14 @@ module Smartpay
         URI.escape("#{checkout_url}/login?session-id=#{response[:id]}&public-key=#{public_key}")
       end
 
+      def as_hash
+        @response
+      end
+
+      def as_json
+        @response.to_json
+      end
+
       private
 
       def checkout_url

data/lib/smartpay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Smartpay
-  VERSION = "0.2.2"
+  VERSION = "0.2.6"
 end

data/lib/smartpay.rb

@@ -6,6 +6,8 @@ require_relative "smartpay/version"
 require_relative 'smartpay/configuration'
 require_relative 'smartpay/client'
 require_relative 'smartpay/api'
+require_relative 'smartpay/errors/invalid_request_payload_error'
+require_relative 'smartpay/requests/checkout_session'
 require_relative 'smartpay/responses/checkout_session'
 
 module Smartpay

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - Smartpay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -64,6 +64,8 @@ files:
 - lib/smartpay/api.rb
 - lib/smartpay/client.rb
 - lib/smartpay/configuration.rb
+- lib/smartpay/errors/invalid_request_payload_error.rb
+- lib/smartpay/requests/checkout_session.rb
 - lib/smartpay/responses/checkout_session.rb
 - lib/smartpay/version.rb
 homepage: https://smartpay.co