trust_pay_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcbb1d0f7e318548f2839f8cbeb9618d138c2b5f
+  data.tar.gz: 8d19b3935f8de119068e6e8f8bcdb2212607c3f8
+SHA512:
+  metadata.gz: 373acf59ec1430047bbf6e1740d8198f1f20f659a3093f6a5ec12ba2efd1cf19a32e45a41366003bf4d761ab05e73281c93bdbaecaf1481ffcc8a4e812c4f149
+  data.tar.gz: 139aa1beb5aeda7d5fd646559037229a84d683ea575dc4021789eb0841fbb269efe6583d3c66f79122540af8f638c6067bb0bdb4a97b3ed785bb157ec8382aab

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trust_pay_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michal Olah
+
+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,88 @@
+# TrustPayRails
+
+A simple implementation of the [Trustpay](http://www.trustpay.eu/)
+payment platform to integrate into Rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trust_pay_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trust_pay_rails
+
+## Usage
+
+To configure the gem you can provide the following environment
+variables:
+
+``` bash
+TRUSTPAY_ENV - [testing|production|fake_bank_url] select an environment
+TRUSTPAY_KEY - your identifier received after registering with Trustpay
+TRUSTPAY_KEY - your key received after registering with TrustPay
+```
+
+You can also configure the gem with an initializer:
+
+``` ruby
+TrustPayRails.environment = (ENV['TRUSTPAY_ENV'] || :testing).to_sym
+TrustPayRails.aid = ENV['TRUSTPAY_AID']
+TrustPayRails.key = ENV['TRUSTPAY_KEY']
+```
+
+After configuring the gem you can create a TrustPay form using one of
+the provided view helpers.
+
+``` erb
+<%= trust_pay_form(amt: '123.45',
+                   cur: 'EUR',
+                   ref: '1234567890',
+                   rurl: trust_pay_return_url,
+                   curl: trust_pay_cancel_url,
+                   eurl: trust_pay_error_url,
+                   nurl: trust_pay_notification_url,
+                   dsc: 'a description no longer than 200 chars',
+                   lng: I18n.locale)
+%>
+
+
+<%= trust_pay_card_form(amt: '123.45',
+                        cur: 'EUR',
+                        ref: '1234567890',
+                        rurl: trust_pay_return_url,
+                        curl: trust_pay_cancel_url,
+                        eurl: trust_pay_error_url,
+                        nurl: trust_pay_notification_url,
+                        dsc: 'a description no longer than 200 chars',
+                        lng: I18n.locale)
+%>
+```
+
+To generate the TrustPay notification urls use the provided generator:
+
+``` bash
+rails g trust_pay_rails:routes
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/trust_pay_rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trust_pay_rails"
+
+# 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

data/bin/setup

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

data/lib/generators/trust_pay_rails/routes_generator.rb

@@ -0,0 +1,19 @@
+module TrustPayRails
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_routes
+        route "get '/trust_pay/notification' => 'trust_pay#notification', as: :trust_pay_notification"
+        route "get '/trust_pay/return' => 'trust_pay#return', as: :trust_pay_return"
+        route "get '/trust_pay/cancel' => 'trust_pay#cancel', as: :trust_pay_cancel"
+        route "get '/trust_pay/error' => 'trust_pay#error', as: :trust_pay_error"
+      end
+
+      def generate_controller
+        copy_file "trust_pay_controller.rb", "app/controllers/trust_pay_controller.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/trust_pay_rails/templates/trust_pay_controller.rb

@@ -0,0 +1,33 @@
+class TrustPayController < ApplicationController
+
+  def notification
+    if TrustPayRails::Signature.signature_match?(trust_pay_params)
+      # TODO: store payment
+      head :ok
+    else
+      head :unprocessable_entity
+    end
+  end
+
+  def return
+    # TODO: process user return
+
+    redirect_to root_url, notice: [t('.flash_message')]
+  end
+
+  def cancel
+    redirect_to root_url, notice: [t('.flash_message')]
+  end
+
+  def error
+    # TODO: process error
+
+    redirect_to root_url, notice: [t('.flash_message')]
+  end
+
+  private
+
+  def trust_pay_params
+    @trust_pay_params ||= Hash[params.map{|k, v| [k.downcase.to_sym, v]}]
+  end
+end

data/lib/trust_pay_rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'trust_pay_rails/view_helpers'
+
+module TrustPayRails
+  class Railtie < Rails::Railtie
+    initializer "trust_pay_rails.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/trust_pay_rails/signature.rb

@@ -0,0 +1,38 @@
+require 'openssl'
+require 'active_support/core_ext/hash/slice'
+
+module TrustPayRails
+  class Signature
+    def self.sign(data={})
+      new(TrustPayRails.key).sign(data)
+    end
+
+    def self.signature_match?(data)
+      new(TrustPayRails.key).signature_match?(data)
+    end
+
+    def initialize(key)
+      @key = key
+    end
+
+    # FIXME: use ruby 2.1 required arguments when we switch
+    def sign(data={})
+      hmac_sha_256(@key, data.slice(:aid, :typ, :amt, :cur, :ref, :res, :tid, :oid, :tss).values.join).upcase
+    end
+
+    def signature_match?(data={})
+      sign(data) == data[:sig]
+    end
+
+    private
+
+    def hmac_sha_256(key, data)
+      unpack_hex_string(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, data))
+    end
+
+    def unpack_hex_string(data)
+      data.unpack("H*").first
+    end
+  end
+end
+

data/lib/trust_pay_rails/version.rb

@@ -0,0 +1,3 @@
+module TrustPayRails
+  VERSION = "0.1.0"
+end

data/lib/trust_pay_rails/view_helpers.rb

@@ -0,0 +1,34 @@
+module TrustPayRails
+  module ViewHelpers
+
+    def trust_pay_form(attributes={})
+      form_tag TrustPayRails.bank_transfer_url do
+        form_elements = trust_pay_form_elements(attributes)
+        form_elements << submit_tag('Pay with bank transfer')
+
+        form_elements.join.html_safe
+      end
+    end
+
+    def trust_pay_card_form(attributes={})
+      form_tag TrustPayRails.card_transfer_url do
+        form_elements = trust_pay_form_elements(attributes)
+        form_elements << submit_tag('Pay with card')
+
+        form_elements.join.html_safe
+      end
+    end
+
+    private
+
+    def trust_pay_form_elements(attributes={})
+      form_elements = attributes.merge!(aid: TrustPayRails.aid).map do |name, value|
+        hidden_field_tag name, value
+      end
+      form_elements << hidden_field_tag(:sig, TrustPayRails::Signature.sign(attributes))
+
+      form_elements
+    end
+
+  end
+end

data/lib/trust_pay_rails.rb

@@ -0,0 +1,37 @@
+require "trust_pay_rails/version"
+require "trust_pay_rails/signature"
+
+require 'trust_pay_rails/railtie' if defined?(Rails)
+
+module TrustPayRails
+  @environment = (ENV['TRUSTPAY_ENV'] || :testing).to_sym
+  @aid = ENV['TRUSTPAY_AID']
+  @key = ENV['TRUSTPAY_KEY']
+  class << self
+    attr_accessor :environment, :fake_bank_url, :fake_card_url, :aid, :key
+  end
+
+  def self.bank_transfer_url
+    case @environment
+    when :testing
+      'https://test.trustpay.eu/mapi/pay.aspx'
+    when :production
+      'https://ib.trustpay.eu/mapi/pay.aspx'
+    when :fake
+      @fake_bank_url
+    end
+  end
+
+  def self.card_transfer_url
+    case @environment
+    when :testing
+      # this won't actually work because trustpay does not offec car payment
+      # testing.
+      'https://test.trustpay.eu/mapi/cardpayments.aspx'
+    when :production
+      'https://ib.trustpay.eu/mapi/cardpayments.aspx'
+    when :fake
+      @fake_card_url
+    end
+  end
+end

data/trust_pay_rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trust_pay_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trust_pay_rails"
+  spec.version       = TrustPayRails::VERSION
+  spec.authors       = ["Michal Olah"]
+  spec.email         = ["olahmichal@gmail.com"]
+
+  spec.summary       = %q{A Ruby client to the TrustPay payment platform.}
+  spec.homepage      = "https://github.com/Learn2Codesk/trust_pay_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails"
+
+  spec.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: trust_pay_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Olah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- olahmichal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/trust_pay_rails/routes_generator.rb
+- lib/generators/trust_pay_rails/templates/trust_pay_controller.rb
+- lib/trust_pay_rails.rb
+- lib/trust_pay_rails/railtie.rb
+- lib/trust_pay_rails/signature.rb
+- lib/trust_pay_rails/version.rb
+- lib/trust_pay_rails/view_helpers.rb
+- trust_pay_rails.gemspec
+homepage: https://github.com/Learn2Codesk/trust_pay_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client to the TrustPay payment platform.
+test_files: []