multibanco_ifthenpay 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e648ad18b726f5416e960a14097eae8bcb3525a
+  data.tar.gz: a466c2092e532bb98ba9cd33ed4af537ca8d1660
+SHA512:
+  metadata.gz: 5d7f6425ac42d2644dd0336445e71721791aeda754747a46c7aa61ee42aa28a219d07c0da89301c929f921ea85793b420878d2a583da38c66a56b9425c1c70de
+  data.tar.gz: 2b6399c4a3e09153d0202d46403dec82b3a0c4d16872e3830af0f0396baa2aaedf07b528ac5699e6287595e46e9208f06f27a4b4ca3aae7156ab56bd3b717df4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rafaelcpalmeida@protonmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in multibanco_ifthenpay.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    multibanco_ifthenpay (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      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.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls
+  multibanco_ifthenpay!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rafael Almeida
+
+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,69 @@
+# Multibanco Ifthenpay Gem
+
+[![Gem Version](https://badge.fury.io/rb/multibanco_ifthenpay.svg)](https://badge.fury.io/rb/multibanco_ifthenpay)
+[![Build Status](https://travis-ci.org/rafaelcpalmeida/multibanco_ifthenpay.svg?branch=master)](https://travis-ci.org/rafaelcpalmeida/multibanco_ifthenpay)
+[![Coverage Status](https://coveralls.io/repos/github/rafaelcpalmeida/multibanco_ifthenpay/badge.svg?branch=master)](https://coveralls.io/github/rafaelcpalmeida/multibanco_ifthenpay?branch=master)
+
+Multibanco is a Portuguese payment method that allows the customer to pay by bank reference. This gem aims to provide a simple way to integrate Ifthenpay's multibanco gateway into your Ruby / Ruby on Rails projects.
+
+Ifthenpay is the provider of the service and a contract with this company is required. See more at [Ifthenpay](https://ifthenpay.com). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multibanco_ifthenpay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multibanco_ifthenpay
+
+## Usage
+After you sign a contract with [Ifthenpay](https://ifthenpay.com) all you have to do is create a new object using the provided entity and sub-entity, an order id and it's value.
+
+You can use the code as the example below:
+
+```ruby
+#!/usr/bin/ruby
+
+require 'multibanco_ifthenpay'
+
+multibanco = MultibancoIfthenpay::Multibanco.new('99999', '999', '1', 15)
+
+puts "Entity: #{multibanco.entity}"
+# Prettify parameter is optional. If you set it as false or omit it, it won't place a blank space between each 3 characters.
+puts "Sub-entity: #{multibanco.print_multibanco_reference(prettify: true)}"
+puts "Value: #{multibanco.order_value}€"
+```
+
+The result for the code above is:
+
+```
+Entity: 99999
+Sub-entity: 999 000 139
+Value: 15€
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rafaelcpalmeida/multibanco_ifthenpay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MultibancoIfthenpay project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rafaelcpalmeida/multibanco_ifthenpay/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multibanco_ifthenpay"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multibanco_ifthenpay/calculator.rb

@@ -0,0 +1,63 @@
+module MultibancoIfthenpay
+  # Multibanco reference calculation formula
+  class Calculator
+    CHK_ARRAY = [3, 30, 9, 90, 27, 76, 81, 34, 49, 5, 50, 15, 53, 45, 62, 38,
+                 89, 17, 73, 51].freeze
+
+    # @param [String] entity
+    # @param [String] sub_entity
+    # @param [String] order_id
+    # @param [Float] order_value
+    # @return [String]
+    def self.get_multibanco_reference(entity, sub_entity, order_id, order_value)
+      order_id = '0000000000' + order_id
+
+      order_value = format('%.2f', order_value)
+
+      chk_str = get_chk_string(entity, sub_entity, order_id, order_value)
+
+      chk_digits = get_chk_digits(chk_str)
+
+      chk_str[5, 3] + chk_str[8, 3] + chk_str[11, 1] + chk_digits
+    end
+
+    # @param [String] entity
+    # @param [String] sub_entity
+    # @param [String] order_id
+    # @param [Float] order_value
+    # @return [String]
+    def self.get_chk_string(entity, sub_entity, order_id, order_value)
+      chk_str = if sub_entity.length == 1
+                  # only the 6 order_id right most digits are going to be used
+                  entity + sub_entity + order_id[-6..-1] +
+                    format('%08.0f', (order_value.to_f * 100))
+                elsif sub_entity.length == 2
+                  # only the 5 order_id right most digits are going to be used
+                  entity + sub_entity + order_id[-5..-1] +
+                    format('%08.0f', (order_value.to_f * 100))
+                else
+                  entity + sub_entity + order_id[-4..-1] +
+                    format('%08.0f', (order_value.to_f * 100))
+                end
+
+      chk_str
+    end
+
+    # @param [String] chk_str
+    # @return [String]
+    def self.get_chk_digits(chk_str)
+      chk_val = 0
+
+      chk_array_size = CHK_ARRAY.length
+
+      CHK_ARRAY.each do |chk_item|
+        chk_val += (chk_str[chk_array_size - 1].to_i % 10) * chk_item
+        chk_array_size -= 1
+      end
+
+      chk_val %= 97
+
+      format('%02.0f', (98 - chk_val))
+    end
+  end
+end

data/lib/multibanco_ifthenpay/version.rb

@@ -0,0 +1,3 @@
+module MultibancoIfthenpay
+  VERSION = '1.1.1'.freeze
+end

data/lib/multibanco_ifthenpay.rb

@@ -0,0 +1,35 @@
+require 'multibanco_ifthenpay/version'
+require 'multibanco_ifthenpay/calculator'
+
+module MultibancoIfthenpay
+  # Multibanco reference generator using Ifthenpay gateway
+  class Multibanco
+    attr_reader :entity, :order_value
+
+    # @param [String] entity
+    # @param [String] sub_entity
+    # @param [String] order_id
+    # @param [Float] order_value
+    def initialize(entity, sub_entity, order_id, order_value)
+      raise ArgumentError, 'Not a valid entity' unless entity.length == 5
+      raise ArgumentError, 'Not a valid sub-entity' unless
+          !sub_entity.empty? && sub_entity.length < 4
+      raise ArgumentError, 'Not a valid order value' unless order_value >= 1
+
+      @entity = entity
+      @sub_entity = sub_entity
+      @order_id = order_id
+      @order_value = order_value
+    end
+
+    # @param [BooleanMatcher] prettify
+    # @return [String]
+    def print_multibanco_reference(prettify = false)
+      reference = MultibancoIfthenpay::Calculator
+                  .get_multibanco_reference(@entity, @sub_entity,
+                                            @order_id, @order_value)
+
+      prettify ? reference.scan(/.{3}/).join(' ') : reference
+    end
+  end
+end

data/multibanco_ifthenpay.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "multibanco_ifthenpay/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "multibanco_ifthenpay"
+  spec.version       = MultibancoIfthenpay::VERSION
+  spec.authors       = ["Rafael Almeida"]
+  spec.email         = ["rafaelcpalmeida@protonmail.com"]
+
+  spec.summary       = "This gem aims to provide a simple way to integrate Ifthenpay's multibanco gateway into your Ruby / Ruby on Rails projects."
+  spec.description   = "Multibanco is a Portuguese payment method that allows the customer to pay by bank reference. This gem aims to provide a simple way to integrate Ifthenpay's multibanco gateway into your Ruby / Ruby on Rails projects."
+  spec.homepage      = "https://github.com/rafaelcpalmeida/multibanco_ifthenpay"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: multibanco_ifthenpay
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Rafael Almeida
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Multibanco is a Portuguese payment method that allows the customer to
+  pay by bank reference. This gem aims to provide a simple way to integrate Ifthenpay's
+  multibanco gateway into your Ruby / Ruby on Rails projects.
+email:
+- rafaelcpalmeida@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multibanco_ifthenpay.rb
+- lib/multibanco_ifthenpay/calculator.rb
+- lib/multibanco_ifthenpay/version.rb
+- multibanco_ifthenpay.gemspec
+homepage: https://github.com/rafaelcpalmeida/multibanco_ifthenpay
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: This gem aims to provide a simple way to integrate Ifthenpay's multibanco
+  gateway into your Ruby / Ruby on Rails projects.
+test_files: []