RubyGems - openpayu - Versions diffs - 0.0.2 - Mend

openpayu 0.0.2

Files changed (102) hide show

checksums.yaml +15 -0
data/.gitignore +18 -0
data/.rspec +3 -0
data/.rubocop.yml +45 -0
data/.ruby-gemset +1 -0
data/.ruby-version +1 -0
data/.travis.yml +10 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +193 -0
data/Rakefile +1 -0
data/doc/EmptyResponseError.html +123 -0
data/doc/HttpStatusException.html +123 -0
data/doc/NotImplementedException.html +123 -0
data/doc/OpenPayU.html +436 -0
data/doc/OpenPayU/Configuration.html +1530 -0
data/doc/OpenPayU/Connection.html +381 -0
data/doc/OpenPayU/Document.html +705 -0
data/doc/OpenPayU/Documents.html +117 -0
data/doc/OpenPayU/Documents/Request.html +503 -0
data/doc/OpenPayU/Documents/Response.html +783 -0
data/doc/OpenPayU/Models.html +117 -0
data/doc/OpenPayU/Models/Address.html +861 -0
data/doc/OpenPayU/Models/Buyer.html +587 -0
data/doc/OpenPayU/Models/Buyer/Delivery.html +312 -0
data/doc/OpenPayU/Models/Card.html +507 -0
data/doc/OpenPayU/Models/Fee.html +367 -0
data/doc/OpenPayU/Models/Model.html +1208 -0
data/doc/OpenPayU/Models/NotifyResponse.html +297 -0
data/doc/OpenPayU/Models/Order.html +1155 -0
data/doc/OpenPayU/Models/PayMethod.html +507 -0
data/doc/OpenPayU/Models/Product.html +787 -0
data/doc/OpenPayU/Models/Refund.html +1020 -0
data/doc/OpenPayU/Models/ShippingMethod.html +367 -0
data/doc/OpenPayU/Models/StatusUpdate.html +647 -0
data/doc/OpenPayU/Models/Token.html +507 -0
data/doc/OpenPayU/Order.html +924 -0
data/doc/OpenPayU/Refund.html +269 -0
data/doc/OpenPayU/Token.html +288 -0
data/doc/OpenPayU/XmlBuilder.html +277 -0
data/doc/WrongConfigurationError.html +123 -0
data/doc/WrongNotifyRequest.html +123 -0
data/doc/WrongOrderParameters.html +267 -0
data/doc/WrongSignatureException.html +123 -0
data/doc/_index.html +446 -0
data/doc/class_list.html +54 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +338 -0
data/doc/file.README.html +281 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +26 -0
data/doc/index.html +281 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +178 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1007 -0
data/doc/top-level-namespace.html +114 -0
data/lib/openpayu.rb +66 -0
data/lib/openpayu/configuration.rb +62 -0
data/lib/openpayu/connection.rb +65 -0
data/lib/openpayu/document.rb +105 -0
data/lib/openpayu/documents/request.rb +34 -0
data/lib/openpayu/documents/response.rb +48 -0
data/lib/openpayu/exceptions.rb +19 -0
data/lib/openpayu/models/address.rb +12 -0
data/lib/openpayu/models/buyer.rb +11 -0
data/lib/openpayu/models/buyer/delivery.rb +7 -0
data/lib/openpayu/models/buyer/invoice.rb +8 -0
data/lib/openpayu/models/card.rb +10 -0
data/lib/openpayu/models/fee.rb +9 -0
data/lib/openpayu/models/model.rb +151 -0
data/lib/openpayu/models/notify_response.rb +9 -0
data/lib/openpayu/models/order.rb +28 -0
data/lib/openpayu/models/pay_method.rb +10 -0
data/lib/openpayu/models/product.rb +10 -0
data/lib/openpayu/models/refund.rb +41 -0
data/lib/openpayu/models/shipping_method.rb +9 -0
data/lib/openpayu/models/status_update.rb +14 -0
data/lib/openpayu/models/token.rb +10 -0
data/lib/openpayu/order.rb +119 -0
data/lib/openpayu/refund.rb +26 -0
data/lib/openpayu/token.rb +27 -0
data/lib/openpayu/version.rb +4 -0
data/lib/openpayu/xml_builder.rb +23 -0
data/lib/openpayu_ruby.rb +2 -0
data/openpayu_ruby.gemspec +40 -0
data/spec/cassettes/cancel_order.yml +50 -0
data/spec/cassettes/create_order.yml +51 -0
data/spec/cassettes/refund_order.yml +100 -0
data/spec/cassettes/retrieve_order.yml +51 -0
data/spec/cassettes/update_order.yml +50 -0
data/spec/integration/order_spec.rb +103 -0
data/spec/openpayu.yml +11 -0
data/spec/spec_helper.rb +27 -0
data/spec/test_objects/order.rb +97 -0
data/spec/unit/configuration_spec.rb +71 -0
data/spec/unit/document_spec.rb +18 -0
data/spec/unit/models/order_spec.rb +82 -0
data/spec/unit/models/refund_spec.rb +24 -0
data/spec/unit/openpayu_spec.rb +27 -0
metadata +327 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,114 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.2
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="OpenPayU.html" title="OpenPayU (module)">OpenPayU</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="EmptyResponseError.html" title="EmptyResponseError (class)">EmptyResponseError</a></span>, <span class='object_link'><a href="HttpStatusException.html" title="HttpStatusException (class)">HttpStatusException</a></span>, <span class='object_link'><a href="NotImplementedException.html" title="NotImplementedException (class)">NotImplementedException</a></span>, <span class='object_link'><a href="WrongConfigurationError.html" title="WrongConfigurationError (class)">WrongConfigurationError</a></span>, <span class='object_link'><a href="WrongNotifyRequest.html" title="WrongNotifyRequest (class)">WrongNotifyRequest</a></span>, <span class='object_link'><a href="WrongOrderParameters.html" title="WrongOrderParameters (class)">WrongOrderParameters</a></span>, <span class='object_link'><a href="WrongSignatureException.html" title="WrongSignatureException (class)">WrongSignatureException</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Tue Dec 17 15:20:58 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.2 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/openpayu.rb ADDED Viewed

