voucherify 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49cefa65987b138ce3db394ed4c367927573a47e
-  data.tar.gz: 8eebd7cbe3e8ea1558ec7c0ee45ace44a5d35166
+  metadata.gz: f662e940ffbbc0d0c111642a61ced7c5e5babb49
+  data.tar.gz: 9a37fac908f845d495ed807bd2cc672e2e3ac78a
 SHA512:
-  metadata.gz: 3aa0f648f576c8589d10425633aea28cae6534b320c60fb9bc32aed2879d70114dfe73349b8d2268aa29122cca8221f7e332666afc229087c5a49685cb323b23
-  data.tar.gz: 8cd9fa4bb7ecead7a00bbabf1c6c7c94be9655d6b9e0ceafa80e8a39a0510b0f8f44995b4744574e86e6fde9cd392bbbefa5ed76836797954a4fbb38bfe61fd0
+  metadata.gz: cb9e9120a701e2e435ebae9ff0c58ef1b535d81989dc73c47fcb65ee20d64a21952fc63964422f1d77b44c2fae2a6a1ea20f181393ece7c876cdc0f6d9dcc431
+  data.tar.gz: 95b1bc3aff39e9e14ba43207f8e13590718f78ac706a38bfaf9625e5ff1f816914bfd4381863c87fb4d45dffbfbe5fbc7f6d230da8cbbf7185524a2d6ba92e72

data/README.md

@@ -66,6 +66,18 @@ Please refer to [rest-client documentation](https://github.com/rest-client/rest-
 
 #### Listing vouchers
 
+Use `voucherify.vouchers(filter)` to get a filtered list of vouchers.
+
+Filter paramters
+- code_query
+- limit (default 10)
+- skip (default 0)
+- category
+- campaign
+- customer
+
+Example:
+
 ```ruby
 voucherify.list({ limit: 10, skip: 20, category: "API Test" })
 ```
@@ -129,14 +141,16 @@ Result:
         "percent_off": 10.0,
         "type": "PERCENT"
     },
-    "expiration_date": "2015-12-31T23:59:59Z",
+    "expiration_date": "2016-12-31T23:59:59Z",
     "redemption": {
         "quantity": 3,
         "redeemed_quantity": 1,
         "redemption_entries": [
             {
-                "date": "2015-09-24T06:03:35Z",
-                "tracking_id": "GENERATED-OR-PROVIDED-TRACKING-ID"
+                "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+                "object": "redemption",
+                "date": "2016-04-24T06:03:35Z",
+                "tracking_id": "(tracking_id not set)"
             }
         ]
     },
@@ -157,8 +171,10 @@ Result:
     "redeemed_quantity": 1,
     "redemption_entries": [
         {
-            "date": "2015-09-24T06:03:35Z",
-            "tracking_id": "GENERATED-OR-PROVIDED-TRACKING-ID"
+            "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+            "object": "redemption",
+            "date": "2016-04-24T06:03:35Z",
+            "tracking_id": "(tracking_id not set)"
         }
     ]
 }
@@ -222,28 +238,39 @@ Result (voucher details after redemption):
 
 ```json
 {
-    "code": "v1GiJYuuS",
-    "campaign": "vip",
-    "discount": {
-        "percent_off": 10.0,
-        "type": "PERCENT"
-    },
-    "expiration_date": "2015-12-31T23:59:59Z",
-    "redemption": {
-        "quantity": 3,
-        "redeemed_quantity": 2,
-        "redemption_entries": [
-            {
-                "date": "2015-09-24T06:03:35Z",
-                "tracking_id": "(tracking_id not set)"
-            },
-            {
-                "date": "2015-09-25T10:34:57Z",
-                "tracking_id": "(tracking_id not set)"
-            },
-        ]
-    },
-    "additional_info": ""
+    "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
+    "object": "redemption",
+    "date": "2016-04-25T10:34:57Z",
+    "tracking_id": "(tracking_id not set)",
+    "voucher": {
+        "code": "v1GiJYuuS",
+        "campaign": "vip",
+        "discount": {
+            "percent_off": 10.0,
+            "type": "PERCENT"
+        },
+        "expiration_date": "2016-12-31T23:59:59Z",
+        "redemption": {
+            "quantity": 3,
+            "redeemed_quantity": 2,
+            "redemption_entries": [
+                {
+                    "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+                    "object": "redemption",
+                    "date": "2016-04-24T06:03:35Z",
+                    "tracking_id": "(tracking_id not set)"
+                },
+                {
+                    "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
+                    "object": "redemption",
+                    "date": "2016-04-25T10:34:57Z",
+                    "tracking_id": "(tracking_id not set)"
+                }
+            ]
+        },
+        "active": true,
+        "additional_info": ""
+    }
 }
 ```
 
