voucherify 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 331f6a24ae1e9b9a777a6918b266238fe742f88f
-  data.tar.gz: b3ce1cfd31685e08e0e1167c71bd9882708ec6c5
+  metadata.gz: aa1601ccbeefeb58cfa46de45babc383d27a6afe
+  data.tar.gz: 07448203a4f06daabf97e0e282f37971e7235d51
 SHA512:
-  metadata.gz: 2a4b14ca70950f4e9cac4480185bdaebb605c9e706b179a03fb3f5d9220716c6afda7d24486474366d51ad0d8ffc827b59a63b65869d02c099bd54480ed72b9f
-  data.tar.gz: a272767515360acc0748c813380ec44f119e32afeb1932c92355e8194dd19a7e28419684509b832ec50fe3f6f67c84f6bbcdb1b8a70b8a338c801816b0f05420
+  metadata.gz: 006a45e1b0042c58e9ac589c8f75385ea5186020b65bb60c695b7d3cd45adc7666c0837ba16afd096665136d14e8bce52bd8bb9e1f315289fd9feba3b565130a
+  data.tar.gz: d9e6cf8f30ef571f2297f3b3f2cd23278d77375b4e31d2bdc9eb4896e6a97bea2895137f25e7bb7f4460805d6756a51a412a186187b59379e6ce787a40bcf95f

data/README.md

