smartpay 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c6d6af18ab67f641631f6e67525ae39c64286ae716819fa2d96658b0571f83b
-  data.tar.gz: 64a89a61dd9cfec7fffad3735bea54ad22c5387e2b68bc8caa54148803aea394
+  metadata.gz: 6c3f54543398cb0fc174621f0527f86329337fb0bce18911f334b32389358db6
+  data.tar.gz: fd7f015bfa49ec0bdf491e34113048098cae02c782abf3b1a8e8bf2df1799387
 SHA512:
-  metadata.gz: 7f2ca92bd0867e03a3f2ab3f2c964bfdb1ead71ade148ea753b28aec3ee57aed4d7ab394041620bba30a02055839b214f164e562ed6281e96bf53968a958e6b4
-  data.tar.gz: 1426c5205f369b614791c2b8277df030f8f693e31b1caf9ac36f8cfef017a95570599ee957c2f615401fb57a6b95f38720d9cdf4296b3cdf8563dc4a5110dde0
+  metadata.gz: 72b70c530d31746bc173e6544dec2681413c97f9ebb099afed726366400e2f5a3420bcc44e078ece36debfd8fd858aec05c77f346c994605eb7900e468774d25
+  data.tar.gz: ff85cd4be5986f315734e67d312b9f0696c7702ca11cb4a4d6768808c26a4557d23f01851f37fbd9506e178399a02224aacceee7e9e32719f2629cbceb95a109

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)
@@ -64,7 +129,7 @@ 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.
+> 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.
@@ -75,8 +140,8 @@ 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_
+  config.public_key = '<YOUR_PUBLIC_KEY>' # the one starts with pk_test_
+  config.secret_key = '<YOUR_SECRET_KEY>' # the one starts with sk_test_
   ...
 ```
 

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

@@ -3,6 +3,6 @@
 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_'
+  config.public_key = 'pk_test_'
+  config.secret_key = 'sk_test_'
 end

data/lib/smartpay/configuration.rb

@@ -3,7 +3,7 @@
 module Smartpay
   class Configuration
     attr_accessor :post_timeout
-    attr_accessor :public_api_key, :private_api_key, :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

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

data/lib/smartpay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartpay
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Smartpay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client