voucherify 0.8.2 → 1.0.0

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format documentation'
+end
 
-task :default => :spec
+task :default => :spec

data/examples/customers.rb

@@ -0,0 +1,32 @@
+require 'voucherify'
+
+voucherify = Voucherify::Client.new({
+                                        :applicationId => 'c70a6f00-cf91-4756-9df5-47628850002b',
+                                        :clientSecretKey => '3266b9f8-e246-4f79-bdf0-833929b1380c'
+                                    })
+
+new_customer = voucherify.customers.create({
+                                               name: 'John Doe',
+                                               email: 'john@email.com',
+                                               description: 'Sample description about customer',
+                                               metadata: {
+                                                   lang: 'en'
+                                               }
+                                           })
+
+puts 'Created Customer:'
+puts new_customer
+
+customer = voucherify.customers.get new_customer['id']
+
+puts 'Retrieved Customer:'
+puts customer
+
+customer[:description] = 'Sample description of customer with updates'
+
+updated_customer = voucherify.customers.update customer
+
+puts 'Updated Customer:'
+puts updated_customer
+
+voucherify.customers.delete updated_customer['id']

data/examples/utils.rb

@@ -1,24 +1,22 @@
-require '../lib/voucherify/utils'
-
-include Utils
+require 'voucherify/utils'
 
 base_price = 20.00
 
-puts "base price: " + base_price.to_s
+puts 'base price: ' + base_price.to_s
 
-puts "===== amount discount ====="
+puts '===== amount discount ====='
 amount_voucher = {
     discount: {
         amount_off: 1000, # 10.0
         type: 'AMOUNT'
     }
 }
-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 'discount:             ' + Voucherify::Utils.calculate_discount(base_price, amount_voucher).to_s
+puts 'price after discount: ' + Voucherify::Utils.calculate_price(base_price, amount_voucher).to_s
 puts
 
 