@@ -381,7 +381,7 @@ voucherify.redeem({
 
 ##### 4. With customer id
 
-If you already created a customer profile in Voucherify's database, whether it was implicitly by providing it to the `redeem` function or explicitly by invoking the [`customer.create`](#create-customer) method, you can identify your customer in following redemptions by a generated id (starting with `cust_`). 
+If you already created a customer profile in Voucherify's database, whether it was implicitly by providing it to the `redeem` function or explicitly by invoking the [`customer.create`](#create-customer) method, you can identify your customer in following redemptions by a generated id (starting with `cust_`).
 
 ```ruby
 voucherify.redeem({
@@ -412,7 +412,7 @@ Filter parameters:
 
 - limit (default: 100)
 - page (default: 0)
-- start_date (default: beginning of current month) 
+- start_date (default: beginning of current month)
 - end_date (default: end of current month)
 - result - Success | Failure-NotExist | Failure-Inactive
 - customer - id or source_id
@@ -653,6 +653,67 @@ voucherify.delete_customer("cust_WGG615E92dhOHz7PV9Vo9gk9")
 
 The response has empty body.
 
+#### Utilities
+
+These methods are used to help calculate prices and discounts.
+
+```ruby
+Utils.calculate_price(base_price, voucher, unit_price)
+Utils.calculate_discount(base_price, voucher, unit_price)
+```
+
+Example:
+
+```ruby
+voucher = {
+  category: "New Customers",
+  type: "DISCOUNT_VOUCHER",
+  discount: {
+    percent_off: 10.0,
+    type: "PERCENT"
+  },
+  start_date: "2016-01-01T00:00:00Z",
+  expiration_date: "2016-12-31T23:59:59Z",
+  redemption: {
+    quantity: 1
+  }
+}
+```
+```ruby
+Utils.calculate_price(20.0, voucher, 0);
+```
+
+Result:
+```ruby
+18
+```
+
+Example:
+
+```ruby
+voucher = {
+  category: "New Customers",
+  type: "DISCOUNT_VOUCHER",
+  discount: {
+    amount_off: 7.0,
+    type: "AMOUNT"
+  },
+  start_date: "2016-01-01T00:00:00Z",
+  expiration_date: "2016-12-31T23:59:59Z",
+  redemption: {
+    quantity: 1
+  }
+}
+```
+```ruby
+Utils.calculate_discount(20.0, voucher, 0);
+```
+
+Result:
+```ruby
+7
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -664,6 +725,7 @@ 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-07-05** - `0.6.0` - new utils module
 - **2016-06-16** - `0.5.0` - unified naming convention
 - **2016-06-12** - `0.4.0` - new customer sdk methods
 - **2016-05-24** - `0.3.0` - new publish structure

data/examples/utils.rb

@@ -0,0 +1,21 @@
+require 'voucherify/utils'
+
+include Utils
+
+discount = Utils.calculate_discount(20, {
+    discount: {
+        unit_off: 2.0,
+        type: 'UNIT'
+    }
+}, 5)
+
+print(discount)
+
+discount = Utils.calculate_price(20, amount_voucher_object = {
+    discount: {
+        amount_off: 7.0,
+        type: 'AMOUNT'
+    }
+})
+
+print(discount)

data/lib/voucherify/utils.rb

@@ -0,0 +1,85 @@
+module Utils
+    def round_money(value)
+        value.round(2)
+    end
+
+    def validate_percent_discount(discount)
+        if !(discount.is_a? Numeric) || !discount.between?(0, 100)
+            raise "Invalid voucher, percent discount should be between 0-100."
+        end
+    end
+
+    def validate_amount_discount(discount)
+        if !(discount.is_a? Numeric) || discount < 0
+            raise "Invalid voucher, amount discount must be bigger than zero."
+        end
+    end
+
+    def validate_unit_discount(discount)
+        if !(discount.is_a? Numeric) || discount < 0
+            raise "Invalid voucher, unit discount must be bigger than zero."
+        end
+    end
+
+    def calculate_price(base_price, voucher, unit_price = nil)
+        if !voucher[:discount]
+            raise "Unsupported voucher type."
+        end
+
+        if voucher[:discount][:type] === 'PERCENT'
+            discount = voucher[:discount][:percent_off]
+            validate_percent_discount(discount);
+            price_discount = base_price * (discount / 100)
+            return round_money(base_price - price_discount)
+
+        elsif voucher[:discount][:type] === 'AMOUNT'
+            discount = voucher[:discount][:amount_off]
+            validate_amount_discount(discount)
+            new_price = base_price - discount
+            return round_money(new_price > 0 ? (new_price) : 0)
+
+        elsif voucher[:discount][:type] === 'UNIT'
+            if !unit_price
+                raise "Missing unit_price argument."
+            end
+            discount = voucher[:discount][:unit_off]
+            validate_unit_discount(discount)
+            new_price = base_price - unit_price * discount
+            return round_money(new_price > 0 ? (new_price) : 0)
+
+        else
+            raise "Unsupported discount type"
+        end
+    end
+
+    def calculate_discount(base_price, voucher, unit_price = nil)
+        if !voucher[:discount]
+            raise "Unsupported voucher type."
+        end
+
+        if voucher[:discount][:type] === 'PERCENT'
+            discount = voucher[:discount][:percent_off]
+            validate_percent_discount(discount);
+            price_discount = base_price * (discount / 100)
+            return round_money(price_discount)
+
+        elsif voucher[:discount][:type] === 'AMOUNT'
+            discount = voucher[:discount][:amount_off]
+            validate_amount_discount(discount)
+            new_price = base_price - discount
+            return round_money(new_price > 0 ? (discount) : (base_price))
+
+        elsif voucher[:discount][:type] === 'UNIT'
+            if !unit_price
+                raise "Missing unit_price argument."
+            end
+            discount = voucher[:discount][:unit_off]
+            validate_unit_discount(discount)
+            price_discount = unit_price * discount
+            return round_money(price_discount > base_price ? (base_price) : (price_discount))
+
+        else
+            raise "Unsupported discount type"
+        end
+    end
+end

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 class Voucherify
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,9 @@ files:
 - bin/console
 - bin/setup
 - examples/customer.rb
+- examples/utils.rb
 - lib/voucherify.rb
+- lib/voucherify/utils.rb
 - lib/voucherify/version.rb
 - voucherify.gemspec
 homepage: https://github.com/rspective/voucherify-ruby-sdk/