processout 0.2.1 → 0.3.0

data/lib/processout/plan.rb

@@ -80,24 +80,30 @@ module ProcessOut
     # Initializes the Plan object
     # Params:
     # +client+:: +ProcessOut+ client instance
-    def initialize(client)
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
       @client = client
 
-      @id = ""
-      @project = nil
-      @name = ""
-      @amount = ""
-      @currency = ""
-      @metadata = Hash.new
-      @interval = ""
-      @trial_period = "0d"
-      @return_url = ""
-      @cancel_url = ""
-      @sandbox = false
-      @created_at = ""
+      @id = data.fetch(:id, "")
+      @project = data.fetch(:project, nil)
+      @name = data.fetch(:name, "")
+      @amount = data.fetch(:amount, "")
+      @currency = data.fetch(:currency, "")
+      @metadata = data.fetch(:metadata, Hash.new)
+      @interval = data.fetch(:interval, "")
+      @trial_period = data.fetch(:trial_period, "0d")
+      @return_url = data.fetch(:return_url, "")
+      @cancel_url = data.fetch(:cancel_url, "")
+      @sandbox = data.fetch(:sandbox, false)
+      @created_at = data.fetch(:created_at, "")
       
     end
 
+    # Create a new Plan using the current client
+    def new(data = {})
+      Plan.new(@client, data)
+    end
+
     # Fills the object with data coming from the API
     # Params:
     # +data+:: +Hash+ of data coming from the API
@@ -145,7 +151,7 @@ module ProcessOut
     # Get all the plans.
     # Params:
     # +options+:: +Hash+ of options