@@ -0,0 +1,66 @@
+# -*- encoding : utf-8 -*-
+require_relative 'openpayu/xml_builder'
+require_relative 'openpayu/version'
+require_relative 'openpayu/configuration'
+require_relative 'openpayu/connection'
+require_relative 'openpayu/exceptions'
+require_relative 'openpayu/order'
+require_relative 'openpayu/refund'
+require_relative 'openpayu/token'
+require_relative 'openpayu/document'
+require_relative 'openpayu/models/model'
+require_relative 'openpayu/models/order'
+require_relative 'openpayu/documents/request'
+require_relative 'openpayu/documents/response'
+require_relative 'openpayu/models/address'
+require_relative 'openpayu/models/buyer'
+require_relative 'openpayu/models/buyer/delivery'
+require_relative 'openpayu/models/buyer/invoice'
+require_relative 'openpayu/models/card'
+require_relative 'openpayu/models/fee'
+require_relative 'openpayu/models/token'
+require_relative 'openpayu/models/pay_method'
+require_relative 'openpayu/models/product'
+require_relative 'openpayu/models/shipping_method'
+require_relative 'openpayu/models/refund'
+require_relative 'openpayu/models/status_update'
+require_relative 'openpayu/models/notify_response'
+module OpenPayU
+  # Generate a signature for signing form sent directly to PayU
+  #
+  # @param [Hash] form_fields Hash with all form fields with values
+  # @param [String] signature_key defaults to Configuration.signature_key
+  # @param [String] algorithm defaults to OpenPayU::Configuration.algorithm
+  # @param [String] merchant_pos_id defaults to Configuration.merchant_pos_id
+  # @return [String] Signature that should be inserted to field
+  #   with name "OpenPayu-Signature"
+  def self.sign_form(form_fields, key = nil, algorithm = nil, pos_id = nil)
+    sorted_values = form_fields.sort.map { |array| array[1] }.join
+    Document.new.generate_signature_structure(
+      sorted_values,
+      algorithm || Configuration.algorithm,
+      pos_id || Configuration.merchant_pos_id,
+      key || Configuration.signature_key
+    )
+  end
+  # Generate a form body for hosted order
+  #
+  # @param [Hash] order Hash
+  # @return [String] A full form containign an order
+  def self.hosted_order_form(order)
+    @order = Models::Order.new(order)
+    render_hash = @order.to_flatten_hash
+    html_form = "<form method='post' " +
+      "action='#{Configuration.get_base_url}order'>\n"
+    render_hash.each do |key, value|
+      html_form << "<input type='hidden' name='#{key}' value='#{value}' />\n"
+    end
+    html_form << "<input type='hidden' name='OpenPayu-Signature'
+      value='#{sign_form(render_hash)}' />
+        <button type='submit' formtarget='_blank' />\n</form>"
+  end
+end

