ccbill_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5f17c7f42a9062584e7ea2c733453a305cbdb2d
-  data.tar.gz: ba9ff6bcda4f7cdf1a405ad0a69a6cb62848df71
+  metadata.gz: 39968023a09afce1fef462927e886edee7bc51e9
+  data.tar.gz: 4e67d3bf54326c605939a446be2edbbb2477187f
 SHA512:
-  metadata.gz: 657b6f24d71f39d9ea0a7d7363134e10053e54a849862008bc56d739270029ecf2b9a1e2fdb350c49664ddefd4eac047e6fbd9d2c9242d17198711c8e2d93a28
-  data.tar.gz: 949d77be90c1ee5012a33d80c7ddc3961ce5af4b1edb89427691a13050382f65c531daad9b87bc8345de95f86893586292bc5fa62c4f6f8658970691869e38c3
+  metadata.gz: 3c4c8c0de66eaed747eb7a44c982dc9f1f7f7a119fc73b40439631b6b0661d4627fc9503d672dd9e7ce33ded621c6466d18724f78b59122fb86d11e31dccc52c
+  data.tar.gz: f46011f2a0a7eb268224cd66aa25bc6c5670a35a1f26d04f54edaf5c1971abe3afc7fc1d691a06080f682c045ae68fe7bd235ef0e930ea1324d5e9e703f17439

data/README.md

@@ -1,6 +1,4 @@
-# GEM IS UNDER CONSNSTRUCTION!
-
-Please Mail me if any - 'dmytro.vasin@gmail.com'
+**Please mail me if any: dmytro.vasin@gmail.com**
 
 # CCBill SDK for Ruby
 
@@ -14,6 +12,10 @@ This gem provides:
   - Background Post 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.
+
+
 # Getting started
 
 ```ruby
@@ -33,6 +35,7 @@ This will create a controller (if one does not exist) and configure it with the
 
 ## Example of usage:
 
+Simple version:
 ```ruby
 form = Ccbill::DynamicPricing.new({
   initial_price_in_cents: 355
@@ -44,6 +47,17 @@ 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)
+
+```ruby
+form = Ccbill::DynamicPricing.new({
+  initial_price_in_cents: 355
+  initial_period: 30,
+  order_id: 'Any configuration information',
+  customer_fname: 'Dmytro',
+  customer_lname: 'Vasin'
+})
+```
 
 ## Controller and methods:
 
@@ -112,69 +126,84 @@ Before reading this part - please read [Setup guide](#setup-guide)
   end
 ```
 
-
-
-
-
-
-
-
-
-
-
-
-
 # Payment Flow
 
-TODO: Video or Etc...
-TODO: NGrok.
-TODO: User should be logged in in the admin panel.
-TODO: Deny redirect happens only after three attempt.
+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:
 
-```ruby
-  callbacks_ccbill GET    /callbacks/ccbill(.:format)  callbacks/ccbills#show
-                   POST   /callbacks/ccbill(.:format)  callbacks/ccbills#create
-```
-
-> Important!
-> CCBill provides two types of payment forms. FlexForms is our newest (and recommended) system. In this gem we use ONLY FlexForms.
-
-
-
-
+### Step 1:
 
+1. You should generate LINK that contains information about order/subscription
 
-!!! https://kb.ccbill.com/How+do+I+set+up+a+user+to+process+test+transactions
-
-
-!!! All prices must be between $2.95 and $100.
-
-!!! CVV only metters!
+This gem will help you in this, next script will generate link:
+```ruby
+Ccbill::DynamicPricing.new({
+  initial_price_in_cents: 355
+  initial_period: 30,
+  order_id: 'Any configuration 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)
 
 
+### 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.
 
+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.
 
+### Step 2:
 
+`Approval Path` and `Deny Path` we set up [here](#create-an-approval-url)
 
+**Approval Path**
 
+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.
 
+**Deny Path**
 
+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)
 
 
+### 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:
 
+```ruby
+  callbacks_ccbill GET    /callbacks/ccbill(.:format)  callbacks/ccbills#show
+                   POST   /callbacks/ccbill(.:format)  callbacks/ccbills#create
+```
 
+### Step 4:
 
+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
 
+This callback contains a lot of information of the attempt: [Background Post](https://kb.ccbill.com/Background+Post)
 
 
 
@@ -339,6 +368,17 @@ 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.
+
+
 # Useful Links:
 * [Dynamic Pricing](https://kb.ccbill.com/Dynamic+Pricing)
 * [FlexForm FAQs](https://kb.ccbill.com/FlexForms+FAQs)
@@ -346,6 +386,8 @@ 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)
 * [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)
 
 # License
 

data/lib/ccbill_ruby/dynamic_pricing.rb

@@ -5,6 +5,8 @@ module CCBill
     attr_accessor :variables, :config, :errors
 
     def initialize(options = {})
+      fail_on_price_set(options)
+
       modified_options = modify_params(options)
 
       self.config = CCBill.configuration
@@ -31,7 +33,13 @@ module CCBill
       end
 
       unless (2.96..99.99).include?(variables[:initial_price].to_f)
-        @errors << 'Price must be between $2.95 and $100.'
+        @errors << 'Initial price must be between $2.95 and $100.'
+      end
+
+      if recurring?
+        unless (2.96..99.99).include?(variables[:recurring_price].to_f)
+          @errors << 'Recurring price must be between $2.95 and $100.'
+        end
       end
 
       @errors.empty?
@@ -46,7 +54,7 @@ module CCBill
           variables[:initial_period],
           variables[:recurring_price],
           variables[:recurring_period],
-          variables[:rebills],
+          variables[:num_rebills],
           variables[:currency_code],
           config.salt
         ]
@@ -63,7 +71,7 @@ module CCBill
     end
 
     def recurring?
-      variables[:recurring_price] || variables[:recurring_period] || variables[:rebills]
+      variables[:recurring_price] || variables[:recurring_period] || variables[:num_rebills]
     end
 
     def required_fields
@@ -76,7 +84,7 @@ module CCBill
         req += [
           :recurring_price,
           :recurring_period,
-          :rebills
+          :num_rebills
         ]
       end
 
@@ -92,7 +100,7 @@ module CCBill
         currency_code:    'currencyCode',
         recurring_price:  'recurringPrice',
         recurring_period: 'recurringPeriod',
-        rebills:          'numRebills',
+        num_rebills:      'numRebills',
         form_digest:      'formDigest'
       }[internal] || internal
     end
@@ -115,11 +123,23 @@ module CCBill
       initial_cents = options.delete(:initial_price_in_cents)
       options[:initial_price] = convert_to_price(initial_cents) if initial_cents
 
+      recurring_cents = options.delete(:recurring_price_in_cents)
+      options[:recurring_price] = convert_to_price(recurring_cents) if recurring_cents
+
       options
     end
 
     def convert_to_price(cents)
       '%.2f' % (cents / 100.to_f)
     end
+
+    def fail_on_price_set(options)
+      compared_array = [:initial_price, :recurring_price] & options.keys
+      if compared_array.any?
+        array_with_cents = compared_array.map{|word| word.to_s + '_in_cents' }.join(', ')
+
+        fail SyntaxError, "You misspelled! Gem uses #{array_with_cents} value(s)."
+      end
+    end
   end
 end

data/lib/ccbill_ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccbill_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dmytro Vasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -102,6 +102,7 @@ files:
 - images/billing_tools.png
 - images/disabling_user_management.png
 - images/encryption_key.png
+- images/redirect_path.png
 - images/url_editor.png
 - images/url_library.png
 - lib/ccbill_ruby.rb