mc2p-ruby 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cf6d964ae739ae4de6ac141e488f89a29b28122
+  data.tar.gz: '0590e374daf4ad713f50b31d0880ab9f5b44d3d2'
+SHA512:
+  metadata.gz: 2f265ef00b103392dcd85527a53b368fccfbf48722547892aa2c50d717883a2b89cd2a1c0392b598c4556a9c5a2b6e644ebe3740522c38b17890d737ab22246c
+  data.tar.gz: 4003ad34dca603880af5be7a7e7ea333483e904f2053604d242ffaa2830a4a82414ca4d38ae7cdc5e389f037b3dff6f178ad12f6c562667e8f96b174da0fe90c

data/README.md

@@ -0,0 +1,125 @@
+# MyChoice2Pay Ruby
+
+
+# Overview
+
+MyChoice2Pay Ruby provides integration access to the MyChoice2Pay API.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mc2p-ruby'
+    
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    gem install mc2p-ruby
+
+# Quick Start Example
+
+    require 'mc2p'
+    
+    mc2p = MC2P::MC2PClient.new('KEY', 'SECRET_KEY')
+    
+    # Create transaction
+    transaction = mc2p.transaction({
+                                       'currency' => 'EUR',
+                                       'products' => [{
+                                                          'amount' => 1,
+                                                          'product_id' => 'PRODUCT-ID'
+                                                      }]
+                                   })
+    # or with product details
+    transaction = mc2p.transaction({
+                                       'currency' => 'EUR',
+                                       'products' => [{
+                                                          'amount' => 1,
+                                                          'product' => {
+                                                              'name' => 'Product',
+                                                              'price' => 5
+                                                          }
+                                                      }]
+                                   })
+    transaction.save
+    transaction.pay_url # Send user to this url to pay
+    transaction.iframe_url # Use this url to show an iframe in your site
+
+    # Get plans
+    plans_paginator = mc2p.plan_resource.list
+    plans_paginator.count
+    plans_paginator.results # Application's plans
+    plans_paginator.next_list
+    
+    # Get product, change and save
+    product = mc2p.product({
+                               'id' => 'PRODUCT-ID'
+                           })
+    product.retrieve
+    product.set('price', 10)
+    product.save
+    
+    # Create and delete tax
+    tax = mc2p.tax({
+                       'name' => 'Tax',
+                       'percent' => 5
+                   })
+    tax.save
+    tax.delete
+    
+    # Check if transaction was paid
+    transaction = mc2p.transaction({
+                                       'id' => 'TRANSACTION-ID'
+                                   })
+    transaction.retrieve
+    transaction.status == 'D' # Paid
+    
+    # Create subscription
+    subscription = mc2p.subscription({
+                                         'currency' => 'EUR',
+                                         'plan_id' => 'PLAN-ID',
+                                         'note' => 'Note example'
+                                     })
+    # or with plan details
+    subscription = mc2p.subscription({
+                                         'currency' => 'EUR',
+                                         'plan' => {
+                                             'name' => 'Plan',
+                                             'price' => 5,
+                                             'duration' => 1,
+                                             'unit' => 'M',
+                                             'recurring' => true
+                                         },
+                                         'note' => 'Note example'
+                                     })
+    subscription.save
+    subscription.pay_url # Send user to this url to pay
+    subscription.iframe_url # Use this url to show an iframe in your site
+
+    # Receive a notification
+    notification_data = mc2p.notification_data(JSON_DICT_RECEIVED_FROM_MYCHOICE2PAY)
+    notification_data.status == 'D' # Paid
+    notification_data.transaction # Transaction Paid
+    notification_data.sale # Sale generated
+
+# Exceptions
+    
+    require 'mc2p'
+    
+    # Incorrect data
+    shipping = mc2p.shipping({
+                                 'name' => 'Normal shipping',
+                                 'price' => 'text' # Price must be number
+                             })
+    begin
+      shipping.save
+    rescue MC2P::InvalidRequestError => e
+      puts e.message # Status code of error
+      puts e.json_body # Info from server
+      puts e.resource # Resource used to make the server request
+      puts e.resource_id # Resource id requested
+    end
+

data/bin/mc2p

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib'

data/lib/base.rb

