voucherify 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c93ad3896239a1fd3e2c739405fc3dbee898d3a
-  data.tar.gz: 6e4cc54c5dd5f77a93e4acc6a17321cb514470f5
+  metadata.gz: ac6bfd1ead5ca241b7d5d62d1e0a18b2b34f6269
+  data.tar.gz: 334f47cdd657274805b1506b794f7d515df6f982
 SHA512:
-  metadata.gz: 16051d3e309373a59b8cbca3aef198a7d3cc846fd1181f5d195d7d7fceea170ce989859ea0b896ee0b19ad1af03684e4e783a3c544779c12a3ffefbe9d14c16a
-  data.tar.gz: ae1cd5a6712285386c73e02e2b8c0d08f1be795541e48b9e5c6795f98b8e72a947cf87d76873de0615a2c1d0193fe69517ab17dfb8e60146b0af4136b9814549
+  metadata.gz: 588e0ab94075bebf6cf57feb95528f9ef8d7cc048d0e7a61f8c2864e319498d63b44dc1ec8908da60f01678d21e146c69f633e315c6d74e46c7a1d9bcd7c54fe
+  data.tar.gz: 7e2ca93824f47367b5cdeeece4dabe3d1681e58d3364324ea611c172ac476c33952315114a367a6604fd6352f5c5136e01a7d2a9605fade26b9d88dcddee6034

data/README.md

@@ -240,6 +240,50 @@ Possible error:
 }
 ```
 
+#### Validating vouchers
+
+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. 
+Then you have to pass `order.amount` expressed in cents (e.g. $10 is 1000).
+
+Example:
+
+```
+validation_result = voucherify.validate("91Ft4U", {
+   tracking_id: "john@lemon.com",
+    customer: {
+         id: "cust_07sVjVsr71Ewot9lVZSrIVLH",
+         source_id: "john@lemon.com",
+         name: "John Lemon"
+     },
+     order: {
+        amount: 1000
+    }
+})
+```
+
+Successful validation result:
+```
+{"code"=>"91Ft4U", "valid"=>true, "gift"=>{"amount"=>10000}, "tracking_id"=>"john@lemon.com"}
+```
+
+Failed validation result:
+```
+{"code"=>"91Ft4U", "valid"=>true, "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:
+
+- `voucher not found`
+- `voucher is disabled`
+- `voucher not active yet`
+- `voucher expired`
+- `quantity exceeded`
+- `gift amount exceeded`
+
 #### Redeeming voucher
 
 ##### 1. Just by code
@@ -763,6 +807,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-08-02** - `0.8.0` - validate voucher
 - **2016-07-18** - `0.7.0` - voucher udpate
 - **2016-07-05** - `0.6.0` - new utils module
 - **2016-06-16** - `0.5.0` - unified naming convention

data/examples/validate.rb

@@ -0,0 +1,15 @@
+require '../lib/voucherify'
+
+voucherify = Voucherify.new({
+                                "applicationId" => "c70a6f00-cf91-4756-9df5-47628850002b",
+                                "clientSecretKey" => "3266b9f8-e246-4f79-bdf0-833929b1380c"
+                            })
+
+validation_result = voucherify.validate("91Ft4U", {
+    tracking_id: "john@lemon.com",
+    order: {
+        amount: 1000
+    }
+})
+
+print(validation_result);

data/lib/voucherify/version.rb

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

data/lib/voucherify.rb

@@ -55,6 +55,25 @@ class Voucherify
     response = RestClient.get(url, @headers.merge({ :params => query }))
     JSON.parse(response.body)
   end
+  
+  # Sample context: 
+  # {
+  #     tracking_id: "john@lemon.com",
+  #     customer: {
+  #         id: "cust_07sVjVsr71Ewot9lVZSrIVLH",
+  #         source_id: "john@lemon.com",
+  #         name: "John Lemon"
+  #     },
+  #     order: {
+  #        amount: 1000
+  #     }
+  # }
+  def validate(code, context = {})
+    url = @backend_url + "/vouchers/" + URI.encode(code) + "/validate"
+
+    response = RestClient.post(url, context.to_json, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  end
 
   def redeem(code, tracking_id = nil)
     payload = {}

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-08-02 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
@@ -82,6 +82,7 @@ files:
 - bin/setup
 - examples/customer.rb
 - examples/utils.rb
+- examples/validate.rb
 - lib/voucherify.rb
 - lib/voucherify/utils.rb
 - lib/voucherify/version.rb
@@ -96,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.0.14.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Voucherify. More info on http://www.voucherify.io