-    def all(options = nil)
+    def all(options = {})
       request = Request.new(@client)
       path    = "/plans"
       data    = {
@@ -158,7 +164,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['plans']
-        tmp = Plan(@client)
+        tmp = Plan.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end
@@ -173,7 +179,7 @@ module ProcessOut
     # Create a new plan.
     # Params:
     # +options+:: +Hash+ of options
-    def create(options = nil)
+    def create(options = {})
       request = Request.new(@client)
       path    = "/plans"
       data    = {
@@ -206,7 +212,7 @@ module ProcessOut
     # Params:
     # +plan_id+:: ID of the plan
     # +options+:: +Hash+ of options
-    def find(plan_id, options = nil)
+    def find(plan_id, options = {})
       request = Request.new(@client)
       path    = "/plans/" + CGI.escape(plan_id) + ""
       data    = {
@@ -231,7 +237,7 @@ module ProcessOut
     # Update the plan. This action won't affect subscriptions already linked to this plan.
     # Params:
     # +options+:: +Hash+ of options
-    def update(options = nil)
+    def update(options = {})
       request = Request.new(@client)
       path    = "/plans/" + CGI.escape(@id) + ""
       data    = {
@@ -259,7 +265,7 @@ module ProcessOut
     # Delete a plan. Subscriptions linked to this plan won't be affected.
     # Params:
     # +options+:: +Hash+ of options
-    def end(options = nil)
+    def end(options = {})
       request = Request.new(@client)
       path    = "/plans/" + CGI.escape(@id) + ""
       data    = {

data/lib/processout/product.rb

@@ -85,25 +85,31 @@ module ProcessOut
     # Initializes the Product object
     # Params:
     # +client+:: +ProcessOut+ client instance
-    def initialize(client)
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
       @client = client
 
-      @id = ""
-      @project = nil
-      @url = ""
-      @name = ""
-      @amount = ""
-      @currency = ""
-      @metadata = Hash.new
-      @request_email = false
-      @request_shipping = false
-      @return_url = ""
-      @cancel_url = ""
-      @sandbox = false
-      @created_at = ""
+      @id = data.fetch(:id, "")
+      @project = data.fetch(:project, nil)
+      @url = data.fetch(:url, "")
+      @name = data.fetch(:name, "")
+      @amount = data.fetch(:amount, "")
+      @currency = data.fetch(:currency, "")
+      @metadata = data.fetch(:metadata, Hash.new)
+      @request_email = data.fetch(:request_email, false)
+      @request_shipping = data.fetch(:request_shipping, false)
+      @return_url = data.fetch(:return_url, "")
+      @cancel_url = data.fetch(:cancel_url, "")
+      @sandbox = data.fetch(:sandbox, false)
+      @created_at = data.fetch(:created_at, "")
       
     end
 
+    # Create a new Product using the current client
+    def new(data = {})
+      Product.new(@client, data)
+    end
+
     # Fills the object with data coming from the API
     # Params:
     # +data+:: +Hash+ of data coming from the API
@@ -154,7 +160,7 @@ module ProcessOut
     # Create a new invoice from the product.
     # Params:
     # +options+:: +Hash+ of options
-    def invoice(options = nil)
+    def invoice(options = {})
       request = Request.new(@client)
       path    = "/products/" + CGI.escape(@id) + "/invoices"
       data    = {
@@ -166,7 +172,7 @@ module ProcessOut
       
       body = response.body
       body = body["invoice"]
-      invoice = Invoice(self._client)
+      invoice = Invoice.new(@client)
       return_values.push(invoice.fill_with_data(body))
 
       
@@ -176,7 +182,7 @@ module ProcessOut
     # Get all the products.
     # Params:
     # +options+:: +Hash+ of options
-    def all(options = nil)
+    def all(options = {})
       request = Request.new(@client)
       path    = "/products"
       data    = {
@@ -189,7 +195,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['products']
-        tmp = Product(@client)
+        tmp = Product.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end
@@ -204,7 +210,7 @@ module ProcessOut
     # Create a new product.
     # Params:
     # +options+:: +Hash+ of options
-    def create(options = nil)
+    def create(options = {})
       request = Request.new(@client)
       path    = "/products"
       data    = {
@@ -236,7 +242,7 @@ module ProcessOut
     # Params:
     # +product_id+:: ID of the product
     # +options+:: +Hash+ of options
-    def find(product_id, options = nil)
+    def find(product_id, options = {})
       request = Request.new(@client)
       path    = "/products/" + CGI.escape(product_id) + ""
       data    = {
@@ -261,7 +267,7 @@ module ProcessOut
     # Save the updated product attributes.
     # Params:
     # +options+:: +Hash+ of options
-    def save(options = nil)
+    def save(options = {})
       request = Request.new(@client)
       path    = "/products/" + CGI.escape(@id) + ""
       data    = {
@@ -292,7 +298,7 @@ module ProcessOut
     # Delete the product.
     # Params:
     # +options+:: +Hash+ of options
-    def delete(options = nil)
+    def delete(options = {})
       request = Request.new(@client)
       path    = "/products/" + CGI.escape(@id) + ""
       data    = {

data/lib/processout/project.rb

@@ -38,17 +38,23 @@ module ProcessOut
     # Initializes the Project object
     # Params:
     # +client+:: +ProcessOut+ client instance
-    def initialize(client)
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
       @client = client
 
-      @id = ""
-      @name = ""
-      @logo_url = ""
-      @email = ""
-      @created_at = ""
+      @id = data.fetch(:id, "")
+      @name = data.fetch(:name, "")
+      @logo_url = data.fetch(:logo_url, "")
+      @email = data.fetch(:email, "")
+      @created_at = data.fetch(:created_at, "")
       
     end
 
+    # Create a new Project using the current client
+    def new(data = {})
+      Project.new(@client, data)
+    end
+
     # Fills the object with data coming from the API
     # Params:
     # +data+:: +Hash+ of data coming from the API
@@ -75,7 +81,7 @@ module ProcessOut
     # Get all the gateway configurations of the project
     # Params:
     # +options+:: +Hash+ of options
-    def gateway_configurations(options = nil)
+    def gateway_configurations(options = {})
       request = Request.new(@client)
       path    = "/projects/" + CGI.escape(@id) + "/gateway-configurations"
       data    = {
@@ -88,7 +94,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['gateway_configurations']
-        tmp = GatewayConfiguration(@client)
+        tmp = GatewayConfiguration.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end

data/lib/processout/refund.rb

@@ -60,20 +60,26 @@ module ProcessOut
     # Initializes the Refund object
     # Params:
     # +client+:: +ProcessOut+ client instance
-    def initialize(client)
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
       @client = client
 
-      @id = ""
-      @transaction = nil
-      @reason = ""
-      @information = ""
-      @amount = ""
-      @metadata = Hash.new
-      @sandbox = false
-      @created_at = ""
+      @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, "")
       
     end
 
+    # Create a new Refund using the current client
+    def new(data = {})
+      Refund.new(@client, data)
+    end
+
     # Fills the object with data coming from the API
     # Params:
     # +data+:: +Hash+ of data coming from the API
@@ -111,7 +117,7 @@ module ProcessOut
     # +transaction_id+:: ID of the transaction
     # +refund_id+:: ID of the refund
     # +options+:: +Hash+ of options
-    def find(transaction_id, refund_id, options = nil)
+    def find(transaction_id, refund_id, options = {})
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds/" + CGI.escape(refund_id) + ""
       data    = {
@@ -137,7 +143,7 @@ module ProcessOut
     # Params:
     # +transaction_id+:: ID of the transaction
     # +options+:: +Hash+ of options
-    def apply(transaction_id, options = nil)
+    def apply(transaction_id, options = {})
       request = Request.new(@client)
       path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds"
       data    = {

data/lib/processout/subscription.rb

@@ -161,34 +161,40 @@ module ProcessOut
     # Initializes the Subscription object
     # Params:
     # +client+:: +ProcessOut+ client instance
-    def initialize(client)
+    # +data+:: data that can be used to fill the object
+    def initialize(client, data = {})
       @client = client
 
-      @id = ""
-      @project = nil
-      @plan = nil
-      @customer = nil
-      @token = nil
-      @url = ""
-      @name = ""
-      @amount = ""
-      @currency = ""
-      @metadata = Hash.new
-      @interval = ""
-      @trial_end_at = ""
-      @activated = false
-      @active = false
-      @canceled = false
-      @cancellation_reason = ""
-      @pending_cancellation = false
-      @cancel_at = ""
-      @return_url = ""
-      @cancel_url = ""
-      @sandbox = false
-      @created_at = ""
-      @activated_at = ""
-      @iterate_at = ""
-      
+      @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, "")
+      
+    end
+
+    # Create a new Subscription using the current client
+    def new(data = {})
+      Subscription.new(@client, data)
     end
 
     # Fills the object with data coming from the API
@@ -274,7 +280,7 @@ module ProcessOut
     # Get the customer owning the subscription.
     # Params:
     # +options+:: +Hash+ of options
-    def customer(options = nil)
+    def customer(options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/customers"
       data    = {
@@ -286,7 +292,7 @@ module ProcessOut
       
       body = response.body
       body = body["customer"]
-      customer = Customer(self._client)
+      customer = Customer.new(@client)
       return_values.push(customer.fill_with_data(body))
 
       
@@ -296,7 +302,7 @@ module ProcessOut
     # Get the discounts applied to the subscription.
     # Params:
     # +options+:: +Hash+ of options
-    def discounts(options = nil)
+    def discounts(options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts"
       data    = {
@@ -309,7 +315,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['discounts']
-        tmp = Discount(@client)
+        tmp = Discount.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end
@@ -325,7 +331,7 @@ module ProcessOut
     # Params:
     # +discount_id+:: ID of the discount or coupon to be removed from the subscription
     # +options+:: +Hash+ of options
-    def remove_discount(discount_id, options = nil)
+    def remove_discount(discount_id, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/discounts/" + CGI.escape(discount_id) + ""
       data    = {
@@ -349,7 +355,7 @@ module ProcessOut
     # Get the subscriptions past transactions.
     # Params:
     # +options+:: +Hash+ of options
-    def transactions(options = nil)
+    def transactions(options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + "/transactions"
       data    = {
@@ -362,7 +368,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['transactions']
-        tmp = Transaction(@client)
+        tmp = Transaction.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end
@@ -377,7 +383,7 @@ module ProcessOut
     # Get all the subscriptions.
     # Params:
     # +options+:: +Hash+ of options
-    def all(options = nil)
+    def all(options = {})
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -390,7 +396,7 @@ module ProcessOut
       a    = Array.new
       body = response.body
       for v in body['subscriptions']
-        tmp = Subscription(@client)
+        tmp = Subscription.new(@client)
         tmp.fill_with_data(v)
         a.push(tmp)
       end
@@ -406,7 +412,7 @@ module ProcessOut
     # Params:
     # +customer_id+:: ID of the customer
     # +options+:: +Hash+ of options
-    def create(customer_id, options = nil)
+    def create(customer_id, options = {})
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -441,7 +447,7 @@ module ProcessOut
     # +customer_id+:: ID of the customer
     # +plan_id+:: ID of the plan
     # +options+:: +Hash+ of options
-    def create_from_plan(customer_id, plan_id, options = nil)
+    def create_from_plan(customer_id, plan_id, options = {})
       request = Request.new(@client)
       path    = "/subscriptions"
       data    = {
@@ -476,7 +482,7 @@ module ProcessOut
     # Params:
     # +subscription_id+:: ID of the subscription
     # +options+:: +Hash+ of options
-    def find(subscription_id, options = nil)
+    def find(subscription_id, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(subscription_id) + ""
       data    = {
@@ -502,7 +508,7 @@ module ProcessOut
     # Params:
     # +prorate+:: Define if proration should be done when updating the plan
     # +options+:: +Hash+ of options
-    def update(prorate, options = nil)
+    def update(prorate, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
@@ -529,7 +535,7 @@ module ProcessOut
     # +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_plan(plan_id, prorate, options = nil)
+    def update_plan(plan_id, prorate, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
@@ -555,7 +561,7 @@ module ProcessOut
     # 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 = nil)
+    def apply_source(source, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
@@ -580,7 +586,7 @@ module ProcessOut
     # Params:
     # +cancellation_reason+:: Cancellation reason
     # +options+:: +Hash+ of options
-    def cancel(cancellation_reason, options = nil)
+    def cancel(cancellation_reason, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {
@@ -606,7 +612,7 @@ module ProcessOut
     # +cancel_at+:: Cancellation date, in the form of a string
     # +cancellation_reason+:: Cancellation reason
     # +options+:: +Hash+ of options
-    def cancel_at(cancel_at, cancellation_reason, options = nil)
+    def cancel_at(cancel_at, cancellation_reason, options = {})
       request = Request.new(@client)
       path    = "/subscriptions/" + CGI.escape(@id) + ""
       data    = {