voucherify 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac6bfd1ead5ca241b7d5d62d1e0a18b2b34f6269
-  data.tar.gz: 334f47cdd657274805b1506b794f7d515df6f982
+  metadata.gz: 6fe764e120a047b704074d28bb3557e97412e421
+  data.tar.gz: e79ac6e9a61e40746d9fcd39ca7a51af40b88a00
 SHA512:
-  metadata.gz: 588e0ab94075bebf6cf57feb95528f9ef8d7cc048d0e7a61f8c2864e319498d63b44dc1ec8908da60f01678d21e146c69f633e315c6d74e46c7a1d9bcd7c54fe
-  data.tar.gz: 7e2ca93824f47367b5cdeeece4dabe3d1681e58d3364324ea611c172ac476c33952315114a367a6604fd6352f5c5136e01a7d2a9605fade26b9d88dcddee6034
+  metadata.gz: d6ded6e46fcf6e24e021fac76c04e13e2ddd6b3264556b57a05f5d87d1604116daa1207e7d4e66d8ac1139103fb9bc67974136f7e7b6d391a13e002a3d74c98d
+  data.tar.gz: 92b7bcb922ba68e442d62b285fc16710a689491e6ac11fb0c08b4f91a18a6c2a5982a1aac4c5dfd9727f09f498cc8eef14eb8771af2834240049f93e8d2c7e1f

data/README.md

@@ -1,12 +1,10 @@
 ## Voucherify Ruby SDK
 
