simplify 1.0.1 → 1.1.0

data/lib/simplify/customer.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Customer < Hash
 
-    # Public key used to access the API.
-    attr_accessor :public_key
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
 
-    # Private key used to access the API.
-    attr_accessor :private_key
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
 
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
+
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
 
 
     # Creates an Customer object
@@ -66,28 +82,22 @@ class Customer < Hash
     # * <code>subscriptions => name</code>    Name describing subscription 
     # * <code>subscriptions => plan</code>    The plan ID that the subscription should be created from. 
     # * <code>subscriptions => quantity</code>    Quantity of the plan for the subscription. 
-    # 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.
+    # * <code>token</code>    If specified, card associated with card token will be used 
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a Customer 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("customer", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("customer", 'create', parms, auth_obj)
         obj = Customer.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 
     # Delete this object
     def delete()
-        h = Simplify::PaymentsApi.execute("customer", 'delete', self, self.public_key, self.private_key)
+        h = Simplify::PaymentsApi.execute("customer", 'delete', self, self.authentication)
         self.merge!(h)
         self
     end
@@ -98,24 +108,16 @@ class Customer < Hash
     # * <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> dateCreated</code><code> id</code><code> name</code><code> email</code><code> reference</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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of Customer objects and the <code>total</code>
     # property contains the total number of Customer objects available for the given criteria.
-    def self.list(criteria = nil, public_key = nil, private_key = nil)
+    def self.list(criteria = nil, *auth)
 
-        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("customer", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("customer", 'list', criteria, auth_obj)
         obj = Customer.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
 
     end
@@ -123,22 +125,15 @@ class Customer < Hash
     # Retrieve a Customer 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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a Customer 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("customer", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("customer", 'show', {"id" => id}, auth_obj)
         obj = Customer.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 
@@ -160,7 +155,7 @@ class Customer < Hash
 # * <code>name</code> Customer name <b>(required)</b>
 # * <code>reference</code> Reference field for external applications use. 
     def update()
-          h = Simplify::PaymentsApi.execute("customer", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("customer", 'update', self, self.authentication)
           self.merge!(h)
           self
     end

data/lib/simplify/deposit.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Deposit < Hash
 
-    # Public key used to access the API.
-    attr_accessor :public_key
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
 
-    # Private key used to access the API.
-    attr_accessor :private_key
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
 
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
+
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
 
 
     # Retrieve Deposit objects.
@@ -47,24 +63,16 @@ class Deposit < Hash
     # * <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> amount</code><code> dateCreated</code><code> depositDate</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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of Deposit objects and the <code>total</code>
     # property contains the total number of Deposit 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
+    def self.list(criteria = nil, *auth)
 
-        h = Simplify::PaymentsApi.execute("deposit", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("deposit", 'list', criteria, auth_obj)
         obj = Deposit.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
 
     end
@@ -72,22 +80,15 @@ class Deposit < Hash
     # Retrieve a Deposit 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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a Deposit 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
+    def self.find(id, *auth)
 
-        h = Simplify::PaymentsApi.execute("deposit", 'show', {"id" => id}, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("deposit", 'show', {"id" => id}, auth_obj)
         obj = Deposit.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 

data/lib/simplify/event.rb

@@ -37,26 +37,18 @@ class Event < Hash
     # params:: a hash of parameters; valid keys are:
     # * <code>payload</code>  The raw JWS message payload.  <b>required</b>
     # * <code>url</code> The URL for the webhook.  If present it must match the URL registered for the webhook.
-    # public_key:: Public to use for the API call. If nil, the value of Simplify::public_key will be used.
-    # private_key:: API key to use for the API call. If nil, the value of Simplify::private_key will be used.
-
-    def self.create(params, 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
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
+    #
+    def self.create(params, *auth)
 
-  	    h = Simplify::PaymentsApi.jws_decode(params, public_key, private_key)
+  	    h = Simplify::PaymentsApi.jws_decode(params, Simplify::PaymentsApi.create_auth_object(auth))
 
 	    if !h['event']
 	        raise ApiException.new("Incorrect data in webhook event", nil, nil)
 	    end
 
 	    obj = Event.new()
-	    obj = obj.merge(h['event'])
+	    obj = obj.merge!(h['event'])
 
 	    obj
     end

data/lib/simplify/invoice.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Invoice < Hash
 
-    # Public key used to access the API.
-    attr_accessor :public_key
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
 
-    # Private key used to access the API.
-    attr_accessor :private_key
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
+
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
 
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
 
 
     # Retrieve Invoice objects.
@@ -47,24 +63,16 @@ class Invoice < Hash
     # * <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> invoiceDate</code><code> customer</code><code> amount</code><code> processedDate</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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of Invoice objects and the <code>total</code>
     # property contains the total number of Invoice objects available for the given criteria.
-    def self.list(criteria = nil, public_key = nil, private_key = nil)
+    def self.list(criteria = nil, *auth)
 
-        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("invoice", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("invoice", 'list', criteria, auth_obj)
         obj = Invoice.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
 
     end
@@ -72,22 +80,15 @@ class Invoice < Hash
     # Retrieve a Invoice 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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a Invoice 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("invoice", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("invoice", 'show', {"id" => id}, auth_obj)
         obj = Invoice.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 
@@ -96,7 +97,7 @@ class Invoice < Hash
     # The properties that can be updated:
     # * <code>status</code> Status of the invoice. Examples: OPEN = Invoice has not been processed and can have invoice items added to it. PAID = Invoice has been paid. UNPAID = Invoice was not paid when the card was processed. System will try up to 5 times to process the card. <b>(required)</b>
     def update()
-          h = Simplify::PaymentsApi.execute("invoice", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("invoice", 'update', self, self.authentication)
           self.merge!(h)
           self
     end

data/lib/simplify/invoiceitem.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class InvoiceItem < Hash
 
-    # Public key used to access the API.
-    attr_accessor :public_key
+    # Authentication object used to access the API (See Simplify::Authentication for details)
+    attr_accessor :authentication
 
-    # Private key used to access the API.
-    attr_accessor :private_key
+    # Returns the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key
+        return self.authentication.public_key
+    end
 
+    # Sets the public key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def public_key=(k)
+        return self.authentication.public_key = k
+    end
+
+    # Returns the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key
+        return self.authentication.private_key
+    end
+
+    # Sets the private key used when accessing this object. <b>Deprecated: please use 'authentication' instead.</b>
+    def private_key=(k)
+        return self.authentication.private_key = k
+    end
 
 
     # Creates an InvoiceItem object
@@ -48,28 +64,21 @@ class InvoiceItem < Hash
     # * <code>currency</code>    Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. <b>required </b><b>default:USD</b>
     # * <code>description</code>    Individual items of an invoice 
     # * <code>invoice</code>    Description of the invoice item <b>required </b>
-    # 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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a InvoiceItem 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("invoiceItem", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("invoiceItem", 'create', parms, auth_obj)
         obj = InvoiceItem.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 
     # Delete this object
     def delete()
-        h = Simplify::PaymentsApi.execute("invoiceItem", 'delete', self, self.public_key, self.private_key)
+        h = Simplify::PaymentsApi.execute("invoiceItem", 'delete', self, self.authentication)
         self.merge!(h)
         self
     end
@@ -80,24 +89,16 @@ class InvoiceItem < Hash
     # * <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> invoice</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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns an object where the <code>list</code> property contains the list of InvoiceItem objects and the <code>total</code>
     # property contains the total number of InvoiceItem objects available for the given criteria.
-    def self.list(criteria = nil, public_key = nil, private_key = nil)
+    def self.list(criteria = nil, *auth)
 
-        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("invoiceItem", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("invoiceItem", 'list', criteria, auth_obj)
         obj = InvoiceItem.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
 
     end
@@ -105,22 +106,15 @@ class InvoiceItem < Hash
     # Retrieve a InvoiceItem 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.
+    # auth:: Authentication information used for the API call.  If no value is passed the global keys Simplify::public_key and Simplify::private_key are used.  For backwards compatibility the public and private keys may be passed instead of the authentication object.
     # Returns a InvoiceItem 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("invoiceItem", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("invoiceItem", 'show', {"id" => id}, auth_obj)
         obj = InvoiceItem.new()
-        obj.public_key = public_key
-        obj.private_key = private_key
-        obj = obj.merge(h)
+        obj.authentication = auth_obj
+        obj = obj.merge!(h)
         obj
     end
 
@@ -131,7 +125,7 @@ class InvoiceItem < Hash
 # * <code>currency</code> Currency code (ISO-4217) for the invoice item. Must match the currency associated with your account. 
 # * <code>description</code> Individual items of an invoice 
     def update()
-          h = Simplify::PaymentsApi.execute("invoiceItem", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("invoiceItem", 'update', self, self.authentication)
           self.merge!(h)
           self
     end