smartpay 0.0.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47818556e63df74af8fe9b541af5da55382239b5269db1b7f120283a5f9de904
-  data.tar.gz: f79f51a7c3957d78b3f739ea1134a132ae4fc5b3c20bafed6621270621c8a57d
+  metadata.gz: 86faee4c994b67bdf3ff9d2454a85d09577b82475917e5048fdb3c373ba1fe30
+  data.tar.gz: 64babfa347d6f484ec3aea689bf735a3aa294e182c95cf80840fcc0632dca043
 SHA512:
-  metadata.gz: 76b19f63d6e0e4663fed1f3a060577569c9a19e4f8a35e01c4485e41c51ea30683242f96aa3367d672a2e75dd762b621f65c74456a7339e601c6ab727ef37755
-  data.tar.gz: d99f4a71d2a3471c7c1f4ad9202a2c5b06b4492838779e84c7f316dbfbefbe6c58639ef7cfd1245f49dbd1cbb0ef7b953ed8b62e1afeb46145fe561174d48c3f
+  metadata.gz: 1d4e5f3a352166fff345a6e6cc3b6e68125b74dae5d0913fc78e780aa37dbe754eb18274ceab76152a991dfd82a883b7d49f8ce93d0a26294d83590f9cb1deb1
+  data.tar.gz: b18f1f1c5602dca17d548e29f525b9238e9490b0340ed6dc69c8b29e8b22c3e300cecad3a6e658ecf31b333d2c0c2dca660bc1ffd2190d7d55a54e500c99c575

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_key` and `config.secret_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_key = '<YOUR_PUBLIC_KEY>' # the one starts with pk_test_
+  config.secret_key = '<YOUR_API_SECRET>' # 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_key = 'pk_test_'
+  config.secret_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/api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Smartpay
+  class Api
+    class << self
+      def create_checkout_session(payload)
+        Responses::CheckoutSession.new(Client.post('/checkout/sessions', payload))
+      end
+    end
+  end
+end

data/lib/smartpay/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module Smartpay
+  class Client
+    class << self
+      def post(path, payload = {})
+        response = RestClient::Request.execute(method: :post, url: api_url(path), headers: headers, timeout: timeout, payload: payload.to_json)
+        JSON.parse(response.body, symbolize_names: true)
+      end
+
+      private
+
+      def api_url(path)
+        "#{Smartpay.configuration.api_url}#{path}"
+      end
+
+      def timeout
+        Smartpay.configuration.post_timeout
+      end
+
+      def headers
+        {
+          accept: :json,
+          content_type: :json,
+          Authorization: "Basic #{secret_key}"
+        }
+      end
+
+      def secret_key
+        Smartpay.configuration.secret_key
+      end
+    end
+  end
+end

data/lib/smartpay/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Smartpay
+  class Configuration
+    attr_accessor :post_timeout
+    attr_accessor :public_key, :secret_key, :api_url, :checkout_url
+
+    DEFAULT_TIMEOUT_SETTING = 30
+    DEFAULT_API_URL = 'https://api.smartpay.co'
+    DEFAULT_CHECKOUT_URL = 'https://checkout.smartpay.co'
+
+    def initialize
+      @post_timeout = DEFAULT_TIMEOUT_SETTING
+      @api_url = DEFAULT_API_URL
+      @checkout_url = DEFAULT_CHECKOUT_URL
+    end
+  end
+end

data/lib/smartpay/responses/checkout_session.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Smartpay
+  module Responses
+    class CheckoutSession
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def redirect_url
+        URI.escape("#{checkout_url}/login?session-id=#{response[:id]}&public-key=#{public_key}")
+      end
+
+      private
+
+      def checkout_url
+        Smartpay.configuration.checkout_url
+      end
+
+      def public_key
+        Smartpay.configuration.public_key
+      end
+    end
+  end
+end

data/lib/smartpay/version.rb

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

data/lib/smartpay.rb

@@ -1,8 +1,23 @@
 # frozen_string_literal: true
 
+require 'json'
+
 require_relative "smartpay/version"
+require_relative 'smartpay/configuration'
+require_relative 'smartpay/client'
+require_relative 'smartpay/api'
+require_relative 'smartpay/responses/checkout_session'
 
 module Smartpay
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Smartpay::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Smartpay
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description:
 email:
 - uxe@smartpay.co
@@ -27,7 +55,16 @@ 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
+- lib/smartpay/configuration.rb
+- lib/smartpay/responses/checkout_session.rb
 - lib/smartpay/version.rb
 homepage: https://smartpay.co
 licenses:
@@ -51,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: The Smartpay Ruby SDK offers easy access to Smartpay API from applications