@@ -267,32 +294,45 @@ voucherify.redeem("v1GiJYuuS", "alice.morgan")
 Result:
 ```json
 {
-    "code": "v1GiJYuuS",
-    "campaign": "vip",
-    "discount": {
-        "percent_off": 10.0,
-        "type": "PERCENT"
-    },
-    "expiration_date": "2015-12-31T23:59:59Z",
-    "redemption": {
-        "quantity": 3,
-        "redeemed_quantity": 3,
-        "redemption_entries": [
-            {
-                "date": "2015-09-24T06:03:35Z",
-                "tracking_id": "(tracking_id not set)"
-            },
-            {
-                "date": "2015-09-25T10:34:57Z",
-                "tracking_id": "(tracking_id not set)"
-            },
-            {
-                "date": "2015-09-25T12:04:08Z",
-                "tracking_id": "alice.morgan"
-            },
-        ]
-    },
-    "additional_info": ""
+    "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
+    "object": "redemption",
+    "date": "2016-04-25T10:34:57Z",
+    "tracking_id": "(tracking_id not set)",
+    "voucher": {
+        "code": "v1GiJYuuS",
+        "campaign": "vip",
+        "discount": {
+            "percent_off": 10.0,
+            "type": "PERCENT"
+        },
+        "expiration_date": "2016-12-31T23:59:59Z",
+        "redemption": {
+            "quantity": 3,
+            "redeemed_quantity": 3,
+            "redemption_entries": [
+                {
+                    "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+                    "object": "redemption",
+                    "date": "2016-04-24T06:03:35Z",
+                    "tracking_id": "(tracking_id not set)"
+                },
+                {
+                    "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
+                    "object": "redemption",
+                    "date": "2016-04-25T10:34:57Z",
+                    "tracking_id": "(tracking_id not set)"
+                },
+                {
+                    "id": "r_irOQWUTAjthQwnkn5JQM1V6N",
+                    "object": "redemption",
+                    "date": "2016-04-25T12:04:08Z",
+                    "tracking_id": "alice.morgan"
+                }
+            ]
+        },
+        "active": true,
+        "additional_info": ""
+    }
 }
 ```
 
@@ -319,6 +359,15 @@ voucherify.redeem({
 #### Listing redemptions
 
 Use `voucherify.redemptions(filter)` to get a filtered list of redemptions.
+Filter parameters:
+
+- limit (default: 100)
+- page (default: 0)
+- start_date (default: beginning of current month) 
+- end_date (default: end of current month)
+- result - Success | Failure-NotExist | Failure-Inactive
+- customer
+
 
 Example - 1000 successful redemptions from April 2016:
 
@@ -398,6 +447,69 @@ voucherify.enable("EASTER-2016")
 
 The response has empty body.
 
+#### Rollback redemption
+
+You can revert a redemption by calling `voucherify.rollback(redemption_id, tracking_id*, reason*, callback*)`.
+This operation creates a rollback entry in voucher's redemption history (`redemption.redemption_entries`)
+and gives 1 redemption back to the pool (decreases `redeemed_quantity` by 1).
+
+```ruby
+voucherify.rollback("r_irOQWUTAjthQwnkn5JQM1V6N", "alice.morgan")
+```
+
+Result:
+```
+{
+    "id": "rr_1634wLkb8glgRXrTmsxRzDBd",
+    "object": "redemption_rollback",
+    "date": "2016-04-25T10:35:02Z",
+    "tracking_id": "alice.morgan",
+    "redemption": "r_irOQWUTAjthQwnkn5JQM1V6N",
+    "voucher": {
+        "code": "v1GiJYuuS",
+        "campaign": "vip",
+        "discount": {
+            "percent_off": 10.0,
+            "type": "PERCENT"
+        },
+        "expiration_date": "2016-12-31T23:59:59Z",
+        "redemption": {
+            "quantity": 3,
+            "redeemed_quantity": 2,
+            "redemption_entries": [
+                {
+                    "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
+                    "object": "redemption",
+                    "date": "2016-04-24T06:03:35Z",
+                    "tracking_id": "(tracking_id not set)"
+                },
+                {
+                    "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
+                    "object": "redemption",
+                    "date": "2016-04-25T10:34:57Z",
+                    "tracking_id": "(tracking_id not set)"
+                },
+                {
+                    "id": "r_irOQWUTAjthQwnkn5JQM1V6N",
+                    "object": "redemption",
+                    "date": "2016-04-25T12:04:08Z",
+                    "tracking_id": "alice.morgan"
+                },
+                {
+                    "id": "rr_1634wLkb8glgRXrTmsxRzDBd",
+                    "object": "redemption_rollback",
+                    "date": "2016-04-25T10:35:02Z",
+                    "tracking_id": "alice.morgan",
+                    "redemption": "r_irOQWUTAjthQwnkn5JQM1V6N"
+                }
+            ]
+        },
+        "active": true,
+        "additional_info": ""
+    }
+}
+```
+
 ## 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.
@@ -409,6 +521,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-04-27** - `0.2.0` - rollback redemption
 - **2016-04-13** - `0.1.3` - bugfix in redeem()
 - **2016-04-13** - `0.1.2` - removed dependency to `pry`
 - **2016-04-12** - `0.1.1` - minor gemspec changes

data/lib/voucherify.rb

@@ -22,7 +22,13 @@ class Voucherify
     JSON.parse(response.body)
   end
 
-  # List vouchers. Sample query: { limit: 100, skip: 200, category: "Loyalty" }
+  # List vouchers. Query parameters:
+  # - code_query
+  # - limit (default 10)
+  # - skip (default 0)
+  # - category
+  # - campaign
+  # - customer
   def list(query)
     url = @backend_url + "/vouchers/"
     response = RestClient.get(url, @headers.merge({ :params => query }))
@@ -104,4 +110,13 @@ class Voucherify
     response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
     nil
   end
+  
+  def rollback(redemption_id, tracking_id=nil, reason=nil)
+    url = @backend_url + "/redemptions/" + URI.encode(redemption_id) + "/rollback"
+    if tracking_id || reason
+        url += "?" + URI.encode_www_form(:tracking_id => tracking_id, :reason => reason)
+    end
+    response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  end
 end

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 class Voucherify
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler