simplify 1.0.1 → 1.1.0

data/lib/simplify.rb

@@ -25,6 +25,8 @@
 # SUCH DAMAGE.
 #
 
+require File.dirname(__FILE__) + '/simplify/authentication'
+require File.dirname(__FILE__) + '/simplify/accesstoken'
 require File.dirname(__FILE__) + '/simplify/cardtoken'
 require File.dirname(__FILE__) + '/simplify/chargeback'
 require File.dirname(__FILE__) + '/simplify/coupon'

data/lib/simplify/accesstoken.rb

@@ -0,0 +1,111 @@
+#
+# 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
+
+require 'uri'
+
+# An OAuth access token.
+class AccessToken < Hash
+
+    #
+    # Construct a AccessToken from a hash.
+    #
+    def initialize(options = {})
+        self.merge!(options)
+    end
+
+
+    # Creates an OAuth access token object.
+    #
+    # auth_code: The OAuth authentication code.
+    # redirect_uri: The OAuth redirection URI.
+    # 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.
+    #
+    def self.create(auth_code, redirect_uri, *auth)
+
+        props = {
+                'grant_type' => 'authorization_code',
+                'code' => auth_code,
+                'redirect_uri' => redirect_uri
+        }
+
+        h = Simplify::PaymentsApi.send_auth_request(props, 'token', Simplify::PaymentsApi.create_auth_object(auth))
+
+        obj = AccessToken.new()
+        obj = obj.merge!(h)
+
+        obj
+
+    end
+
+
+    # Refreshes the OAuth access token
+    #
+    # 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.
+    #
+    def refresh(*auth)
+
+        rt = self['refresh_token']
+        if rt == nil || rt.empty?
+            raise ArgumentError.new("Cannot refresh access token; refresh token is invalid.")
+        end
+
+        props = {
+                'grant_type' => 'refresh_token',
+                'refresh_token' => rt
+        }
+
+        h = Simplify::PaymentsApi.send_auth_request(props, 'token', Simplify::PaymentsApi.create_auth_object(auth))
+
+        self.merge!(h)
+        self
+    end
+
+
+    # Revokes the access token.
+    #
+    # 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.
+    #
+    def revoke(*auth)
+
+        token = self['access_token']
+        if token == nil || token.empty?
+            raise ArgumentError.new("Cannot revoke access token; access token is invalid.")
+        end
+
+        props = {
+                'token' => token
+        }
+
+        h = Simplify::PaymentsApi.send_auth_request(props, 'revoke', Simplify::PaymentsApi.create_auth_object(auth))
+        self.clear
+        self
+    end
+
+end
+end

data/lib/simplify/authentication.rb

@@ -0,0 +1,64 @@
+#
+# 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
+
+# Holds Authentication information used when accessing the API
+class Authentication
+
+    # Public key used to access the API.
+    attr_accessor :public_key
+
+    # Private key used to access the API.
+    attr_accessor :private_key
+
+    # OAuth token used to access the API.
+    attr_accessor :access_token
+
+    # Creates an Authentication object.
+    #
+    # options:: hash containing information to initialise the object.  Valid options are :public_key, :private_key and :access_token.
+    # If no value for public_key is passed or the value is nil then Simplify::public_key is used.  If no value for private_key is
+    # passed or the value is nil then Simplify::private_key is used.
+    #
+    def initialize(options = {})
+
+        @public_key = options[:public_key]
+        if @public_key == nil
+            @public_key = Simplify::public_key
+        end
+
+        @private_key = options[:private_key]
+        if private_key == nil
+            @private_key = Simplify::private_key
+        end
+
+        @access_token = options[:access_token]
+    end
+
+end
+end

data/lib/simplify/cardtoken.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class CardToken < 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 CardToken object
@@ -57,44 +73,30 @@ class CardToken < Hash
     # * <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.
+    # 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 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
+    def self.create(parms, *auth)
 
-        h = Simplify::PaymentsApi.execute("cardToken", 'create', parms, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("cardToken", 'create', parms, auth_obj)
         obj = CardToken.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
 
     # 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.
+    # 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 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
+    def self.find(id, *auth)
 
-        h = Simplify::PaymentsApi.execute("cardToken", 'show', {"id" => id}, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("cardToken", 'show', {"id" => id}, auth_obj)
         obj = CardToken.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/chargeback.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Chargeback < 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 Chargeback objects.
@@ -46,25 +62,17 @@ class Chargeback < Hash
     # * <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.
+    # * <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>. 
+    # 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 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
+    def self.list(criteria = nil, *auth)
 
-        h = Simplify::PaymentsApi.execute("chargeback", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("chargeback", 'list', criteria, auth_obj)
         obj = Chargeback.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 Chargeback < Hash
     # 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.
+    # 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 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
+    def self.find(id, *auth)
 
-        h = Simplify::PaymentsApi.execute("chargeback", 'show', {"id" => id}, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("chargeback", 'show', {"id" => id}, auth_obj)
         obj = Chargeback.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/constants.rb

@@ -30,10 +30,10 @@ module Simplify
   # Constants.
   class Constants
 
-     @@version = '1.0.1'
+     @@version = '1.1.0'
      @@api_base_live_url = 'https://api.simplify.com/v1/api'
      @@api_base_sandbox_url = 'https://sandbox.simplify.com/v1/api'
-
+     @@oauth_base_url = 'https://www.simplify.com/commerce/oauth';
 
      # Returns the base URL for the live API.
      def self.api_base_live_url
@@ -45,12 +45,16 @@ module Simplify
          @@api_base_sandbox_url
      end
 
+     # Returns the base URL for OAuth.
+     def self.oauth_base_url
+        @@oauth_base_url
+     end
+
      # Returns the SDK version.
      def self.version 
-       @@version
+         @@version
      end
 
-
   end
 end
 

data/lib/simplify/coupon.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Coupon < 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 Coupon object
@@ -52,28 +68,21 @@ class Coupon < Hash
     # * <code>maxRedemptions</code>    Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. 
     # * <code>percentOff</code>    Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. 
     # * <code>startDate</code>    First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. <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 Coupon 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("coupon", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("coupon", 'create', parms, auth_obj)
         obj = Coupon.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("coupon", 'delete', self, self.public_key, self.private_key)
+        h = Simplify::PaymentsApi.execute("coupon", 'delete', self, self.authentication)
         self.merge!(h)
         self
     end
@@ -84,24 +93,16 @@ class Coupon < 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> maxRedemptions</code><code> timesRedeemed</code><code> id</code><code> startDate</code><code> endDate</code><code> percentOff</code><code> couponCode</code><code> durationInMonths</code><code> amountOff</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 Coupon objects and the <code>total</code>
     # property contains the total number of Coupon 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("coupon", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("coupon", 'list', criteria, auth_obj)
         obj = Coupon.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
@@ -109,22 +110,15 @@ class Coupon < Hash
     # Retrieve a Coupon 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 Coupon 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("coupon", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("coupon", 'show', {"id" => id}, auth_obj)
         obj = Coupon.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
 
@@ -134,7 +128,7 @@ class Coupon < Hash
     # * <code>endDate</code> The ending date in UTC millis for the coupon. This must be after the starting date of the coupon. 
 # * <code>maxRedemptions</code> Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. 
     def update()
-          h = Simplify::PaymentsApi.execute("coupon", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("coupon", 'update', self, self.authentication)
           self.merge!(h)
           self
     end