voucherify 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 140c349b5ee5635e7b41f7b01c680c05acaa9081
-  data.tar.gz: a41b8a70c13c8db33cdf9143a48b54045b20067e
+  metadata.gz: 47084c3e1f9039e6822f63a982e1c2a7cf44fdd0
+  data.tar.gz: 2d2999fefb3b474554af556bbc7cd959313688d6
 SHA512:
-  metadata.gz: 16004c4efce7f26a7ca9b54b999bd92fa4a4dfd85ac112df519be6f24a5259bf8bd11faa72c2e491a078b8dddf1b2124583b4a5c9d16443af146c5ec10cc87e8
-  data.tar.gz: adc92706284a7386dc1505daf11bed39748b7acf3efd03e8ba9eb777d4b0be5f7abb3c4ed508a5d42a6f96019b7f79df1dfc8650e0464410f76a42959ce9b0ae
+  metadata.gz: 0643b79deb5d824f3ec4deeffbd7dd0b915780a19311ae1352371539795121b2e5bc9c21b341b732e6e84527ceda2ff2a424d27e26d88030e2d3d9ce623a8569
+  data.tar.gz: b8b31e911aac503866369f3a4413d59c1d99823ffd521eb5986b9748ad19eadc185d38b47fcc5373e933100609fd7d72b6a71124ee4db07c35fa190dd0fc4a50

data/.gitignore

@@ -34,3 +34,6 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# Jetbrains temp
+.idea

data/README.md

@@ -1,6 +1,6 @@
 ## Voucherify Ruby SDK
 
-[Voucherify](http://voucherify.io?utm_source=inbound&utm_medium=github&utm_campaign=voucherify-ruby-sdk) has a new platform that will help your team automate voucher campaigns. It does this by providing composable API and the marketer-friendly interface that increases teams' productivity:
+[Voucherify](http://voucherify.io?utm_source=github&utm_medium=sdk&utm_campaign=acq) has a new platform that will help your team automate voucher campaigns. It does this by providing composable API and the marketer-friendly interface that increases teams' productivity:
 
 - **roll-out thousands** of vouchers **in minutes** instead of weeks,
 - **check status** or disable **every single** promo code in real time,
@@ -150,6 +150,7 @@ Result:
                 "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
                 "object": "redemption",
                 "date": "2016-04-24T06:03:35Z",
+                "customer_id": null,
                 "tracking_id": "(tracking_id not set)"
             }
         ]
@@ -174,6 +175,7 @@ Result:
             "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
             "object": "redemption",
             "date": "2016-04-24T06:03:35Z",
+            "customer_id": null,
             "tracking_id": "(tracking_id not set)"
         }
     ]
@@ -250,6 +252,7 @@ Result (voucher details after redemption):
     "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
     "object": "redemption",
     "date": "2016-04-25T10:34:57Z",
