processout 0.2.0

data/lib/processout/networking/request.rb

@@ -0,0 +1,95 @@
+require "net/http"
+require "net/https"
+require "json"
+
+module ProcessOut
+  class Request
+    def initialize(client)
+      @client = client
+    end
+
+    # ApplyHeaders applies the pre-defined headers to the request
+    def apply_headers(req, options)
+      req.basic_auth @client.project_id, @client.project_secret
+      req.content_type = "application/json"
+      req["API-Version"] = "1.3.0.0"
+      req["User-Agent"] = "utf-8"
+
+      unless options.nil?
+        req["Idempotency-Key"] = options.fetch(:idempotency_key, "")
+        req["Disable-Logging"] = options.fetch(:disable_logging, "")
+      end
+    end
+    protected :apply_headers
+
+    # ComputeData computes the data to be sent in the request
+    def compute_data(data, options)
+      unless options.nil?
+        data["expand"] = options.fetch(:expand, "")
+        data["filter"] = options.fetch(:filter, "")
+        data["limit"] = options.fetch(:limit, "")
+        data["page"] = options.fetch(:page, "")
+        data["end_before"] = options.fetch(:end_before, "")
+        data["start_after"] = options.fetch(:start_after, "")
+      end
+      data
+    end
+    protected :compute_data
+
+    # GET sends a get request to the API
+    def get(path, data, options) 
+      uri = URI(@client.host + path)
+      uri.query = URI.encode_www_form(self.compute_data(data, options))
+      req = Net::HTTP::Get.new(uri)
+      self.apply_headers(req, options)
+
+      Net::HTTP.start(uri.hostname, uri.port,
+        :use_ssl => true) do |http|
+
+        http.request(req)
+      end
+    end
+
+    # POST sends a post request to the API
+    def post(path, data, options) 
+      uri = URI(@client.host + path)
+      req = Net::HTTP::Post.new(uri)
+      req.body = data.to_json
+      self.apply_headers(req, options)
+
+      Net::HTTP.start(uri.hostname, uri.port,
+        :use_ssl => true) do |http|
+
+        http.request(req)
+      end
+    end
+
+    # PUT sends a put request to the API
+    def put(path, data, options) 
+      uri = URI(@client.host + path)
+      req = Net::HTTP::Put.new(uri)
+      req.body = data.to_json
+      self.apply_headers(req, options)
+
+      Net::HTTP.start(uri.hostname, uri.port,
+        :use_ssl => true) do |http|
+
+        http.request(req)
+      end
+    end
+
+    # DELETE sends a delete request to the API
+    def delete(path, data, options) 
+      uri = URI(@client.host + path)
+      req = Net::HTTP::Delete.new(uri)
+      req.body = data.to_json
+      self.apply_headers(req, options)
+
+      Net::HTTP.start(uri.hostname, uri.port,
+        :use_ssl => true) do |http|
+
+        http.request(req)
+      end
+    end
+  end
+end

data/lib/processout/networking/response.rb

@@ -0,0 +1,61 @@
+require "net/http"
+require "json"
+
+require "processout/errors/authentication_error"
+require "processout/errors/generic_error"
+require "processout/errors/internal_error"
+require "processout/errors/notfound_error"
+require "processout/errors/validation_error"
+
+module ProcessOut
+  class Response
+  attr_reader :body
+
+    def initialize(resp)
+      @resp = resp
+      @status = resp.code.to_i
+      @body = JSON.parse(resp.body)
+      self.check
+    end
+
+    # Success returns whether or not the response returned a successful message
+    def success
+      if @body.include? "success"
+        return @body["success"]
+      end
+      false
+    end
+
+    # Message returns the error message contained in the response, if any
+    def message
+      if @body.include? "message"
+        return @body["message"]
+      end
+      ""
+    end
+
+    # Check checks the response didn't contain any error, or raises an
+    # error if one was found
+    def check
+      unless self.success
+        if @status == 404
+          raise NotFoundError, self.message
+        end
+        if @status == 401
+          raise AuthenticationError, self.message
+        end
+        if @status == 400
+          raise ValidationError, self.message
+        end
+        if @status >= 500
+          raise InternalError, "ProcessOut returned an internal error (" +
+            @status.to_s + "): " + self.message
+        end
+
+        raise GenericError, "ProcessOut returned an error (" +
+          @status.to_s + "): " + self.message
+      end
+    end
+    protected :check
+  end
+end