-puts "===== percent discount ===="
+puts '===== percent discount ===='
 
 percent_discount_voucher = {
     discount: {
@@ -27,12 +25,12 @@ percent_discount_voucher = {
     }
 }
 
-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 'discount:             ' + Voucherify::Utils.calculate_discount(base_price, percent_discount_voucher).to_s
+puts 'price after discount: ' + Voucherify::Utils.calculate_price(base_price, percent_discount_voucher).to_s
 puts
 
 
-puts "===== unit discount ======="
+puts '===== unit discount ======='
 
 unit_discount_voucher = {
     discount: {
@@ -41,12 +39,12 @@ unit_discount_voucher = {
     }
 }
 
-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 'discount:             ' + Voucherify::Utils.calculate_discount(base_price, unit_discount_voucher, 5).to_s
+puts 'price after discount: ' + Voucherify::Utils.calculate_price(base_price, unit_discount_voucher, 5).to_s
 puts
 
 
-puts "===== gift voucher ========"
+puts '===== gift voucher ========'
 
 gift_voucher = {
     gift: {
@@ -55,11 +53,11 @@ gift_voucher = {
     }
 }
 
-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 'discount:             ' + Voucherify::Utils.calculate_discount(base_price, gift_voucher).to_s
+puts 'price after discount: ' + Voucherify::Utils.calculate_price(base_price, gift_voucher).to_s
 puts
 
-puts "===== gift voucher 2 ======"
+puts '===== gift voucher 2 ======'
 
 gift_voucher2 = {
     gift: {
@@ -68,6 +66,6 @@ gift_voucher2 = {
     }
 }
 
-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 'discount:             ' + Voucherify::Utils.calculate_discount(base_price, gift_voucher2).to_s
+puts 'price after discount: ' + Voucherify::Utils.calculate_price(base_price, gift_voucher2).to_s
 puts

data/examples/vouchers.rb

@@ -0,0 +1,20 @@
+require 'voucherify'
+
+voucherify = Voucherify::Client.new({
+                                        :applicationId => 'c70a6f00-cf91-4756-9df5-47628850002b',
+                                        :clientSecretKey => '3266b9f8-e246-4f79-bdf0-833929b1380c'
+                                    })
+
+puts voucherify.vouchers.validate('91Ft4U', {
+    tracking_id: 'john@lemon.com',
+    order: {
+        amount: 1000
+    }
+})
+
+query = {limit: 10, skip: 20, category: 'API Test'}
+puts voucherify.vouchers.list(query)
+
+puts voucherify.vouchers.enable '91Ft4U'
+
+puts voucherify.vouchers.disable '91Ft4U'

data/lib/voucherify/client.rb

@@ -0,0 +1,69 @@
+require 'uri'
+require 'rest-client'
+require 'json'
+
+module Voucherify
+
+  class Client
+    def initialize (options)
+      @options = options
+      @backend_url = 'https://api.voucherify.io/v1'
+      @headers = {
+          'X-App-Id' => @options[:applicationId],
+          'X-App-Token' => @options[:clientSecretKey],
+          'X-Voucherify-Channel' => 'Ruby-SDK',
+          :accept => :json
+      }
+    end
+
+    def vouchers
+      Voucherify::Service::Vouchers.new(self)
+    end
+
+    def distributions
+      Voucherify::Service::Distributions.new(self)
+    end
+
+    def validations
+      Voucherify::Service::Validations.new(self)
+    end
+
+    def redemptions
+      Voucherify::Service::Redemptions.new(self)
+    end
+
+    def customers
+      Voucherify::Service::Customers.new(self)
+    end
+
+    def get(path, params = {})
+      url = @backend_url + path
+      response = RestClient.get(url, @headers.merge({:params => params}))
+      JSON.parse(response.body)
+    end
+
+    def put(path, body, params = {})
+      url = @backend_url + path
+      response = RestClient.put(url, body, @headers.merge({:params => params, :content_type => :json}))
+      JSON.parse(response.body)
+    end
+
+    def post(path, body, params = {})
+      url = @backend_url + path
+      response = RestClient.post(url, body, @headers.merge({:params => params, :content_type => :json}))
+      if !response.body.empty?
+        JSON.parse(response.body)
+      else
+        nil
+      end
+
+    end
+
+    def delete(path, params = {})
+      url = @backend_url + path
+      RestClient.delete(url, @headers.merge({:params => params}))
+      nil
+    end
+  end
+
+end

data/lib/voucherify/service/customers.rb

@@ -0,0 +1,29 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Customers
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(customer)
+        @client.post('/customers/', customer.to_json)
+      end
+
+      def get(customer_id)
+        @client.get('/customers/' + customer_id)
+      end
+
+      def update(customer)
+        @client.put('/customers/' + (customer['id'] || customer[:id]), customer.to_json)
+      end
+
+      def delete(customer_id)
+        @client.delete('/customers/' + customer_id)
+      end
+    end
+  end
+end

data/lib/voucherify/service/distributions.rb

@@ -0,0 +1,26 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Distributions
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def publish(campaign_name)
+        url = '/vouchers/publish'
+        payload = {}
+
+        if campaign_name.is_a? String
+          url += '?campaign=' + URI.encode(campaign_name)
+        elsif campaign_name.is_a? Hash
+          payload = campaign_name
+        end
+
+        @client.post(url, payload.to_json)
+      end
+    end
+  end
+end

data/lib/voucherify/service/redemptions.rb

@@ -0,0 +1,36 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Redemptions
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def redeem(code, params = {})
+        url = '/vouchers/' + URI.encode(code) + '/redemption'
+        @client.post(url, params.to_json)
+      end
+
+      def list(query = {})
+        @client.get('/redemptions/', query)
+      end
+
+      def get_for_voucher(code)
+        @client.get('/vouchers/' + URI.encode(code) + '/redemption')
+      end
+
+      def rollback(redemption_id, params = {})
+        reason = params['reason'] || params[:reason]
+        url = '/redemptions/'+ URI.encode(redemption_id) + '/rollback'
+        url += '?reason=' + URI.encode(reason) if reason
+        params.delete 'reason'
+        params.delete :reason
+        @client.post(url, params.to_json)
+      end
+
+    end
+  end
+end

data/lib/voucherify/service/validations.rb

@@ -0,0 +1,17 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Validations
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def validate_voucher(code, context = {})
+        @client.post('/vouchers/' + URI.encode(code) + '/validate', context.to_json)
+      end
+    end
+  end
+end

data/lib/voucherify/service/vouchers.rb

@@ -0,0 +1,52 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Vouchers
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(code, options = {})
+        url = '/vouchers/'
+        url += URI.encode(code) if code
+        @client.post(url, options.to_json)
+      end
+
+      def get(code)
+        @client.get('/vouchers/' + URI.encode(code))
+      end
+
+      def update(voucher_update)
+        url = '/vouchers/' + URI.encode(voucher_update['code'])
+        @client.put(url, voucher_update.to_json)
+      end
+
+      def list(query)
+        @client.get('/vouchers/', query)
+      end
+
+      def enable(code)
+        url = '/vouchers/' + URI.encode(code) + '/enable'
+        @client.post(url, nil)
+        nil
+      end
+
+      def disable(code)
+        url = '/vouchers/' + URI.encode(code) + '/disable'
+        @client.post(url, nil)
+        nil
+      end
+
+      def delete(code, params = {})
+        force = params['force'] || params[:force]
+        url = '/vouchers/' + URI.encode(code)
+        url += '?force=' + (!!force).to_s
+        @client.delete(url, nil)
+        nil
+      end
+    end
+  end
+end

data/lib/voucherify/utils.rb

@@ -1,99 +1,101 @@
-module Utils
-    def round_money(value)
-        value.round(2)
+module Voucherify
+  module Utils
+    def self.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
+    def self.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
+    def self.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
+    def self.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)
-        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
+    def self.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
+
+      if voucher[:discount][:type] === 'PERCENT'
+        discount = voucher[:discount][:percent_off]
+        validate_percent_discount(discount);
+        price_discount = base_price * (discount / 100.0)
+        return round_money(base_price - price_discount)
+
+      elsif voucher[:discount][:type] === 'AMOUNT'
+        discount = voucher[:discount][:amount_off] / e
+        validate_amount_discount(discount)
+        new_price = base_price - discount
+        return round_money(new_price > 0 ? (new_price) : 0)
 
-        if voucher[:discount][:type] === 'PERCENT'
-            discount = voucher[:discount][:percent_off]
-            validate_percent_discount(discount);
-            price_discount = base_price * (discount / 100.0)
-            return round_money(base_price - price_discount)
-
-        elsif voucher[:discount][:type] === 'AMOUNT'
-            discount = voucher[:discount][:amount_off] / e
-            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"
+      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)
-        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
+    def self.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][:type] === 'PERCENT'
-            discount = voucher[:discount][:percent_off]
-            validate_percent_discount(discount);
-            price_discount = base_price * (discount / 100.0)
-            return round_money(price_discount)
-
-        elsif voucher[:discount][:type] === 'AMOUNT'
-            discount = voucher[:discount][:amount_off] / e
-            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"
+      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.0)
+        return round_money(price_discount)
+
+      elsif voucher[:discount][:type] === 'AMOUNT'
+        discount = voucher[:discount][:amount_off] / e
+        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
 end

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
-class Voucherify
-  VERSION = "0.8.2"
+module Voucherify
+  VERSION = '1.0.0'
 end