smartpay 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d6c56f2c6abb2cf337532c6e3d10943111aed67b585d62c5fb6bdc1ab26198
-  data.tar.gz: 8f67b047ab3bfb8cc28c503657ea3f02bb83f6cab0fd25ce04ca9eab90853bb2
+  metadata.gz: 0c6d6af18ab67f641631f6e67525ae39c64286ae716819fa2d96658b0571f83b
+  data.tar.gz: 64a89a61dd9cfec7fffad3735bea54ad22c5387e2b68bc8caa54148803aea394
 SHA512:
-  metadata.gz: 87a360308fd0f6d5b5ec8cb73c28f611c03ae465ccb16bd5fc53d989812e95b84e1873890fa011fd27adde18d3f953c1974a26499f4b5beae36b4c79db6aa25b
-  data.tar.gz: 020bc848c1ddb5bfe842bac6e78b622cde388fcd33de9719f5e877a2583e2b47aaa733c0e626d7aa7a8e41c35d7fc945feef9b1c02bd95eadc217211c7cd96ea
+  metadata.gz: 7f2ca92bd0867e03a3f2ab3f2c964bfdb1ead71ade148ea753b28aec3ee57aed4d7ab394041620bba30a02055839b214f164e562ed6281e96bf53968a958e6b4
+  data.tar.gz: 1426c5205f369b614791c2b8277df030f8f693e31b1caf9ac36f8cfef017a95570599ee957c2f615401fb57a6b95f38720d9cdf4296b3cdf8563dc4a5110dde0

data/README.md

@@ -1,28 +1,101 @@
-# Smartpay
+# Smartpay Ruby Library
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smartpay`. To experiment with that code, run `bin/console` for an interactive prompt.
+The Smartpay Ruby library offers easy access to Smartpay API from applications written in Ruby.
 
-TODO: Delete this and the text above, and describe your gem
+## Requirements
+
+- Ruby 2.6+
+- Smartpay `API keys & secrets`. You can find your credential at the `settings > credentials` page on your [dashboard](https://dashboard.smartpay.co/settings/credentials).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you use system built-in Ruby, you might need to be the `sudoer` to be able to `sudo` in some of the following steps. We recommend you to use either [rbenv](https://github.com/rbenv/rbenv) or [rvm](https://rvm.io/) to have your own non-global Ruby to avoid potential permission issues.
+
+Once you have your Ruby in place, add the latest version of Smartpay to your project's dependencies:
+
+```sh
+gem install smartpay
+```
+
+If you want to build the gem yourself from source:
+
+```sh
+gem build smartpay.gemspec
+```
+
+### Bundler
+
+If you are installing via bundler, make sure that you use the `https` resource in your Gemfile to avoid the risk of gems being compromised:
 
 ```ruby
+source 'https://rubygems.org'
+
 gem 'smartpay'
 ```
 
-And then execute:
+## Use with your favorite frameworks
+
+### Ruby on Rails (RoR)
+
+#### Install Rails
+
+```sh
+gem install rails
+```
+
+#### Create your app
+
+```sh
+rails new app-with-smartpay
+```
+
+#### Add Smartpay
+
+```sh
+cd app-with-smartpay
+bundle add smartpay
+```
+
+#### Generator
+
+```sh
+bundle exec rails generate smartpay:install
+```
+
+This introduces 4 changes for a pre-built Smartpay Checkout example:
+
+> 1. A new initializer - `config/initializers/smartpay.rb`. You will have to update the `config.public_api_key` and `config.private_api_key` with your own credentials to make this work.
+> 2. A new controller - `app/controllers/smartpays_controller.rb`. This is where you can see how a Checkout session is configured & created.
+> 3. A new view - `app/views/smartpays/index.html.erb`. The minimum frontend required.
+> 4. A new route in config/routes.rb.
+
+#### Fill in your API keys
+
+Edit the keys with your own credentials in `config/initializers/smartpay.rb`.
+
+```ruby
+  ...
+  config.public_api_key = '<YOUR_PUBLIC_API_KEY>' # the one starts with pk_test_
+  config.private_api_key = '<YOUR_PRIVATE_API_KEY>' # the one starts with sk_test_
+  ...
+```
+
+#### Start your server
+
+```sh
+bundle exec rails server
+```
 
-    $ bundle install
+### Test with Checkout Session
 
-Or install it yourself as:
+Visit [http://localhost:3000/smartpays](http://localhost:3000/smartpays).
 
-    $ gem install smartpay
+Click the `checkout` button on the page to be redirected to Smartpay's Checkout.
 
-## Usage
+To try out different cases, you can use the following test credit cards for different cases:
 
-TODO: Write usage instructions here
+- Payment succeeds: `4242 4242 4242 4242`
+- Payment is declined: `4100 0000 0000 0019`
 
 ## Development
 

data/lib/generators/smartpay/install_generator.rb

@@ -0,0 +1,18 @@
+# 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"
+      template "assets/stylesheets/demo.css", "app/assets/stylesheets/demo.css"
+      directory "views", "app/views/smartpays"
+
+      route "resources :smartpays, only: [:index, :create]"
+    end
+  end
+end

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/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.co/smartpayments'
+  config.checkout_url = 'https://checkout.smartpay.co'
+  config.public_api_key = 'pk_test_'
+  config.private_api_key = 'sk_test_'
+end

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

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<%= stylesheet_link_tag "demo" %>
+	</head>
+	<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
@@ -22,12 +24,12 @@ module Smartpay
         {
           accept: :json,
           content_type: :json,
-          Authorization: "Basic #{api_secret}"
+          Authorization: "Basic #{private_api_key}"
         }
       end
 
-      def api_secret
-        Smartpay.configuration.api_secret
+      def private_api_key
+        Smartpay.configuration.private_api_key
       end
     end
   end

data/lib/smartpay/configuration.rb

@@ -3,7 +3,7 @@
 module Smartpay
   class Configuration
     attr_accessor :post_timeout
-    attr_accessor :public_key, :api_secret, :api_url, :checkout_url
+    attr_accessor :public_api_key, :private_api_key, :api_url, :checkout_url
 
     DEFAULT_TIMEOUT_SETTING = 30
     DEFAULT_API_URL = 'https://api.smartpay.co'

data/lib/smartpay/responses/checkout_session.rb

@@ -10,7 +10,7 @@ module Smartpay
       end
 
       def redirect_url
-        URI.escape("#{checkout_url}/login?session-id=#{response[:id]}&public-key=#{public_key}")
+        URI.escape("#{checkout_url}/login?session-id=#{response[:id]}&public-key=#{public_api_key}")
       end
 
       private
@@ -19,8 +19,8 @@ module Smartpay
         Smartpay.configuration.checkout_url
       end
 
-      def public_key
-        Smartpay.configuration.public_key
+      def public_api_key
+        Smartpay.configuration.public_api_key
       end
     end
   end

data/lib/smartpay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Smartpay
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - uxe@smartpay.co
 executables: []
@@ -55,6 +55,11 @@ files:
 - Rakefile
 - 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
 - lib/smartpay.rb
 - lib/smartpay/api.rb
 - lib/smartpay/client.rb
@@ -68,7 +73,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 +88,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.