processout 1.0.6 → 1.0.7

data/lib/processout/project.rb

@@ -42,11 +42,11 @@ module ProcessOut
     def initialize(client, data = {})
       @client = client
 
-      @id = data.fetch(:id, "")
-      @name = data.fetch(:name, "")
-      @logo_url = data.fetch(:logo_url, "")
-      @email = data.fetch(:email, "")
-      @created_at = data.fetch(:created_at, "")
+      self.id = data.fetch(:id, nil)
+      self.name = data.fetch(:name, nil)
+      self.logo_url = data.fetch(:logo_url, nil)
+      self.email = data.fetch(:email, nil)
+      self.created_at = data.fetch(:created_at, nil)
       
     end
 
@@ -59,6 +59,9 @@ module ProcessOut
     # Params:
     # +data+:: +Hash+ of data coming from the API
     def fill_with_data(data)
+      if data.nil?
+        return self
+      end
       if data.include? "id"
         self.id = data["id"]
       end
@@ -78,10 +81,28 @@ module ProcessOut
       self
     end
 
+    # Prefills the object with the data passed as Parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.name = data.fetch(:name, self.name)
+      self.logo_url = data.fetch(:logo_url, self.logo_url)
+      self.email = data.fetch(:email, self.email)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      
+      self
+    end
+
     # Get all the gateway configurations of the project
     # Params:
     # +options+:: +Hash+ of options
     def fetch_gateway_configurations(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/projects/" + CGI.escape(@id) + "/gateway-configurations"
       data    = {

data/lib/processout/refund.rb

@@ -64,14 +64,14 @@ module ProcessOut
     def initialize(client, data = {})
       @client = client
 
-      @id = data.fetch(:id, "")
-      @transaction = data.fetch(:transaction, nil)
-      @reason = data.fetch(:reason, "")
-      @information = data.fetch(:information, "")
-      @amount = data.fetch(:amount, "")
-      @metadata = data.fetch(:metadata, Hash.new)
-      @sandbox = data.fetch(:sandbox, false)
-      @created_at = data.fetch(:created_at, "")
+      self.id = data.fetch(:id, nil)
+      self.transaction = data.fetch(:transaction, nil)
+      self.reason = data.fetch(:reason, nil)
+      self.information = data.fetch(:information, nil)
+      self.amount = data.fetch(:amount, nil)
+      self.metadata = data.fetch(:metadata, nil)
+      self.sandbox = data.fetch(:sandbox, nil)
+      self.created_at = data.fetch(:created_at, nil)
       
     end
 
@@ -84,6 +84,9 @@ module ProcessOut
     # Params:
     # +data+:: +Hash+ of data coming from the API
     def fill_with_data(data)
+      if data.nil?
+        return self
+      end
       if data.include? "id"
         self.id = data["id"]
       end
@@ -112,12 +115,33 @@ module ProcessOut
       self
     end
 
+    # Prefills the object with the data passed as Parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.transaction = data.fetch(:transaction, self.transaction)
+      self.reason = data.fetch(:reason, self.reason)
+      self.information = data.fetch(:information, self.information)
+      self.amount = data.fetch(:amount, self.amount)
+      self.metadata = data.fetch(:metadata, self.metadata)
+      self.sandbox = data.fetch(:sandbox, self.sandbox)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      
+      self
+    end
+
     # Find a transaction's refund by its ID.
     # Params:
     # +transaction_id+:: ID of the transaction on which the refund was applied
     # +refund_id+:: ID of the refund
     # +options+:: +Hash+ of options
     def find(transaction_id, refund_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds/" + CGI.escape(refund_id) + ""
       data    = {
@@ -144,6 +168,8 @@ module ProcessOut
     # +transaction_id+:: ID of the transaction
     # +options+:: +Hash+ of options
     def apply(transaction_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds"
       data    = {

data/lib/processout/subscription.rb

@@ -165,30 +165,30 @@ module ProcessOut
     def initialize(client, data = {})
       @client = client
 
-      @id = data.fetch(:id, "")
-      @project = data.fetch(:project, nil)
-      @plan = data.fetch(:plan, nil)
-      @customer = data.fetch(:customer, nil)
-      @token = data.fetch(:token, nil)
-      @url = data.fetch(:url, "")
-      @name = data.fetch(:name, "")
-      @amount = data.fetch(:amount, "")
-      @currency = data.fetch(:currency, "")
-      @metadata = data.fetch(:metadata, Hash.new)
-      @interval = data.fetch(:interval, "")
-      @trial_end_at = data.fetch(:trial_end_at, "")
-      @activated = data.fetch(:activated, false)
-      @active = data.fetch(:active, false)
-      @canceled = data.fetch(:canceled, false)
-      @cancellation_reason = data.fetch(:cancellation_reason, "")
-      @pending_cancellation = data.fetch(:pending_cancellation, false)
-      @cancel_at = data.fetch(:cancel_at, "")
-      @return_url = data.fetch(:return_url, "")
-      @cancel_url = data.fetch(:cancel_url, "")
-      @sandbox = data.fetch(:sandbox, false)
-      @created_at = data.fetch(:created_at, "")
-      @activated_at = data.fetch(:activated_at, "")
-      @iterate_at = data.fetch(:iterate_at, "")
+      self.id = data.fetch(:id, nil)
+      self.project = data.fetch(:project, nil)
+      self.plan = data.fetch(:plan, nil)
+      self.customer = data.fetch(:customer, nil)
+      self.token = data.fetch(:token, nil)
+      self.url = data.fetch(:url, nil)
+      self.name = data.fetch(:name, nil)
+      self.amount = data.fetch(:amount, nil)
+      self.currency = data.fetch(:currency, nil)
+      self.metadata = data.fetch(:metadata, nil)
+      self.interval = data.fetch(:interval, nil)
+      self.trial_end_at = data.fetch(:trial_end_at, nil)
+      self.activated = data.fetch(:activated, nil)
+      self.active = data.fetch(:active, nil)
+      self.canceled = data.fetch(:canceled, nil)
+      self.cancellation_reason = data.fetch(:cancellation_reason, nil)
+      self.pending_cancellation = data.fetch(:pending_cancellation, nil)
+      self.cancel_at = data.fetch(:cancel_at, nil)
+      self.return_url = data.fetch(:return_url, nil)
+      self.cancel_url = data.fetch(:cancel_url, nil)
+      self.sandbox = data.fetch(:sandbox, nil)
+      self.created_at = data.fetch(:created_at, nil)
+      self.activated_at = data.fetch(:activated_at, nil)
+      self.iterate_at = data.fetch(:iterate_at, nil)
       
     end
 
@@ -201,6 +201,9 @@ module ProcessOut
     # Params:
     # +data+:: +Hash+ of data coming from the API
     def fill_with_data(data)
+      if data.nil?
+        return self
+      end
       if data.include? "id"
         self.id = data["id"]
       end
@@ -277,10 +280,47 @@ module ProcessOut
       self
     end
 
+    # Prefills the object with the data passed as Parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.project = data.fetch(:project, self.project)
+      self.plan = data.fetch(:plan, self.plan)
+      self.customer = data.fetch(:customer, self.customer)
+      self.token = data.fetch(:token, self.token)
+      self.url = data.fetch(:url, self.url)
+      self.name = data.fetch(:name, self.name)
+      self.amount = data.fetch(:amount, self.amount)
+      self.currency = data.fetch(:currency, self.currency)
+      self.metadata = data.fetch(:metadata, self.metadata)
+      self.interval = data.fetch(:interval, self.interval)
+      self.trial_end_at = data.fetch(:trial_end_at, self.trial_end_at)
+      self.activated = data.fetch(:activated, self.activated)
+      self.active = data.fetch(:active, self.active)
+      self.canceled = data.fetch(:canceled, self.canceled)
+      self.cancellation_reason = data.fetch(:cancellation_reason, self.cancellation_reason)
+      self.pending_cancellation = data.fetch(:pending_cancellation, self.pending_cancellation)
+      self.cancel_at = data.fetch(:cancel_at, self.cancel_at)
+      self.return_url = data.fetch(:return_url, self.return_url)
+      self.cancel_url = data.fetch(:cancel_url, self.cancel_url)
+      self.sandbox = data.fetch(:sandbox, self.sandbox)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      self.activated_at = data.fetch(:activated_at, self.activated_at)
+      self.iterate_at = data.fetch(:iterate_at, self.iterate_at)
+      
+      self
+    end
+
     # Get the customer owning the subscription.
     # Params:
     # +options+:: +Hash+ of options
     def fetch_customer(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/customers"
       data    = {
@@ -303,6 +343,8 @@ module ProcessOut
     # Params:
     # +options+:: +Hash+ of options
     def fetch_discounts(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts"
       data    = {
@@ -332,6 +374,8 @@ module ProcessOut
     # +coupon_id+:: ID of the coupon
     # +options+:: +Hash+ of options
     def apply_coupon(coupon_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts"
       data    = {
@@ -355,6 +399,8 @@ module ProcessOut
     # +discount_id+:: ID of the discount
     # +options+:: +Hash+ of options
     def find_discount(discount_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts/" + CGI.escape(discount_id) + ""
       data    = {
@@ -378,6 +424,8 @@ module ProcessOut
     # +discount_id+:: ID of the discount or coupon to be removed from the subscription
     # +options+:: +Hash+ of options
     def remove_discount(discount_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts/" + CGI.escape(discount_id) + ""
       data    = {
@@ -402,6 +450,8 @@ module ProcessOut
     # Params:
     # +options+:: +Hash+ of options
     def fetch_transactions(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/transactions"
       data    = {
@@ -430,6 +480,8 @@ module ProcessOut
     # Params:
     # +options+:: +Hash+ of options
     def all(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -459,6 +511,8 @@ module ProcessOut
     # +customer_id+:: ID of the customer
     # +options+:: +Hash+ of options
     def create(customer_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -494,6 +548,8 @@ module ProcessOut
     # +plan_id+:: ID of the plan
     # +options+:: +Hash+ of options
     def create_from_plan(customer_id, plan_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -529,6 +585,8 @@ module ProcessOut
     # +subscription_id+:: ID of the subscription
     # +options+:: +Hash+ of options
     def find(subscription_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(subscription_id) + ""
       data    = {
@@ -550,15 +608,18 @@ module ProcessOut
       return_values[0]
     end
 
-    # Update the subscription.
+    # Update the subscription's plan.
     # Params:
+    # +plan_id+:: ID of the new plan to be applied on the subscription
     # +prorate+:: Define if proration should be done when updating the plan
     # +options+:: +Hash+ of options
-    def update(prorate, options = {})
+    def update_plan(plan_id, prorate, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
-        "trial_end_at" => @trial_end_at, 
+        "plan_id" => plan_id, 
         "prorate" => prorate
       }
 
@@ -576,17 +637,17 @@ module ProcessOut
       return_values[0]
     end
 
-    # Update the subscription's plan.
+    # Apply a source to the subscription to activate or update the subscription's source.
     # Params:
-    # +plan_id+:: ID of the new plan to be applied on the subscription
-    # +prorate+:: Define if proration should be done when updating the plan
+    # +source+:: Source to be applied on the subscription and used to pay future invoices. Can be a card, a token or a gateway request
     # +options+:: +Hash+ of options
-    def update_plan(plan_id, prorate, options = {})
+    def apply_source(source, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
-        "plan_id" => plan_id, 
-        "prorate" => prorate
+        "source" => source
       }
 
       response = Response.new(request.put(path, data, options))
@@ -603,15 +664,20 @@ module ProcessOut
       return_values[0]
     end
 
-    # Apply a source to the subscription to activate or update the subscription's source.
+    # Save the updated subscription attributes.
     # Params:
-    # +source+:: Source to be applied on the subscription and used to pay future invoices. Can be a card, a token or a gateway request
     # +options+:: +Hash+ of options
-    def apply_source(source, options = {})
+    def save(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
-        "source" => source
+        "name" => @name, 
+        "amount" => @amount, 
+        "interval" => @interval, 
+        "trial_end_at" => @trial_end_at, 
+        "metadata" => @metadata
       }
 
       response = Response.new(request.put(path, data, options))
@@ -633,6 +699,8 @@ module ProcessOut
     # +cancellation_reason+:: Cancellation reason
     # +options+:: +Hash+ of options
     def cancel(cancellation_reason, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
@@ -659,6 +727,8 @@ module ProcessOut
     # +cancellation_reason+:: Cancellation reason
     # +options+:: +Hash+ of options
     def cancel_at_date(cancel_at, cancellation_reason, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {

data/lib/processout/token.rb

@@ -71,14 +71,14 @@ module ProcessOut
     def initialize(client, data = {})
       @client = client
 
-      @id = data.fetch(:id, "")
-      @customer = data.fetch(:customer, nil)
-      @customer_id = data.fetch(:customer_id, "")
-      @card = data.fetch(:card, nil)
-      @type = data.fetch(:type, "")
-      @metadata = data.fetch(:metadata, Hash.new)
-      @is_subscription_only = data.fetch(:is_subscription_only, false)
-      @created_at = data.fetch(:created_at, "")
+      self.id = data.fetch(:id, nil)
+      self.customer = data.fetch(:customer, nil)
+      self.customer_id = data.fetch(:customer_id, nil)
+      self.card = data.fetch(:card, nil)
+      self.type = data.fetch(:type, nil)
+      self.metadata = data.fetch(:metadata, nil)
+      self.is_subscription_only = data.fetch(:is_subscription_only, nil)
+      self.created_at = data.fetch(:created_at, nil)
       
     end
 
@@ -91,6 +91,9 @@ module ProcessOut
     # Params:
     # +data+:: +Hash+ of data coming from the API
     def fill_with_data(data)
+      if data.nil?
+        return self
+      end
       if data.include? "id"
         self.id = data["id"]
       end
@@ -119,12 +122,33 @@ module ProcessOut
       self
     end
 
+    # Prefills the object with the data passed as Parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.customer = data.fetch(:customer, self.customer)
+      self.customer_id = data.fetch(:customer_id, self.customer_id)
+      self.card = data.fetch(:card, self.card)
+      self.type = data.fetch(:type, self.type)
+      self.metadata = data.fetch(:metadata, self.metadata)
+      self.is_subscription_only = data.fetch(:is_subscription_only, self.is_subscription_only)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      
+      self
+    end
+
     # Find a customer's token by its ID.
     # Params:
     # +customer_id+:: ID of the customer
     # +token_id+:: ID of the token
     # +options+:: +Hash+ of options
     def find(customer_id, token_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/customers/" + CGI.escape(customer_id) + "/tokens/" + CGI.escape(token_id) + ""
       data    = {
@@ -152,6 +176,8 @@ module ProcessOut
     # +source+:: Source used to create the token (most likely a card token generated by ProcessOut.js)
     # +options+:: +Hash+ of options
     def create(customer_id, source, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/customers/" + CGI.escape(customer_id) + "/tokens"
       data    = {
@@ -180,6 +206,8 @@ module ProcessOut
     # +target+:: Authorization request ID
     # +options+:: +Hash+ of options
     def create_from_request(customer_id, source, target, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/customers/" + CGI.escape(customer_id) + "/tokens"
       data    = {
@@ -206,6 +234,8 @@ module ProcessOut
     # Params:
     # +options+:: +Hash+ of options
     def delete(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "customers/" + CGI.escape(@customer_id) + "/tokens/" + CGI.escape(@id) + ""
       data    = {

data/lib/processout/transaction.rb

@@ -137,23 +137,23 @@ module ProcessOut
     def initialize(client, data = {})
       @client = client
 
-      @id = data.fetch(:id, "")
-      @project = data.fetch(:project, nil)
-      @customer = data.fetch(:customer, nil)
-      @subscription = data.fetch(:subscription, nil)
-      @token = data.fetch(:token, nil)
-      @card = data.fetch(:card, nil)
-      @name = data.fetch(:name, "")
-      @authorized_amount = data.fetch(:authorized_amount, "")
-      @captured_amount = data.fetch(:captured_amount, "")
-      @currency = data.fetch(:currency, "")
-      @status = data.fetch(:status, "")
-      @authorized = data.fetch(:authorized, false)
-      @captured = data.fetch(:captured, false)
-      @processout_fee = data.fetch(:processout_fee, "")
-      @metadata = data.fetch(:metadata, Hash.new)
-      @sandbox = data.fetch(:sandbox, false)
-      @created_at = data.fetch(:created_at, "")
+      self.id = data.fetch(:id, nil)
+      self.project = data.fetch(:project, nil)
+      self.customer = data.fetch(:customer, nil)
+      self.subscription = data.fetch(:subscription, nil)
+      self.token = data.fetch(:token, nil)
+      self.card = data.fetch(:card, nil)
+      self.name = data.fetch(:name, nil)
+      self.authorized_amount = data.fetch(:authorized_amount, nil)
+      self.captured_amount = data.fetch(:captured_amount, nil)
+      self.currency = data.fetch(:currency, nil)
+      self.status = data.fetch(:status, nil)
+      self.authorized = data.fetch(:authorized, nil)
+      self.captured = data.fetch(:captured, nil)
+      self.processout_fee = data.fetch(:processout_fee, nil)
+      self.metadata = data.fetch(:metadata, nil)
+      self.sandbox = data.fetch(:sandbox, nil)
+      self.created_at = data.fetch(:created_at, nil)
       
     end
 
@@ -166,6 +166,9 @@ module ProcessOut
     # Params:
     # +data+:: +Hash+ of data coming from the API
     def fill_with_data(data)
+      if data.nil?
+        return self
+      end
       if data.include? "id"
         self.id = data["id"]
       end
@@ -221,10 +224,40 @@ module ProcessOut
       self
     end
 
+    # Prefills the object with the data passed as Parameters
+    # Params:
+    # +data+:: +Hash+ of data
+    def prefill(data)
+      if data.nil?
+        return self
+      end
+      self.id = data.fetch(:id, self.id)
+      self.project = data.fetch(:project, self.project)
+      self.customer = data.fetch(:customer, self.customer)
+      self.subscription = data.fetch(:subscription, self.subscription)
+      self.token = data.fetch(:token, self.token)
+      self.card = data.fetch(:card, self.card)
+      self.name = data.fetch(:name, self.name)
+      self.authorized_amount = data.fetch(:authorized_amount, self.authorized_amount)
+      self.captured_amount = data.fetch(:captured_amount, self.captured_amount)
+      self.currency = data.fetch(:currency, self.currency)
+      self.status = data.fetch(:status, self.status)
+      self.authorized = data.fetch(:authorized, self.authorized)
+      self.captured = data.fetch(:captured, self.captured)
+      self.processout_fee = data.fetch(:processout_fee, self.processout_fee)
+      self.metadata = data.fetch(:metadata, self.metadata)
+      self.sandbox = data.fetch(:sandbox, self.sandbox)
+      self.created_at = data.fetch(:created_at, self.created_at)
+      
+      self
+    end
+
     # Get the transaction's refunds.
     # Params:
     # +options+:: +Hash+ of options
     def fetch_refunds(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(@id) + "/refunds"
       data    = {
@@ -254,6 +287,8 @@ module ProcessOut
     # +refund_id+:: ID of the refund
     # +options+:: +Hash+ of options
     def find_refund(refund_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(@id) + "/refunds/" + CGI.escape(refund_id) + ""
       data    = {
@@ -276,6 +311,8 @@ module ProcessOut
     # Params:
     # +options+:: +Hash+ of options
     def all(options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions"
       data    = {
@@ -305,6 +342,8 @@ module ProcessOut
     # +transaction_id+:: ID of the transaction
     # +options+:: +Hash+ of options
     def find(transaction_id, options = {})
+      self.prefill(options)
+
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(transaction_id) + ""
       data    = {

data/lib/processout/version.rb

@@ -1,3 +1,3 @@
 module ProcessOut
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end