voucherify 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8903d1d22de61bf4ebda5db9a52ad5ebce28c067
-  data.tar.gz: 1889dc404c0b5c51f72929f9d9ec6d773bc53ca1
+  metadata.gz: 93236863fb4ac7cae0378cb4c8287bf04686b651
+  data.tar.gz: 8819259dbfbaa0411336f5a7bcbeead247f67f49
 SHA512:
-  metadata.gz: 73682fd328a86822a6cf3306575616f3efef2c883c68b3c9c946d55c5f8c7acf6d283c5b809a0337ac3000509c4e06bb60a7f525d70081965fcf8e3180f25ee3
-  data.tar.gz: b7e10d6d01eef68d6aeefbe95a03531f4211227bc1ba02b9ccad89b34980390a62eb50099d7db304470fb0212ee020a3e912babdb523e5873c853e44ccb2d7fa
+  metadata.gz: 8bf377abdcd3bb07477ed748a179836fc5c5c4033ace42f9feb490fe9c8eba7572ee4fa8ae269d31ee291082a5ab3a40da95372c151a53c26473dcb122f45387
+  data.tar.gz: f43536f00e1f4eece69096286742742a7d51d251fe2067412907edc838dbecfcbb293b54fc4d6b6fdaf1fee9409294ebcb8fdb9e4d89ec2abbafda5e6ddd295d

data/README.md

@@ -344,24 +344,34 @@ with their namespaced equivalent.
 
 ## 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.
+When the Voucherify API responds with an error (HTTP status code is 4xx or 5xx) then the client raises a `VoucherifyError`.
+It contains following properties:
+- `code` - HTTP status code
+- `message` - a human-readable message providing short description about the error.
+- `details` - a human-readable message providing more details about the error, usually includes a hint on how to fix the error
+- `key` - a short string describing the kind of error that occurred.
+
+Example:
 
 ```ruby
 begin
   voucherify.distributions.publish('test')
-rescue => e
-  JSON.parse(e.response)
+rescue Voucherify::VoucherifyError => e
+  puts e.code
+  puts e.message
+  puts e.details
+  puts e.key
 end
 ```
 
-```json
-{
-    "code": 400,
-    "message": "Couldn't find any voucher suitable for publication."
-}
-```
+The ouput may be:
 
-Please refer to [rest-client documentation](https://github.com/rest-client/rest-client#exceptions-see-httpwwww3orgprotocolsrfc2616rfc2616-sec10html) for more detailed information.
+```
+400
+Couldn't find any voucher suitable for publication.
+Use auto-update campaigns if you want Voucherify to generate vouchers automatically.
+no_voucher_suitable_for_publication
+```
 
 ## Development
 
@@ -374,7 +384,8 @@ 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-01-04** - `1.2.0` - added [import vouchers](#import-vouchers) method.
+- **2017-03-22** - `1.3.0` - improved error handling
+- **2017-01-04** - `1.2.0` - added [import vouchers](#import-vouchers) method.
 - **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 
@@ -406,6 +417,7 @@ 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
+[Import Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers-1
 
 [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
@@ -436,3 +448,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 [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/examples/vouchers.rb

@@ -4,13 +4,18 @@ voucherify = Voucherify::Client.new({
                                         :applicationId => 'c70a6f00-cf91-4756-9df5-47628850002b',
                                         :clientSecretKey => '3266b9f8-e246-4f79-bdf0-833929b1380c'
                                     })
-
-puts voucherify.vouchers.validate('91Ft4U', {
+begin
+    puts voucherify.validations.validate_voucher('91Ft4U', {
     tracking_id: 'john@lemon.com',
     order: {
-        amount: 1000
+      amount: 1000
     }
-})
+  })
+rescue Voucherify::VoucherifyError => e
+    puts e.message
+    puts e.details
+    puts e.key
+end
 
 query = {limit: 10, skip: 20, category: 'API Test'}
 puts voucherify.vouchers.list(query)

data/lib/voucherify/client.rb

@@ -47,32 +47,63 @@ module Voucherify
     end
 
     def get(path, params = {})
-      url = @backend_url + path
-      response = RestClient.get(url, @headers.merge({:params => params}))
-      JSON.parse(response.body)
+      begin
+        url = @backend_url + path
+        response = RestClient.get(url, @headers.merge({:params => params}))
+        JSON.parse(response.body)
+      rescue RestClient::Exception => e
+        raise VoucherifyError.new(e)
+      end
     end
 
     def put(path, body, params = {})
-      url = @backend_url + path
-      response = RestClient.put(url, body, @headers.merge({:params => params, :content_type => :json}))
-      JSON.parse(response.body)
+      begin
+        url = @backend_url + path
+        response = RestClient.put(url, body, @headers.merge({:params => params, :content_type => :json}))
+        JSON.parse(response.body)
+      rescue RestClient::Exception => e
+        raise VoucherifyError.new(e)
+      end
     end
 
     def post(path, body, params = {})
-      url = @backend_url + path
-      response = RestClient.post(url, body, @headers.merge({:params => params, :content_type => :json}))
-      if !response.body.empty?
-        JSON.parse(response.body)
-      else
-        nil
+      begin
+        url = @backend_url + path
+        response = RestClient.post(url, body, @headers.merge({:params => params, :content_type => :json}))
+        if !response.body.empty?
+          JSON.parse(response.body)
+        else
+          nil
+        end
+      rescue RestClient::Exception => e
+        raise VoucherifyError.new(e)
       end
-
     end
 
     def delete(path, params = {})
-      url = @backend_url + path
-      RestClient.delete(url, @headers.merge({:params => params}))
-      nil
+      begin
+        url = @backend_url + path
+        RestClient.delete(url, @headers.merge({:params => params}))
+        nil
+      rescue RestClient::Exception => e
+        raise VoucherifyError.new(e)
+      end
+    end
+  end
+  
+  class VoucherifyError < RuntimeError
+    attr_reader :response
+    attr_reader :code
+    attr_reader :details
+    attr_reader :key
+  
+    def initialize (restClientError)
+      @response = restClientError.response
+      parsedResponse = JSON.parse(@response)
+      @code = parsedResponse['code']
+      @details = parsedResponse['details']
+      @key = parsedResponse['key']
+      super(parsedResponse['message'])
     end
   end
 

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 module Voucherify
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler