mc2p-ruby 0.1.2

data/lib/mixins.rb

@@ -0,0 +1,377 @@
+module MC2P
+
+  # Basic info of the object item
+  class ObjectItemMixin
+    attr_accessor :json_dict
+    attr_accessor :resource
+    attr_accessor :_deleted
+
+    def initialize(json_dict, resource, id_property = 'id')
+      @json_dict = json_dict
+      @resource = resource
+      @_deleted = nil
+      @id_property = id_property
+    end
+
+    def id_required_and_not_deleted
+      raise BadUseError('Object don\'t have ID') unless
+          @json_dict.fetch(@id_property, false)
+      raise BadUseError('Object deleted') if @_deleted
+    end
+
+    # Returns: Name of the object and content
+    def to_s
+      "#{self.class.name} #{@json_dict}"
+    end
+  end
+
+  # Allows delete an object item
+  class DeleteObjectItemMixin < ObjectItemMixin
+    # Deletes the object item
+    def delete
+      id_required_and_not_deleted
+      @resource.delete(
+        @json_dict[@id_property]
+      )
+      @_deleted = true
+    end
+  end
+
+  # Allows retrieve an object item
+  class RetrieveObjectItemMixin < ObjectItemMixin
+    # Retrieves the data of the object item
+    def retrieve
+      id_required_and_not_deleted
+      obj = @resource.detail(
+        @json_dict[@id_property]
+      )
+      @json_dict = obj.json_dict
+    end
+  end
+
+  # Allows create an object item
+  class CreateObjectItemMixin < ObjectItemMixin
+    # Creates the object item with the json_dict data
+    def _create
+      obj = @resource.create(
+        @json_dict
+      )
+      @json_dict = obj.json_dict
+    end
+
+    # Executes the internal function _create if the object item don't have id
+    def save
+      _create unless @json_dict.fetch(@id_property, false)
+    end
+  end
+
+  # Allows change an object item
+  class SaveObjectItemMixin < CreateObjectItemMixin
+    # Changes the object item with the json_dict data
+    def _change
+      id_required_and_not_deleted
+      obj = @resource.change(
+        @json_dict[@id_property],
+        @json_dict
+      )
+      @json_dict = obj.json_dict
+    end
+
+    # Executes the internal function _create if the object item don't have id,
+    # in other case, call to _change
+    def save
+      if @json_dict.fetch(@id_property, false)
+        _change
+      else
+        _create
+      end
+    end
+  end
+
+  # Allows make refund, capture and void an object item
+  class RefundCaptureVoidObjectItemMixin < ObjectItemMixin
+    # Refund the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def refund(data = nil)
+      id_required_and_not_deleted
+      @resource.refund(
+        @json_dict[@id_property],
+        data
+      )
+    end
+
+    # Capture the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def capture(data = nil)
+      id_required_and_not_deleted
+      @resource.capture(
+        @json_dict[@id_property],
+        data
+      )
+    end
+
+    # Void the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def void(data = nil)
+      id_required_and_not_deleted
+      @resource.void(
+        @json_dict[@id_property],
+        data
+      )
+    end
+  end
+
+  # Allows make card and share an object item
+  class CardShareObjectItemMixin < ObjectItemMixin
+    # Send card details
+    # Params:
+    # +gateway_code+:: gateway_code to send
+    # +data+:: data to send
+    # Returns: response dictionary
+    def card(gateway_code, data = nil)
+      id_required_and_not_deleted
+      @resource.card(
+        @json_dict[@id_property],
+        gateway_code,
+        data
+      )
+    end
+
+    # Send share details
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def share(data = nil)
+      id_required_and_not_deleted
+      @resource.share(
+        @json_dict[@id_property],
+        data
+      )
+    end
+  end
+
+  # Add property to get pay_url based on token
+  class PayURLMixin < ObjectItemMixin
+    def initialize(json_dict, resource)
+      super(json_dict, resource)
+      @pay_url = 'https://pay.mychoice2pay.com/#/%s'
+      @iframe_url = 'https://pay.mychoice2pay.com/#/%s/iframe'
+    end
+
+    # Returns: pay url
+    def pay_url
+      id_required_and_not_deleted
+      @pay_url % @json_dict['token']
+    end
+
+    # Returns: iframe url
+    def iframe_url
+      id_required_and_not_deleted
+      @iframe_url % @json_dict['token']
+    end
+  end
+
+  # Basic info of the resource
+  class ResourceMixin
+    # Initializes a resource
+    # Params:
+    # +api_request+:: Api request used to make all the requests to the API
+    # +path+:: Path used to make all the requests to the API
+    # +object_item_class+:: Object item class used to return values
+    # +paginator_class+:: Paginator class used to return values
+    def initialize(api_request, path, object_item_class, paginator_class)
+      @api_request = api_request
+      @path = path
+      @object_item_class = object_item_class
+      @paginator_class = paginator_class
+    end
+
+    # Params:
+    # +resource_id+:: id used on the url returned
+    # Returns: url to request or change an item
+    def detail_url(resource_id)
+      "#{@path}#{resource_id}/"
+    end
+
+    # Help function to make a request that return one item
+    # Params:
+    # +func+:: function to make the request
+    # +data+:: data passed in the request
+    # +resource_id+:: id to use on the requested url
+    # Returns: an object item that represent the item returned
+    def _one_item(func, data = nil, resource_id = nil)
+      url = resource_id.nil? ? @path : detail_url(resource_id)
+
+      obj_data = @api_request.send(
+        func,
+        url,
+        data,
+        nil,
+        self,
+        resource_id
+      )
+
+      @object_item_class.new(obj_data, self)
+    end
+  end
+
+  # Allows send requests of detail
+  class DetailOnlyResourceMixin < ResourceMixin
+    # Params:
+    # +resource_id+:: id to request
+    # Returns: an object item class with the response of the server
+    def detail(resource_id)
+      _one_item('get',
+                nil,
+                resource_id)
+    end
+  end
+
+  # Allows send requests of list and detail
+  class ReadOnlyResourceMixin < DetailOnlyResourceMixin
+    # Params:
+    # +abs_url+:: if is passed the request is sent to this url
+    # Returns: a paginator class with the response of the server
+    def list(abs_url = nil)
+      json_dict = @api_request.get(
+        abs_url.nil? ? @path : nil,
+        nil,
+        abs_url,
+        self
+      )
+      @paginator_class.new(json_dict, @object_item_class, self)
+    end
+  end
+
+  # Allows send requests of create
+  class CreateResourceMixin < ResourceMixin
+    # Params:
+    # +data+:: data used on the request
+    # Returns: an object item class with the response of the server
+    def create(data)
+      _one_item('post',
+                data)
+    end
+  end
+
+  # Allows send requests of change
+  class ChangeResourceMixin < ResourceMixin
+    # Params:
+    # +resource_id+:: id to request
+    # +data+:: data used on the request
+    # Returns: an object item class with the response of the server
+    def change(resource_id, data)
+      _one_item('patch',
+                data,
+                resource_id)
+    end
+  end
+
+  # Allows send requests of delete
+  class DeleteResourceMixin < ResourceMixin
+    # Params:
+    # +resource_id+::id to request
+    def delete(resource_id)
+      _one_item('delete',
+                nil,
+                resource_id)
+    end
+  end
+
+  # Allows send requests of actions
+  class ActionsResourceMixin < ResourceMixin
+    # Params:
+    # +resource_id+:: id used on the url returned
+    # +action+:: action used on the url returned
+    # Returns: url to make an action in an item
+    def detail_action_url(resource_id, action)
+      "#{@path}#{resource_id}/#{action}/"
+    end
+
+    # Params:
+    # +func+:: function to make the request
+    # +resource_id+:: id to use on the requested url
+    # +action+:: action to use on the requested url
+    # +data+:: data passed in the request
+    # Returns: response dictionary
+    def _one_item_action(func, resource_id, action, data = nil)
+      url = detail_action_url(resource_id, action)
+      @api_request.send(
+        func,
+        url,
+        data,
+        nil,
+        self,
+        resource_id
+      )
+    end
+  end
+
+  # Allows send action requests of refund, capture and void
+  class RefundCaptureVoidResourceMixin < ActionsResourceMixin
+    # Params:
+    # +resource_id+:: id to request
+    # +data+:: data to send
+    # Returns: response dictionary
+    def refund(resource_id, data = nil)
+      _one_item_action('post200',
+                       resource_id,
+                       'refund',
+                       data)
+    end
+
+    # Params:
+    # +resource_id+:: id to request
+    # +data+:: data to send
+    # Returns: response dictionary
+    def capture(resource_id, data = nil)
+      _one_item_action('post200',
+                       resource_id,
+                       'capture',
+                       data)
+    end
+
+    # Params:
+    # +resource_id+:: id to request
+    # +data+:: data to send
+    # Returns: response dictionary
+    def void(resource_id, data = nil)
+      _one_item_action('post200',
+                       resource_id,
+                       'void',
+                       data)
+    end
+  end
+
+  # Allows send action requests of card and share
+  class CardShareResourceMixin < ActionsResourceMixin
+    # Params:
+    # +resource_id+:: id to request
+    # +gateway_code+:: gateway_code to send
+    # +data+:: data to send
+    # Returns: response dictionary
+    def card(resource_id, gateway_code, data = nil)
+      _one_item_action('post',
+                       resource_id,
+                       "card/#{gateway_code}",
+                       data)
+    end
+
+    # Params:
+    # +resource_id+:: id to request
+    # +data+:: data to send
+    # Returns: response dictionary
+    def share(resource_id, data = nil)
+      _one_item_action('post',
+                       resource_id,
+                       'share',
+                       data)
+    end
+  end
+end