-[Voucherify](http://voucherify.io?utm_source=github&utm_medium=sdk&utm_campaign=acq) has a new platform that will help your team automate voucher campaigns. It does this by providing composable API and the marketer-friendly interface that increases teams' productivity:
+[Voucherify](http://voucherify.io?utm_source=github&utm_medium=sdk&utm_campaign=acq) is an API-first platform for software developers who are dissatisfied with high-maintenance custom coupon software. Our product is a coupon infrastructure through API that provides a quicker way to build coupon generation, distribution and tracking. Unlike legacy coupon software we have:
 
-- **roll-out thousands** of vouchers **in minutes** instead of weeks,
-- **check status** or disable **every single** promo code in real time,
-- **track redemption** history and build reports on the fly.
-
-Here you can find a library that makes it easier to integrate Voucherify with your Ruby server.
+* an API-first SaaS platform that enables customisation of every aspect of coupon campaigns
+* a management console that helps cut down maintenance and reporting overhead
+* an infrastructure to scale up coupon activity in no time
 
 Full documentation is located at [voucherify.readme.io](https://voucherify.readme.io).
 
@@ -85,47 +83,77 @@ voucherify.list({ limit: 10, skip: 20, category: "API Test" })
 Result:
 ```json
 [{
-     "code": "9mYBpIk",
-     "campaign": null,
-     "category": "API Test",
-     "type": "DISCOUNT_VOUCHER",
-     "discount": {
-       "type": "AMOUNT",
-       "amount_off": 400
-     },
-     "start_date": "2016-03-01T12:00:00Z",
-     "expiration_date": null,
-     "redemption": {
-       "quantity": 1,
-       "redeemed_quantity": 0,
-       "redemption_entries": []
-     },
-     "active": true,
-     "additional_info": null,
-     "metadata": null
-   },
-   {
-       "code": "AzTsIH",
-       "campaign": null,
-       "category": "API Test",
-       "type": "GIFT_VOUCHER",
-       "gift": {
-         "amount": 5000
-       },
-       "start_date": "2016-03-01T10:00:00Z",
-       "expiration_date": null,
-       "redemption": {
-        "quantity": 1,
+    "code": "9mYBpIk",
+    "campaign": null,
+    "category": "API Test",
+    "type": "DISCOUNT_VOUCHER",
+    "discount": {
+    "type": "AMOUNT",
+        "amount_off": 400
+    },
+    "start_date": "2016-03-01T12:00:00Z",
+    "expiration_date": null,
+    "publish": {
+        "object": "list",
+        "count": 1,
+        "data_ref": "entries",
+        "entries": [{
+            "channel": "Email",
+            "customer": "alice.morgan@email.com",
+            "customer_id": "cust_1fnSUBno3iimKTPNDCkjg4xV",
+            "published_at": "2016-01-22T09:25:07Z"
+        }]
+    },
+    "redemption": {
+        "object": "list",
+        "quantity": 3,
+        "data_ref": "redemption_entries",
+        "redeemed_quantity": 1,
+        "redemption_entries": [{
+            "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+            "object": "redemption",
+            "date": "2016-04-24T06:03:35Z",
+            "customer_id": null,
+            "tracking_id": "(tracking_id not set)"
+        }]
+    },
+    "active": true,
+    "additional_info": null,
+    "metadata": null
+}, {
+    "code": "AzTsIH",
+    "campaign": null,
+    "category": "API Test",
+    "type": "GIFT_VOUCHER",
+    "gift": {
+        "amount": 10000,
+        "balance": 5000
+    },
+    "start_date": "2016-03-01T10:00:00Z",
+    "expiration_date": null,
+    "publish": {
+        "object": "list",
+        "count": 1,
+        "data_ref": "entries",
+        "entries": [{
+            "channel": "Email",
+            "customer": "alice.morgan@email.com",
+            "customer_id": "cust_1fnSUBno3iimKTPNDCkjg4xV",
+            "published_at": "2016-01-22T09:25:07Z"
+        }]
+    },
+    "redemption": {
+        "object": "list",
+        "quantity": 0,
+        "data_ref": "redemption_entries",
         "redeemed_quantity": 0,
         "redeemed_amount": 0,
         "redemption_entries": []
-       },
-       "active": true,
-       "additional_info": null,
-       "metadata": null
-   },
-   ...
-]  
+    },
+    "active": true,
+    "additional_info": null,
+    "metadata": null
+}]  
 ```
 
 #### Getting voucher details
@@ -145,8 +173,21 @@ Result:
         "type": "PERCENT"
     },
     "expiration_date": "2016-12-31T23:59:59Z",
+    "publish": {
+        "object": "list",
+        "count": 1,
+        "data_ref": "entries",
+        "entries": [{
+            "channel": "Email",
+            "customer": "alice.morgan@email.com",
+            "customer_id": "cust_1fnSUBno3iimKTPNDCkjg4xV",
+            "published_at": "2016-01-22T09:25:07Z"
+        }]
+    },
     "redemption": {
+        "object": "list",
         "quantity": 3,
+        "data_ref": "redemption_entries",
         "redeemed_quantity": 1,
         "redemption_entries": [
             {
@@ -195,11 +236,19 @@ Example:
 ```ruby
 voucherify.publish("First Ride")
 ```
+
 or
+
 ```ruby
 voucherify.publish({campaign: "First Ride", channel: "Email", customer: "donny.roll@mail.com"})
 ```
 
+or
+
+```ruby
+voucherify.publish({voucher: "FR-zT-u9I7zG", channel: "Email", customer: "donny.roll@mail.com"})
+```
+
 Positive result:
 
 ```json
@@ -214,15 +263,20 @@ Positive result:
    "start_date": "2015-01-01T00:00:00Z",
    "expiration_date": "2016-12-31T23:59:59Z",
    "publish": {
+        "object": "list",
         "count": 1,
+        "data_ref": "entries",
         "entries": [{
             "channel": "Email",
             "customer": "donny.roll@mail.com",
+            "customer_id": "cust_1fnSUBno3iimKTPNDCkjg4xV",
             "published_at": "2016-01-22T09:25:07Z"
         }]
    },
    "redemption": {
-      "quantity": 1,
+      "object": "list",
+      "quantity": 0,
+      "data_ref": "redemption_entries",
       "redeemed_quantity": 0,
       "redemption_entries": []
    },
@@ -246,33 +300,38 @@ Validation lets you check if given voucher code can be successfuly redeemed.
 
 `voucherify.validate(code, context)`
 
-The `context` param is generaly optional unless you are validating a gift voucher. 
+The `context` param is generally optional unless you are validating a gift voucher or a voucher with order validation rules. 
 Then you have to pass `order.amount` expressed in cents (e.g. $10 is 1000).
+Validation rules also require to pass `order.items` as a list of objects including `product_id`, `sku_id` and `quantity`.
 
 Example:
 
 ```
 validation_result = voucherify.validate("91Ft4U", {
-   tracking_id: "john@lemon.com",
+    tracking_id: "john@lemon.com",
     customer: {
          id: "cust_07sVjVsr71Ewot9lVZSrIVLH",
          source_id: "john@lemon.com",
          name: "John Lemon"
-     },
-     order: {
-        amount: 1000
+    },
+    order: {
+        amount: 1250
+        items: [
+             { product_id: "prod_ELvEXqF4qzB7Rs", sku_id: "sku_GoXSOI4FwJZafb", quantity: 1 },
+             { product_id: "prod_wye1naw5JO5dh3", sku_id: "sku_U3rHSlfOCGUnbo", quantity: 2 }
+        ]
     }
 })
 ```
 
 Successful validation result:
 ```
-{"code"=>"91Ft4U", "valid"=>true, "gift"=>{"amount"=>10000}, "tracking_id"=>"john@lemon.com"}
+{"code"=>"91Ft4U", "valid"=>true, "gift"=>{"amount"=>10000, "balance"=>5000}, "tracking_id"=>"john@lemon.com"}
 ```
 
 Failed validation result:
 ```
-{"code"=>"91Ft4U", "valid"=>true, "reason"=>"gift amount exceeded", "tracking_id"=>"john@lemon.com"}
+{"code"=>"91Ft4U", "valid"=>false, "reason"=>"gift amount exceeded", "tracking_id"=>"john@lemon.com"}
 ```
 
 There are several reasons why validation may fail (`valid: false` response). You can find the actual cause in the `reason` field:
@@ -283,6 +342,8 @@ There are several reasons why validation may fail (`valid: false` response). You
 - `voucher expired`
 - `quantity exceeded`
 - `gift amount exceeded`
+- `customer does not match segment rules`
+- `order does not match validation rules`
 
 #### Redeeming voucher
 
@@ -311,7 +372,9 @@ Result (voucher details after redemption):
         },
         "expiration_date": "2016-12-31T23:59:59Z",
         "redemption": {
+            "object": "list",
             "quantity": 3,
+            "data_ref": "redemption_entries",
             "redeemed_quantity": 2,
             "redemption_entries": [
                 {
@@ -437,8 +500,9 @@ voucherify.redeem({
 
 ##### 5. With order amount
 
-Redeeming a gift voucher requires to pass an amount that you wish to withdraw from the voucher.
-Order amount have to be expressed in cents, as an integer. For example $22.50 should be provided as 2250:    
+Redeeming a gift voucher requires passing order amount. The same applies to vouchers with validation rules on order's total amount.  
+Order amount have to be expressed in cents, as an integer. For example $22.50 should be provided as 2250.
+Gift voucher balance will be used to cover the order amount entirely or partially.
 
 ```ruby
 voucherify.redeem({
@@ -448,6 +512,21 @@ voucherify.redeem({
         })
 ```
 
+##### 6. With order items
+
+Vouchers with validation rules regarding products or SKUs require to pass `order.items`.
+Items are a list of objects consisting of `product_id`, `sku_id` and `quantity`.
+
+```javascript
+voucherify.redeem({
+        voucher: "91Ft4U",
+        order: {
+            items: [
+                { product_id: "prod_ELvEXqF4qzB7Rs", sku_id: "sku_GoXSOI4FwJZafb", quantity: 1 },
+                { product_id: "prod_wye1naw5JO5dh3", sku_id: "sku_U3rHSlfOCGUnbo", quantity: 2 }
+            ]
+        })
+```
 
 #### Listing redemptions
 
@@ -528,8 +607,16 @@ Result (voucher details):
     },
     "start_date": "2016-01-01T00:00:00Z",
     "expiration_date": "2016-12-31T23:59:59Z",
+    "publish": {
+        "object": "list",
+        "count": 0,
+        "data_ref": "entries",
+        "entries": []
+    },
     "redemption": {
+        "object": "list",
         "quantity": 1,
+        "data_ref": "redemption_entries",
         "redeemed_quantity": 0,
         "redemption_entries": []
     },
@@ -607,8 +694,16 @@ Result:
             "type": "PERCENT"
         },
         "expiration_date": "2016-12-31T23:59:59Z",
+        "publish": {
+            "object": "list",
+            "count": 0,
+            "data_ref": "entries",
+            "entries": []
+        },
         "redemption": {
+            "object": "list",
             "quantity": 3,
+            "data_ref": "redemption_entries",
             "redeemed_quantity": 2,
             "redemption_entries": [
                 {
@@ -807,6 +902,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/rspective/voucherify-ruby-sdk.
 
 ## Changelog
+- **2016-12-02** - `0.8.2` - support gift vouchers in utils, fix price and discount calculations for amount discounts 
+- **2016-10-03** - `0.8.1` - publish update 
 - **2016-08-02** - `0.8.0` - validate voucher
 - **2016-07-18** - `0.7.0` - voucher udpate
 - **2016-07-05** - `0.6.0` - new utils module

data/examples/utils.rb

@@ -1,21 +1,73 @@
-require 'voucherify/utils'
+require '../lib/voucherify/utils'
 
 include Utils
 
-discount = Utils.calculate_discount(20, {
+base_price = 20.00
+
+puts "base price: " + base_price.to_s
+
+puts "===== amount discount ====="
+amount_voucher = {
     discount: {
-        unit_off: 2.0,
-        type: 'UNIT'
+        amount_off: 1000, # 10.0
+        type: 'AMOUNT'
     }
-}, 5)
+}
+puts "discount:             " + Utils.calculate_discount(base_price, amount_voucher).to_s
+puts "price after discount: " + Utils.calculate_price(base_price, amount_voucher).to_s
+puts
+
 
-print(discount)
+puts "===== percent discount ===="
 
-discount = Utils.calculate_price(20, amount_voucher_object = {
+percent_discount_voucher = {
     discount: {
-        amount_off: 7.0,
-        type: 'AMOUNT'
+        percent_off: 20,
+        type: 'PERCENT'
+    }
+}
+
+puts "discount:             " + Utils.calculate_discount(base_price, percent_discount_voucher).to_s
+puts "price after discount: " + Utils.calculate_price(base_price, percent_discount_voucher).to_s
+puts
+
+
+puts "===== unit discount ======="
+
+unit_discount_voucher = {
+    discount: {
+        unit_off: 2,
+        type: 'UNIT'
+    }
+}
+
+puts "discount:             " + Utils.calculate_discount(base_price, unit_discount_voucher, 5).to_s
+puts "price after discount: " + Utils.calculate_price(base_price, unit_discount_voucher, 5).to_s
+puts
+
+
+puts "===== gift voucher ========"
+
+gift_voucher = {
+    gift: {
+        amount: 1000,
+        balance: 500
+    }
+}
+
+puts "discount:             " + Utils.calculate_discount(base_price, gift_voucher).to_s
+puts "price after discount: " + Utils.calculate_price(base_price, gift_voucher).to_s
+puts
+
+puts "===== gift voucher 2 ======"
+
+gift_voucher2 = {
+    gift: {
+        amount: 10000,
+        balance: 5000
     }
-})
+}
 
-print(discount)
+puts "discount:             " + Utils.calculate_discount(base_price, gift_voucher2).to_s
+puts "price after discount: " + Utils.calculate_price(base_price, gift_voucher2).to_s
+puts

data/lib/voucherify/utils.rb

@@ -22,6 +22,13 @@ module Utils
     end
 
     def calculate_price(base_price, voucher, unit_price = nil)
+        e = 100.0
+    
+        if voucher[:gift]
+            discount = [voucher[:gift][:balance] / e, base_price].min
+            return round_money(base_price - discount)          
+        end
+    
         if !voucher[:discount]
             raise "Unsupported voucher type."
         end
@@ -29,11 +36,11 @@ module Utils
         if voucher[:discount][:type] === 'PERCENT'
             discount = voucher[:discount][:percent_off]
             validate_percent_discount(discount);
-            price_discount = base_price * (discount / 100)
+            price_discount = base_price * (discount / 100.0)
             return round_money(base_price - price_discount)
 
         elsif voucher[:discount][:type] === 'AMOUNT'
-            discount = voucher[:discount][:amount_off]
+            discount = voucher[:discount][:amount_off] / e
             validate_amount_discount(discount)
             new_price = base_price - discount
             return round_money(new_price > 0 ? (new_price) : 0)
@@ -53,6 +60,13 @@ module Utils
     end
 
     def calculate_discount(base_price, voucher, unit_price = nil)
+        e = 100.0
+        
+        if voucher[:gift]
+            discount = [voucher[:gift][:balance] / e, base_price].min
+            return round_money(discount)          
+        end
+    
         if !voucher[:discount]
             raise "Unsupported voucher type."
         end
@@ -60,11 +74,11 @@ module Utils
         if voucher[:discount][:type] === 'PERCENT'
             discount = voucher[:discount][:percent_off]
             validate_percent_discount(discount);
-            price_discount = base_price * (discount / 100)
+            price_discount = base_price * (discount / 100.0)
             return round_money(price_discount)
 
         elsif voucher[:discount][:type] === 'AMOUNT'
-            discount = voucher[:discount][:amount_off]
+            discount = voucher[:discount][:amount_off] / e
             validate_amount_discount(discount)
             new_price = base_price - discount
             return round_money(new_price > 0 ? (discount) : (base_price))

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 class Voucherify
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
 description: 
@@ -73,7 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -97,17 +97,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Voucherify. More info on http://www.voucherify.io