@@ -0,0 +1,331 @@
+module MC2P
+  # Paginator - class used on list requests
+  class Paginator
+    attr_accessor :count
+    attr_accessor :results
+
+    # Initializes a paginator
+    # Params:
+    # +json_dict+:: Response from server
+    # +object_item_class+:: Class to wrapper all the items from results field
+    # +resource+:: Resource used to get next and previous items
+    def initialize(json_dict, object_item_class, resource)
+      @count = json_dict.fetch('count', 0)
+      @_previous = json_dict.fetch('previous', nil)
+      @_next = json_dict.fetch('next', nil)
+      @results = []
+      json_dict.fetch('results', []).each do |result|
+        @results.push(object_item_class.new(result, resource))
+        @resource = resource
+      end
+    end
+
+    # Params:
+    # Returns: Paginator object with the next items
+    def next_list
+      @_next ? @resource.list(abs_url: @_next) : nil
+    end
+
+    # Params:
+    # Returns: Paginator object with the previous items
+    def previous_list
+      @_previous ? @resource.list(abs_url: @_previous) : nil
+    end
+  end
+
+  # Object item - class used to wrap the data from API that represent an item
+  class ObjectItem < ObjectItemMixin
+    # 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)
+      @json_dict = json_dict.nil? ? {} : json_dict
+      @resource = resource
+      @_deleted = false
+      @id_property = 'id'
+    end
+
+    # Allows use the following syntax to get a field of the object:
+    #     obj.name
+    # Params:
+    # +key+:: Field to return
+    # Returns: Value of the field from json_dict
+    def method_missing(key, *args)
+      @json_dict.include?(key.to_s) ? @json_dict[key.to_s] : super
+    end
+
+    def respond_to_missing?(key, include_private = false)
+      @json_dict.include?(key.to_s) || super
+    end
+
+    def respond_to?(key, include_private = false)
+      @json_dict.include?(key.to_s) || super
+    end
+
+    # Allows use the following syntax to set a field of the object:
+    #     obj.name = 'example'
+    # Params:
+    # +key+:: Field to change
+    # +value+:: Content to replace the current value
+    def set(key, value)
+      @json_dict[key] = value
+    end
+  end
+
+  # Object item that allows retrieve an item
+  class ReadOnlyObjectItem < ObjectItem
+    # 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)
+      @retrieve_mixin = RetrieveObjectItemMixin.new(json_dict, resource)
+      super(json_dict, resource)
+    end
+
+    # Retrieve object with object_id and return
+    # Params:
+    # +object_id+:: Id to retrieve
+    # Returns: Object after retrieve
+    def self.get(object_id)
+      obj = new({
+                  @id_property => object_id
+                }, resource)
+      obj.retrieve
+      obj
+    end
+
+    # Retrieves the data of the object item
+    def retrieve
+      @retrieve_mixin.json_dict = @json_dict
+      @retrieve_mixin._deleted = @_deleted
+      @retrieve_mixin.retrieve
+      @json_dict = @retrieve_mixin.json_dict
+    end
+  end
+
+  # Object item that allows retrieve and create an item
+  class CRObjectItem < 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)
+      @create_mixin = CreateObjectItemMixin.new(json_dict, resource)
+      super(json_dict, resource)
+    end
+
+    # Creates the object item with the json_dict data
+    def _create
+      @create_mixin.json_dict = @json_dict
+      @create_mixin._deleted = @_deleted
+      @create_mixin._create
+      @json_dict = @create_mixin.json_dict
+    end
+
+    # Executes the internal function _create if the object item don't have id
+    def save
+      @create_mixin.json_dict = @json_dict
+      @create_mixin._deleted = @_deleted
+      @create_mixin.save
+      @json_dict = @create_mixin.json_dict
+    end
+  end
+
+  # Object item that allows retrieve, create and change an item
+  class CRUObjectItem < 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)
+      @save_mixin = SaveObjectItemMixin.new(json_dict, resource)
+      super(json_dict, resource)
+    end
+
+    # Creates the object item with the json_dict data
+    def _create
+      @save_mixin.json_dict = @json_dict
+      @save_mixin._deleted = @_deleted
+      @save_mixin._create
+      @json_dict = @save_mixin.json_dict
+    end
+
+    # Creates the object item with the json_dict data
+    def _change
+      @save_mixin.json_dict = @json_dict
+      @save_mixin._deleted = @_deleted
+      @save_mixin._change
+      @json_dict = @save_mixin.json_dict
+    end
+
+    # Executes the internal function _create if the object item don't have id
+    def save
+      @save_mixin.json_dict = @json_dict
+      @save_mixin._deleted = @_deleted
+      @save_mixin.save
+      @json_dict = @save_mixin.json_dict
+    end
+  end
+
+  # Object item that allows retrieve, create, change and delete an item
+  class CRUDObjectItem < CRUObjectItem
+    # 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)
+      @delete_mixin = DeleteObjectItemMixin.new(json_dict, resource)
+      super(json_dict, resource)
+    end
+
+    # Deletes the object item
+    def delete
+      @delete_mixin.json_dict = @json_dict
+      @delete_mixin._deleted = @_deleted
+      @delete_mixin.delete
+      @json_dict = @delete_mixin.json_dict
+      @_deleted = @delete_mixin._deleted
+    end
+  end
+
+  # Object item that allows retrieve, create and to get pay_url based
+  # on token of an item
+  class PayURLCRObjectItem < CRObjectItem
+    # 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)
+      @pay_url_mixin = PayURLMixin.new(json_dict, resource)
+      super(json_dict, resource)
+    end
+
+    # Returns: pay_url
+    def pay_url
+      @pay_url_mixin.json_dict = @json_dict
+      @pay_url_mixin.pay_url
+    end
+
+    # Returns: iframe_url
+    def iframe_url
+      @pay_url_mixin.json_dict = @json_dict
+      @pay_url_mixin.iframe_url
+    end
+  end
+
+  # Resource - class used to manage the requests to the API related with
+  # a resource
+  # ex: product
+  class Resource < 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
+    def initialize(api_request, path, object_item_class)
+      @paginator_class = Paginator
+      super(api_request, path, object_item_class, @paginator_class)
+    end
+  end
+
+  # Resource that allows send requests of detail
+  class DetailOnlyResource < Resource
+    # 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
+    def initialize(api_request, path, object_item_class)
+      super(api_request, path, object_item_class)
+      @do_resource_mixin = DetailOnlyResourceMixin.new(api_request, path,
+                                                       object_item_class,
+                                                       @paginator_class)
+    end
+
+    # Params:
+    # +resource_id+:: id to request
+    # Returns: an object item class with the response of the server
+    def detail(resource_id)
+      @do_resource_mixin.detail(resource_id)
+    end
+  end
+
+  # Resource that allows send requests of list and detail
+  class ReadOnlyResource < DetailOnlyResource
+    # 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
+    def initialize(api_request, path, object_item_class)
+      super(api_request, path, object_item_class)
+      @ro_resource_mixin = ReadOnlyResourceMixin.new(api_request, path,
+                                                     object_item_class,
+                                                     @paginator_class)
+    end
+
+    # 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)
+      @ro_resource_mixin.list(abs_url)
+    end
+  end
+
+  # Resource that allows send requests of create, list and detail
+  class CRResource < ReadOnlyResource
+    # 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
+    def initialize(api_request, path, object_item_class)
+      super(api_request, path, object_item_class)
+      @create_resource_mixin = CreateResourceMixin.new(api_request, path,
+                                                       object_item_class,
+                                                       @paginator_class)
+    end
+
+    # Params:
+    # +data+:: data used on the request
+    # Returns: an object item class with the response of the server
+    def create(data)
+      @create_resource_mixin.create(data)
+    end
+  end
+
+  # Resource that allows send requests of delete, change, create,
+  # list and detail
+  class CRUDResource < CRResource
+    # 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
+    def initialize(api_request, path, object_item_class)
+      super(api_request, path, object_item_class)
+      @change_resource_mixin = ChangeResourceMixin.new(api_request, path,
+                                                       object_item_class,
+                                                       @paginator_class)
+      @delete_resource_mixin = DeleteResourceMixin.new(api_request, path,
+                                                       object_item_class,
+                                                       @paginator_class)
+    end
+
+    # 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)
+      @change_resource_mixin.change(resource_id, data)
+    end
+
+    # Params:
+    # +resource_id+::id to request
+    def delete(resource_id)
+      @delete_resource_mixin.delete(resource_id)
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,37 @@
+module MC2P
+  # MC2P Error - class used to manage the exceptions related with mc2p library
+  class MC2PError < StandardError
+    attr_accessor :json_body
+    attr_accessor :resource
+    attr_accessor :resource_id
+
+    # Initializes an error
+    # Params:
+    # +message+:: Error type
+    # +json_body+:: Response from server
+    # +resource+:: Class resource used when the error raised
+    # +resource_id+:: Resource id requested when the error raised
+    def initialize(message = nil, json_body = nil,
+                   resource = nil, resource_id = nil)
+      super(message)
+
+      @_message = message
+      @json_body = json_body
+      @resource = resource
+      @resource_id = resource_id
+    end
+
+    # Returns: Error type and response
+    def to_s
+      "#{@_message} #{@json_body}"
+    end
+  end
+
+  # Invalid request error
+  class InvalidRequestError < MC2PError
+  end
+
+  # Bad use error
+  class BadUseError < MC2PError
+  end
+end

