payment_gateway-mundipagg 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9620558567bbf299e2df403ee3c624a7e09f3722
-  data.tar.gz: bcc613c4e9f4e5b831a7511f984db740eb38c54e
+  metadata.gz: 282e280e42ca33cd04dc16ecd54c92bd88aa3d1d
+  data.tar.gz: e43e5e8a08db7256275d2c5290927599f063d61b
 SHA512:
-  metadata.gz: e1bad6ad97a8f75ce34ca3cdebd8567dcc8d5ff7250c85510eb658ea196740a6e2d84f716c236de79db81e04475b647da5704c1380b0b7427e7f03185e629f34
-  data.tar.gz: c271f04690c66dd2db93d5187de55a6bfe3cc0d5211c03a863170dbf1f60a5fb9d3092e0714fcaea45852645765cc3eca265d9e1b64e873e0fbfd19c1eb5d687
+  metadata.gz: 2bebf6534ccc25b43d5cb40d88bc70e2d3d1f1124d26cb9598818a445070ee90899e5ce5ae72d02839cd22f7a15633a8772a28ba3405f86bb58ebee17eb7e947
+  data.tar.gz: fde3534aaf6a0da779fb9af099fc7d6176f638d2411aadc33aba10dddc7be5e488e8c30ba517999081388a226e53ec48534bedd8c867d96a629898a9fba705a3

data/.gitignore

