liqpay 0.1.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb8c24034981cbb7c7ce37aac9f8bb24746b8e2f
+  data.tar.gz: 4a65b5598669d54294f98bd40dadd0acfda7d6ec
+SHA512:
+  metadata.gz: 44978d20a3d2e76a3e8af6c143a9f2b7cf12ef7a615cbb131fead7a56ad2f84747c9714d496161e32c6659f909b22cffaafcb9046b70758c173a95d22dd12f27
+  data.tar.gz: 1830483461086edb9144f5ecbaca1205e1746bd35879bb00ff7d19c8f97784a61eba06e7d0d9e8080964f128c89267e3d0927acc3c70575aad928ffc27fb4f81

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.0
+
+* Updated gem to be compatible with the new LiqPAY API
+
 ## 0.1.2
 
 * Fixed initializer syntax

data/README.md

@@ -1,47 +1,62 @@
 # LiqPAY
 
-This Ruby gem implements the [LiqPAY](http://liqpay.com) billing system.
+This Ruby gem implements the [LiqPAY](https://www.liqpay.com) billing system API, as described in [the LiqPAY documentation](https://www.liqpay.com/doc).
 
-As of now it only covers the [Liq&Buy 1.2 API](https://liqpay.com/?do=pages&p=cnb12), which is used to accept credit card payments on your site.
+**Users of version 0.1.2 and earlier:** your version of the gem uses the older, deprecated LiqPAY API; you should migrate to v1.0.0, but it requires you to change configuration and set up a server callback endpoint, so it's not a trivial upgrade.
+
+## Demo
+
+There is a demo app at http://liqpay-demo.herokuapp.com, source at https://github.com/leonid-shevtsov/liqpay_demo
 
 ## Installation
 
-Include the [liqpay gem](https://rubygems.org/gems/liqpay) in your app.
+Include the [liqpay gem](https://rubygems.org/gems/liqpay) in your `Gemfile`:
+
+```ruby
+gem 'liqpay', '~>1.0.0'
+```
+
+The gem requries at least Ruby 1.9.
 
 ## Configuration
 
-The recommended way is setting the `Liqpay.default_options` hash somewhere in
+You can provide all of the payment options in the request object, but the recommended way is setting the `Liqpay.default_options` hash somewhere in
 your initializers.
 
-You MUST supply the `merchant_id` and `merchant_signature` options, that are
-provided by LiqPAY when you sign up, on the [merchant details page](https://liqpay.com/?do=shop_access).
+You should supply the `public_key` and `private_key` options, that are
+provided by LiqPAY when you sign up and create a shop on the [shops page](https://www.liqpay.com/admin/business):
 
-## Processing payments through Liq&Buy
+```ruby
+# config/initializers/liqpay.rb
+Liqpay.default_options = {
+    public_key: ENV['LIQPAY_PUBLIC_KEY'],
+    private_key: ENV['LIQPAY_PRIVATE_KEY'],
+    currency: 'UAH'
+}
+```
+
+
+## Processing payments through LiqPay
 
 ### General flow
 
-1. User initiates the payment process; you redirect him to LiqPAY via POST, providing necessary parameters to set up the payment's amount and description
+1. User initiates the payment process; you redirect him to LiqPAY via a POST form, providing necessary parameters such as the payment's amount, order id and description.
 
 2. Users completes payment through LiqPAY.
 
-3. LiqPAY redirects the user to the URL you specified.
+3. LiqPAY redirects the user to the URL you specified with GET.
 
-4. You validate the response against your secret signature.
+4. You wait for a callback that LiqPAY will POST to your designated `server_url`.
 
 5. If the payment was successful: You process the payment on your side.
 
 6. If the payment was cancelled: You cancel the operation.
 
-So, LiqPAY is pretty simple, it does no server-to-server validation, just a
-browser-driven flow.
+The most recent version of the LiqPAY API *requires* you to have a serverside endpoint, which makes it impossible to test it with a local address.
 
 ### Implementation in Rails 
 
-0. Configure Liqpay:
-
-        # config/initializers/liqpay.rb
-        Liqpay.default_options[:merchant_id] = 'MY_MERCHANT_ID'
-        Liqpay.default_options[:merchant_signature] = 'MY_MERCHANT_SIGNATURE'
+0. Configure Liqpay
 
 1. Create a `Liqpay::Request` object
 
@@ -53,61 +68,70 @@ browser-driven flow.
     model (I suggest that you should), pass its ID. If not, it can be a random
     string stored in the session, or whatever, but *it must be unique*.
 
-        @liqpay_request = Liqpay::Request.new(
-          :amount => '999.99', 
-          :currency => 'UAH', 
-          :order_id => '123', 
-          :description => 'Some Product',
-          :result_url => liqpay_payment_url
-        )
+    ```ruby
+    @liqpay_request = Liqpay::Request.new(
+      amount: '999.99', 
+      currency: 'UAH', 
+      order_id: '123', 
+      description: 'Some Product',
+      result_url: order_url(@order),
+      server_url: liqpay_payment_url
+    )
+    ```
 
     **Note that this does not do anything permanent.** No saves to the database, no
     requests to LiqPAY.
     
-
-
 2. Put a payment button somewhere
 
     As you need to make a POST request, there is definitely going to be a form somewhere. 
 
     To output a form consisting of a single "Pay with LiqPAY" button, do
 
-        <%=liqpay_button @liqpay_request %>
+    ```erb
+    <%=liqpay_button @liqpay_request %>
+    ```
 
     Or:
 
-        <%=liqpay_button @liqpay_request, :title => "Pay now!" %>
+    ```erb
+    <%=liqpay_button @liqpay_request, title: "Pay now!" %>
+    ```
 
     Or:
 
-        <%=liqpay_button @liqpay_request do %>
-          <%=link_to 'Pay now!', '#', :onclick => 'document.forms[0].submit();' %>
-        <% end %>
+    ```erb
+    <%=liqpay_button @liqpay_request do %>
+      <%=link_to 'Pay now!', '#', onclick: 'document.forms[0].submit();' %>
+    <% end %>
+    ```
 
 3. Set up a receiving endpoint.
-       
-        # config/routes.rb
-        post '/liqpay_payment' => 'payments#liqpay_payment'
-
-        # app/controllers/payments_controller.rb
-        class PaymentsController < ApplicationController
-          # Skipping forgery protection here is important
-          protect_from_forgery :except => :liqpay_payment
-
-          def liqpay_payment
-            @liqpay_response = Liqpay::Response.new(params)
-
-            if @liqpay_response.success?
-              # check that order_id is valid
-              # check that amount matches
-              # handle success
-            else
-              # handle error
-            end
-          rescue Liqpay::InvalidResponse
-            # handle error
-          end
+
+    ```ruby       
+    # config/routes.rb
+    post '/liqpay_payment' => 'payments#liqpay_payment'
+
+    # app/controllers/payments_controller.rb
+    class PaymentsController < ApplicationController
+      # Skipping forgery protection here is important
+      protect_from_forgery :except => :liqpay_payment
+
+      def liqpay_payment
+        @liqpay_response = Liqpay::Response.new(params)
+
+        if @liqpay_response.success?
+          # check that order_id is valid
+          # check that amount matches
+          # handle success
+        else
+          # handle error
         end
+      rescue Liqpay::InvalidResponse
+        # handle error
+      end
+    end
+    ```
 
 That's about it.
 
@@ -119,4 +143,4 @@ That's about it.
 
 - - -
 
-2012 Leonid Shevtsov
+Ruby implementation (c) 2012-2014 Leonid Shevtsov

data/lib/liqpay.rb

@@ -5,9 +5,8 @@ require 'liqpay/response'
 require 'liqpay/railtie' if defined?(Rails)
 
 module Liqpay
-  LIQBUY_API_VERSION = '1.2'
-  LIQBUY_ENDPOINT_URL = 'https://www.liqpay.com/?do=clickNbuy'
-  SUPPORTED_CURRENCIES = %w(UAH USD EUR RUR)
+  LIQPAY_ENDPOINT_URL = 'https://www.liqpay.com/api/pay'
+  SUPPORTED_CURRENCIES = %w(UAH USD EUR RUB)
 
   @default_options = {}
   class << self; attr_accessor :default_options; end

data/lib/liqpay/base_operation.rb

@@ -3,22 +3,26 @@ require 'base64'
 
 module Liqpay
   class BaseOperation
-    attr_accessor :merchant_id, :merchant_signature
+    attr_accessor :public_key, :private_key
 
     def initialize(options={})
       options.replace(Liqpay.default_options.merge(options))
 
-      @merchant_id = options[:merchant_id]
-      @merchant_signature = options[:merchant_signature]
+      @public_key = options[:public_key]
+      @private_key = options[:private_key]
     end
 
     def signature
-      @signature ||= sign(xml, @merchant_signature)
+      @signature ||= sign(signature_fields)
+    end
+
+    def signature_fields
+      raise NotImplementedError
     end
 
   private
-    def sign(xml, signature)
-      Base64.encode64(Digest::SHA1.digest(signature + xml + signature)).strip
+    def sign(fields)
+      Base64.encode64(Digest::SHA1.digest(@private_key + fields.join(''))).strip
     end
   end
 end

data/lib/liqpay/liqpay_helper.rb

@@ -12,8 +12,11 @@ module Liqpay
     def liqpay_button(liqpay_request, options={}, &block)
       id = options.fetch(:id, 'liqpay_form')
       title = options.fetch(:title, 'Pay with LiqPAY')
-      content_tag(:form, :id => id, :action => Liqpay::LIQBUY_ENDPOINT_URL, :method => :post) do
-        result = hidden_field_tag(:operation_xml, liqpay_request.encoded_xml)+hidden_field_tag(:signature, liqpay_request.signature)
+      content_tag(:form, :id => id, :action => Liqpay::LIQPAY_ENDPOINT_URL, :method => :post) do
+        result = liqpay_request.form_fields.map{|name, value|
+          hidden_field_tag(name, value)
+        }.join("\n").html_safe
+        
         if block_given?
           result += yield
         else

data/lib/liqpay/request.rb

@@ -7,77 +7,56 @@ module Liqpay
     attr_accessor :amount
     # REQUIRED Currency of payment - one of `Liqpay::SUPPORTED_CURRENCIES`
     attr_accessor :currency
-    # REQUIRED Arbitrary but unique ID
+    # REQUIRED Description to be displayed to the user
+    attr_accessor :description
+    # RECOMMENDED Arbitrary but unique ID (May be REQUIRED by LiqPay configuration)
     attr_accessor :order_id
     # RECOMMENDED URL that the user will be redirected to after payment
     attr_accessor :result_url
     # RECOMMENDED URL that'll receive the order details in the background.
     attr_accessor :server_url
-    # RECOMMENDED Description to be displayed to the user
-    attr_accessor :description
-    # Phone number to be suggested to the user
-    #
-    # LiqPAY requires users to provide a phone number before payment.
-    # If you know the user's phone number, you can provide it so he
-    # doesn't have to enter it manually.
-    attr_accessor :default_phone
-    # Method of payment. One or more (comma-separated) of:
-    #   card - by card
-    #   liqpay - by liqpay account
-    attr_accessor :pay_way
-
-    attr_accessor :exp_time
-    attr_accessor :goods_id
+    # OPTIONAL type of payment = either `buy` (the default) or `donate`
+    attr_accessor :type
+    # OPTIONAL UI language - `ru` or `en`
+    attr_accessor :language
 
     def initialize(options={})
       super(options)
-      
-      @result_url = options[:result_url]
-      @server_url = options[:server_url]
-      @order_id = options[:order_id]
+
       @amount = options[:amount]
       @currency = options[:currency]
       @description = options[:description]
-      @default_phone = options[:default_phone]
-      @pay_way = options[:pay_way]
+      @order_id = options[:order_id]
+      @result_url = options[:result_url]
+      @server_url = options[:server_url]
+      @type = options[:type]
+      @language = options[:language]
       @kamikaze = options[:kamikaze]
     end
 
-    def encoded_xml
-      @encoded_xml ||= encode(xml)
-    end
-
-    def xml
-      @xml ||= make_xml
+    def signature_fields
+      [amount, currency, public_key, order_id, type, description, result_url, server_url]
     end
 
-
-  private
-    def encode(xml)
-      Base64.encode64(xml).gsub(/\s/,'')
-    end
-
-    def make_xml
+    def form_fields
       validate! unless @kamikaze
-      Nokogiri::XML::Builder.new { |xml|
-        xml.request {
-          xml.version Liqpay::LIQBUY_API_VERSION
-          xml.merchant_id merchant_id
-          xml.result_url result_url
-          xml.server_url server_url
-          xml.order_id order_id
-          xml.amount "%0.2f" % amount
-          xml.currency currency
-          xml.description description
-          xml.default_phone default_phone
-          xml.pay_way pay_way.is_a?(Array) ? pay_way.join(',') : pay_way
-        }
-      }.to_xml
+      {
+        public_key: public_key,
+        amount: amount,
+        currency: currency,
+        description: description,
+        order_id: order_id,
+        result_url: result_url,
+        server_url: server_url,
+        type: type,
+        signature: signature,
+        language: language
+      }.reject{|k,v| v.nil?}
     end
 
+  private
     def validate!
-
-      %w(merchant_id merchant_signature currency amount order_id).each do |required_field|
+      %w(public_key amount currency description).each do |required_field|
         raise Liqpay::Exception.new(required_field + ' is a required field') unless self.send(required_field).to_s != ''
       end
 
@@ -89,7 +68,7 @@ module Liqpay
         raise Liqpay::Exception.new('amount must be a number')
       end
 
-      raise Liqpay::Exception.new('goods_id must only contain digits') unless goods_id.to_s =~ /\A\d*\Z/
+      raise Liqpay::Exception.new('amount must be rounded to 2 decimal digits') unless self.amount.round(2) == self.amount
 
       raise Liqpay::Exception.new('amount must be more than 0.01') unless amount > 0.01
     end

data/lib/liqpay/response.rb

@@ -1,15 +1,12 @@
 require 'base64'
-require 'nokogiri'
 require 'liqpay/base_operation'
 
 module Liqpay
   class Response < BaseOperation
     SUCCESS_STATUSES = %w(success wait_secure)
 
-    attr_reader :encoded_xml, :signature, :xml
-
-    ATTRIBUTES = %w(merchant_id order_id amount currency description status code transaction_id pay_way sender_phone goods_id pays_count)
-    %w(merchant_id order_id description goods_id pays_count).each do |attr|
+    ATTRIBUTES = %w(public_key order_id amount currency description type status transaction_id sender_phone)
+    %w(public_key order_id description type).each do |attr|
       attr_reader attr
     end
 
@@ -22,20 +19,18 @@ module Liqpay
     #   success
     #   wait_secure - success, but the card wasn't known to the system 
     attr_reader :status
-    # Error code
-    attr_reader :code
     # LiqPAY's internal transaction ID
     attr_reader :transaction_id
-    # Chosen method of payment
-    attr_reader :pay_way
     # Payer's phone
     attr_reader :sender_phone
 
-    def initialize(options = {})
+    def initialize(params = {}, options = {})
       super(options)
 
-      @encoded_xml = options[:operation_xml]
-      @signature = options[:signature]
+      ATTRIBUTES.each do |attribute|
+        instance_variable_set "@#{attribute}", params[attribute]
+      end
+      @request_signature = params["signature"]
 
       decode!
     end
@@ -45,19 +40,15 @@ module Liqpay
       SUCCESS_STATUSES.include? self.status
     end
 
+    def signature_fields
+      [amount, currency, public_key, order_id, type, description, status, transaction_id, sender_phone]
+    end
+
   private
     def decode!
-      @xml = Base64.decode64(@encoded_xml)
-      
-      if sign(@xml, @merchant_signature) != @signature
+      if signature != @request_signature
         raise Liqpay::InvalidResponse
       end
-
-      doc = Nokogiri.XML(@xml)
-
-      ATTRIBUTES.each do |attr|
-        self.instance_variable_set('@'+attr, doc.at(attr).try(:content))
-      end
     end
   end
 end

data/lib/liqpay/version.rb

@@ -1,3 +1,3 @@
 module Liqpay
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/liqpay.gemspec

@@ -11,7 +11,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{LiqPAY billing API implementation in Ruby}
   s.description = %q{LiqPAY billing API implementation in Ruby}
 
-  s.add_dependency 'nokogiri'
   s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,38 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: liqpay
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &70239324845220 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70239324845220
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70239324844620 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70239324844620
 description: LiqPAY billing API implementation in Ruby
 email:
 - leonid@shevtsov.me
@@ -55,32 +46,25 @@ files:
 - liqpay.gemspec
 homepage: https://github.com/leonid-shevtsov/liqpay
 licenses: []
+metadata: {}
 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: 3679480104141870157
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3679480104141870157
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: LiqPAY billing API implementation in Ruby
 test_files: []