voucherify 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd9695952723777efe716ab4f8a48b11d40e250
-  data.tar.gz: fd835a4412be0cb48ffdbf51c08e166888c76db1
+  metadata.gz: 6735d1504bcd3793ae0a670d0a687e17e38f2519
+  data.tar.gz: 8880cf6c0bb216754bc960924ae064895160ffdb
 SHA512:
-  metadata.gz: ae0453d58a61850caaafcd216ef4b8800a8f070c8201c69ade68029de3b2fd99a77fda76b85c06f5e016524dcb09401993d7da85c05778a52879871aa08b8d5c
-  data.tar.gz: 259f36f42f969e8aa85e763483878a517310cb8c93757a1c32917fe56927834f6ebcbed6bcbb25e3f97714502c2295d02cb552ad3a293bdfa88d394eafcee8fc
+  metadata.gz: ace85201f017f9b164bbf91d2888177a62ccb52b0197db600879dccd06d64c62d5416cea56566d69b3d7eea181d2cba2db3dba38278740dc27d26e8b6a0e1d6c
+  data.tar.gz: d67ad31d24816f1276e28b2d14d63a0bab5f12310c4ab1a86fc643cd82366310fb90d12996b7838a8ee76d62fd01f1ca39263b534d4cbc442334be5458bb9caf

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install:
+  - gem update bundler
+install: 
+  - bundle install
+script:
+  - rake spec

data/README.md

@@ -5,6 +5,7 @@
 <h3 align="center">Official <a href="http://voucherify.io?utm_source=github&utm_medium=sdk&utm_campaign=acq">Voucherify</a> SDK for Ruby</h3>
 
 <p align="center">
+  <a href="https://travis-ci.org/voucherifyio/voucherify-ruby-sdk"><img src="https://travis-ci.org/voucherifyio/voucherify-ruby-sdk.svg?branch=master" alt="Build Status"/></a>
   <a href="https://rubygems.org/gems/voucherify"><img src="https://img.shields.io/gem/v/voucherify.svg" alt="Gem Version"/></a>
   <a href="https://rubygems.org/gems/voucherify"><img src="https://img.shields.io/gem/dt/voucherify.svg" alt="Gem Downloads"/></a>
 </p>
@@ -28,6 +29,8 @@
 API:
 <a href="#vouchers-api">Vouchers</a>
 |
+<a href="#campaigns-api">Campaigns</a>
+|
 <a href="#distributions-api">Distributions</a>
 |
 <a href="#validations-api">Validations</a>
@@ -36,6 +39,8 @@ API:
 |
 <a href="#customers-api">Customers</a>
 |
+<a href="#products-api">Products</a>
+|
 <a href="#utils">Utils</a>
 </p>
 
@@ -115,6 +120,32 @@ voucherify.vouchers.disable(code)
 ```
 ---
 
+### Campaigns API
+Methods are provided within `voucherify.campaigns.*` namespace.
+- [Create Campaign](#create-campaign)
+- [Get Campaign](#get-campaign)
+- [Add Voucher to Campaign](#add-voucher-to-campaign)
+- [Import Vouchers to Campaign](#import-vouchers-to-campaign)
+
+#### [Create Campaign]
+```ruby
+voucherify.campaigns.create(campaign)
+```
+#### [Get Campaign]
+```ruby
+voucherify.campaigns.get(campaign_name)
+```
+#### [Add Voucher to Campaign]
+```ruby
+voucherify.campaigns.add_voucher(campaign_name, [params])
+```
+#### [Import Vouchers to Campaign]
+```ruby
+voucherify.campaigns.import_vouchers(campaign_name, vouchers)
+```
+
+---
+
 ### Distributions API
 Methods are provided within `voucherify.distributions.*` namespace.
 
@@ -200,6 +231,63 @@ voucherify.customers.update(customer)
 voucherify.customers.delete(customer_id)
 ```
 
