dotpay 0.0.1

data/README.rdoc

@@ -0,0 +1,44 @@
+= dotpay.pl gem
+
+{<img src="https://travis-ci.org/friendlyfashion/dotpay.png" />}[https://travis-ci.org/friendlyfashion/dotpay]
+
+== Description
+
+dotpay.pl gem provides tools for working with http://dotpay.pl online payments system
+
+== How to use
+
+Start by configuring Dotpay:
+
+  Dotpay.configure do |config|
+    config.account_id           = 1234
+    config.pin                  = 'your URLC pin here'
+  end
+
+== Authorizing URLC callback
+
+Sample URLC callback handling action.
+
+  def callback
+    response = Dotpay::Response.new(params)
+
+    if response.authorized?
+      if response.status_done?
+        # process your order
+      end
+
+      render :text => 'OK', :layout => false
+    else
+      render :text => 'ERROR', :layout => false
+    end
+  end
+
+== Cancelling transaction using cancel API
+
+You can cancel existing transaction:
+
+  Dotpay.cancel_transaction(t_id, amount, control)
+
+Also you can do partial refund:
+
+  Dotpay.cancel_transaction(t_id, amount, control, type: 2)

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/dotpay.rb

@@ -0,0 +1,50 @@
+require "dotpay/version"
+require "dotpay/configuration"
+require "dotpay/error"
+require "dotpay/response"
+require "dotpay/client"
+require "dotpay/cancel_request"
+
+module Dotpay
+  class << self
+    attr_writer :configuration
+
+    ##
+    # Used to configure Dotpay.
+    #
+    # = Example
+    #
+    #   Dotpay.configure do |config|
+    #     config.account_id            = 0000
+    #     config.pin                   = 'aaaabbbbccccdddd'
+    #     config.cancel_login          = 'cancelapilogin'
+    #     config.cancel_password       = 'cancelapipassword'
+    #   end
+    def configure
+      yield(configuration)
+    end
+
+    ##
+    # The configuration object.
+    # Recommended to use Dotpay.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Cancel transaction
+    def cancel_transaction(t_id, amount, control, options = {})
+      cancel_request = CancelRequest.new(t_id, amount, control, options)
+
+      client.cancel_transaction(cancel_request)
+    end
+
+    private
+
+    ##
+    # Dotpay Client.
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+  end
+end

data/lib/dotpay/cancel_request.rb

@@ -0,0 +1,42 @@
+require 'digest/md5'
+
+module Dotpay
+  class CancelRequest
+    attr_reader :t_id, :amount, :control, :type
+
+    TYPE_FULL = 1
+    TYPE_PARTIAL = 2
+
+    def initialize(t_id, amount, control, options = {})
+      options = {
+        type: TYPE_FULL
+      }.merge(options)
+
+      @t_id = t_id
+      @amount = "%0.2f" % amount
+      @control = control
+      @type = options[:type]
+    end
+
+    def checksum
+      calculate_checksum
+    end
+
+    private
+
+    def calculate_checksum
+      data = [ Dotpay.configuration.cancel_login,
+               Dotpay.configuration.pin,
+               type,
+               Dotpay.configuration.account_id,
+               t_id,
+               amount,
+               control ]
+
+      data_string = data.join(':')
+
+      Digest::MD5.hexdigest(data_string)
+    end
+
+  end
+end

data/lib/dotpay/client.rb

@@ -0,0 +1,44 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+module Dotpay
+  class Client
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def cancel_transaction(cancel_request)
+      params = {
+        id:       @configuration.account_id,
+        t_id:     cancel_request.t_id,
+        control:  cancel_request.control,
+        amount:   cancel_request.amount,
+        type:     cancel_request.type,
+        login:    @configuration.cancel_login,
+        passwd:   @configuration.cancel_password,
+        md5:      cancel_request.checksum
+      }
+
+      response = post(@configuration.cancel_endpoint, params)
+
+      raise Error.new(response.body) unless response.body.strip == "OK"
+
+      return true
+    end
+
+    private
+
+    def post(url, params)
+      uri = URI.parse(url)
+
+      https = Net::HTTP.new(uri.host,uri.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data(params)
+
+      https.request(request)
+    end
+  end
+end

data/lib/dotpay/configuration.rb

@@ -0,0 +1,54 @@
+module Dotpay
+  class Configuration
+    # Account ID in Dotpay system, for which payment is made (Seller's account ID)
+    attr_accessor :account_id
+
+    # URLC PIN
+    # 16-character alphanumeric string defined in section: Settings → URLC parameters
+    attr_accessor :pin
+
+    # Language
+    #
+    # Defaults to :pl
+    #
+    # :pl → Polish
+    # :en → English
+    # :de → German
+    # :it → Italian
+    # :fr → French
+    # :es → Spanish
+    # :cz → Czech
+    # :ru → Russian
+    # :bg → Bulgarian
+    attr_accessor :language
+
+    # service hostname
+    attr_accessor :endpoint
+
+    # provider's email
+    attr_accessor :email
+
+    # Cancel API endpoint
+    attr_accessor :cancel_endpoint
+
+    # Cancel API login
+    attr_accessor :cancel_login
+
+    # Cancel API password
+    attr_accessor :cancel_password
+
+    def initialize
+      @language = :pl
+      @endpoint = 'https://ssl.dotpay.pl/'
+      @cancel_endpoint = 'https://ssl.dotpay.pl/api/cancel/'
+    end
+
+    ##
+    # Allows config options to be read like a hash
+    #
+    # option: Key for a given attribute
+    def [](option)
+      send(option)
+    end
+  end
+end

data/lib/dotpay/error.rb

@@ -0,0 +1,4 @@
+module Dotpay
+  class Error < ::StandardError
+  end
+end

data/lib/dotpay/response.rb

@@ -0,0 +1,72 @@
+require 'digest/md5'
+
+module Dotpay
+  class Response
+    CHECKSUM_KEYS = %w(id control t_id amount email service code username password t_status)
+
+    STATUS_NEW          = 1
+    STATUS_DONE         = 2
+    STATUS_REJECTED     = 3
+    STATUS_REFUND       = 4
+    STATUS_COMPLAINT    = 5
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def t_id
+      params['t_id']
+    end
+
+    def control
+      params['control']
+    end
+
+    def amount
+      params['amount']
+    end
+
+    def authorized?
+      params['md5'] == calculate_checksum
+    end
+
+    def status
+      params['t_status'].to_i
+    end
+
+    def status_new?
+      status == STATUS_NEW
+    end
+
+    def status_done?
+      status == STATUS_DONE
+    end
+
+    def status_rejected?
+      status == STATUS_REJECTED
+    end
+
+    def status_refund?
+      status == STATUS_REFUND
+    end
+
+    def status_complaint?
+      status == STATUS_COMPLAINT
+    end
+
+    private
+
+    def calculate_checksum
+      data = [ Dotpay.configuration.pin ]
+
+      CHECKSUM_KEYS.each { |key| data << params[key] }
+
+      data_string = data.join(':')
+
+      Digest::MD5.hexdigest(data_string)
+    end
+
+  end
+end

data/lib/dotpay/version.rb

@@ -0,0 +1,3 @@
+module Dotpay
+  VERSION = "0.0.1"
+end

data/spec/cancel_request_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Dotpay::CancelRequest do
+  before :each do
+    Dotpay.configure do |config|
+      config.account_id             = 1234
+      config.pin                    = 'testtesttesttest'
+      config.cancel_login           = 'testlogin'
+      config.cancel_password        = 'testpass'
+    end
+  end
+
+  describe ".new" do
+    let(:t_id) { "TST01" }
+    let(:amount) { "1.00" }
+    let(:control) { "ABCD" }
+
+    subject { Dotpay::CancelRequest.new(t_id, amount, control) }
+
+    its(:t_id) { should == t_id }
+    its(:amount) { should == amount }
+    its(:control) { should == control }
+    its(:type) { should == Dotpay::CancelRequest::TYPE_FULL }
+    its(:checksum) { should == "5f6b85d31fa19ee60db2e2bcc9c595f6" }
+  end
+end

data/spec/dotpay_pl_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Dotpay do
+  before :each do
+    Dotpay.configure do |config|
+      config.account_id             = 1234
+      config.pin                    = 'testtesttesttest'
+      config.cancel_login           = 'testlogin'
+      config.cancel_password        = 'testpass'
+    end
+  end
+
+  it "should have defaults" do
+    Dotpay.configuration.endpoint.should == 'https://ssl.dotpay.pl/'
+    Dotpay.configuration.cancel_endpoint.should == 'https://ssl.dotpay.pl/api/cancel/'
+    Dotpay.configuration.language.should == :pl
+  end
+
+  describe "#configure" do
+    it "should allow configuring" do
+      Dotpay.configuration.account_id.should        == 1234
+      Dotpay.configuration.pin.should               == 'testtesttesttest'
+      Dotpay.configuration.cancel_login.should      == 'testlogin'
+      Dotpay.configuration.cancel_password.should   == 'testpass'
+    end
+  end
+
+  describe "#cancel_transaction" do
+    subject { Dotpay.cancel_transaction("TX01", 1.00, 'ABC') }
+
+    context "successful" do
+      before do
+        stub_request(:post, "https://ssl.dotpay.pl/api/cancel/").
+          with(:body => {
+          "amount"=>"1.00",
+          "control"=>"ABC",
+          "id"=>"1234",
+          "login"=>"testlogin",
+          "md5"=>"e077b995f4e592ce5b9a428df2d009bf",
+          "passwd"=>"testpass",
+          "t_id"=>"TX01",
+          "type"=>"1"}
+        ).to_return(:status => 200, :body => "OK", :headers => {})
+      end
+
+      it { should be_true }
+    end
+
+    context "error" do
+      before do
+        stub_request(:post, "https://ssl.dotpay.pl/api/cancel/").
+          with(:body => {
+          "amount"=>"1.00",
+          "control"=>"ABC",
+          "id"=>"1234",
+          "login"=>"testlogin",
+          "md5"=>"e077b995f4e592ce5b9a428df2d009bf",
+          "passwd"=>"testpass",
+          "t_id"=>"TX01",
+          "type"=>"1"}
+        ).to_return(:status => 200, :body => "err01", :headers => {})
+      end
+
+      specify do
+        expect { subject }.to raise_error(Dotpay::Error)
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe Dotpay::Response do
+  before :each do
+    Dotpay.configure do |config|
+      config.account_id             = 1234
+      config.pin                    = 'testtesttesttest'
+    end
+  end
+
+  describe "#authorized?" do
+    let(:params) do
+      { "status"=>"FAIL",
+        "control"=>"5DA5L8F5",
+        "amount"=>"1.00",
+        "id"=>"66548",
+        "transaction_id"=>"66548-TST55",
+        "t_id"=>"66548-TST55",
+        "t_date"=>"2013-02-13 16:23:43",
+        "o_id"=>"66548-ZTST55",
+        "email"=>"test@email.com",
+        "t_status"=>"3",
+        "description"=>"Uzsakymo 5DA5L8F5 apmokejimas",
+        "version"=>"1.4",
+        "orginal_amount"=>"1.00 PLN",
+        "channel"=>"20",
+        "md5"=>"a4d146472f99f123d0960732dcfd4be8"}
+    end
+
+    let(:response) { Dotpay::Response.new(params) }
+
+    subject { response.authorized? }
+
+    it { should be_true }
+
+    context "invalid pin" do
+      before { Dotpay.configuration.stub(:pin).and_return('badpin') }
+      it { should be_false }
+    end
+  end
+
+  describe "#status_done?" do
+    let(:params) do
+      { "status"=>"OK",
+        "control"=>"5DA5L8F5",
+        "amount"=>"1.00",
+        "id"=>"66548",
+        "transaction_id"=>"66548-TST55",
+        "t_id"=>"66548-TST55",
+        "t_date"=>"2013-02-13 16:23:43",
+        "o_id"=>"66548-ZTST55",
+        "email"=>"test@email.com",
+        "t_status"=>"2",
+        "description"=>"Uzsakymo 5DA5L8F5 apmokejimas",
+        "version"=>"1.4",
+        "orginal_amount"=>"1.00 PLN",
+        "channel"=>"20",
+        "md5"=>"a4d146472f99f123d0960732dcfd4be8"}
+    end
+
+    let(:response) { Dotpay::Response.new(params) }
+
+    subject { response.status_done? }
+
+    it { should be_true }
+
+    context "not done" do
+      let(:params) do
+        { "status"=>"FAIL",
+          "control"=>"5DA5L8F5",
+          "amount"=>"1.00",
+          "id"=>"66548",
+          "transaction_id"=>"66548-TST55",
+          "t_id"=>"66548-TST55",
+          "t_date"=>"2013-02-13 16:23:43",
+          "o_id"=>"66548-ZTST55",
+          "email"=>"test@email.com",
+          "t_status"=>"3",
+          "description"=>"Uzsakymo 5DA5L8F5 apmokejimas",
+          "version"=>"1.4",
+          "orginal_amount"=>"1.00 PLN",
+          "channel"=>"20",
+          "md5"=>"a4d146472f99f123d0960732dcfd4be8"}
+      end
+
+      it { should be_false }
+    end
+
+    describe "#status_rejected?" do
+      let(:params) do
+        { "status"=>"FAIL",
+          "control"=>"5DA5L8F5",
+          "amount"=>"1.00",
+          "id"=>"66548",
+          "transaction_id"=>"66548-TST55",
+          "t_id"=>"66548-TST55",
+          "t_date"=>"2013-02-13 16:23:43",
+          "o_id"=>"66548-ZTST55",
+          "email"=>"test@email.com",
+          "t_status"=>"3",
+          "description"=>"Uzsakymo 5DA5L8F5 apmokejimas",
+          "version"=>"1.4",
+          "orginal_amount"=>"1.00 PLN",
+          "channel"=>"20",
+          "md5"=>"a4d146472f99f123d0960732dcfd4be8"}
+      end
+
+      let(:response) { Dotpay::Response.new(params) }
+
+      subject { response.status_rejected? }
+
+      it { should be_true }
+
+      context "not rejected" do
+        let(:params) do
+          { "status"=>"OK",
+            "control"=>"5DA5L8F5",
+            "amount"=>"1.00",
+            "id"=>"66548",
+            "transaction_id"=>"66548-TST55",
+            "t_id"=>"66548-TST55",
+            "t_date"=>"2013-02-13 16:23:43",
+            "o_id"=>"66548-ZTST55",
+            "email"=>"test@email.com",
+            "t_status"=>"2",
+            "description"=>"Uzsakymo 5DA5L8F5 apmokejimas",
+            "version"=>"1.4",
+            "orginal_amount"=>"1.00 PLN",
+            "channel"=>"20",
+            "md5"=>"a4d146472f99f123d0960732dcfd4be8"}
+        end
+
+        it { should be_false }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start
+end
+
+require 'rubygems'
+require 'bundler/setup'
+require 'dotpay'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dotpay
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Laurynas Butkus
+- Mindaugas Mozuras
+- Tomas Varaneckas
+- Andrius Janauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies: []
+description: Online payments using dotpay.pl
+email:
+- laurynas.butkus@gmail.com
+- mindaugas.mozuras@gmail.com
+- tomas.varaneckas@gmail.com
+- andrius.janauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dotpay/cancel_request.rb
+- lib/dotpay/client.rb
+- lib/dotpay/configuration.rb
+- lib/dotpay/error.rb
+- lib/dotpay/response.rb
+- lib/dotpay/version.rb
+- lib/dotpay.rb
+- Rakefile
+- README.rdoc
+- spec/cancel_request_spec.rb
+- spec/dotpay_pl_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/friendlyfashion/dotpay
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1359324167960202671
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1359324167960202671
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: dotpay gem
+test_files:
+- spec/cancel_request_spec.rb
+- spec/dotpay_pl_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb