voucherify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c55ee00e0d7f7eac4ddc7c1af5a22f5f86c8f123
+  data.tar.gz: 567e26d05a69d3f16f04168000192b3f7dc0e3a9
+SHA512:
+  metadata.gz: a1f68cce9487f59ea25600870dbcd345e5b1d1f544d1a437cf8b19cfa7431045df8c75458b158e1f11e167744e03319d5017c1128e3fdbce269d92e41c6dc257
+  data.tar.gz: e13b130625ed45c3ab0e8bb20f49ff694e7d12a634a9102604ee3f24b885a93774e303011f7c635b2828fb82d9c9768b6f18ada03c0f73c25e36d80908444a6f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .ruby-version
+# .ruby-gemset
+Gemfile.lock
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voucherify.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 rspective P.Rychlik sp.j.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,419 @@
+## 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:
+
+- **roll-out thousands** of vouchers **in minutes** instead of weeks,
+- **check status** or disable **every single** promo code in real time,
+- **track redemption** history and build reports on the fly.
+
+Here you can find a library that makes it easier to integrate Voucherify with your Ruby server.
+
+Full documentation is located at [voucherify.readme.io](https://voucherify.readme.io).
+
+### Usage
+
+#### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voucherify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voucherify
+
+#### Authentication
+
+[Log-in](http://app.voucherify.io/#/login) to Voucherify web interface and obtain your Application Keys from [Configuration](https://app.voucherify.io/#/app/configuration):
+
+![](https://www.filepicker.io/api/file/WKYkl2bSAWKHccEN9tEG)
+
+```ruby
+require "voucherify"
+
+voucherify = Voucherify.new({
+  "applicationId" => "YOUR-APPLICATION-ID-OBTAINED-FROM-CONFIGURATION",
+  "clientSecretKey" => "YOUR-CLIENT-SECRET-KEY-OBTAINED-FROM-CONFIGURATION"
+})
+```
+
+#### Error handling
+
+This voucherify gem uses [rest-client](https://github.com/rest-client/rest-client) under the hood for handling HTTP calls. In case of an HTTP 4xx or 5xx error, a RestClient exception is thrown. The server's specific response is available in `.response` of the exception object.
+
+```ruby
+begin
+  voucherify.publish("test")
+rescue => e
+  JSON.parse(e.response)
+end
+```
+
+```json
+{
+    "code": 400,
+    "message": "Couldn't find any voucher suitable for publication."
+}
+```
+
+Please refer to [rest-client documentation](https://github.com/rest-client/rest-client#exceptions-see-httpwwww3orgprotocolsrfc2616rfc2616-sec10html) for more detailed information.
+
+#### Listing vouchers
+
+```ruby
+voucherify.list({ limit: 10, skip: 20, category: "API Test" })
+```
+
+Result:
+```json
+[{
+     "code": "9mYBpIk",
+     "campaign": null,
+     "category": "API Test",
+     "discount": {
+       "type": "AMOUNT",
+       "amount_off": 400
+     },
+     "start_date": "2016-03-01T12:00:00Z",
+     "expiration_date": null,
+     "redemption": {
+       "quantity": 1,
+       "redeemed_quantity": 0,
+       "redemption_entries": []
+     },
+     "active": true,
+     "additional_info": null,
+     "metadata": null
+   },
+   {
+       "code": "AzTsIH",
+       "campaign": null,
+       "category": "API Test",
+       "discount": {
+        "type": "AMOUNT",
+        "amount_off": 400
+       },
+       "start_date": "2016-03-01T10:00:00Z",
+       "expiration_date": null,
+       "redemption": {
+        "quantity": 1,
+        "redeemed_quantity": 0,
+        "redemption_entries": []
+       },
+       "active": true,
+       "additional_info": null,
+       "metadata": null
+   },
+   ...
+]  
+```
+
+#### Getting voucher details
+
+```ruby
+voucherify.get("v1GiJYuuS")
+```
+
+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": 1,
+        "redemption_entries": [
+            {
+                "date": "2015-09-24T06:03:35Z",
+                "tracking_id": "GENERATED-OR-PROVIDED-TRACKING-ID"
+            }
+        ]
+    },
+    "additional_info": ""
+}
+```
+
+#### Getting voucher redemption
+
+```ruby
+voucherify.redemption("v1GiJYuuS")
+```
+
+Result:
+```json
+{
+    "quantity": 3,
+    "redeemed_quantity": 1,
+    "redemption_entries": [
+        {
+            "date": "2015-09-24T06:03:35Z",
+            "tracking_id": "GENERATED-OR-PROVIDED-TRACKING-ID"
+        }
+    ]
+}
+```
+
+#### 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. 
+
+Example:
+
+```ruby
+voucherify.publish("First Ride")
+```
+
+Positive result:
+
+```json
+{
+   "code": "FR-zT-u9I7zG",
+   "campaign": "First Ride",
+   "category": null,
+   "discount": {
+      "type": "PERCENT",
+      "amount_off": 50
+   },
+   "start_date": "2015-01-01T00:00:00Z",
+   "expiration_date": "2016-12-31T23:59:59Z",
+   "redemption": {
+      "quantity": 1,
+      "redeemed_quantity": 0,
+      "redemption_entries": []
+   },
+   "active": true,
+   "additional_info": null,
+   "metadata": {
+      "published": "2016-01-22T09:25:07Z"
+   }
+}
+```
+
+Possible error:
+
+```json
+{
+  "code": 400,
+  "message": "Couldn't find any voucher suitable for publication."
+}
+```
+
+#### Redeeming voucher
+
+##### 1. Just by code
+
+```ruby
+voucherify.redeem("v1GiJYuuS")
+```
+
+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": ""
+}
+```
+
+Error:
+```json
+{
+  "code": 400,
+  "message": "voucher expired or quantity exceeded",
+  "details": "v1GiJYuuS"
+}
+```
+
+##### 2. With tracking id
+
+You can provide a tracking id (e.g. your customer's login or a generated id) to the voucher redemption request.
+
+```ruby
+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": ""
+}
+```
+
+##### 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.
+
+```ruby
+voucherify.redeem({
+    voucher: "v1GiJYuuS",
+    customer: {
+        id: "alice.morgan",
+        name: "Alice Morgan",
+        email: "alice@morgan.com",
+        description: "",
+        metadata: {
+            locale: "en-GB",
+            shoeSize: 5,
+            favourite_brands: ["Armani", "L’Autre Chose", "Voucherify"]
+        }
+    })
+```
+
+### Listing redemptions
+
+Use `voucherify.redemptions(filter)` to get a filtered list of redemptions.
+
+Example - 1000 successful redemptions from April 2016:
+
+```ruby
+filter = {
+    limit: 1000,
+    page: 0,
+    start_date: "2016-04-01T00:00:00",
+    end_date: "2016-04-30T23:59:59",
+    result: "Success"
+}
+
+voucherify.redemptions(filter)
+```
+
+#### Creating vouchers
+
+Use `voucherify.create(code, options)` to create new vouchers.
+
+```ruby
+code = "EASTER-2016" # use given voucher code
+code = nil # for an automatically generated string
+
+# single-use voucher with 10% off discount that is valid throughout the whole 2016
+opts = {
+  category: "New Customers",
+  discount: {
+    percent_off: 10.0,
+    type: "PERCENT"
+  },
+  start_date: "2016-01-01T00:00:00Z",
+  expiration_date: "2016-12-31T23:59:59Z",
+  redemption: {
+    quantity: 1
+  }
+}
+
+voucherify.create(code, opts)
+```
+
+Result (voucher details):
+```json
+{
+    "code": "9Yi5g",
+    "campaign": null,
+    "category": "New Customers",
+    "discount": {
+        "type": "PERCENT",
+        "percent_off": 10.0
+    },
+    "start_date": "2016-01-01T00:00:00Z",
+    "expiration_date": "2016-12-31T23:59:59Z",
+    "redemption": {
+        "quantity": 1,
+        "redeemed_quantity": 0,
+        "redemption_entries": []
+    },
+    "active": true,
+    "additional_info": null,
+    "metadata": null
+}
+```
+
+### Disable a voucher
+
+```ruby
+voucherify.disable("EASTER-2016")
+```
+
+The response has empty body.
+
+### Enable a voucher
+
+```ruby
+voucherify.enable("EASTER-2016")
+```
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rspective/voucherify-ruby-sdk.
+
+## Changelog
+- **2016-04-11** - `0.1.0` - First version:
+  - Authentication
+  - Voucher information: *retrieve voucher*, *list vouchers*, *retrieve redemptions*, *list redemptions*
+  - Voucher operations: *redeem voucher*, *publish voucher*, *create voucher*, *enable/disable voucher*
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "voucherify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/voucherify.rb

@@ -0,0 +1,109 @@
+require "voucherify/version"
+require "net/http"
+require "uri"
+require "rest-client"
+require "json"
+
+require "pry"
+
+
+class Voucherify
+  def initialize(options)
+    @backend_url = "https://api.voucherify.io/v1"
+    @options = options
+    @headers = {
+      "X-App-Id" => @options["applicationId"],
+      "X-App-Token" => @options["clientSecretKey"],
+      "X-Voucherify-Channel" => "Ruby-SDK",
+      :accept => :json
+    }
+  end
+
+  def get(code)
+    url = @backend_url + "/vouchers/" + URI.encode(code)
+    response = RestClient.get(url, @headers)
+    JSON.parse(response.body)
+  end
+
+  # List vouchers. Sample query: { limit: 100, skip: 200, category: "Loyalty" }
+  def list(query)
+    url = @backend_url + "/vouchers/"
+    response = RestClient.get(url, @headers.merge({ :params => query }))
+    JSON.parse(response.body)
+  end
+
+  def redemption(code)
+    url = @backend_url + "/vouchers/" + URI.encode(code) + "/redemption"
+    response = RestClient.get(url, @headers)
+    JSON.parse(response.body)
+  end
+
+  # List redemptions. Sample query (1000 successful redemptions from April 2016):
+  # {
+  #   limit: 1000,
+  #   page: 0,
+  #   start_date: "2016-04-01T00:00:00",
+  #   end_date: "2016-04-30T23:59:59",
+  #   result: "Success"
+  # }
+  def redemptions(query)
+    url = @backend_url + "/redemptions/"
+    response = RestClient.get(url, @headers.merge({ :params => query }))
+    JSON.parse(response.body)
+  end
+
+  def redeem(code, tracking_id = nil)
+    payload = {}
+
+    if code.is_a? Hash
+      payload = code
+      code = payload["voucher"]
+      payload.delete "voucher"
+    end
+
+    url = @backend_url + "/vouchers/" + URI.encode(code) + "/redemption"
+    url += ("?tracking_id=" + URI.encode(tracking_id)) if tracking_id
+
+    response = RestClient.post(url, payload.to_json, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  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 }))
+    JSON.parse(response.body)
+  end
+
+  # `code` is optional - will be generated if absent.
+  # Sample `options` object:
+  # {
+  #   category: "New Customers",
+  #   discount: {
+  #     percent_off: 10.0,
+  #     type: "PERCENT"
+  #   },
+  #   start_date: "2016-01-01T00:00:00Z",
+  #   expiration_date: "2016-12-31T23:59:59Z",
+  #   redemption: {
+  #     quantity: 100 
+  #   }
+  # }
+  def create(code, options = {})
+    url = @backend_url + "/vouchers/"
+    url += URI.encode(code) if code
+    response = RestClient.post(url, options.to_json, @headers.merge({ :content_type => :json }))
+    JSON.parse(response.body)
+  end
+
+  def enable(code)
+    url = @backend_url + "/vouchers/" + URI.encode(code) + "/enable"
+    response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
+    nil
+  end
+
+  def disable(code)
+    url = @backend_url + "/vouchers/" + URI.encode(code) + "/disable"
+    response = RestClient.post(url, nil, @headers.merge({ :content_type => :json }))
+    nil
+  end
+end

data/lib/voucherify/version.rb

@@ -0,0 +1,3 @@
+class Voucherify
+  VERSION = "0.1.0"
+end

data/voucherify.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voucherify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voucherify"
+  spec.version       = Voucherify::VERSION
+  spec.authors       = ["pawelrychlik"]
+  spec.email         = ["pawel.rychlik@rspective.pl"]
+
+  spec.summary       = %q{Ruby SDK for Voucherify}
+  spec.homepage      = "http://www.voucherify.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  spec.add_dependency "rest-client", "~> 1.8"
+
+  spec.required_ruby_version = '>= 1.9.3'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: voucherify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pawelrychlik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: 
+email:
+- pawel.rychlik@rspective.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/voucherify.rb
+- lib/voucherify/version.rb
+- voucherify.gemspec
+homepage: http://www.voucherify.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Voucherify
+test_files: []