smartpay 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4d84133812657ba1e6e6683ea63bc14f9dd421420b0694d3d31aa0098ead74
-  data.tar.gz: 8b356926abcb9d367eb64e5873859af80791499ab3ed2feb8c688deee487fbf6
+  metadata.gz: b85b02e47b248634100a1f5c9cc54aa977ae0306debfa54615f916c17b190d43
+  data.tar.gz: b001d7cc034fb87d5f80e2d9fafc202d343fc52a03ec2d13bbc774c0dd980fb4
 SHA512:
-  metadata.gz: 32293e37471385b80585a095b8f9ebb828914997746970fb7a02111995bf7d75b09aad59ac2ece4955e36361f36f0d568754491547557d05e2d3fca20be058df
-  data.tar.gz: e93cda74f1d6fa16a1b4e1b898f8498118cfada872f7ff6f15fb993d444e914d7fa866870e4d0a9c31d199043438c6e6404d2de37ea94e494aafe5b401dbcdd9
+  metadata.gz: fc3a2b1c0d41558e07cd4298119446f5fada619c0625e66278437c503c7980d353d1eee2e0948bf3be036e33facbff391354705c11068f3a13dfd226873a1e11
+  data.tar.gz: c5ae98b31fb8c102bf9ace17467569fba7642f121d00ca2aac64ca9f28cfdca26988c063713fbd43a9aab63914cd9bb3e7107c321589f225ecb0ac7f7ee4bef5

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/install_generator.rb

@@ -9,6 +9,7 @@ module Smartpay
     def install
       template "initializer.rb", "config/initializers/smartpay.rb"
       template "controller.rb", "app/controllers/smartpays_controller.rb"
+      template "assets/stylesheets/demo.css", "app/assets/stylesheets/demo.css"
       directory "views", "app/views/smartpays"
 
       route "resources :smartpays, only: [:index, :create]"

data/lib/generators/smartpay/templates/assets/stylesheets/demo.css

@@ -0,0 +1,18 @@
+input[type="submit"] {
+  padding: 0 40px;
+  font: 500 16px/48px Helvetica, sans-serif;
+  appearance: none;
+  position: absolute;
+  left: 50%;
+  top: 50%;
+  transform: translate(-50%, -50%);
+  border: 0;
+  color: #fff;
+  background: #4456dd;
+  border-radius: 6px;
+  cursor: pointer;
+}
+
+input[type="submit"]:hover {
+  background: #3445c1;
+}

data/lib/generators/smartpay/templates/views/index.html.erb

@@ -1,5 +1,8 @@
 <!DOCTYPE html>
 <html>
+	<head>
+		<%= stylesheet_link_tag "demo" %>
+	</head>
 	<body>
 		<%= form_tag smartpays_path do %>
 			<%= submit_tag 'Checkout' %>

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.1"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Smartpay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -56,6 +56,7 @@ files:
 - bin/console
 - bin/setup
 - lib/generators/smartpay/install_generator.rb
+- lib/generators/smartpay/templates/assets/stylesheets/demo.css
 - lib/generators/smartpay/templates/controller.rb
 - lib/generators/smartpay/templates/initializer.rb
 - lib/generators/smartpay/templates/views/index.html.erb