ccbill_ruby 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39968023a09afce1fef462927e886edee7bc51e9
-  data.tar.gz: 4e67d3bf54326c605939a446be2edbbb2477187f
+  metadata.gz: 9bcda695920d9205dfd4510acd087a4c01ba5b2f
+  data.tar.gz: cac9da0badec1558966a66f3a04721d415e450c3
 SHA512:
-  metadata.gz: 3c4c8c0de66eaed747eb7a44c982dc9f1f7f7a119fc73b40439631b6b0661d4627fc9503d672dd9e7ce33ded621c6466d18724f78b59122fb86d11e31dccc52c
-  data.tar.gz: f46011f2a0a7eb268224cd66aa25bc6c5670a35a1f26d04f54edaf5c1971abe3afc7fc1d691a06080f682c045ae68fe7bd235ef0e930ea1324d5e9e703f17439
+  metadata.gz: 7ac9da183ee526c314a571bd7b9a6a1a9f45564c9393239ae3b0ab3cd391d0dfb1cc9ebc674a3dbd88bd6faaa787d45f969d07623adfd55e64c3976cbdf0d196
+  data.tar.gz: 34e8110012e4c1d0ab5a24d1bb1695efb227e5f3f8b3dc6be7131535b808bfb76218c5c15b82a4f79ef0dd5d327b06a8921e9df7a4d7dfe46ca8be43944dcf72

data/.circleci/config.yml

@@ -0,0 +1,10 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/circleci-ccbill-ruby
+    docker:
+      - image: circleci/ruby:2.4.1-node-browsers
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec

data/README.md

@@ -1,19 +1,27 @@
 **Please mail me if any: dmytro.vasin@gmail.com**
 
+---
+
 # CCBill SDK for Ruby
 
