smartpay 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574ea8c0a8437a946bebba2924965c3a5c62ee8c4ccc990a3222491ccebb30ee
-  data.tar.gz: fb334df6541a5869c2ad7df5250f69f7c7593e6b5f804fdcbb3d878298a82cbd
+  metadata.gz: cb4d84133812657ba1e6e6683ea63bc14f9dd421420b0694d3d31aa0098ead74
+  data.tar.gz: 8b356926abcb9d367eb64e5873859af80791499ab3ed2feb8c688deee487fbf6
 SHA512:
-  metadata.gz: 9778570f0c65d94e1f5006ce19254ceef5cfc369f5b654579b091777048ce20c6ba317c0e9fa307de9d8a46dd4feda0ed774d2ce401786c059375d93f3b9e054
-  data.tar.gz: a8aca7526235571495966f9f68dbc7dfe4693cf56d832c5a01543993fd88cce0c19af0a14a0137e7c42d6287485bb6c200c8cc3596984eaa6798bdf592be3ab6
+  metadata.gz: 32293e37471385b80585a095b8f9ebb828914997746970fb7a02111995bf7d75b09aad59ac2ece4955e36361f36f0d568754491547557d05e2d3fca20be058df
+  data.tar.gz: e93cda74f1d6fa16a1b4e1b898f8498118cfada872f7ff6f15fb993d444e914d7fa866870e4d0a9c31d199043438c6e6404d2de37ea94e494aafe5b401dbcdd9

data/README.md

@@ -1,56 +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 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:
 
-    $ bundle add smartpay
+```sh
+gem build smartpay.gemspec
+```
 
-Or, you can add this line to your application's Gemfile and specify the version restriction:
+### 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
-gem 'smartpay', "~> 0.1.0"
+source 'https://rubygems.org'
+
+gem 'smartpay'
+```
+
+## Use with your favorite frameworks
+
+### Ruby on Rails (RoR)
+
+#### Install Rails
+
+```sh
+gem install rails
 ```
 
-And then execute:
+#### Create your app
+
+```sh
+rails new app-with-smartpay
+```
 
-    $ bundle install
+#### Add Smartpay
 
-## Usage for Ruby on Rails
+```sh
+cd app-with-smartpay
+bundle add smartpay
+```
 
-After installed the gem package, you can generate relevant files with:
+#### Generator
 
-    $ bundle exec rails generate smartpay:install
+```sh
+bundle exec rails generate smartpay:install
+```
 
-This will introduce 4 changes, including a simple example for checkout session flow:
+This introduces 4 changes for a pre-built Smartpay Checkout example:
 
-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
+> 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.
 
-### Setup Server Credentials
+#### Fill in your API keys
 
-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).
+Edit the keys with your own credentials in `config/initializers/smartpay.rb`.
 
-Update your API key and secret to the fields `public_key` and `api_secret` 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
+```
 
 ### 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/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/smartpay/client.rb

@@ -24,12 +24,12 @@ module Smartpay
         {
           accept: :json,
           content_type: :json,
-          Authorization: "Basic #{api_secret}"
+          Authorization: "Basic #{secret_key}"
         }
       end
 
-      def api_secret
-        Smartpay.configuration.api_secret
+      def secret_key
+        Smartpay.configuration.secret_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/version.rb

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

metadata

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