data/lib/mc2p.rb

@@ -0,0 +1,125 @@
+require 'unirest'
+
+require_relative 'errors'
+require_relative 'request'
+require_relative 'mixins'
+require_relative 'base'
+require_relative 'objects'
+require_relative 'resources'
+require_relative 'notification'
+
+module MC2P
+  VERSION = '0.1.2'
+
+  # MC2P - class used to manage the communication with MyChoice2Pay API
+  class MC2PClient
+    attr_accessor :api_request
+
+    attr_accessor :product_resource
+    attr_accessor :plan_resource
+    attr_accessor :tax_resource
+    attr_accessor :shipping_resource
+    attr_accessor :coupon_resource
+    attr_accessor :transaction_resource
+    attr_accessor :subscription_resource
+    attr_accessor :sale_resource
+    attr_accessor :currency_resource
+    attr_accessor :gateway_resource
+    attr_accessor :pay_data_resource
+
+    # 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
+    def initialize(key, secret_key)
+      @api_request = APIRequest.new(key, secret_key)
+
+      @product_resource = ProductResource.new(@api_request,
+                                              '/product/',
+                                              Product)
+      @plan_resource = PlanResource.new(@api_request,
+                                        '/plan/',
+                                        Plan)
+      @tax_resource = TaxResource.new(@api_request,
+                                      '/tax/',
+                                      Tax)
+      @shipping_resource = ShippingResource.new(@api_request,
+                                                '/shipping/',
+                                                Shipping)
+      @coupon_resource = CouponResource.new(@api_request,
+                                            '/coupon/',
+                                            Coupon)
+      @transaction_resource = TransactionResource.new(@api_request,
+                                                      '/transaction/',
+                                                      Transaction)
+      @subscription_resource = SubscriptionResource.new(@api_request,
+                                                        '/subscription/',
+                                                        Subscription)
+      @sale_resource = SaleResource.new(@api_request,
+                                        '/sale/',
+                                        Sale)
+      @currency_resource = CurrencyResource.new(@api_request,
+                                                '/currency/',
+                                                Currency)
+      @gateway_resource = GatewayResource.new(@api_request,
+                                              '/gateway/',
+                                              Gateway)
+      @pay_data_resource = PayDataResource.new(@api_request,
+                                               '/pay/',
+                                               PayData)
+    end
+
+    def _wrapper(cls, resource, data)
+      cls.new(data, resource)
+    end
+
+    def product(data)
+      _wrapper(Product, @product_resource, data)
+    end
+
+    def plan(data)
+      _wrapper(Plan, @plan_resource, data)
+    end
+
+    def tax(data)
+      _wrapper(Tax, @tax_resource, data)
+    end
+
+    def shipping(data)
+      _wrapper(Shipping, @shipping_resource, data)
+    end
+
+    def coupon(data)
+      _wrapper(Coupon, @coupon_resource, data)
+    end
+
+    def transaction(data)
+      _wrapper(Transaction, @transaction_resource, data)
+    end
+
+    def subscription(data)
+      _wrapper(Subscription, @subscription_resource, data)
+    end
+
+    def sale(data)
+      _wrapper(Sale, @sale_resource, data)
+    end
+
+    def currency(data)
+      _wrapper(Currency, @currency_resource, data)
+    end
+
+    def gateway(data)
+      _wrapper(Gateway, @gateway_resource, data)
+    end
+
+    def pay_data(data)
+      _wrapper(PayData, @pay_data_resource, data)
+    end
+
+    def notification_data(data)
+      NotificationData.new(data, self)
+    end
+  end
+end