@@ -0,0 +1 @@
+.tool-versions

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 0.0.1 - 2018-01-24
+
+* Created first services for mundipagg
+
+### 0.0.2 - 2018-01-25
+
+* Fixed dependencies config in gemspec
+
+### 0.0.3 - 2018-01-25
+
+* Fixed gem packing

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    payment_gateway-mundipagg (0.0.3)
+      activesupport (>= 3.0)
+      credit_card_validations (~> 3.4)
+      http (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    credit_card_validations (3.4.0)
+      activemodel (>= 3, <= 6)
+      activesupport (>= 3, <= 6)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http (3.0.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.0.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    public_suffix (3.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  payment_gateway-mundipagg!
+  pry-byebug (~> 3.5)
+  rspec (~> 3.6)
+  webmock (~> 3.1)
+
+BUNDLED WITH
+   1.16.1

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Felipe G. Hespanhol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Payment Gateway - Mundipagg
+
+This library provides an easy integration with Mundipagg services in Ruby.
+
+## Installation
+
+### 1 - Include `gem "payment_gateway-mundipagg"` in your Gemfile.
+
+### 2 - Set your access key given by Mundipagg
+
+If your use Rails, create a file in initializer containing following code:
+
+```
+PaymentGateway::Mundipagg.configure do |config|
+  config.access_key = "your-access-key-here"
+end
+```
+Or else configure it manually.
+
+### 3 - Call the referred service module you want to use. E.g.:
+
+```
+require 'payment_gateway/mundipagg/plan'
+
+mundipagg_plan = PaymentGateway::Mundipagg::Plan.new
+mundipagg_plan.list # Lists all registered plans
+```
+
+## Available services at the moment
+
+All methods receives a hash as described in Mundipagg docs (https://docs.mundipagg.com/reference) and returns parsed gateway responses also as described in the docs in ruby Hash format.
+
+### Plan
+
+Methods:
+
+- list
+- create
+- destroy
+
+### Card
+
+- list
+- create
+- destroy
+
+### Customer
+
+- show
+- list
+- create
+
+### Subscription
+
+- list
+- create
+- create_from_plan
+- cancel
+
+### Order
+
+- list
+- create
+
+## License
+
+MIT License. Copyright 2017 Felipe G. Hespanhol

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/payment_gateway/mundipagg/base.rb

@@ -0,0 +1,35 @@
+require 'http'
+
+module PaymentGateway
+  module Mundipagg
+
+    class Base
+      class GatewayError < StandardError; end
+      class MissingAccessKeyError < StandardError; end
+
+      API_URL = 'https://api.mundipagg.com/core/v1'
+
+      def initialize
+        access_key = PaymentGateway::Mundipagg.configuration.access_key
+        raise MissingAccessKeyError if access_key.nil? || access_key.eql?('')
+      end
+
+      protected
+
+      def request(method, url, options={ headers: {}, body: {}, params: {} })
+        headers = { 'Content-Type' => 'application/json' }
+        headers.merge!(options[:headers]) unless options[:headers].nil?
+        response = HTTP.basic_auth(user: PaymentGateway::Mundipagg.configuration.access_key, pass: '').
+                        headers('Content-Type' => 'application/json').
+                        send(method, url, json: options[:body], params: options[:params])
+        if response.status.eql?(200)
+          response.parse.with_indifferent_access
+        else
+          error_message = "#{response.status} - #{response.parse['errors'] || response.parse['message']}"
+          raise GatewayError, error_message
+        end
+      end
+    end
+
+  end
+end

data/lib/payment_gateway/mundipagg/card.rb

@@ -0,0 +1,142 @@
+require 'credit_card_validations'
+
+module PaymentGateway
+  module Mundipagg
+    class Card < Base
+      class MissingCardDataAttributeError < StandardError; end
+      class InvalidCardNumberError < StandardError; end
+
+      attr_accessor :customer_id
+
+      def initialize(customer_id)
+        super()
+        raise "User customer_id cannot be blank" if customer_id.blank?
+        @customer_id = customer_id
+      end
+
+      def list
+        request(:get, mount_url)
+      end
+
+      def show(card_id)
+        request(:get, mount_url("/#{card_id}"))
+      end
+
+      def any?
+        list&.any?
+      end
+
+      ### Card data ###
+      #
+      # {
+      #   "number": "5425019448107793",
+      #   "holder_name": "Tony Stark",
+      # 	"holder_document": "93095135270",
+      #   "exp_month": 1,
+      #   "exp_year": 18,
+      #   "cvv": "351",
+      #   "billing_address": {
+      #     street: "Malibu Point",
+      #     "number": "10880",
+      #     "ZIP code": "90265",
+      #     "neighborhood": "Central Malibu",
+      #     "city": Malibu,
+      #     "state": "HERE",
+      #     "country": "US"
+      #   }
+      # }
+      def create(card_data)
+        validate_card_data(card_data)
+        request(:post, mount_url, body: card_request_body(card_data))
+      end
+
+      def destroy(credit_card_id)
+        if credit_card_id.blank?
+          raise "Credit card id cannot be blank"
+        end
+        response = request(:delete, mount_url("/#{credit_card_id}"))
+      end
+
+      def validate_card_data(card_data)
+        validate_card_data_attributes_presence(card_data)
+        validate_card_number((card_data[:number] || card_data['number']))
+        validate_card_exp_date(card_data)
+        validate_card_cvv((card_data[:cvv] || card_data['cvv']))
+      end
+
+      def validate_card_number(card_number)
+        unless CreditCardValidations::Detector.new(card_number).valid?
+          raise InvalidCardNumberError
+        end
+      end
+
+      def validate_card_exp_date(card_data)
+        exp_month = card_data[:exp_month] || card_data['exp_month']
+        exp_year  = card_data[:exp_year] || card_data['exp_year']
+        unless exp_month.is_a?(Integer) && exp_month.in?(1..12)
+          raise "Invalid card exp_month, use integer from 1 to 12"
+        end
+        unless exp_year.is_a?(Integer) && exp_year.in?(0..50)
+          raise "Invalid card exp_year, user integer from 0 to 50"
+        end
+      end
+
+      def validate_card_cvv(cvv)
+        raise "Invalid cvv" unless /^[0-9]{3,4}$/.match(cvv.to_s)
+      end
+
+      private
+
+      def mount_url(relative_path="")
+        "#{API_URL}/customers/#{@customer_id}/cards" + relative_path
+      end
+
+      def card_request_body(card_data)
+        card_data = card_data.with_indifferent_access
+        {
+          number:          card_data[:number],
+          holder_name:     card_data[:holder_name],
+          holder_document: card_data[:holder_document],
+          exp_month:       card_data[:exp_month],
+          exp_year:        card_data[:exp_year],
+          cvv:             card_data[:cvv],
+          options:         { verify_card: true }
+        }.tap { |body|
+          if card_data[:billing_address].present?
+            body[:billing_address] = parsed_billing_address(card_data)
+          end
+        }
+      end
+
+      def parsed_billing_address(card_data)
+        card_data = card_data.with_indifferent_access
+        billing_address = card_data[:billing_address]
+        {
+          street:       billing_address[:street],
+          number:       billing_address[:number],
+          zip_code:     billing_address[:zip_code],
+          neighborhood: billing_address[:neighborhood],
+          city:         billing_address[:city],
+          state:        billing_address[:state],
+          country:      billing_address[:country]
+        }
+      end
+
+      def validate_card_data_attributes_presence(card_data)
+        card_data = card_data.with_indifferent_access
+        [
+          :number,
+          :holder_name,
+          :holder_document,
+          :exp_month,
+          :exp_year,
+          :cvv
+        ].each do |key|
+          if card_data[key].blank?
+            raise MissingCardDataAttributeError, "Missing #{key} in card_data object"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/payment_gateway/mundipagg/customer.rb

@@ -0,0 +1,67 @@
+module PaymentGateway
+  module Mundipagg
+    class Customer < Base
+
+      def show(customer_id)
+        url = "#{API_URL}/customers/#{customer_id}"
+        request(:get, url)
+      end
+
+      def find(options)
+        list_url = "#{API_URL}/customers"
+        request(:get, list_url, params: options)
+      end
+
+      def list
+        list_url = "#{API_URL}/customers"
+        response = request(:get, list_url)
+        response.parse['data']
+      end
+
+      def any?
+        list&.any?
+      end
+
+      def create(customer_data)
+        creation_url = "#{API_URL}/customers"
+        request(:post, creation_url, body: create_customer_body(customer_data))
+      end
+
+      private
+
+      def create_customer_body(customer_data)
+        customer_data = customer_data.with_indifferent_access
+        {
+          name:     customer_data[:name],
+          email:    customer_data[:email],
+          type:     customer_data[:type] || 'individual',
+          document: customer_data[:document],
+          gender:   customer_data[:gender],
+          phones: {
+            home_phone: {
+              country_code: customer_data.dig(:phones, :home_phone, :country_code),
+              area_code:    customer_data.dig(:phones, :home_phone, :area_code),
+              number:       customer_data.dig(:phones, :home_phone, :number)
+            },
+            mobile_phone: {
+              country_code: customer_data.dig(:phones, :mobile_phone, :country_code),
+              area_code:    customer_data.dig(:phones, :mobile_phone, :area_code),
+              number:       customer_data.dig(:phones, :mobile_phone, :number)
+            }
+          },
+          address: {
+            street:       customer_data.dig(:address, :street),
+            number:       customer_data.dig(:address, :number),
+            complement:   customer_data.dig(:address, :complement),
+            zip_code:     customer_data.dig(:address, :zip_code),
+            neighborhood: customer_data.dig(:address, :neighborhood),
+            city:         customer_data.dig(:address, :city),
+            state:        customer_data.dig(:address, :state),
+            country:      customer_data.dig(:address, :country)
+          },
+          metadata: customer_data[:metadata] || {}
+        }
+      end
+    end
+  end
+end

data/lib/payment_gateway/mundipagg/order.rb

@@ -0,0 +1,23 @@
+module PaymentGateway
+  module Mundipagg
+
+    class Order < Base
+
+      def list
+        request(:get, mount_url)
+      end
+
+      def create(order_data)
+        request(:post, mount_url, body: order_data)
+      end
+
+      private
+
+      def mount_url(relative_path="")
+        "#{API_URL}/orders" + relative_path
+      end
+
+    end
+
+  end
+end

data/lib/payment_gateway/mundipagg/plan.rb

@@ -0,0 +1,56 @@
+module PaymentGateway
+  module Mundipagg
+
+    class Plan < Base
+
+      def list
+        list_url = "#{API_URL}/plans"
+        response = request(:get, list_url)
+        response
+      end
+
+      def any?
+        list&.any?
+      end
+
+      # {
+      #   "name"           => "Básico",
+      #   "currency"       => "BRL",
+      #   "interval"       => "month",
+      #   "interval_count" => 1,
+      #   "billing_type"   => "prepaid",
+      #   "items" => [
+      #     {
+      #       "name"     => "Assinatura",
+      #       "quantity" => 1,
+      #       "pricing_scheme" => {
+      #         # R$ 20,00
+      #         "price" => 2000
+      #       }
+      #     }
+      #   ],
+      #   "metadata" => {
+      #     "id" => "plano-basico"
+      #   }
+      # }
+      def create(plan_data)
+        validate_plan_data(plan_data)
+        creation_url = "#{API_URL}/plans"
+        request(:post, creation_url, body: plan_data)
+      end
+
+      def destroy(plan_id)
+        destruction_url = "#{API_URL}/plans/#{plan_id}"
+        request(:delete, destruction_url)
+      end
+
+      private
+
+      def validate_plan_data(plan_data)
+        raise "Plan data is missing name" if plan_data[:name].blank?
+      end
+
+    end
+
+  end
+end

data/lib/payment_gateway/mundipagg/subscription.rb

@@ -0,0 +1,56 @@
+module PaymentGateway
+  module Mundipagg
+
+    class Subscription < Base
+
+      def list(query_parameters={})
+        request(:get, mount_url, params: query_parameters)
+      end
+
+      def list_customer(customer_id, query_parameters={})
+        raise "Customer id cannot be blank" if customer_id.blank?
+        url = mount_url("?customer_id=#{customer_id}")
+        request(:get, url, params: query_parameters)
+      end
+
+      def create(subscription_data)
+        validate_credit_card_data(subscription_data)
+        request(:post, mount_url, body: subscription_data)
+      end
+
+      # plan_id and payment_method are required
+      def create_from_plan(subscription_data)
+        validate_plan_data(subscription_data)
+        validate_credit_card_data(subscription_data)
+        request(:post, mount_url, body: subscription_data)
+      end
+
+      def cancel(subscription_id)
+        url = mount_url("/#{subscription_id}")
+        request(:delete, url)
+      end
+      alias_method :destroy, :cancel
+
+      private
+
+      def mount_url(relative_path="")
+        "#{API_URL}/subscriptions" + relative_path
+      end
+
+      def validate_plan_data(subscription_data)
+        subscription_data = subscription_data.with_indifferent_access
+        raise "Missing plan_id in subscription data" if subscription_data[:plan_id].blank?
+      end
+
+      def validate_credit_card_data(subscription_data)
+        subscription_data = subscription_data.with_indifferent_access
+        if subscription_data[:payment_method].eql?('credit_card') &&
+            (subscription_data[:card].blank? && subscription_data[:card_id].blank?)
+          raise "Missing card data or card_id"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/payment_gateway/mundipagg.rb

@@ -0,0 +1,27 @@
+module PaymentGateway
+  module Mundipagg
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    class Configuration
+      attr_accessor :access_key
+
+      def initialize
+        @access_key = nil
+      end
+    end
+  end
+end

data/lib/payment_gateway-mundipagg.rb

@@ -0,0 +1,9 @@
+require 'active_support/all'
+
+require 'payment_gateway/mundipagg'
+require 'payment_gateway/mundipagg/base'
+require 'payment_gateway/mundipagg/plan'
+require 'payment_gateway/mundipagg/card'
+require 'payment_gateway/mundipagg/customer'
+require 'payment_gateway/mundipagg/subscription'
+require 'payment_gateway/mundipagg/order'

data/payment_gateway-mundipagg.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = "payment_gateway-mundipagg"
+  s.version     = "0.0.3"
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ["MIT"]
+  s.summary     = "Easy integration with Mundipagg payment gateway services"
+  s.email       = "felipeghespanhol@gmail.com"
+  s.homepage    = "https://github.com/felipehespanhol/payment_gateway-mundipagg"
+  s.description = "Easy integration with Mundipagg payment gateway services"
+  s.authors     = ['Felipe G. Hespanhol']
+
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split("\n")
+  s.required_ruby_version = '>= 2.3.4'
+
+  s.add_runtime_dependency("http", "~> 3.0")
+  s.add_runtime_dependency("activesupport", ">=3.0")
+  s.add_runtime_dependency("credit_card_validations", "~>3.4")
+
+  s.add_development_dependency("rspec", "~>3.6")
+  s.add_development_dependency("webmock", "~>3.1")
+  s.add_development_dependency("pry-byebug", "~>3.5")
+end

data/spec/payment_gateway/mundipagg/card_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe PaymentGateway::Mundipagg::Card do
+  describe '.initialize' do
+    include_examples 'access key needed', PaymentGateway::Mundipagg::Card, 1
+  end
+
+  before do
+    config_access_key
+  end
+
+  describe '#create' do
+    let(:customer_id)  { "cus_yoqONwOJI1IBNbjl" }
+    let(:url)          { "https://api.mundipagg.com/core/v1/customers/#{customer_id}/cards" }
+    let(:valid_params) { RequestMocks::Mundipagg::Card.create }
+
+    before do
+      stub_mundipagg_request(:card, :create, :post, url, valid_params)
+    end
+
+    it "requests mundipagg api with POST https://api.mundipagg.com/core/v1/customers/cus_yoqONwOJI1IBNbjl/cards " do
+      PaymentGateway::Mundipagg::Card.new(customer_id).create(valid_params)
+      expect(WebMock).to have_requested(:post, url).with(body: valid_params)
+    end
+    
+  end
+end