+### Products API
+Methods are provided within `voucherify.products.*` namespace.
+
+- [Create Product](#create-product)
+- [Get Product](#get-product)
+- [Update Product](#update-product)
+- [Delete Product](#delete-product)
+- [List Products](#list-products)
+- [Create SKU](#create-sku)
+- [Get SKU](#get-sku)
+- [Update SKU](#update-sku)
+- [Delete SKU](#delete-sku)
+- [List all product SKUs](#list-all-product-skus)
+
+#### [Create Product]
+```ruby
+voucherify.products.create(product)
+```
+Check [product object](https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#the-product-object).
+#### [Get Product]
+```ruby
+voucherify.products.get(product_id)
+```
+#### [Update Product]
+```ruby
+voucherify.products.update(product)
+```
+#### [Delete Product]
+```ruby
+voucherify.products.delete(product_id)
+```
+#### [List Products]
+```ruby
+voucherify.products.list([params])
+```
+#### [Create SKU]
+```ruby
+voucherify.products.create_sku(product_id, sku)
+```
+Check [SKU object](https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#the-sku-object).
+#### [Get SKU]
+```ruby
+voucherify.products.get_sku(product_id, sku_id)
+```
+#### [Update SKU]
+```ruby
+voucherify.products.update_sku(product_id, sku)
+```
+#### [Delete SKU]
+```ruby
+voucherify.products.delete_sku(product_id, sku_id)
+```
+#### [List all product SKUs]
+```ruby
+voucherify.products.list_skus(product_id)
+```
+
 ---
 
 ### Migration from 0.x
@@ -280,6 +368,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-12-29** - `1.1.0` - introduced [campaigns api](#campaigns-api) and [products api](#products-api).
 - **2016-12-15** - `1.0.0` - introduced namespaces, unified method names, updated README. Migration from versions 0.x required [migration from version 0.x](#migration-from-0x)
 - **2016-12-02** - `0.8.2` - support gift vouchers in utils, fix price and discount calculations for amount discounts 
 - **2016-10-03** - `0.8.1` - publish update 
@@ -310,8 +399,16 @@ The gem is available as open source under the terms of the [MIT License](http://
 [List Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-vouchers
 [Enable Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#enable-voucher
 [Disable Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#disable-voucher
+
+[Create Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-campaign
+[Get Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-campaign
+[Add Voucher to Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#add-voucher-to-campaign
+[Import Vouchers to Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers
+
 [Publish Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#publish-voucher
+
 [Validate Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#validate-voucher
+
 [Redeem Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#redeem-voucher
 [List Redemptions]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-redemptions
 [Get Voucher's Redemptions]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#vouchers-redemptions
@@ -320,4 +417,15 @@ The gem is available as open source under the terms of the [MIT License](http://
 [Create Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-customer
 [Get Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#read-customer
 [Update Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-customer
-[Delete Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-customer
+[Delete Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-customer
+
+[Create Product]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-product
+[Get Product]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-product
+[Update Product]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-product
+[Delete Product]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-product
+[List Products]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-products
+[Create SKU]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-sku
+[Get SKU]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-sku
+[Update SKU]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-sku
+[Delete SKU]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-sku
+[List all product SKUs]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-skus

data/Rakefile

@@ -1,8 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--format documentation'
-end
-
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec

data/lib/voucherify.rb

@@ -1,7 +1,9 @@
 require 'voucherify/version'
 require 'voucherify/client'
+require 'voucherify/service/campaigns'
 require 'voucherify/service/customers'
 require 'voucherify/service/distributions'
+require 'voucherify/service/products'
 require 'voucherify/service/redemptions'
 require 'voucherify/service/validations'
 require 'voucherify/service/vouchers'

data/lib/voucherify/client.rb

@@ -5,12 +5,14 @@ require 'json'
 module Voucherify
 
   class Client
+    attr_reader :backend_url
+
     def initialize (options)
       @options = options
       @backend_url = 'https://api.voucherify.io/v1'
       @headers = {
-          'X-App-Id' => @options[:applicationId],
-          'X-App-Token' => @options[:clientSecretKey],
+          'X-App-Id' => @options[:applicationId] || @options['applicationId'],
+          'X-App-Token' => @options[:clientSecretKey] || @options['clientSecretKey'],
           'X-Voucherify-Channel' => 'Ruby-SDK',
           :accept => :json
       }
@@ -36,6 +38,14 @@ module Voucherify
       Voucherify::Service::Customers.new(self)
     end
 
+    def products
+      Voucherify::Service::Products.new(self)
+    end
+
+    def campaigns
+      Voucherify::Service::Campaigns.new(self)
+    end
+
     def get(path, params = {})
       url = @backend_url + path
       response = RestClient.get(url, @headers.merge({:params => params}))

data/lib/voucherify/service/campaigns.rb

@@ -0,0 +1,39 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Campaigns
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(campaign)
+        @client.post('/campaigns', campaign.to_json)
+      end
+
+      def get(campaign_name)
+        @client.get("/campaigns/#{URI.encode(campaign_name)}")
+      end
+
+      def delete(campaign_name, params = {})
+        @client.delete("/campaigns/#{URI.encode(campaign_name)}", {:force => (!!(params['force'] || params[:force])).to_s})
+        nil
+      end
+
+      def add_voucher(campaign_name, params = {})
+        code = params['code'] || params[:code]
+        url = "/campaigns/#{URI.encode(campaign_name)}/vouchers"
+        url += "/#{URI.encode(code)}" if code
+        params.delete 'code'
+        params.delete :code
+        @client.post(url, params.to_json)
+      end
+
+      def import_vouchers(campaign_name, vouchers)
+        @client.post("/campaigns/#{URI.encode(campaign_name)}/import", vouchers.to_json)
+      end
+    end
+  end
+end

data/lib/voucherify/service/customers.rb

@@ -10,19 +10,19 @@ module Voucherify
       end
 
       def create(customer)
-        @client.post('/customers/', customer.to_json)
+        @client.post('/customers', customer.to_json)
       end
 
       def get(customer_id)
-        @client.get('/customers/' + customer_id)
+        @client.get("/customers/#{URI.encode(customer_id)}")
       end
 
       def update(customer)
-        @client.put('/customers/' + (customer['id'] || customer[:id]), customer.to_json)
+        @client.put("/customers/#{URI.encode(customer['id'] || customer[:id])}", customer.to_json)
       end
 
       def delete(customer_id)
-        @client.delete('/customers/' + customer_id)
+        @client.delete("/customers/#{URI.encode(customer_id)}")
       end
     end
   end

data/lib/voucherify/service/distributions.rb

@@ -9,17 +9,15 @@ module Voucherify
         @client = client
       end
 
-      def publish(campaign_name)
-        url = '/vouchers/publish'
+      def publish(params)
         payload = {}
-
-        if campaign_name.is_a? String
-          url += '?campaign=' + URI.encode(campaign_name)
-        elsif campaign_name.is_a? Hash
-          payload = campaign_name
+        if params.is_a? String
+          payload = {:campaign => params}
+        elsif params.is_a? Hash
+          payload = params
         end
 
-        @client.post(url, payload.to_json)
+        @client.post('/vouchers/publish', payload.to_json)
       end
     end
   end

data/lib/voucherify/service/products.rb

@@ -0,0 +1,53 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Products
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(product)
+        @client.post('/products', product.to_json)
+      end
+
+      def get(product_id)
+        @client.get("/products/#{URI.encode(product_id)}")
+      end
+
+      def update(product)
+        @client.put("/products/#{URI.encode(product['id'] || product[:id])}", product.to_json)
+      end
+
+      def delete(product_id)
+        @client.delete("/products/#{URI.encode(product_id)}")
+      end
+
+      def list(query = {})
+        @client.get('/products', query)
+      end
+
+      def create_sku(product_id, sku)
+        @client.post("/products/#{URI.encode(product_id)}/skus", sku.to_json)
+      end
+
+      def get_sku(product_id, sku_id)
+        @client.get("/products/#{URI.encode(product_id)}/skus/#{URI.encode(sku_id)}")
+      end
+
+      def update_sku(product_id, sku)
+        @client.put("/products/#{URI.encode(product_id)}/skus/#{URI.encode(sku['id'] || sku[:id])}", sku.to_json)
+      end
+
+      def delete_sku(product_id, sku_id)
+        @client.delete("/products/#{URI.encode(product_id)}/skus/#{URI.encode(sku_id)}")
+      end
+
+      def list_skus(product_id)
+        @client.get("/products/#{URI.encode(product_id)}/skus")
+      end
+    end
+  end
+end

data/lib/voucherify/service/redemptions.rb

@@ -10,25 +10,23 @@ module Voucherify
       end
 
       def redeem(code, params = {})
-        url = '/vouchers/' + URI.encode(code) + '/redemption'
-        @client.post(url, params.to_json)
+        @client.post("/vouchers/#{URI.encode(code)}/redemption", params.to_json)
       end
 
       def list(query = {})
-        @client.get('/redemptions/', query)
+        @client.get('/redemptions', query)
       end
 
       def get_for_voucher(code)
-        @client.get('/vouchers/' + URI.encode(code) + '/redemption')
+        @client.get("/vouchers/#{URI.encode(code)}/redemption")
       end
 
-      def rollback(redemption_id, params = {})
-        reason = params['reason'] || params[:reason]
-        url = '/redemptions/'+ URI.encode(redemption_id) + '/rollback'
-        url += '?reason=' + URI.encode(reason) if reason
-        params.delete 'reason'
-        params.delete :reason
-        @client.post(url, params.to_json)
+      def rollback(redemption_id, payload = {})
+        reason = payload['reason'] || payload[:reason]
+        params = reason ? {:reason => reason} : {}
+        payload.delete 'reason'
+        payload.delete :reason
+        @client.post("/redemptions/#{URI.encode(redemption_id)}/rollback", payload.to_json, params)
       end
 
     end

data/lib/voucherify/service/validations.rb

@@ -10,7 +10,7 @@ module Voucherify
       end
 
       def validate_voucher(code, context = {})
-        @client.post('/vouchers/' + URI.encode(code) + '/validate', context.to_json)
+        @client.post("/vouchers/#{URI.encode(code)}/validate", context.to_json)
       end
     end
   end

data/lib/voucherify/service/vouchers.rb

@@ -10,41 +10,35 @@ module Voucherify
       end
 
       def create(code, options = {})
-        url = '/vouchers/'
-        url += URI.encode(code) if code
+        url = '/vouchers'
+        url += '/' + URI.encode(code) if code
         @client.post(url, options.to_json)
       end
 
       def get(code)
-        @client.get('/vouchers/' + URI.encode(code))
+        @client.get("/vouchers/#{URI.encode(code)}")
       end
 
       def update(voucher_update)
-        url = '/vouchers/' + URI.encode(voucher_update['code'])
-        @client.put(url, voucher_update.to_json)
+        @client.put("/vouchers/#{URI.encode(voucher_update['code'] || voucher_update[:code])}", voucher_update.to_json)
       end
 
       def list(query)
-        @client.get('/vouchers/', query)
+        @client.get('/vouchers', query)
       end
 
       def enable(code)
-        url = '/vouchers/' + URI.encode(code) + '/enable'
-        @client.post(url, nil)
+        @client.post("/vouchers/#{URI.encode(code)}/enable", nil)
         nil
       end
 
       def disable(code)
-        url = '/vouchers/' + URI.encode(code) + '/disable'
-        @client.post(url, nil)
+        @client.post("/vouchers/#{URI.encode(code)}/disable", nil)
         nil
       end
 
       def delete(code, params = {})
-        force = params['force'] || params[:force]
-        url = '/vouchers/' + URI.encode(code)
-        url += '?force=' + (!!force).to_s
-        @client.delete(url, nil)
+        @client.delete("/vouchers/#{URI.encode(code)}", {:force => (!!(params['force'] || params[:force])).to_s})
         nil
       end
     end

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 module Voucherify
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/voucherify.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   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 'webmock', '~> 2.3.1'
 
   spec.add_dependency 'rest-client', '~> 2.0'
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -85,8 +101,10 @@ files:
 - examples/vouchers.rb
 - lib/voucherify.rb
 - lib/voucherify/client.rb
+- lib/voucherify/service/campaigns.rb
 - lib/voucherify/service/customers.rb
 - lib/voucherify/service/distributions.rb
+- lib/voucherify/service/products.rb
 - lib/voucherify/service/redemptions.rb
 - lib/voucherify/service/validations.rb
 - lib/voucherify/service/vouchers.rb
@@ -106,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='