+[![Circle CI](https://circleci.com/gh/DmytroVasin/ccbill_ruby.svg?style=shield)](https://circleci.com/gh/DmytroVasin/ccbill_ruby)
+
 Unofficial CCBill SDK for Ruby.
 
 This gem provides:
+- Interface for URL generation with simple validation
+- Postback verification (WebHooks)
 - Easy Install
 - Getting started guide
 - Generator that creates
-  - Approve/Deny callback paths
-  - Background Post path
+  - Approve/Deny callback path
+  - Webhook callback path
 - Url/Form Generator for test and live mode
 
 
-> Important! CCBill provides two types of payment forms. FlexForms is our newest (and recommended) system. In this gem we use ONLY FlexForms.
+> Important! CCBill provides two types of payment forms.<br/>
+> FlexForms is our newest (and recommended) system.
+> In this gem we use ONLY FlexForms with DynamiPricing.
 
 
 # Getting started
@@ -30,12 +38,12 @@ Next, you need to run the generator:
 $ rails generate ccbill:install
 ```
 
-This will create a controller (if one does not exist) and configure it with the default actions. The generator also configures your config/routes.rb file to point to the CCBill controller.
+This will create a controller (if one does not exist) and configure it with the default actions. The generator also configures your `config/routes.rb` file to point to the CCBill controller.
 
 
 ## Example of usage:
 
-Simple version:
+Single billing transaction:
 ```ruby
 form = Ccbill::DynamicPricing.new({
   initial_price_in_cents: 355
@@ -47,15 +55,31 @@ form.valid?    #=> True/False
 form.url       #=> URL
 ```
 
-To prefill the form you can pass additional variables like: `customer_fname`, `customer_lname`, 'address1', etc. [Full list of variables](https://kb.ccbill.com/Webhooks+User+Guide#Payment_Form)
-
+Recurring transactions:
 ```ruby
 form = Ccbill::DynamicPricing.new({
-  initial_price_in_cents: 355
+  initial_price_in_cents: 3000,
   initial_period: 30,
-  order_id: 'Any configuration information',
+  recurring_price_in_cents: 100,
+  recurring_period: 30,
+  num_rebills: 99
+  order_id: 'Any configuration information'
+})
+
+form.valid?    #=> True/False
+form.url       #=> URL
+```
+
+To prefill the form you can pass additional variables like: `customer_fname`, `customer_lname`, `address1`, etc.<br/>
+[Full list of variables](https://kb.ccbill.com/Webhooks+User+Guide#Payment_Form)
+
+```ruby
+Ccbill::DynamicPricing.new({
+  ...
   customer_fname: 'Dmytro',
-  customer_lname: 'Vasin'
+  customer_lname: 'Vasin',
+  email: 'dmytro.vasin@gmail.com',
+  city: 'Dnepr'
 })
 ```
 
@@ -81,6 +105,8 @@ Before reading this part - please read [Setup guide](#setup-guide)
     config.account = 'account_id'
     config.sub_account = '0000'
     config.flexform_id = 'flexform_id'
+    config.min_price = '2.95'
+    config.max_price = '100'
   end
 ```
 
@@ -88,11 +114,10 @@ Before reading this part - please read [Setup guide](#setup-guide)
   # app/controllers/callbacks/ccbills_controller.rb
   module Callbacks
     class CcbillsController < ApplicationController
-      # before_action :check_ccbill_callback, only: :create
 
       # GET: Redirect from payment system after approval/deny.
       def show
-        case response_params[:mppResponse]
+        case params[:mppResponse]
         when 'CheckoutSuccess'
           flash[:notice] = "Payment was successfully paid"
         when 'CheckoutFail'
@@ -104,107 +129,100 @@ Before reading this part - please read [Setup guide](#setup-guide)
         redirect_to root_url
       end
 
-      # POST: Post Back
+      # POST: Webhooks
       def create
-        postback = CCBill::Postback.new(response_params)
-
-        if postback.approval?
-          # Do something "Approval" postback.
-        else
-          # Do something "Deny" postback.
+        begin
+          # Your code goes here.
+        rescue StandardError => error
+          # I assume we should put `rescue` statement because CCBill will call our server again and again untill he will receive 200
+          # When there was failure of sending webhooks or the system was under maintenance at the moment.
         end
 
-        head :no_content
+        head :ok
       end
 
-      private
-
-      def response_params
-        @response_params ||= params.except(:controller, :action).to_unsafe_h
-      end
     end
   end
 ```
 
-# Payment Flow
+# Payment Flow ( via DynamiPricing )
 
-To make some payment through CCBill via DynamiPricing:
-
-The payment form is the CCBill form that will be displayed to customers after they choose to check out using CCBill. The payment form accepts customer payment information, processes the payment, and returns the customer to your Site through callbacks ( GET ) where you can catche the response and do proper redirect:
+### TL; DR;
+- On the Site User clicks by generated link. After that user will be redirect to the `payment form`
+- The `payment form` is the CCBill form that will be displayed to customers after they choose to check out using CCBill. The `payment form` accepts customer payment information
+- After processes the payment CCBill returns the customer to the Site through specified callbacks ( GET: `callbacks/ccbills#show` )
+- Besides CCBill will produce another request ( Webhook request ) with status of the payment attempt. ( POST: `callbacks/ccbills#create` )
 
 ### Step 1:
 
-1. You should generate LINK that contains information about order/subscription
+1. You should generate link.<br/>
+That link should contains information about order/subscription or etc. ( What order exactly was paid )
 
-This gem will help you in this, next script will generate link:
+This gem will help you in this case. Next script will generate link:
 ```ruby
 Ccbill::DynamicPricing.new({
   initial_price_in_cents: 355
   initial_period: 30,
-  order_id: 'Any configuration information'
+  order_id: 'Any additional information'
 }).url
 ```
 
-This link contains variables: `initial_price`, `initial_period` and additional variable `order_id`.  To enhance security, that url contains `FormDigest` value. The formDigest value is a hex-encoded MD5 hash, calculated using a combination of the fields and a salt value. [More information](https://kb.ccbill.com/Dynamic+Pricing+User+Guide#Generating_the_MD5_Hash)
+This link contains variables: `initial_price`, `initial_period` and additional variable `order_id`.<br/>
+To enhance security, generated url will contains `formDigest` value. The `formDigest` value is a hex-encoded MD5 hash, calculated using a combination of the fields and a salt value. [Read More](https://kb.ccbill.com/Dynamic+Pricing+User+Guide#Generating_the_MD5_Hash)
 
 
 ### Step 2:
 
-2. By clicking on this link user will be redirected to the CCBill payment form.
-This form is generated by admin. Find out more at [Configure your CCBill Account:](#configure-your-ccbill-account) section.
+2. By clicking on this link user will be redirected to the CCBill `payment form`.<br/>
+This form was generated by the admin inside CCBill admin panel.<br/>
+Find out more at [Configure your CCBill Account](#configure-your-ccbill-account) section.
 
 When user fill-in all fields. He can follow 2 way: `Approve` and `Deny`
 
 But here is two thing:
-1 On `Deny` response: App will propose to Try Again (User will stay at the payment system)
-2 On `Deny` response: App will receive `Deny` postback. ( `callbacks/ccbills#create` ). With Deny attributes.
-3 To Receive `Deny` redirect:
-> The reason you aren’t redirected to denial URL is because our system sees these declines as ‘soft’ declines, and by default, you need to have at least 3 soft declines in a row until you are redirected to denial url. So if you want to test denial redirection, you will need to click ‘Try again’ and fill out the credit card number for three consecutive times and you will be redirected. If the consumer is ‘hard’ declined(for example transaction is denied by consumer’s bank), he would be redirected after first form submission. Additionally, we can turn off this rule to have soft denial three times before redirection and if you would like us to do so, please confirm.
-4. Test Cards
-[Test cards](https://kb.ccbill.com/How+do+I+set+up+a+user+to+process+test+transactions) you can find here. But one thing you should remember: Only `CVV` metters:
->  When performing test transactions in Sandbox mode, cvv2 higher then 300 will result in approval even though you used denial credit card. If you try to test it in live mode, you would receive denial no matter what cvv2 you are using.
+1. On `Deny` response: App will propose to Try Again (User will stay at the payment system)
+2. On `Deny` response: App will receive `Deny` webhook callback (`callbacks/ccbills#create`) that will contain `Deny` attributes.
+3. To Receive `Deny` redirect user must do 3 `Deny` attempt.
 
-### Step 2:
+> Explanation: The reason you aren’t redirected to denial URL is because our system sees these declines as ‘soft’ declines, and by default, you need to have at least 3 soft declines in a row until you are redirected to denial url. So if you want to test denial redirection, you will need to click ‘Try again’ and fill out the credit card number for three consecutive times and you will be redirected. If the consumer is ‘hard’ declined(for example transaction is denied by consumer’s bank), he would be redirected after first form submission. Additionally, we can turn off this rule to have soft denial three times before redirection and if you would like us to do so, please confirm.
 
-`Approval Path` and `Deny Path` we set up [here](#create-an-approval-url)
+4. Test Cards<br/>
+Test cards you can [find here](https://kb.ccbill.com/How+do+I+set+up+a+user+to+process+test+transactions).<br/>
+But one thing you should remember: Only `CVV` metters:<br/>
 
-**Approval Path**
+> Explanation: When performing test transactions in Sandbox mode, cvv2 higher then 300 will result in approval even though you used denial credit card. If you try to test it in live mode, you would receive denial no matter what cvv2 you are using.
 
-This is the path customers take when their transaction is approved. The Approval Tile is always below the Primary and Deny Tile. When editing the Approval Path, your options are limited.
+`Approval Path` and `Deny Path` was specified when we create FlexForm [here](#create-a-new-flexform)
 
-**Deny Path**
+**Approval Path**<br/>
+Customer will follow by this path if his transaction will be approved. You can find `Approval Tile` below the `Primary` and `Deny Tile`.
 
+**Deny Path**<br/>
 This is the path consumers take when they are declined on a transaction. They will be redirected to the deny path to try again. The Deny Tile is always to the right of the Primary Tile.
 
-To set up a Deny Path:
-
-- Click the Deny Tile. A new window has opened. It will be very similar to the one you saw when you created the Primary Tile.
-- Select one of several redirect options along the left side of the screen.
-  - New Form. Create a new FlexForm as you did for the Primary Tile.
-  - Existing Form. Use a previously made Form.
-  - URL. Add an external or internal link. Send customers back to your website or to a third party payment form.
-
-![Deny Path](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/redirect_path.png)
+![Approval and Deny paths](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/approval-and-deny.png)
 
 
 ### Step 3:
-After previouse steps, ccbill returns the customer to your Site through callbacks ( GET ) where you can catche the response and do proper redirect:
+After previouse steps, ccbill redirects the customer to the Site through callbacks ( GET ) where you can catche the response and do proper redirect:
 
 ```ruby
   callbacks_ccbill GET    /callbacks/ccbill(.:format)  callbacks/ccbills#show
-                   POST   /callbacks/ccbill(.:format)  callbacks/ccbills#create
 ```
 
 ### Step 4:
+When a transaction is approved or denied, data will be sent to the Webhooks URL, if that event has been selected within the configuration. The data sent will include everything passed into the payment form along with the data entered into the payment form by the consumer, excluding payment information. This data can be parsed and handled
 
-Postback: According to `POST` action in your controller.
-
-Background Post allows Merchants to receive data posts from our system to a script that the Merchant creates. Merchants can parse that data from the script into their databases/tables for member tracking. Background Post only works for NEW transactions.
-
-Some kind of background callback to the app that happens on each attempt to Pay
+Webhook: According to `POST` action in your controller:<br/>
+```ruby
+                   POST   /callbacks/ccbill(.:format)  callbacks/ccbills#create
+```
 
-This callback contains a lot of information of the attempt: [Background Post](https://kb.ccbill.com/Background+Post)
+Webhooks is some kind of background callback to the app that happens on each attempt to Pay.<br>
+This callback contains a lot of information of the attempt. For example: [NewSaleSuccess](https://kb.ccbill.com/Webhooks+User+Guide#NewSaleSuccess)
 
+> WebHooks vs Background Post
+> When you use webhooks, there is no need to use Postback also. The main difference is that Postback only sends notifications for approved and denied transactions, and webhooks sends posts for all existing events, for example, renewal, cancellation, failed rebill, refund, chargeback, void, etc. The complete list of events can be found [here](https://kb.ccbill.com/Webhooks+User+Guide#Webhooks_Notifications)
 
 
 # Setup guide
@@ -272,7 +290,7 @@ Please work with your CCBill support representative to activate Dynamic Pricing
 
 Please note that if Dynamic Pricing is enabled on the subaccount level, ALL signup forms on that subaccount must use Dynamic Pricing in order to function correctly. This includes forms created on the subaccount prior to Dynamic Pricing being enabled. If Dynamic Pricing is enabled only on a particular form and not the entire subaccount, other forms on that subaccount will not be required to use Dynamic Pricing.
 
-![URL Library](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/url_library.png)
+![Dynamic Pricing](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/dynamic-price.png)
 
 ### Creating a Salt / Encryption Key
 
@@ -298,10 +316,10 @@ Here is standart [Getting Started with Flex Froms](https://kb.ccbill.com/FlexFor
 
 #### Visit FlexForms:
 - Ensure All is selected in the top Client Account drop-down menu. FlexForms are not specific to sub accounts, and cannot be managed when a sub account is selected.
-- Navigate to the FlexForms Systems tab in the top menu bar and select FlexForms Payment Links. All existing forms will be displayed in a table.
+- Navigate to the `FlexForms Systems` tab in the top menu bar and select `FlexForms Payment Links`. All existing forms will be displayed in a table.
 - Make sure that you in sendbox ( Top left corner )
 
-#### Create an Approval URL
+#### Create Library of URLs (Approval and Deny)
 
 - Click the **URLs Library** button in the upper-right to create a new URL. The Saved URLs Editor dialog displays.
 - Create Payment Success URL
@@ -312,15 +330,14 @@ Here is standart [Getting Started with Flex Froms](https://kb.ccbill.com/FlexFor
 - Click Save to commit your changes.
 
 > Important:
-> 1. Do not create alot of flex-form. You can't delete them!
-> 2. This is URLS ( GET ) where user will be redirected after success/deny payment.
-> 3. We set `mppResponse=CheckoutSuccess` and `mppResponse=CheckoutFail` because we use this attribute at `callbacks/ccbills#show` action.
+> 2. This is URLS ( GET ) will be used to specify where CCBill should redirect User after success/deny payment.
+> 3. We set `mppResponse=CheckoutSuccess` and `mppResponse=CheckoutFail` because we use this attribute at `callbacks/ccbills#show` action to determine kind of response (success/fail).
 
 ![URLs Editor](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/url_editor.png)
 
 #### Create a New FlexForm
 
-- Click the `Add New** button in the upper-left to create a new form.
+- Click the **Add New** button in the upper-left to create a new form.
 - The **A New Form** dialog is displayed:
   - **Payment Flow Name**. At the top, enter a name for the new payment flow (this will be different than the form name, as a single form can be used in multiple flows). Forexample: 'Dev Form'
   - **Form Name**. Under Form Name, enter a name for the form. Forexample: '001ff'
@@ -329,54 +346,92 @@ Here is standart [Getting Started with Flex Froms](https://kb.ccbill.com/FlexFor
   - Save the form
 - Edit the Flow
   - Approval redirect to the Site
-    - Click the arrow button to the left of your new flow to view the details. ( Screenshot below )
+    - Click the arrow button to the left of your new flow to view the details. Approval Tile.
     - Under the green Approve arrow, click the square to modify the action.
     - **Approval URL**. In the left menu, select A URL. Select **Select a Saved URL** and select the URL your created earlier (e.g. Payment Success).
     - **Redirect Time**. Select a redirect time of 1 second using the slider at the bottom and save the form. ( e.g. 4 seconds )
   - Deny redirect to the Site
-    - Under the red Deny arrow, click the square to modify the action.
-    - **Approval URL. In the left menu, select A URL. Select **Select a Saved URL** and select the URL your created earlier (e.g. Payment Decline`).
+    - Under the red Deny arrow, click the square to modify the action. Deny Tile.
+    - **Approval URL**. In the left menu, select A URL. Select **Select a Saved URL** and select the URL your created earlier (e.g. `Payment Decline`).
     - **Redirect Time**. Select a redirect time of 1 second using the slider at the bottom and save the form. ( e.g. 7 seconds )
 - Flex ID. Make note of the Flex ID: this value will be entered into the your configuration file. ( `config/initializers/ccbill.rb` )
 
+> You may read how to setup instant redirect [here](#dev-expirience)
 
-#### Background Post
+> Important:
+> Do not create alot of FlexForm's. You can't delete them!
 
-While still in the **Sub Account Admin** section, select **Advanced** from the left menu. Notice the top section titled **Background Post Information**. We will be modifying the **Approval Post URL** and **Denial Post URL** fields.
+![Deny Path](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/redirect_path.png)
 
-Path | URL
---- | ---
-**Approval Post URL** | `http://[SiteHost or Ngrok]/callbacks/ccbill`
-**Denial Post URL** | `http://[SiteHost or Ngrok]/callbacks/ccbill`
 
-CCBill calls this URL in background.
+#### Webhooks
 
-Note: That will be `POST` request. In our case It will call `callbacks/ccbills#create` action. In this action based on patams we will find-out what request was called.
+In your CCBill admin interface, navigate to **Sub Account Admin** section, select **Webhooks** from the left menu.<br>
+Fill in `Webhook URL` text box with the `http://[SiteHost or Ngrok]/callbacks/ccbill` url. CCBill will call specified URL in background.<br>
+Make sure to check 'all' check boxes on this page and pick JSON Webhook Format<br>
 
-![Background Post Information](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/background_post_information.png)
+Note: That will be `POST` request.<br>
+In our case It will call `callbacks/ccbills#create` action.<br>
+In this action based on params we will find-out what request was called.
 
-**Your CCBill account is now configured**
+![Webhook information](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/webhooks.png)
 
+**:sparkles: Your CCBill account is now configured :sparkles:**
 
-# Go To LIVE:
 
-TODO:
+# Price Restrictions
+
+Price Minimums and Maximums<br/>
+All Merchants are assigned a default structure in line with the following:
+
+Pricing<br/>
+Minimum: $2.95 USD<br/>
+Maximum: $100.00 USD<br/>
+
+Time Periods<br/>
+Initial Period: 2-365 Days<br/>
+Rebill Period: 30, 60, or 90 Days<br/>
+
+> Changes to your available price ranges require upper management approval. If you would like to make changes, please contact CCBill Merchant Support. We'll talk to you about the changes you want and submit your request to the right people. This process can take one or two business days to complete.
+
+
+# Response Digest Value:
+
+In [Dynamic Pricing article](https://kb.ccbill.com/Dynamic+Pricing#Response_Digest_Value) was described that you can test digest value from response. That is true ONLY for `production` mode. In test mode digets value is not match.
+
+Gem allows you to test that via:
+
+```ruby
+postback = CCBill::Postback.new(params)
+postback.verified?    #=> True/False
+```
+
+> Important! This method work only in 'non-test' mode.
+> Important! This method work only for `NewSaleSuccess` and `NewSaleFailure`
+
+
+# Go To LIVE:
 
 The LINKS that you get from the Sandbox Mode page are different from the links that you get from the Live Mode page
 
+Do not forget to create another FlexForm for the production env.
+
 Please read next:
 - [FlexForms Sandbox](https://kb.ccbill.com/FlexForms+Sandbox?page_ref_id=452)
 - [FlexForms Form Status and Live Mode](https://kb.ccbill.com/FlexForms+Form+Status+and+Live+Mode?page_ref_id=453)
 
 # Dev Expirience:
 
-TODO:
-
-TODO: NGrok.
-
-TODO: 3) You are able to check the number and amount of test transactions you had in selected timeframe. In order to do so, please navigate to Reports >> Alphabetical list >> C >> Credit/check transactions >> select date range and select Test transactions from Options dropdown menu.
-
-TODO: !!! All prices must be between $2.95 and $100.
+1. Ngrok. For the local machine use `ngrok` to set real links from the Ccbill.
+2. Deny/Approval paths - Write to support to set "Redirect time in seconds:" to "Immediately". Without this option after approve/deny user will be redirected to the blank page with the URL of redirect ( image below ) and that page can't be customized, with this option user will instantly be redirected.
+![Redirect After Aprove](https://raw.githubusercontent.com/DmytroVasin/ccbill_ruby/master/images/redirect_after_approval.png)
+3. Check transactions: Admin are able to check the number and amount of test transactions you had in selected timeframe. In order to do so, please navigate to Reports >> Alphabetical list >> C >> Credit/check transactions >> select date range and select Test transactions from Options dropdown menu.
+4. All prices must be between [$2.95 and $100](https://kb.ccbill.com/Price+Minimums+and+Maximums)
+5. In development mode you can't check transaction from the point 3.
+6. Test transaction can't be "cancelled, void, etc". The only way you could test is to use real credit card and then refund the subscription after it rebills. Personnaly I tested only NewSaleSuccess, NewSaleFailure responses.
+7. All received responses I attached to the [Responses](https://github.com/DmytroVasin/ccbill_ruby/tree/master/responses). ( I little bit changed own info )
+8. Response Digest Value. In [Dynamic Pricing article](https://kb.ccbill.com/Dynamic+Pricing#Response_Digest_Value) was described that you can test digest value from response. That is true ONLY for `production` mode. In test mode digets value is not match.
+9. Do not create alot of FlexForm's. You can't delete them
 
 
 # Useful Links:
@@ -386,8 +441,11 @@ TODO: !!! All prices must be between $2.95 and $100.
 * [FlexForms Sandbox](https://kb.ccbill.com/FlexForms+Sandbox?page_ref_id=452)
 * [FlexForms Form Status and Live Mode](https://kb.ccbill.com/FlexForms+Form+Status+and+Live+Mode?page_ref_id=453)
 * [Test Transactions and Credit Cards](https://kb.ccbill.com/How+do+I+set+up+a+user+to+process+test+transactions)
-* [Background Post](https://kb.ccbill.com/Background+Post)
 * [Webhooks - prefil variables](https://kb.ccbill.com/Webhooks+User+Guide#Payment_Form)
+* [Price Minimums and Maximums](https://kb.ccbill.com/Price+Minimums+and+Maximums)
+* [Responses](https://github.com/DmytroVasin/ccbill_ruby/tree/master/responses)
+
+TODO: Datalink.
 
 # License
 

data/ccbill_ruby.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rspec", "~> 3.6.0"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "json"
 end

data/lib/ccbill_ruby/cli/install/ccbill.rb

@@ -5,4 +5,6 @@ CCBill.configure do |config|
   config.account = 'account_id'
   config.sub_account = '0000'
   config.flexform_id = 'flexform_id'
+  config.min_price = '2.95'
+  config.max_price = '100'
 end

data/lib/ccbill_ruby/cli/install/ccbill_controller.rb

@@ -1,10 +1,9 @@
 module Callbacks
   class CcbillsController < ApplicationController
-    # before_action :check_ccbill_callback, only: :create
 
     # GET: Redirect from payment system after approval/deny.
     def show
-      case response_params[:mppResponse]
+      case params[:mppResponse]
       when 'CheckoutSuccess'
         flash[:notice] = "Payment was successfully paid"
       when 'CheckoutFail'
@@ -16,23 +15,17 @@ module Callbacks
       redirect_to root_url
     end
 
-    # POST: Post Back
+    # POST: Webhooks
     def create
-      postback = CCBill::Postback.new(response_params)
-
-      if postback.approval?
-        # Do something "Approval" postback.
-      else
-        # Do something "Deny" postback.
+      begin
+        # Your code goes here.
+      rescue StandardError => error
+        # I assume we should put `rescue` statement because CCBill will call our server again and again untill he will receive 200
+        # When there was failure of sending webhooks or the system was under maintenance at the moment.
       end
 
-      head :no_content
+      head :ok
     end
 
-    private
-
-    def response_params
-      @response_params ||= params.except(:controller, :action).to_unsafe_h
-    end
   end
 end

data/lib/ccbill_ruby/configuration.rb

@@ -8,6 +8,9 @@ module CCBill
     attr_accessor :salt
     attr_accessor :default_currency
 
+    attr_accessor :min_price
+    attr_accessor :max_price
+
     attr_accessor :account
     attr_accessor :sub_account
 
@@ -19,6 +22,9 @@ module CCBill
       @mode = :test
       @default_currency = '840' # USD
 
+      @min_price = 2.95
+      @max_price = 100
+
       @test_endpoint = TEST_ENDPOINT
       @live_endpoint = LIVE_ENDPOINT
     end

data/lib/ccbill_ruby/dynamic_pricing.rb

@@ -5,11 +5,12 @@ module CCBill
     attr_accessor :variables, :config, :errors
 
     def initialize(options = {})
+      self.config = CCBill.configuration
+
       fail_on_price_set(options)
 
       modified_options = modify_params(options)
 
-      self.config = CCBill.configuration
       self.variables = {
         account:        config.account,
         sub_account:    config.sub_account,
@@ -18,7 +19,7 @@ module CCBill
     end
 
     def url
-      raise DynamicPricingError.new(errors.join(' ')) if !valid?
+      raise DynamicPricingError.new(self.errors.join(' ')) if !valid?
 
       variables[:form_digest] = encode_form_digest
 
@@ -26,23 +27,23 @@ module CCBill
     end
 
     def valid?
-      @errors = []
+      self.errors = []
 
       required_fields.each do |field|
-        @errors << "#{field} is required." if !variables[field]
+        self.errors << "#{field} is required." if !variables[field]
       end
 
-      unless (2.96..99.99).include?(variables[:initial_price].to_f)
-        @errors << 'Initial price must be between $2.95 and $100.'
+      unless (config.min_price.to_f..config.max_price.to_f).include?(variables[:initial_price].to_f)
+        self.errors << "Initial price must be between $#{config.min_price} and $#{config.max_price}."
       end
 
       if recurring?
-        unless (2.96..99.99).include?(variables[:recurring_price].to_f)
-          @errors << 'Recurring price must be between $2.95 and $100.'
+        unless (config.min_price.to_f..config.max_price.to_f).include?(variables[:recurring_price].to_f)
+          self.errors << "Recurring price must be between $#{config.min_price} and $#{config.max_price}."
         end
       end
 
-      @errors.empty?
+      self.errors.empty?
     end
 
     private

data/lib/ccbill_ruby/postback.rb

@@ -6,34 +6,32 @@ module CCBill
       self.response_params = response_params
     end
 
-    def approval?
-      !denial?
+    def verified?
+      # NOTE: https://github.com/DmytroVasin/ccbill_ruby#response-digest-value
+      return true if CCBill.configuration.test?
+
+      response_params['dynamicPricingValidationDigest'] == encode_digest_response
     end
 
-    def denial?
-      [:reasonForDeclineCode, :reasonForDecline, :denialId].any? do |key|
+    private
+
+    def denied?
+      ['failureCode', 'failureReason'].any? do |key|
         !response_params[key].to_s.strip.empty?
       end
     end
 
-    def verified?
-      fail 'NOTE: Does not work on test env - Did not check for production.'
-      response_params[:responseDigest] == encode_digest_response
-    end
-
-    private
-
     def encode_digest_response
-      verify_fields = if approval?
+      verify_fields = if denied?
         [
-          response_params[:subscription_id],
-          '1',
+          response_params['transactionId'],
+          '0',
           CCBill.configuration.salt
         ]
       else
         [
-          response_params[:denialId],
-          '0',
+          response_params['subscriptionId'],
+          '1',
           CCBill.configuration.salt
         ]
       end

data/lib/ccbill_ruby/version.rb

@@ -1,3 +1,3 @@
 module CCBill
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/responses/cancellation.json

@@ -0,0 +1,9 @@
+{
+  "eventType": "Cancellation",
+  "clientAccnum":"007687",
+  "clientSubacc":"0001",
+  "reason":"Satisfied Customer",
+  "source":"customerSupport",
+  "subscriptionId":"0117240102000000048",
+  "timestamp":"2017-07-01 05:18:43"
+}

data/responses/chargeback.json

@@ -0,0 +1,15 @@
+{
+   "eventType": "Chargeback",
+   "accountingAmount":"19.99",
+   "accountingCurrency":"USD",
+   "accountingCurrencyCode":"840",
+   "amount":"19.99",
+   "clientAccnum":"007687",
+   "clientSubacc":"0001",
+   "currency":"USD",
+   "currencyCode":"840",
+   "reason":"Charged Back on 05\/05\/2016",
+   "subscriptionId":"02161032010000000000",
+   "timestamp":"2016-05-05 04:37:59",
+   "transactionId":"02161032010000000000"
+}

data/responses/reccuring_new_sale_failure.json

@@ -0,0 +1,58 @@
+{
+   "accountingCurrency":"USD",
+   "accountingCurrencyCode":"840",
+   "accountingInitialPrice":"18.0",
+   "accountingRecurringPrice":"18.0",
+   "address1":"asdasdasd",
+   "billedCurrency":"USD",
+   "billedCurrencyCode":"840",
+   "billedInitialPrice":"18.00",
+   "billedRecurringPrice":"18.00",
+   "cardType":"VISA",
+   "city":"asdasdad",
+   "clientAccnum":"007687",
+   "clientSubacc":"0001",
+   "country":"UA",
+   "dynamicPricingValidationDigest":"ed7d71a3a7d34d4be2f1153d5058538c",
+   "email":"test@gmail.com",
+   "failureCode":"BE-900",
+   "failureReason":"transaction declined",
+   "firstName":"Mellowcollen",
+   "flexId":"08db4ae9-0000-0000-0000-e0275cf91c00",
+   "formName":"003ff",
+   "ipAddress":"217.20.178.5",
+   "initialPeriod":"30",
+   "lastName":"asdasdasd",
+   "paymentType":"CREDIT",
+   "postalCode":"123123",
+   "priceDescription":"$18.00(USD) for 30 days then $18.00(USD) recurring every 30 days",
+   "rebills":"99",
+   "recurringPeriod":"30",
+   "recurringPriceDescription":"$18.00(USD) recurring every 30 days",
+   "referringUrl":"http://localhost:3000/users/00000",
+   "state":"Chernihivs`ka Oblast`",
+   "subscriptionCurrency":"USD",
+   "subscriptionCurrencyCode":"840",
+   "subscriptionInitialPrice":"18.00",
+   "subscriptionRecurringPrice":"18.00",
+   "timestamp":"2017-08-28 07:08:09",
+   "transactionId":"0117240102000000048",
+   "X-clientSubacc":"0004",
+   "X-clientAccnum":"947687",
+   "X-email":"collenmellow@gmail.com",
+   "X-customer_fname":"Mellowcollen",
+   "X-mpp_model_id":"00000",
+   "X-mpp_subscriber_id":"00000",
+   "X-numRebills":"99",
+   "X-recurringPeriod":"30",
+   "X-initialPeriod":"30",
+   "X-currencyCode":"840",
+   "X-formDigest":"ed7d71a3a7d34d4be2f1153d5058538c",
+   "X-recurringPrice":"18.00",
+   "X-initialPrice":"18.00",
+   "X-city":"",
+   "eventType":"NewSaleFailure",
+   "eventGroupType":"Subscription",
+   "controller":"callbacks/ccbills",
+   "action":"create"
+}

data/responses/reccuring_new_sale_success.json

@@ -0,0 +1,63 @@
+{
+   "accountingCurrency":"USD",
+   "accountingCurrencyCode":"840",
+   "accountingInitialPrice":"18.0",
+   "accountingRecurringPrice":"18.0",
+   "address1":"asdasdasd",
+   "billedCurrency":"USD",
+   "billedCurrencyCode":"840",
+   "billedInitialPrice":"18.00",
+   "billedRecurringPrice":"18.00",
+   "bin":"444444",
+   "cardType":"VISA",
+   "city":"asdasdad",
+   "clientAccnum":"007687",
+   "clientSubacc":"0001",
+   "country":"UA",
+   "dynamicPricingValidationDigest":"ed7d71a3a7d34d4be2f1153d5058538c",
+   "email":"test@gmail.com",
+   "expDate":"0322",
+   "firstName":"Mellowcollen",
+   "flexId":"08db4ae9-0000-0000-0000-e0275cf91c00",
+   "formName":"003ff",
+   "initialPeriod":"30",
+   "ipAddress":"217.20.178.5",
+   "last4":"6666",
+   "lastName":"asdasdasd",
+   "nextRenewalDate":"2017-09-27",
+   "paymentAccount":"5bbb1dc47a3595bdfedce0000001cd3",
+   "paymentType":"CREDIT",
+   "postalCode":"123123",
+   "priceDescription":"$18.00(USD) for 30 days then $18.00(USD) recurring every 30 days",
+   "rebills":"99",
+   "recurringPeriod":"30",
+   "recurringPriceDescription":"$18.00(USD) recurring every 30 days",
+   "referringUrl":"http://localhost:3000/users/000000",
+   "state":"Chernihivs`ka Oblast`",
+   "subscriptionCurrency":"USD",
+   "subscriptionCurrencyCode":"840",
+   "subscriptionId":"0117240102000000049",
+   "subscriptionInitialPrice":"18.00",
+   "subscriptionRecurringPrice":"18.00",
+   "subscriptionTypeId":"0000000464",
+   "timestamp":"2017-08-28 07:08:52",
+   "transactionId":"0117240102000000049",
+   "X-clientSubacc":"007687",
+   "X-clientAccnum":"0001",
+   "X-email":"collenmellow@gmail.com",
+   "X-customer_fname":"Mellowcollen",
+   "X-mpp_model_id":"000000",
+   "X-mpp_subscriber_id":"00000",
+   "X-numRebills":"99",
+   "X-recurringPeriod":"30",
+   "X-initialPeriod":"30",
+   "X-currencyCode":"840",
+   "X-formDigest":"ed7d71a3a7d34d4be2f1153d5058538c",
+   "X-recurringPrice":"18.00",
+   "X-initialPrice":"18.00",
+   "X-city":"",
+   "eventType":"NewSaleSuccess",
+   "eventGroupType":"Subscription",
+   "controller":"callbacks/ccbills",
+   "action":"create"
+}

data/responses/single_new_sale_success.json

@@ -0,0 +1,55 @@
+{
+   "accountingCurrency":"USD",
+   "accountingCurrencyCode":"840",
+   "accountingInitialPrice":"45.0",
+   "address1":"test",
+   "billedCurrency":"USD",
+   "billedCurrencyCode":"840",
+   "billedInitialPrice":"45.00",
+   "billedRecurringPrice":"0.00",
+   "bin":"444444",
+   "cardType":"VISA",
+   "city":"test",
+   "clientAccnum":"007687",
+   "clientSubacc":"0001",
+   "country":"UA",
+   "dynamicPricingValidationDigest":"8f32cc52c16e9d0117a6a52c3a7325a1",
+   "email":"test@gmail.com",
+   "expDate":"0219",
+   "firstName":"Mellowcollen",
+   "flexId":"08db4ae9-0000-0000-0000-e0275cf91c00",
+   "formName":"00001",
+   "initialPeriod":"90",
+   "ipAddress":"000.20.000.5",
+   "last4":"6666",
+   "lastName":"test",
+   "paymentAccount":"00000000003595bdfedce0000000000",
+   "paymentType":"CREDIT",
+   "postalCode":"123123",
+   "priceDescription":"$45.00(USD) for 90 days (non-recurring)",
+   "rebills":"0",
+   "recurringPeriod":"0",
+   "referringUrl":"http://localhost:3000/users/00000",
+   "state":"Chernihivs`ka Oblast`",
+   "subscriptionCurrency":"USD",
+   "subscriptionCurrencyCode":"840",
+   "subscriptionId":"0117240102000000041",
+   "subscriptionInitialPrice":"45.00",
+   "subscriptionRecurringPrice":"0.00",
+   "subscriptionTypeId":"0000000891",
+   "timestamp":"2017-08-28 06:06:03",
+   "transactionId":"0117240102000000041",
+   "X-clientSubacc":"007687",
+   "X-clientAccnum":"0001",
+   "X-initialPrice":"45.00",
+   "X-city":"",
+   "X-email":"collenmellow@gmail.com",
+   "X-customer_fname":"Mellowcollen",
+   "X-mpp_model_id":"00000",
+   "X-mpp_subscriber_id":"000000",
+   "X-initialPeriod":"90",
+   "X-formDigest":"8f32cc52c16e9d0117a6a52c3a7325a1",
+   "X-currencyCode":"840",
+   "eventType":"NewSaleSuccess",
+   "eventGroupType":"Subscription"
+}

data/responses/void.json

@@ -0,0 +1,15 @@
+{
+   "eventType": "Void",
+   "accountingAmount":"48.99",
+   "accountingCurrency":"USD",
+   "accountingCurrencyCode":"840",
+   "amount":"48.99",
+   "clientAccnum":"007687",
+   "clientSubacc":"0001",
+   "currency":"USD",
+   "currencyCode":"840",
+   "reason":"Threatened CB",
+   "subscriptionId":"0000006401000006464",
+   "timestamp":"2017-01-27 13:31:12",
+   "transactionId":"0000000001000006464"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccbill_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Dmytro Vasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides interfaces to interact with CCBill services.
 email:
 - dmytro.vasin@gmail.com
@@ -87,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -98,13 +113,15 @@ files:
 - bin/console
 - bin/setup
 - ccbill_ruby.gemspec
-- images/background_post_information.png
+- images/approval-and-deny.png
 - images/billing_tools.png
 - images/disabling_user_management.png
+- images/dynamic-price.png
 - images/encryption_key.png
+- images/redirect_after_approval.png
 - images/redirect_path.png
 - images/url_editor.png
-- images/url_library.png
+- images/webhooks.png
 - lib/ccbill_ruby.rb
 - lib/ccbill_ruby/cli.rb
 - lib/ccbill_ruby/cli/install.rb
@@ -114,6 +131,12 @@ files:
 - lib/ccbill_ruby/dynamic_pricing.rb
 - lib/ccbill_ruby/postback.rb
 - lib/ccbill_ruby/version.rb
+- responses/cancellation.json
+- responses/chargeback.json
+- responses/reccuring_new_sale_failure.json
+- responses/reccuring_new_sale_success.json
+- responses/single_new_sale_success.json
+- responses/void.json
 homepage: https://github.com/DmytroVasin/ccbill_ruby/
 licenses:
 - MIT