simplify 1.0.1 → 1.1.0

data/lib/simplify/refund.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Refund < 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 Refund object
@@ -47,22 +63,16 @@ class Refund < Hash
     # * <code>amount</code>    Amount of the refund in minor units. Example: 1000 = 10.00 <b>required </b>
     # * <code>payment</code>    ID of the payment for the refund <b>required </b>
     # * <code>reason</code>    Reason for the refund 
-    # 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>reference</code>    Custom reference field to be used with outside systems. 
+    # 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 Refund 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("refund", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("refund", 'create', parms, auth_obj)
         obj = Refund.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,24 +82,16 @@ class Refund < 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> 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.
+    # 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 Refund objects and the <code>total</code>
     # property contains the total number of Refund 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("refund", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("refund", 'list', criteria, auth_obj)
         obj = Refund.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
@@ -97,22 +99,15 @@ class Refund < Hash
     # Retrieve a Refund 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 Refund 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("refund", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("refund", 'show', {"id" => id}, auth_obj)
         obj = Refund.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/subscription.rb

@@ -33,12 +33,28 @@ module Simplify
 #
 class Subscription < 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 Subscription object
@@ -52,28 +68,21 @@ class Subscription < Hash
     # * <code>name</code>    Name describing subscription 
     # * <code>plan</code>    The ID of the plan that should be used for the subscription. 
     # * <code>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.
+    # 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 Subscription 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("subscription", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("subscription", 'create', parms, auth_obj)
         obj = Subscription.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("subscription", 'delete', self, self.public_key, self.private_key)
+        h = Simplify::PaymentsApi.execute("subscription", 'delete', self, self.authentication)
         self.merge!(h)
         self
     end
@@ -84,24 +93,16 @@ class Subscription < 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> plan</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 Subscription objects and the <code>total</code>
     # property contains the total number of Subscription 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("subscription", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("subscription", 'list', criteria, auth_obj)
         obj = Subscription.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 Subscription < Hash
     # Retrieve a Subscription 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 Subscription 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("subscription", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("subscription", 'show', {"id" => id}, auth_obj)
         obj = Subscription.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
 
@@ -140,7 +134,7 @@ class Subscription < Hash
 # * <code>prorate</code> Whether to prorate existing subscription. <b>(required)</b>
 # * <code>quantity</code> Quantity of the plan for the subscription. 
     def update()
-          h = Simplify::PaymentsApi.execute("subscription", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("subscription", 'update', self, self.authentication)
           self.merge!(h)
           self
     end

data/lib/simplify/webhook.rb

@@ -33,40 +33,49 @@ module Simplify
 #
 class Webhook < 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 Webhook object
     #
     # parms:: a hash of parameters; valid keys are:
     # * <code>url</code>    Endpoint URL <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 Webhook 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("webhook", 'create', parms, public_key, private_key)
+    def self.create(parms, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("webhook", 'create', parms, auth_obj)
         obj = Webhook.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("webhook", 'delete', self, self.public_key, self.private_key)
+        h = Simplify::PaymentsApi.execute("webhook", 'delete', self, self.authentication)
         self.merge!(h)
         self
     end
@@ -77,24 +86,16 @@ class Webhook < 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>. 
-    # 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 Webhook objects and the <code>total</code>
     # property contains the total number of Webhook 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("webhook", 'list', criteria, public_key, private_key)
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("webhook", 'list', criteria, auth_obj)
         obj = Webhook.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
@@ -102,22 +103,15 @@ class Webhook < Hash
     # Retrieve a Webhook 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 Webhook 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("webhook", 'show', {"id" => id}, public_key, private_key)
+    def self.find(id, *auth)
+
+        auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
+        h = Simplify::PaymentsApi.execute("webhook", 'show', {"id" => id}, auth_obj)
         obj = Webhook.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
 
@@ -126,7 +120,7 @@ class Webhook < Hash
     # The properties that can be updated:
     # * <code>url</code> Endpoint URL <b>(required)</b>
     def update()
-          h = Simplify::PaymentsApi.execute("webhook", 'update', self, self.public_key, self.private_key)
+          h = Simplify::PaymentsApi.execute("webhook", 'update', self, self.authentication)
           self.merge!(h)
           self
     end

metadata

@@ -1,71 +1,70 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: simplify
-version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
-authors:
+authors: 
 - Simplify Commerce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-10-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-hmac
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Ruby access to the Simplify Commerce API
 email: support@simplify.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- lib/simplify/accesstoken.rb
 - lib/simplify/apiexception.rb
+- lib/simplify/authentication.rb
 - lib/simplify/cardtoken.rb
 - lib/simplify/chargeback.rb
 - lib/simplify/constants.rb
@@ -82,29 +81,35 @@ files:
 - lib/simplify/subscription.rb
 - lib/simplify/webhook.rb
 - lib/simplify.rb
+has_rdoc: true
 homepage: https://www.simplify.com/commerce
-licenses:
+licenses: 
 - BSD
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Simplify Commerce Ruby SDK
 test_files: []
+