voucherify 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f662e940ffbbc0d0c111642a61ced7c5e5babb49
-  data.tar.gz: 9a37fac908f845d495ed807bd2cc672e2e3ac78a
+  metadata.gz: 140c349b5ee5635e7b41f7b01c680c05acaa9081
+  data.tar.gz: a41b8a70c13c8db33cdf9143a48b54045b20067e
 SHA512:
-  metadata.gz: cb9e9120a701e2e435ebae9ff0c58ef1b535d81989dc73c47fcb65ee20d64a21952fc63964422f1d77b44c2fae2a6a1ea20f181393ece7c876cdc0f6d9dcc431
-  data.tar.gz: 95b1bc3aff39e9e14ba43207f8e13590718f78ac706a38bfaf9625e5ff1f816914bfd4381863c87fb4d45dffbfbe5fbc7f6d230da8cbbf7185524a2d6ba92e72
+  metadata.gz: 16004c4efce7f26a7ca9b54b999bd92fa4a4dfd85ac112df519be6f24a5259bf8bd11faa72c2e491a078b8dddf1b2124583b4a5c9d16443af146c5ec10cc87e8
+  data.tar.gz: adc92706284a7386dc1505daf11bed39748b7acf3efd03e8ba9eb777d4b0be5f7abb3c4ed508a5d42a6f96019b7f79df1dfc8650e0464410f76a42959ce9b0ae

data/README.md

@@ -182,14 +182,18 @@ Result:
 
 #### Publishing voucher
 
-This method selects active, unpublished voucher from the specific campaign and returns it to client. 
-In effect, this voucher is marked as published and it will not be announced once again to customer. 
+This method selects a voucher that is suitable for publication, adds a publish entry and returns the voucher.
+A voucher is suitable for publication when it's active and hasn't been published more times than the redemption limit.
 
 Example:
 
 ```ruby
 voucherify.publish("First Ride")
 ```
+or
+```ruby
+voucherify.publish({campaign: "First Ride", channel: "Email", customer: "donny.roll@mail.com"})
+```
 
 Positive result:
 
@@ -204,16 +208,21 @@ Positive result:
    },
    "start_date": "2015-01-01T00:00:00Z",
    "expiration_date": "2016-12-31T23:59:59Z",
+   "publish": {
+        "count": 1,
+        "entries": [{
+            "channel": "Email",
+            "customer": "donny.roll@mail.com",
+            "published_at": "2016-01-22T09:25:07Z"
+        }]
+   },
    "redemption": {
       "quantity": 1,
       "redeemed_quantity": 0,
       "redemption_entries": []
    },
    "active": true,
-   "additional_info": null,
-   "metadata": {
-      "published": "2016-01-22T09:25:07Z"
-   }
+   "additional_info": null
 }
 ```
 
@@ -521,6 +530,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-05-24** - `0.3.0` - new publish structure
 - **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`

data/lib/voucherify.rb

@@ -29,6 +29,7 @@ class Voucherify
   # - category
   # - campaign
   # - customer
+  # Sample query: { limit: 100, skip: 200, category: "Loyalty" }
   def list(query)
     url = @backend_url + "/vouchers/"
     response = RestClient.get(url, @headers.merge({ :params => query }))
@@ -73,8 +74,16 @@ class Voucherify
   end
 
   def publish(campaign_name)
-    url = @backend_url + "/vouchers/publish?campaign=" + URI.encode(campaign_name)
-    response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
+    url = @backend_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
+        
+    response = RestClient.post(url, payload.to_json, @headers.merge({ :content_type => :json }))
     JSON.parse(response.body)
   end
 

data/lib/voucherify/version.rb

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

metadata

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