smartpay 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d6c56f2c6abb2cf337532c6e3d10943111aed67b585d62c5fb6bdc1ab26198
-  data.tar.gz: 8f67b047ab3bfb8cc28c503657ea3f02bb83f6cab0fd25ce04ca9eab90853bb2
+  metadata.gz: 574ea8c0a8437a946bebba2924965c3a5c62ee8c4ccc990a3222491ccebb30ee
+  data.tar.gz: fb334df6541a5869c2ad7df5250f69f7c7593e6b5f804fdcbb3d878298a82cbd
 SHA512:
-  metadata.gz: 87a360308fd0f6d5b5ec8cb73c28f611c03ae465ccb16bd5fc53d989812e95b84e1873890fa011fd27adde18d3f953c1974a26499f4b5beae36b4c79db6aa25b
-  data.tar.gz: 020bc848c1ddb5bfe842bac6e78b622cde388fcd33de9719f5e877a2583e2b47aaa733c0e626d7aa7a8e41c35d7fc945feef9b1c02bd95eadc217211c7cd96ea
+  metadata.gz: 9778570f0c65d94e1f5006ce19254ceef5cfc369f5b654579b091777048ce20c6ba317c0e9fa307de9d8a46dd4feda0ed774d2ce401786c059375d93f3b9e054
+  data.tar.gz: a8aca7526235571495966f9f68dbc7dfe4693cf56d832c5a01543993fd88cce0c19af0a14a0137e7c42d6287485bb6c200c8cc3596984eaa6798bdf592be3ab6

data/README.md

@@ -6,23 +6,51 @@ TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the latest version of Smartpay to your project's dependencies:
+
+    $ bundle add smartpay
+
+Or, you can add this line to your application's Gemfile and specify the version restriction:
 
 ```ruby
-gem 'smartpay'
+gem 'smartpay', "~> 0.1.0"
 ```
 
 And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage for Ruby on Rails
+
+After installed the gem package, you can generate relevant files with:
+
+    $ bundle exec rails generate smartpay:install
+
+This will introduce 4 changes, including a simple example for checkout session flow:
+
+1. Add new initializer in `config/initializers/smartpay.rb`
+2. Add controller to `app/controllers/smartpays_controller.rb`
+3. Add view to `app/views/smartpays/index.html.erb`
+4. Add routes to `config/routes.rb` for checkout session
+
+### Setup Server Credentials
+
+Make sure you have the credentials (API key & secret) from Smartpay before you can have a working integration.
+You can find your credentials at the `settings > credentials` page on your [dashboard](https://merchant.smartpay.co/settings/credentials).
+
+Update your API key and secret to the fields `public_key` and `api_secret` in `config/initializers/smartpay.rb`.
+
+### Test with Checkout Session
+
+Start your server and navigate to `http://localhost:3000/smartpays`.
 
-    $ gem install smartpay
+Click the `checkout` button to be redirected to the Checkout page.
 
-## Usage
+Replace any of these test accounts to the field `customerInfo.emailAddress` of request payload in `app/controllers/smartpays_controller.rb` to simulate a payment.
 
-TODO: Write usage instructions here
+1. Payment succeeds: `success@smartpay.co`
+2. Payment requires authentication: `auth.required@smartpay.co`
+3. Payment is declined: `declined@smartpay.co`
 
 ## Development
 

data/lib/generators/smartpay/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Smartpay
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def install
+      template "initializer.rb", "config/initializers/smartpay.rb"
+      template "controller.rb", "app/controllers/smartpays_controller.rb"
+      directory "views", "app/views/smartpays"
+
+      route "resources :smartpays, only: [:index, :create]"
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+class SmartpaysController < ApplicationController
+  def new
+  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
+        },
+        "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
+      })
+    redirect_to session.redirect_url
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Smartpay.configure do |config|
+  config.api_url = 'https://api.smartpay.re/smartpayments'
+  config.checkout_url = 'https://checkout.smartpay.re'
+  config.public_key = 'pk_test_'
+  config.api_secret = 'sk_test_'
+end

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

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+	<body>
+		<%= form_tag smartpays_path do %>
+			<%= submit_tag 'Checkout' %>
+		<% end %>
+	</body>
+</html>

data/lib/smartpay/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rest-client'
+
 module Smartpay
   class Client
     class << self

data/lib/smartpay/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Smartpay
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2021-10-18 00:00:00.000000000 Z
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - uxe@smartpay.co
 executables: []
@@ -55,6 +55,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/smartpay/install_generator.rb
+- lib/generators/smartpay/templates/controller.rb
+- lib/generators/smartpay/templates/initializer.rb
+- lib/generators/smartpay/templates/views/index.html.erb
 - lib/smartpay.rb
 - lib/smartpay/api.rb
 - lib/smartpay/client.rb
@@ -68,7 +72,7 @@ metadata:
   homepage_uri: https://smartpay.co
   source_code_uri: https://github.com/smartpay-co/sdk-ruby
   changelog_uri: https://github.com/smartpay-co/sdk-ruby/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: The Smartpay Ruby SDK offers easy access to Smartpay API from applications
   written in Ruby.