data/lib/openpayu/configuration.rb ADDED Viewed

@@ -0,0 +1,62 @@
+# -*- encoding : utf-8 -*-
+require 'singleton'
+module OpenPayU
+  class Configuration
+    include Singleton
+    class << self
+      attr_accessor :env, :merchant_pos_id, :pos_auth_key, :client_id,
+        :client_secret, :signature_key, :service_domain, :country, :data_format,
+          :algorithm, :protocol, :order_url, :notify_url, :continue_url
+      def configure(file_path = nil)
+        set_defaults
+        if block_given?
+          yield self
+        else
+          file = File.open(file_path) if file_path && File.exists?(file_path)
+          env = defined?(Rails) ? Rails.env : ENV['RACK_ENV']
+          config = YAML.load(file)[env]
+          if config.present?
+            config.each_pair do |key, value|
+              send("#{key}=", value)
+            end
+          end
+        end
+        valid?
+      end
+      def set_defaults
+        @service_domain = 'payu.com'
+        @env    = 'sandbox'
+        @country = 'pl'
+        @algorithm = 'MD5'
+      end
+      def required_parameters
+        [:merchant_pos_id, :signature_key]
+      end
+      def valid?
+        required_parameters.each do |parameter|
+          if send(parameter).nil? || send(parameter).blank?
+            raise WrongConfigurationError, "Parameter #{parameter} is invalid."
+          end
+        end
+        true
+      end
+      def get_base_url
+        "#{@protocol}://#{@env}.#{@service_domain}/api/v2/"
+      end
+      def use_ssl?
+        @protocol == 'https'
+      end
+    end
+  end
+end

data/lib/openpayu/connection.rb ADDED Viewed

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+require 'net/http'
+require 'net/https'
+require 'uri'
+module OpenPayU
+  class Connection
+    def self.post(url, data, headers)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if OpenPayU::Configuration.use_ssl?
+      request = Net::HTTP::Post.new(uri.path)
+      request.body = data
+      request['Content-Type'] =
+        "application/#{OpenPayU::Configuration.data_format}"
+      request['OpenPayu-Signature'] = headers['OpenPayu-Signature']
+      response = http.request(request)
+      { response: response, request: request }
+    end
+    def self.put(url, data, headers)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if OpenPayU::Configuration.use_ssl?
+      request = Net::HTTP::Put.new(uri.path)
+      request.body = data
+      request['Content-Type'] =
+        "application/#{OpenPayU::Configuration.data_format}"
+      request['OpenPayu-Signature'] = headers['OpenPayu-Signature']
+      response = http.request(request)
+      { response: response, request: request }
+    end
+    def self.get(url, data, headers)
+      common_connection(url, data, headers, 'GET')
+    end
+    def self.delete(url, data, headers)
+      common_connection(url, data, headers, 'DELETE')
+    end
+    private
+    def self.common_connection(url, data, headers, method)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if OpenPayU::Configuration.use_ssl?
+      request =
+        if method == 'DELETE'
+          Net::HTTP::Delete.new(uri.request_uri, headers)
+        else
+          Net::HTTP::Get.new(uri.request_uri, headers)
+        end
+      request['Content-Type'] =
+        "application/#{OpenPayU::Configuration.data_format}"
+      request['OpenPayu-Signature'] = headers['OpenPayu-Signature']
+      response = http.request(request)
+      { response: response, request: request }
+    end
+  end
+end

