simplify 1.0.0

data/lib/simplify.rb

@@ -0,0 +1,41 @@
+#
+# Copyright (c) 2013, MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+require File.dirname(__FILE__) + '/simplify/cardtoken'
+require File.dirname(__FILE__) + '/simplify/chargeback'
+require File.dirname(__FILE__) + '/simplify/coupon'
+require File.dirname(__FILE__) + '/simplify/customer'
+require File.dirname(__FILE__) + '/simplify/deposit'
+require File.dirname(__FILE__) + '/simplify/event'
+require File.dirname(__FILE__) + '/simplify/invoice'
+require File.dirname(__FILE__) + '/simplify/invoiceitem'
+require File.dirname(__FILE__) + '/simplify/payment'
+require File.dirname(__FILE__) + '/simplify/plan'
+require File.dirname(__FILE__) + '/simplify/refund'
+require File.dirname(__FILE__) + '/simplify/subscription'
+require File.dirname(__FILE__) + '/simplify/webhook'
+

data/lib/simplify/apiexception.rb

@@ -0,0 +1,160 @@
+#
+# Copyright (c) 2013, MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+module Simplify
+
+
+  # Base class for all API exceptions.
+  class ApiException < Exception
+
+      # HTML status code (or nil if there is no status code)
+      attr_reader :status
+
+      # Error data returned from the API represented as a map.
+      attr_reader :errorData
+
+      # Unique reference ID for the API error.
+      attr_reader :reference
+
+      # API code for the error.
+      attr_reader :errorCode
+
+      # Description of the error.
+      attr_reader :errorMessage
+
+      def initialize(message, status, errorData)
+        super(message)
+
+        @status = status
+        @errorMessage = message        
+        @fieldErrors = []
+        if errorData != nil
+          @errorData = errorData
+          @reference = errorData.has_key?('reference') ? errorData['reference'] : nil
+
+          if errorData.has_key?('error')
+              error = errorData['error']
+              @errorCode = error['code']
+              if error.has_key?('message')
+                  message = error['message']
+              end
+          end
+        end
+        super(message)
+      end
+
+      # Returns a string descrption of the error.
+      def describe()
+        return "#{self.class}: \"#{self.to_s()}\" (status: #{@status}, error code #{@errorCode}, reference: #{@reference})"
+      end
+    
+    end
+
+    # Exception representing API authentication errors.
+    class AuthenticationException < ApiException
+    end
+
+
+    # Exception representing invalid requests made to the API.
+    class BadRequestException < ApiException 
+
+
+      # A single error on a field of an API request.
+      class FieldError 
+
+
+        # The name of the field with the error.
+        attr_reader :fieldName
+
+        # The code for the field error.
+        attr_reader :errorCode
+
+        # Description of the error.
+        attr_reader :message
+
+        def initialize(errorData)
+            @fieldName = errorData['field']
+            @errorCode = errorData['code']
+            @message = errorData['message']        
+        end
+
+        # Returns string representation of the error.
+        def to_s()
+            return "Field error: #{@fieldName} \"#{@message}\" (#{@errorCode})"
+        end
+      end
+
+      # List of field errors associatied with this error (empty if there are no field errors).
+      attr_reader :fieldErrors
+
+      alias :super_describe :describe
+
+      def initialize(message, status, errorData)
+
+        super(message, status, errorData)
+
+        @fieldErrors = []
+        if errorData.has_key?('error')
+            error = errorData['error']
+            if error.has_key?('fieldErrors')
+                fieldErrors = error['fieldErrors']
+                fieldErrors.each do |fieldError|
+                    @fieldErrors << FieldError.new(fieldError)
+                end
+            end
+        end
+      end
+
+      # Returns boolean indicating if there are field errors associated with this API error.
+      def hasFieldErrors?
+          return @fieldErrors.length > 1
+      end
+
+      # Returns a string description of the error including any field errors.
+      def describe()      
+        s = super_describe()
+        @fieldErrors.each do |fieldError|
+            s = s + "\n" + fieldError.to_s
+        end
+        return s + "\n"
+      end
+
+    end
+
+    # Exception representing a object not found for an API request.
+    class ObjectNotFoundException < ApiException
+    end
+
+    # Exception representing an invalid operation request.
+    class NotAllowedException < ApiException
+    end
+
+    # Exception representing a system error during processing of an API request.
+    class SystemException < ApiException
+    end
+
+end

data/lib/simplify/cardtoken.rb