data/lib/notification.rb

@@ -0,0 +1,73 @@
+module MC2P
+  # Notification data - class to manage notification from MyChoice2Pay
+  class NotificationData
+    # Initializes a notification data
+    # Params:
+    # +json_body+:: content of request from MyChoice2Pay
+    # +mc2p+:: MC2PClient
+    def initialize(json_body, mc2p)
+      @json_body = json_body
+      @mc2p = mc2p
+    end
+
+    # Returns: status of payment
+    def status
+      @json_body['status']
+    end
+
+    # Returns: status of subscription
+    def subscription_status
+      @json_body['subscription_status']
+    end
+
+    # Returns: type of payment
+    def type
+      @json_body['type']
+    end
+
+    # Returns: order_id sent when payment was created
+    def order_id
+      @json_body['order_id']
+    end
+
+    # Returns: action executed
+    def action
+      @json_body['action']
+    end
+
+    # Returns: transaction generated when payment was created
+    def transaction
+      ret = nil
+      if type == 'P'
+        ret = @mc2p.transaction('id' => @json_body['id'])
+        ret.retrieve
+      end
+      ret
+    end
+
+    # Returns: subscription generated when payment was created
+    def subscription
+      ret = nil
+      if type == 'S'
+        ret = @mc2p.subscription('id' => @json_body['id'])
+        ret.retrieve
+      end
+      ret
+    end
+
+    # Returns: sale generated when payment was paid
+    def sale
+      ret = nil
+      if @json_body.include?('sale_id')
+        ret = @mc2p.sale('id' => @json_body['sale_id'])
+        ret.retrieve
+      end
+      ret
+    end
+
+    # Returns: action of sale executed
+    def sale_action
+      @json_body['sale_action']
+    end
+  end
+end