+    "customer_id": null,
     "tracking_id": "(tracking_id not set)",
     "voucher": {
         "code": "v1GiJYuuS",
@@ -267,12 +270,14 @@ Result (voucher details after redemption):
                     "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
                     "object": "redemption",
                     "date": "2016-04-24T06:03:35Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 },
                 {
                     "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
                     "object": "redemption",
                     "date": "2016-04-25T10:34:57Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 }
             ]
@@ -306,7 +311,8 @@ Result:
     "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
     "object": "redemption",
     "date": "2016-04-25T10:34:57Z",
-    "tracking_id": "(tracking_id not set)",
+    "customer_id": "cust_84LPwcHJ1jVEpxV1uF9nLLBB",
+    "tracking_id": "alice.morgan",
     "voucher": {
         "code": "v1GiJYuuS",
         "campaign": "vip",
@@ -323,18 +329,21 @@ Result:
                     "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
                     "object": "redemption",
                     "date": "2016-04-24T06:03:35Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 },
                 {
                     "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
                     "object": "redemption",
                     "date": "2016-04-25T10:34:57Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 },
                 {
                     "id": "r_irOQWUTAjthQwnkn5JQM1V6N",
                     "object": "redemption",
                     "date": "2016-04-25T12:04:08Z",
+                    "customer_id": "cust_84LPwcHJ1jVEpxV1uF9nLLBB",
                     "tracking_id": "alice.morgan"
                 }
             ]
@@ -347,13 +356,13 @@ Result:
 
 ##### 3. With customer profile
 
-You can record a detailed customer profile consisting of an `id` (obligatory), `name`, `email`, `description` and a `metadata` section that can include any data you wish.
+You can record a detailed customer profile consisting of an `source_id`, `name`, `email`, `description` and a `metadata` section that can include any data you wish. Voucherify will create (or update) provided customer profile in its database.
 
 ```ruby
 voucherify.redeem({
     "voucher" => "v1GiJYuuS",
     "customer" => {
-        "id" => "alice.morgan",
+        "source_id" => "alice.morgan",
         "name" => "Alice Morgan",
         "email" => "alice@morgan.com",
         "description" => "look ma no hands",
@@ -375,7 +384,7 @@ Filter parameters:
 - start_date (default: beginning of current month) 
 - end_date (default: end of current month)
 - result - Success | Failure-NotExist | Failure-Inactive
-- customer
+- customer - id or source_id
 
 
 Example - 1000 successful redemptions from April 2016:
@@ -472,6 +481,7 @@ Result:
     "id": "rr_1634wLkb8glgRXrTmsxRzDBd",
     "object": "redemption_rollback",
     "date": "2016-04-25T10:35:02Z",
+    "customer_id": "cust_84LPwcHJ1jVEpxV1uF9nLLBB",
     "tracking_id": "alice.morgan",
     "redemption": "r_irOQWUTAjthQwnkn5JQM1V6N",
     "voucher": {
@@ -490,24 +500,28 @@ Result:
                     "id": "r_gQzOnTwmhn2nTLwW4sZslNKY",
                     "object": "redemption",
                     "date": "2016-04-24T06:03:35Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 },
                 {
                     "id": "r_yRmanaA6EgSE9uDYvMQ5Evfp",
                     "object": "redemption",
                     "date": "2016-04-25T10:34:57Z",
+                    "customer_id": null,
                     "tracking_id": "(tracking_id not set)"
                 },
                 {
                     "id": "r_irOQWUTAjthQwnkn5JQM1V6N",
                     "object": "redemption",
                     "date": "2016-04-25T12:04:08Z",
+                    "customer_id": "cust_84LPwcHJ1jVEpxV1uF9nLLBB",
                     "tracking_id": "alice.morgan"
                 },
                 {
                     "id": "rr_1634wLkb8glgRXrTmsxRzDBd",
                     "object": "redemption_rollback",
                     "date": "2016-04-25T10:35:02Z",
+                    "customer_id": "cust_84LPwcHJ1jVEpxV1uF9nLLBB",
                     "tracking_id": "alice.morgan",
                     "redemption": "r_irOQWUTAjthQwnkn5JQM1V6N"
                 }
@@ -519,6 +533,93 @@ Result:
 }
 ```
 
+#### Create customer
+
+```ruby
+customer = {
+  name: "John Doe",
+  email: "john@email.com",
+  description: "Sample description about customer",
+  metadata: {
+    lang: "en"
+  }
+}
+
+voucherify.create_customer(customer)
+```
+
+Result:
+
+```json
+{
+    "id": "cust_WGG615E92dhOHz7PV9Vo9gk9",
+    "created_at": "2016-06-12T15:52:49Z",
+    "description": "Sample description about customer",
+    "email": "john@email.com",
+    "metadata": {
+        "lang": "en"
+    },
+    "name": "John Doe",
+    "object": "customer"
+}
+```
+
+#### Fetch customer
+
+```ruby
+voucherify.fetch_customer("cust_WGG615E92dhOHz7PV9Vo9gk9")
+```
+
+Result:
+
+```json
+{
+    "id": "cust_WGG615E92dhOHz7PV9Vo9gk9",
+    "created_at": "2016-06-12T15:52:49Z",
+    "description": "Sample description about customer",
+    "email": "john@email.com",
+    "metadata": {
+        "lang": "en"
+    },
+    "name": "John Doe",
+    "object": "customer"
+}
+```
+
+#### Update customer
+
+```ruby
+customer = {
+  id: "cust_WGG615E92dhOHz7PV9Vo9gk9",
+  description: "Sample description about customer with changes"
+}
+voucherify.update_customer(customer)
+```
+
+Result:
+
+```json
+{
+    "id": "cust_WGG615E92dhOHz7PV9Vo9gk9",
+    "created_at": "2016-06-12T15:52:49Z",
+    "description": "Sample description about customer with changes",
+    "email": "john@email.com",
+    "metadata": {
+        "lang": "en"
+    },
+    "name": "John Doe",
+    "object": "customer"
+}
+```
+
+#### Delete customer
+
+```ruby
+voucherify.delete_customer("cust_WGG615E92dhOHz7PV9Vo9gk9")
+```
+
+The response has empty body.
+
 ## 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.
@@ -530,6 +631,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-06-12** - `0.4.0` - new customer sdk methods
 - **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()

data/examples/customer.rb

@@ -0,0 +1,29 @@
+require 'voucherify'
+
+voucherify = Voucherify.new({
+                                "applicationId" => "c70a6f00-cf91-4756-9df5-47628850002b",
+                                "clientSecretKey" => "3266b9f8-e246-4f79-bdf0-833929b1380c"
+                            })
+
+new_customer = voucherify.create_customer({
+                                              name: "John Doe",
+                                              email: "john@email.com",
+                                              description: "Sample description about customer",
+                                              metadata: {
+                                                  lang: "en"
+                                              }
+                                          })
+
+print(new_customer)
+
+customer = voucherify.fetch_customer(new_customer["id"])
+
+print(customer)
+
+customer[:description] = "Sample description of customer with updates"
+
+updated_customer = voucherify.update_customer(customer)
+
+print(updated_customer)
+
+voucherify.delete_customer(updated_customer["id"])

data/lib/voucherify.rb

@@ -128,4 +128,28 @@ class Voucherify
     response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
     JSON.parse(response.body)
   end
+
+  def create_customer(customer)
+    url = @backend_url + "/customers/"
+    response = RestClient.post(url, customer.to_json, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  end
+
+  def fetch_customer(customer_id)
+    url = @backend_url + "/customers/" + customer_id
+    response = RestClient.get(url, @headers)
+    JSON.parse(response.body)
+  end
+
+  def update_customer(customer)
+    url = @backend_url + "/customers/" + (customer["id"] || customer[:id])
+    response = RestClient.put(url, customer.to_json, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  end
+
+  def delete_customer(customer_id)
+    url = @backend_url + "/customers/" + customer_id
+    response = RestClient.delete(url, @headers)
+    nil
+  end
 end

data/lib/voucherify/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/customer.rb
 - lib/voucherify.rb
 - lib/voucherify/version.rb
 - voucherify.gemspec