smartpay 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574ea8c0a8437a946bebba2924965c3a5c62ee8c4ccc990a3222491ccebb30ee
-  data.tar.gz: fb334df6541a5869c2ad7df5250f69f7c7593e6b5f804fdcbb3d878298a82cbd
+  metadata.gz: 6c3f54543398cb0fc174621f0527f86329337fb0bce18911f334b32389358db6
+  data.tar.gz: fd7f015bfa49ec0bdf491e34113048098cae02c782abf3b1a8e8bf2df1799387
 SHA512:
-  metadata.gz: 9778570f0c65d94e1f5006ce19254ceef5cfc369f5b654579b091777048ce20c6ba317c0e9fa307de9d8a46dd4feda0ed774d2ce401786c059375d93f3b9e054
-  data.tar.gz: a8aca7526235571495966f9f68dbc7dfe4693cf56d832c5a01543993fd88cce0c19af0a14a0137e7c42d6287485bb6c200c8cc3596984eaa6798bdf592be3ab6
+  metadata.gz: 72b70c530d31746bc173e6544dec2681413c97f9ebb099afed726366400e2f5a3420bcc44e078ece36debfd8fd858aec05c77f346c994605eb7900e468774d25
+  data.tar.gz: ff85cd4be5986f315734e67d312b9f0696c7702ca11cb4a4d6768808c26a4557d23f01851f37fbd9506e178399a02224aacceee7e9e32719f2629cbceb95a109

data/README.md

@@ -1,56 +1,166 @@
-# 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
+## Documentation
+
+- [Payment Flow](https://docs.smartpay.co/#payment_flow)
+- [API Document](https://api-doc.smartpay.co)
+
+## 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 the latest version of Smartpay to your project's dependencies:
+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'
+```
+
+## 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
 
-    $ bundle add smartpay
+You can find the description and requirement for request payload in [API Document](https://api-doc.smartpay.co/#8a3538b1-530c-448c-8bae-4a41cdf0b8fd).
 
-Or, you can add this line to your application's Gemfile and specify the version restriction:
+```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
-gem 'smartpay', "~> 0.1.0"
+session = Smartpay::Api.create_checkout_session(payload)
 ```
 
-And then execute:
+Then, you can redirect your customer to the session url by calling `redirect_url`:
 
-    $ bundle install
+```ruby
+session.redirect_url
+```
 
-## Usage for Ruby on Rails
+## Use with your favorite frameworks
 
-After installed the gem package, you can generate relevant files with:
+### Ruby on Rails (RoR)
 
-    $ bundle exec rails generate smartpay:install
+#### Install Rails
 
-This will introduce 4 changes, including a simple example for checkout session flow:
+```sh
+gem install rails
+```
 
-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
+#### Create your app
 
-### Setup Server Credentials
+```sh
+rails new app-with-smartpay
+```
+
+#### Add Smartpay
 
-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).
+```sh
+cd app-with-smartpay
+bundle add smartpay
+```
 
-Update your API key and secret to the fields `public_key` and `api_secret` in `config/initializers/smartpay.rb`.
+#### 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_SECRET_KEY>' # the one starts with sk_test_
+  ...
+```
+
+#### Start your server
+
+```sh
+bundle exec rails server
+```
 
 ### Test with Checkout Session
 
-Start your server and navigate to `http://localhost:3000/smartpays`.
+Visit [http://localhost:3000/smartpays](http://localhost:3000/smartpays).
 
-Click the `checkout` button to be redirected to the Checkout page.
+Click the `checkout` button on the page to be redirected to Smartpay's Checkout.
 
-Replace any of these test accounts to the field `customerInfo.emailAddress` of request payload in `app/controllers/smartpays_controller.rb` to simulate a payment.
+To try out different cases, you can use the following test credit cards for different cases:
 
-1. Payment succeeds: `success@smartpay.co`
-2. Payment requires authentication: `auth.required@smartpay.co`
-3. Payment is declined: `declined@smartpay.co`
+- Payment succeeds: `4242 4242 4242 4242`
+- Payment is declined: `4100 0000 0000 0019`
 
 ## Development
 

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

@@ -1,8 +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.api_url = 'https://api.smartpay.co/smartpayments'
+  config.checkout_url = 'https://checkout.smartpay.co'
   config.public_key = 'pk_test_'
-  config.api_secret = 'sk_test_'
+  config.secret_key = 'sk_test_'
 end

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

@@ -24,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_key, :secret_key, :api_url, :checkout_url
 
     DEFAULT_TIMEOUT_SETTING = 30
     DEFAULT_API_URL = 'https://api.smartpay.co'

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.0"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Smartpay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-18 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