data/lib/objects.rb

@@ -0,0 +1,135 @@
+module MC2P
+
+  # Product object
+  class Product < CRUDObjectItem
+
+  end
+
+  # Plan object
+  class Plan < CRUDObjectItem
+
+  end
+
+  # Tax object
+  class Tax < CRUDObjectItem
+
+  end
+
+  # Shipping object
+  class Shipping < CRUDObjectItem
+
+  end
+
+  # Coupon object
+  class Coupon < CRUDObjectItem
+
+  end
+
+  # Transaction object
+  class Transaction < PayURLCRObjectItem
+
+  end
+
+  # Subscription object
+
+  class Subscription < PayURLCRObjectItem
+
+  end
+
+  # Sale object
+  class Sale < ReadOnlyObjectItem
+    # Initializes an object item
+    # Params:
+    # +json_dict+:: Data of the object
+    # +resource+:: Resource used to delete, save, create or retrieve the object
+    def initialize(json_dict, resource)
+      super(json_dict, resource)
+      @rcv_mixin = RefundCaptureVoidObjectItemMixin.new(json_dict, resource)
+    end
+
+    # Refund the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def refund(data = nil)
+      @rcv_mixin.json_dict = @json_dict
+      @rcv_mixin._deleted = @_deleted
+      @rcv_mixin.refund(data)
+      @json_dict = @rcv_mixin.json_dict
+      @_deleted = @rcv_mixin._deleted
+    end
+
+    # Capture the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def capture(data = nil)
+      @rcv_mixin.json_dict = @json_dict
+      @rcv_mixin._deleted = @_deleted
+      @rcv_mixin.capture(data)
+      @json_dict = @rcv_mixin.json_dict
+      @_deleted = @rcv_mixin._deleted
+    end
+
+    # Void the object item
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def void(data = nil)
+      @rcv_mixin.json_dict = @json_dict
+      @rcv_mixin._deleted = @_deleted
+      @rcv_mixin.void(data)
+      @json_dict = @rcv_mixin.json_dict
+      @_deleted = @rcv_mixin._deleted
+    end
+
+  end
+
+  # Currency object
+  class Currency < ReadOnlyObjectItem
+
+  end
+
+  # Gateway object
+  class Gateway < ReadOnlyObjectItem
+
+  end
+
+  # PayData object
+  class PayData < ReadOnlyObjectItem
+
+    # Initializes an object item
+    # Params:
+    # +json_dict+:: Data of the object
+    # +resource+:: Resource used to delete, save, create or retrieve the object
+    def initialize(json_dict, resource)
+      super(json_dict, resource, 'token')
+      @cs_mixin = CardShareObjectItemMixin.new(json_dict, resource, 'token')
+    end
+
+    # Send card details
+    # Params:
+    # +gateway_code+:: gateway_code to send
+    # +data+:: data to send
+    # Returns: response dictionary
+    def card(gateway_code, data = nil)
+      @cs_mixin.json_dict = @json_dict
+      @cs_mixin._deleted = @_deleted
+      @cs_mixin.card(gateway_code, data)
+      @json_dict = @cs_mixin.json_dict
+      @_deleted = @cs_mixin._deleted
+    end
+
+    # Send share details
+    # Params:
+    # +data+:: data to send
+    # Returns: response dictionary
+    def share(data = nil)
+      @cs_mixin.json_dict = @json_dict
+      @cs_mixin._deleted = @_deleted
+      @cs_mixin.share(data)
+      @json_dict = @cs_mixin.json_dict
+      @_deleted = @cs_mixin._deleted
+    end
+  end
+end