data/lib/processout/plan.rb

@@ -0,0 +1,280 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class Plan
+    
+    attr_reader :id
+    attr_reader :project
+    attr_reader :name
+    attr_reader :amount
+    attr_reader :currency
+    attr_reader :metadata
+    attr_reader :interval
+    attr_reader :trial_period
+    attr_reader :return_url
+    attr_reader :cancel_url
+    attr_reader :sandbox
+    attr_reader :created_at
+
+    
+    def id=(val)
+      @id = val
+    end
+    
+    def project=(val)
+      if val.instance_of? Project
+        @project = val
+      else
+        obj = Project.new(@client)
+        obj.fill_with_data(val)
+        @project = obj
+      end
+      
+    end
+    
+    def name=(val)
+      @name = val
+    end
+    
+    def amount=(val)
+      @amount = val
+    end
+    
+    def currency=(val)
+      @currency = val
+    end
+    
+    def metadata=(val)
+      @metadata = val
+    end
+    
+    def interval=(val)
+      @interval = val
+    end
+    
+    def trial_period=(val)
+      @trial_period = val
+    end
+    
+    def return_url=(val)
+      @return_url = val
+    end
+    
+    def cancel_url=(val)
+      @cancel_url = val
+    end
+    
+    def sandbox=(val)
+      @sandbox = val
+    end
+    
+    def created_at=(val)
+      @created_at = val
+    end
+    
+
+    # Initializes the Plan object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    def initialize(client)
+      @client = client
+
+      @id = ""
+      @project = nil
+      @name = ""
+      @amount = ""
+      @currency = ""
+      @metadata = Hash.new
+      @interval = ""
+      @trial_period = "0d"
+      @return_url = ""
+      @cancel_url = ""
+      @sandbox = false
+      @created_at = ""
+      
+    end
+
+    # Fills the object with data coming from the API
+    # Params:
+    # +data+:: +Hash+ of data coming from the API
+    def fill_with_data(data)
+      if data.include? "id"
+        @id = data["id"]
+      end
+      if data.include? "project"
+        @project = data["project"]
+      end
+      if data.include? "name"
+        @name = data["name"]
+      end
+      if data.include? "amount"
+        @amount = data["amount"]
+      end
+      if data.include? "currency"
+        @currency = data["currency"]
+      end
+      if data.include? "metadata"
+        @metadata = data["metadata"]
+      end
+      if data.include? "interval"
+        @interval = data["interval"]
+      end
+      if data.include? "trial_period"
+        @trial_period = data["trial_period"]
+      end
+      if data.include? "return_url"
+        @return_url = data["return_url"]
+      end
+      if data.include? "cancel_url"
+        @cancel_url = data["cancel_url"]
+      end
+      if data.include? "sandbox"
+        @sandbox = data["sandbox"]
+      end
+      if data.include? "created_at"
+        @created_at = data["created_at"]
+      end
+      
+      self
+    end
+
+    # Get all the plans.
+    # Params:
+    # +options+:: +Hash+ of options
+    def all(options = nil)
+      request = Request.new(@client)
+      path    = "/plans"
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      return_values = Array.new
+      
+      a    = Array.new
+      body = response.body
+      for v in body['plans']
+        tmp = Plan(@client)
+        tmp.fill_with_data(v)
+        a.push(tmp)
+      end
+
+      return_values.push(a)
+      
+
+      
+      return_values[0]
+    end
+
+    # Create a new plan.
+    # Params:
+    # +options+:: +Hash+ of options
+    def create(options = nil)
+      request = Request.new(@client)
+      path    = "/plans"
+      data    = {
+        "id": @id, 
+        "name": @name, 
+        "amount": @amount, 
+        "currency": @currency, 
+        "interval": @interval, 
+        "trial_period": @trial_period, 
+        "metadata": @metadata, 
+        "return_url": @return_url, 
+        "cancel_url": @cancel_url
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["plan"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Find a plan by its ID.
+    # Params:
+    # +plan_id+:: ID of the plan
+    # +options+:: +Hash+ of options
+    def find(plan_id, options = nil)
+      request = Request.new(@client)
+      path    = "/plans/" + CGI.escape(plan_id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["plan"]
+      
+      
+      obj = Plan.new(@client)
+      return_values.push(obj.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Update the plan. This action won't affect subscriptions already linked to this plan.
+    # Params:
+    # +options+:: +Hash+ of options
+    def update(options = nil)
+      request = Request.new(@client)
+      path    = "/plans/" + CGI.escape(@id) + ""
+      data    = {
+        "name": @name, 
+        "trial_period": @trial_period, 
+        "metadata": @metadata, 
+        "return_url": @return_url, 
+        "cancel_url": @cancel_url
+      }
+
+      response = Response.new(request.put(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["plan"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Delete a plan. Subscriptions linked to this plan won't be affected.
+    # Params:
+    # +options+:: +Hash+ of options
+    def end(options = nil)
+      request = Request.new(@client)
+      path    = "/plans/" + CGI.escape(@id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.delete(path, data, options))
+      return_values = Array.new
+      
+      return_values.push(response.success)
+
+      
+      return_values[0]
+    end
+
+    
+  end
+end

data/lib/processout/product.rb

@@ -0,0 +1,313 @@
+# The content of this file was automatically generated
+
+require "cgi"
+require "processout/networking/request"
+require "processout/networking/response"
+
+module ProcessOut
+  class Product
+    
+    attr_reader :id
+    attr_reader :project
+    attr_reader :url
+    attr_reader :name
+    attr_reader :amount
+    attr_reader :currency
+    attr_reader :metadata
+    attr_reader :request_email
+    attr_reader :request_shipping
+    attr_reader :return_url
+    attr_reader :cancel_url
+    attr_reader :sandbox
+    attr_reader :created_at
+
+    
+    def id=(val)
+      @id = val
+    end
+    
+    def project=(val)
+      if val.instance_of? Project
+        @project = val
+      else
+        obj = Project.new(@client)
+        obj.fill_with_data(val)
+        @project = obj
+      end
+      
+    end
+    
+    def url=(val)
+      @url = val
+    end
+    
+    def name=(val)
+      @name = val
+    end
+    
+    def amount=(val)
+      @amount = val
+    end
+    
+    def currency=(val)
+      @currency = val
+    end
+    
+    def metadata=(val)
+      @metadata = val
+    end
+    
+    def request_email=(val)
+      @request_email = val
+    end
+    
+    def request_shipping=(val)
+      @request_shipping = val
+    end
+    
+    def return_url=(val)
+      @return_url = val
+    end
+    
+    def cancel_url=(val)
+      @cancel_url = val
+    end
+    
+    def sandbox=(val)
+      @sandbox = val
+    end
+    
+    def created_at=(val)
+      @created_at = val
+    end
+    
+
+    # Initializes the Product object
+    # Params:
+    # +client+:: +ProcessOut+ client instance
+    def initialize(client)
+      @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 = ""
+      
+    end
+
+    # Fills the object with data coming from the API
+    # Params:
+    # +data+:: +Hash+ of data coming from the API
+    def fill_with_data(data)
+      if data.include? "id"
+        @id = data["id"]
+      end
+      if data.include? "project"
+        @project = data["project"]
+      end
+      if data.include? "url"
+        @url = data["url"]
+      end
+      if data.include? "name"
+        @name = data["name"]
+      end
+      if data.include? "amount"
+        @amount = data["amount"]
+      end
+      if data.include? "currency"
+        @currency = data["currency"]
+      end
+      if data.include? "metadata"
+        @metadata = data["metadata"]
+      end
+      if data.include? "request_email"
+        @request_email = data["request_email"]
+      end
+      if data.include? "request_shipping"
+        @request_shipping = data["request_shipping"]
+      end
+      if data.include? "return_url"
+        @return_url = data["return_url"]
+      end
+      if data.include? "cancel_url"
+        @cancel_url = data["cancel_url"]
+      end
+      if data.include? "sandbox"
+        @sandbox = data["sandbox"]
+      end
+      if data.include? "created_at"
+        @created_at = data["created_at"]
+      end
+      
+      self
+    end
+
+    # Create a new invoice from the product.
+    # Params:
+    # +options+:: +Hash+ of options
+    def invoice(options = nil)
+      request = Request.new(@client)
+      path    = "/products/" + CGI.escape(@id) + "/invoices"
+      data    = {
+
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["invoice"]
+      invoice = Invoice(self._client)
+      return_values.push(invoice.fill_with_data(body))
+
+      
+      return_values[0]
+    end
+
+    # Get all the products.
+    # Params:
+    # +options+:: +Hash+ of options
+    def all(options = nil)
+      request = Request.new(@client)
+      path    = "/products"
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      return_values = Array.new
+      
+      a    = Array.new
+      body = response.body
+      for v in body['products']
+        tmp = Product(@client)
+        tmp.fill_with_data(v)
+        a.push(tmp)
+      end
+
+      return_values.push(a)
+      
+
+      
+      return_values[0]
+    end
+
+    # Create a new product.
+    # Params:
+    # +options+:: +Hash+ of options
+    def create(options = nil)
+      request = Request.new(@client)
+      path    = "/products"
+      data    = {
+        "name": @name, 
+        "amount": @amount, 
+        "currency": @currency, 
+        "metadata": @metadata, 
+        "request_email": @request_email, 
+        "request_shipping": @request_shipping, 
+        "return_url": @return_url, 
+        "cancel_url": @cancel_url
+      }
+
+      response = Response.new(request.post(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["product"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Find a product by its ID.
+    # Params:
+    # +product_id+:: ID of the product
+    # +options+:: +Hash+ of options
+    def find(product_id, options = nil)
+      request = Request.new(@client)
+      path    = "/products/" + CGI.escape(product_id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.get(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["product"]
+      
+      
+      obj = Product.new(@client)
+      return_values.push(obj.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Save the updated product attributes.
+    # Params:
+    # +options+:: +Hash+ of options
+    def save(options = nil)
+      request = Request.new(@client)
+      path    = "/products/" + CGI.escape(@id) + ""
+      data    = {
+        "name": @name, 
+        "amount": @amount, 
+        "currency": @currency, 
+        "metadata": @metadata, 
+        "request_email": @request_email, 
+        "request_shipping": @request_shipping, 
+        "return_url": @return_url, 
+        "cancel_url": @cancel_url
+      }
+
+      response = Response.new(request.put(path, data, options))
+      return_values = Array.new
+      
+      body = response.body
+      body = body["product"]
+      
+      
+      return_values.push(self.fill_with_data(body))
+      
+
+      
+      return_values[0]
+    end
+
+    # Delete the product.
+    # Params:
+    # +options+:: +Hash+ of options
+    def delete(options = nil)
+      request = Request.new(@client)
+      path    = "/products/" + CGI.escape(@id) + ""
+      data    = {
+
+      }
+
+      response = Response.new(request.delete(path, data, options))
+      return_values = Array.new
+      
+      return_values.push(response.success)
+
+      
+      return_values[0]
+    end
+
+    
+  end
+end