data/lib/openpayu/document.rb ADDED Viewed

@@ -0,0 +1,105 @@
+# -*- encoding : utf-8 -*-
+require 'digest'
+module OpenPayU
+  class Document
+    def generate_signature_structure(data, algorithm, pos_id = '', key = '')
+      if key.empty?
+        raise WrongConfigurationError,
+              'Merchant Signature Key (signature_key)
+              should not be null or empty.'
+      end
+      raise WrongConfigurationError,
+            'Merchant Pos Id (merchant_pos_id) should
+            not be null or empty.' if pos_id.blank?
+      signature = generate_signature(data, algorithm, key)
+      "sender=#{pos_id};signature=#{signature};algorithm=#{algorithm}"
+    end
+    def generate_signature(data, algorithm, signature_key)
+      data = data + signature_key.to_s
+      if algorithm == 'MD5'
+        signature = Digest::MD5.hexdigest(data)
+      elsif %w(SHA SHA1 SHA-1).include? algorithm
+        signature = Digest::SHA1.hexdigest data
+      elsif %w(SHA-256 SHA256 SHA_256).include? algorithm
+        signature = Digest::SHA256.hexdigest data
+      else
+        signature = ''
+      end
+      signature
+    end
+    def verify_response
+      unless @response
+        raise EmptyResponseError,
+              "Got empty response from request: #{@request.try(:body)}"
+      end
+      if (@message_name == 'OrderNotifyRequest' ||
+          %w(200 201 422 302).include?(response.code)) &&
+          verify_signature(@body)
+        true
+      else
+        raise HttpStatusException,
+              "Invalid HTTP response code (#{@response.code}).
+              Response body: #{@body}."
+      end
+    end
+    def verify_signature(message)
+      signature = parse_signature
+      generated_signature = generate_signature(
+        message,
+        signature['algorithm'],
+        OpenPayU::Configuration.signature_key
+      )
+      if generated_signature == signature['signature']
+        true
+      else
+        raise WrongSignatureException,
+              "Invalid signature: Got message signed with:
+              #{signature["signature"]}. Generated signature:
+              #{generated_signature}"
+      end
+    end
+    def parse_signature
+      parameters = {}
+      get_signature.split(';').each do |parameter|
+        k, v = parameter.split('=')
+        parameters[k] = v
+      end
+      parameters
+    end
+    def get_signature
+      @response['X-OpenPayU-Signature'] ||
+      @response['x-openpayu-signature'] ||
+      @response['openpayu-signature'] ||
+      @response.headers['x-openpayu-signature'] ||
+      @response.headers['openpayu-signature']
+    end
+    def underscore_keys(hash)
+      deep_transform_keys(hash) { |key| key.underscore }
+    end
+    def deep_transform_keys(hash, &block)
+      result = {}
+      hash.each do |key, value|
+        result[yield(key)] =
+          if value.is_a?(Hash)
+            deep_transform_keys(value, &block)
+          else
+            value
+          end
+      end
+      result
+    end
+  end
+end

data/lib/openpayu/documents/request.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+module OpenPayU
+  module Documents
+    class Request < Document
+      attr_accessor :headers, :body
+      def initialize(data)
+        @body = data
+        set_headers
+      end
+      def set_headers
+        @headers = {
+          'OpenPayu-Signature' => generate_signature_structure(
+              @body,
+              OpenPayU::Configuration.algorithm,
+              OpenPayU::Configuration.merchant_pos_id,
+              OpenPayU::Configuration.signature_key
+            ),
+          'openpayu-signature' => generate_signature_structure(
+              @body,
+              OpenPayU::Configuration.algorithm,
+              OpenPayU::Configuration.merchant_pos_id,
+              OpenPayU::Configuration.signature_key
+            )
+        }
+      end
+      def [](header_name)
+        @headers[header_name]
+      end
+    end
+  end
+end