data/lib/request.rb

@@ -0,0 +1,87 @@
+module MC2P
+  # API request - class used to connect with the API
+  class APIRequest
+    # Initializes an api request
+    # Params:
+    # +key+:: key to connect with API
+    # +secret_key+:: secret key to connect with API
+    def initialize(key, secret_key)
+      @key = key
+      @secret_key = secret_key
+
+      @authorization_header = 'AppKeys'
+      @api_url = 'api.mychoice2pay.com/v1'
+    end
+
+    # Creates the headers to include in the request
+    # Returns: A dictionary with the headers needed for the API
+    def headers
+      {
+        'authorization' => "#{@authorization_header} #{@key}:#{@secret_key}",
+        'content-type' => 'application/json'
+      }
+    end
+
+    # Params:
+    # +path+:: relative url
+    # Returns: The absolute url to send the request
+    def get_abs_url(path)
+      "https://#{@api_url}#{path}"
+    end
+
+    # Decorator to make the request based on the method received
+    # Params:
+    # +method+:: method to make the request
+    # +status_code+:: value to check if the request receive a correct response
+    # Returns: a function to make the request
+    def _request(method, status_code = 200, path = nil, data = nil,
+                 abs_url = nil, resource = nil, resource_id = nil)
+      url = abs_url.nil? ? get_abs_url(path) : abs_url
+
+      request = Unirest.send(method.downcase, url,
+                             headers: headers,
+                             parameters: data.to_json)
+
+      if request.code != status_code
+        raise InvalidRequestError.new(
+          "Error #{request.code}",
+          request.body,
+          resource,
+          resource_id
+        )
+      end
+
+      status_code != 204 ? request.body : {}
+    end
+
+    # POST 201 function
+    def post(path = nil, data = nil, abs_url = nil,
+             resource = nil, resource_id = nil)
+      _request('post', 201, path, data, abs_url, resource, resource_id)
+    end
+
+    # POST 200 function
+    def post200(path = nil, data = nil, abs_url = nil,
+                resource = nil, resource_id = nil)
+      _request('post', 200, path, data, abs_url, resource, resource_id)
+    end
+
+    # GET 200 function
+    def get(path = nil, data = nil, abs_url = nil,
+            resource = nil, resource_id = nil)
+      _request('get', 200, path, data, abs_url, resource, resource_id)
+    end
+
+    # PATCH 200 function
+    def patch(path = nil, data = nil, abs_url = nil,
+              resource = nil, resource_id = nil)
+      _request('patch', 200, path, data, abs_url, resource, resource_id)
+    end
+
+    # DELETE 204 function
+    def delete(path = nil, data = nil, abs_url = nil,
+               resource = nil, resource_id = nil)
+      _request('delete', 204, path, data, abs_url, resource, resource_id)
+    end
+  end
+end