@@ -0,0 +1,102 @@
+#
+# Copyright (c) 2013, MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+require 'simplify/paymentsapi'
+
+module Simplify
+
+# A CardToken object.
+#
+class CardToken < Hash
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+
+
+    # Creates an CardToken object
+    #
+    # parms:: a hash of parameters; valid keys are:
+    # * <code>callback</code>    The URL callback for the cardtoken 
+    # * <code>card => addressCity</code>    City of the cardholder. 
+    # * <code>card => addressCountry</code>    Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. 
+    # * <code>card => addressLine1</code>    Address of the cardholder. 
+    # * <code>card => addressLine2</code>    Address of the cardholder if needed. 
+    # * <code>card => addressState</code>    State code (USPS code) of residence of the cardholder. 
+    # * <code>card => addressZip</code>    Postal code of the cardholder. 
+    # * <code>card => cvc</code>    CVC security code of the card. This is the code on the back of the card. Example: 123 
+    # * <code>card => expMonth</code>    Expiration month of the card. Format is MM. Example: January = 01 <b>required </b>
+    # * <code>card => expYear</code>    Expiration year of the card. Format is YY. Example: 2013 = 13 <b>required </b>
+    # * <code>card => name</code>    Name as appears on the card. 
+    # * <code>card => number</code>    Card number as it appears on the card. <b>required </b>
+    # * <code>key</code>    Key used to create the card token. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a CardToken object.
+    def self.create(parms, public_key = nil, private_key = nil)
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("cardToken", 'create', parms, public_key, private_key)
+        obj = CardToken.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+    # Retrieve a CardToken object from the API
+    #
+    # id:: ID of object to retrieve
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a CardToken object.
+    def self.find(id, public_key = nil, private_key = nil)
+        if public_key == nil then
+             public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("cardToken", 'show', {"id" => id}, public_key, private_key)
+        obj = CardToken.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+end
+end

data/lib/simplify/chargeback.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (c) 2013, MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+require 'simplify/paymentsapi'
+
+module Simplify
+
+# A Chargeback object.
+#
+class Chargeback < Hash
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+
+
+    # Retrieve Chargeback objects.
+    # criteria:: a hash of parameters; valid keys are: 
+    # * <code>filter</code>    Filters to apply to the list.  
+    # * <code>max</code>    Allows up to a max of 50 list items to return.  <b>default:20</b>
+    # * <code>offset</code>    Used in paging of the list.  This is the start offset of the page.  <b>default:0</b>
+    # * <code>sorting</code>    Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <code>asc</code> for ascending or <code>desc</code> for descending).  Sortable properties are: <code> id</code><code> amount</code><code> description</code><code> dateCreated</code><code> paymentDate</code>. 
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns an object where the <code>list</code> property contains the list of Chargeback objects and the <code>total</code>
+    # property contains the total number of Chargeback objects available for the given criteria.
+    def self.list(criteria = nil, public_key = nil, private_key = nil)
+
+        if public_key == nil then
+            public_key = Simplify::public_key
+        end
+        if private_key == nil then
+           private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("chargeback", 'list', criteria, public_key, private_key)
+        obj = Chargeback.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+
+    end
+
+    # Retrieve a Chargeback object from the API
+    #
+    # id:: ID of object to retrieve
+    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
+    # private_key:: Private key to use for the API call. If nil, the value of Simplify::private_key will be used.
+    # Returns a Chargeback object.
+    def self.find(id, public_key = nil, private_key = nil)
+        if public_key == nil then
+             public_key = Simplify::public_key
+        end
+        if private_key == nil then
+            private_key = Simplify::private_key
+        end
+
+        h = Simplify::PaymentsApi.execute("chargeback", 'show', {"id" => id}, public_key, private_key)
+        obj = Chargeback.new()
+        obj.public_key = public_key
+        obj.private_key = private_key
+        obj = obj.merge(h)
+        obj
+    end
+
+end
+end

data/lib/simplify/constants.rb

@@ -0,0 +1,56 @@
+#
+# Copyright (c) 2013, MasterCard International Incorporated
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification, are 
+# permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice, this list of 
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of 
+# conditions and the following disclaimer in the documentation and/or other materials 
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its 
+# contributors may be used to endorse or promote products derived from this software 
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
+# SUCH DAMAGE.
+#
+
+module Simplify
+
+  # Constants.
+  class Constants
+
+     @@version = '1.0.0'
+     @@api_base_live_url = 'https://api.simplify.com/v1/api'
+     @@api_base_sandbox_url = 'https://sandbox.simplify.com/v1/api'
+
+
+     # Returns the base URL for the live API.
+     def self.api_base_live_url
+         @@api_base_live_url
+     end
+
+     # Returns the base URL for the sandbox API.
+     def self.api_base_sandbox_url
+         @@api_base_sandbox_url
+     end
+
+     # Returns the SDK version.
+     def self.version 
+       @@version
+     end
+
+
+  end
+end
+