khipu-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Helper khipu_button that generates a form with hidden inputs and a single image input according to Khipu's documentation.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Klaus Hott Vidal
+
+MIT License
+
+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,86 @@
+# KhipuRails
+
+[Khipu](https://khipu.com/home) is a service that facilitates web billing and collection in Chile.
+It handles very elegantly bank transfers and allows to generate bills in batches.
+It offers an API for developers to create via POST new charges.
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+```ruby
+gem 'khipu-rails'
+```
+
+Create an initializer with the following code.
+```ruby
+KhipuRails::Config.user_id = ID
+KhipuRails::Config.api_key = API KEY
+```
+
+*ID and API KEY can be found [here](https://khipu.com/merchant/profile#instant-notification-data)*
+
+# Features
+
+## Creating a button for a single bill
+
+This gem provides a helper to build a button using the right parameters provided in the [API documentation](https://khipu.com/page/api#creacion-formulario).
+
+### khipu_button
+**khipu_button subject, amount, options = {}**
+
+Params:
+* **subject**: The subject of the bill. *(max 255 chars)*
+* **amount**: Amount to charge.
+
+Options:
+* **:body**: Further description of the charge.
+* **:return_url**: callback URL to specify to the browser once the payment is comlpeted.
+* **:cancel_url**: callback URL to specify to the browser if the user decides not to proceed with the transaction.
+* **:transaction_id**: additional identifier related to the transaction.
+* **:payer_email**: The email of the payer. If this is set, Khipu will pre-fill this field in the payment page.
+* **:picture_url**: The URL of the product or service related to this charge.
+* **:custom**: Additional information related to this charge such as shipment instructions.
+* **:button_image**: Identifier of the button to display. If you designed your own button you can also provide the URL. *(It defaults to __"50x25"__ when __nil__ given)*
+* **:receiver_id**: You can specify a receiver if you don't want to use the data stored in the **KhipuRails::Config.user_id** variable.
+* **:secret**: You can specify a secret if you don't want to use the data stored in the **KhipuRails::Config.api_key** variable.
+
+**[Button Images provided by Khipu](https://khipu.com/page/botones-de-pago)**
+
+**50x25**: ![50x25 Button](https://s3.amazonaws.com/static.khipu.com/buttons/50x25.png)
+
+**100x25**: ![100x25 Button](https://s3.amazonaws.com/static.khipu.com/buttons/100x25.png)
+
+**100x50**: ![100x50 Button](https://s3.amazonaws.com/static.khipu.com/buttons/100x50.png)
+
+**150x25**: ![150x25 Button](https://s3.amazonaws.com/static.khipu.com/buttons/150x25.png)
+
+**150x50**: ![150x50 Button](https://s3.amazonaws.com/static.khipu.com/buttons/150x50.png)
+
+**150x75**: ![150x75 Button](https://s3.amazonaws.com/static.khipu.com/buttons/150x75.png)
+
+**150x75-B**: ![150x75-B Button](https://s3.amazonaws.com/static.khipu.com/buttons/150x75-B.png)
+
+**200x50**: ![200x50 Button](https://s3.amazonaws.com/static.khipu.com/buttons/200x50.png)
+
+**200x75**: ![200x75 Button](https://s3.amazonaws.com/static.khipu.com/buttons/200x75.png)
+
+# TODO:
+
+## Validation of payment notifications
+
+If you provide an URL for Khipu to deliver [notifications](https://khipu.com/page/api#notification-instantanea) on succesfull payments, this gem provides a validation method to prevent forgery of notifications.
+
+### khipu_validation
+
+**khipu_validation params, local_validation = false**
+
+* **params**: The POST params delivered by Khipu.
+* **local_validation**: Wether the validation should be done at the [local machine](https://khipu.com/page/api#validacion-local) or by [Khipu's API](https://khipu.com/page/api#validacion-web-service).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/khipu-rails.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'khipu_rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "khipu-rails"
+  gem.version       = KhipuRails::VERSION
+  gem.authors       = ["Klaus Hott Vidal"]
+  gem.email         = ["klahott@gmail.com"]
+  gem.description   = %q{This gem provides a rails wrapper for the khipu api.}
+  gem.summary       = %q{This gem provides a rails wrapper for the khipu api.}
+  gem.homepage      = %q{https://github.com/janther/khipu-rails}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rails", "~> 3.1.10"
+
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "nokogiri"
+  gem.add_development_dependency "capybara", "~> 1.1.2"
+end

data/lib/khipu-rails.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require "khipu_rails"
+require "khipu_rails/version"
+require "khipu_rails/config"
+require "khipu_rails/button_helper"
+
+ActionView::Base.send :include, KhipuRails::ButtonHelper

data/lib/khipu_rails.rb

@@ -0,0 +1,2 @@
+module KhipuRails
+end

data/lib/khipu_rails/button_helper.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+module KhipuRails
+  module ButtonHelper
+    def khipu_button subject, amount, options = {}
+      options.reverse_merge! body:           '',
+                             return_url:     '',
+                             cancel_url:     '',
+                             transaction_id: '',
+                             payer_email:    '',
+                             picture_url:    '',
+                             custom:         '',
+                             button_image:   '50x25',                    #Default Button Image
+                             receiver_id:    KhipuRails::Config.user_id, #Loads user id from configuration
+                             secret:         KhipuRails::Config.api_key  #Loads api key from configuration
+
+      options[:subject] = subject #Adds the subject param to the options for khipu_hash
+      options[:amount]  = amount  #Adds the amount param to the options for khipu_hash
+
+      button_image = KhipuRails::Config.khipu_images()[options[:button_image]] || options[:button_image]
+
+      form_tag 'https://khipu.com/payment/api/createPaymentPage', authenticity_token: false do
+        [].tap do |i|
+          i << hidden_field_tag(:receiver_id, options[:receiver_id])
+          i << hidden_field_tag(:subject, subject)
+          i << hidden_field_tag(:body, options[:body])
+          i << hidden_field_tag(:amount, amount)
+          i << hidden_field_tag(:return_url, options[:return_url])
+          i << hidden_field_tag(:cancel_url, options[:cancel_url])
+          i << hidden_field_tag(:custom, options[:custom])
+          i << hidden_field_tag(:transaction_id, options[:transaction_id])
+          i << hidden_field_tag(:payer_email, options[:payer_email])
+          i << hidden_field_tag(:picture_url, options[:picture_url])
+          i << hidden_field_tag(:hash, khipu_hash(options))
+          i << image_submit_tag(button_image, name: :submit)
+        end.join.html_safe
+      end
+    end
+
+    private
+    def khipu_hash options = {}
+      raw = [
+        "receiver_id=#{options[:receiver_id]}",
+        "subject=#{options[:subject]}",
+        "body=#{options[:body]}",
+        "amount=#{options[:amount]}",
+        "return_url=#{options[:return_url]}",
+        "cancel_url=#{options[:cancel_url]}",
+        "custom=#{options[:custom]}",
+        "transaction_id=#{options[:transaction_id]}",
+        "picture_url=#{options[:picture_url]}",
+        "payer_email=#{options[:payer_email]}",
+        "secret=#{options[:secret]}"
+      ].join('&')
+      Digest::SHA1.hexdigest raw
+    end
+  end
+end

data/lib/khipu_rails/config.rb

@@ -0,0 +1,33 @@
+module KhipuRails
+  class Config
+    def self.khipu_images
+      {
+        "50x25"    => "https://s3.amazonaws.com/static.khipu.com/buttons/50x25.png",
+        "100x25"   => "https://s3.amazonaws.com/static.khipu.com/buttons/100x25.png",
+        "100x50"   => "https://s3.amazonaws.com/static.khipu.com/buttons/100x50.png",
+        "150x25"   => "https://s3.amazonaws.com/static.khipu.com/buttons/150x25.png",
+        "150x50"   => "https://s3.amazonaws.com/static.khipu.com/buttons/150x50.png",
+        "150x75"   => "https://s3.amazonaws.com/static.khipu.com/buttons/150x75.png",
+        "150x75-B" => "https://s3.amazonaws.com/static.khipu.com/buttons/150x75.png",
+        "200x50"   => "https://s3.amazonaws.com/static.khipu.com/buttons/200x50.png",
+        "200x75"   => "https://s3.amazonaws.com/static.khipu.com/buttons/200x75.png"
+      }
+    end
+
+    def self.user_id= value
+      @@user_id = value
+    end
+
+    def self.api_key= value
+      @@api_key = value
+    end
+
+    def self.user_id
+      @@user_id
+    end
+
+    def self.api_key
+      @@api_key
+    end
+  end
+end

data/lib/khipu_rails/version.rb

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

data/spec/khipu_rails/khipu_helpers_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe KhipuRails::ButtonHelper do
+  before :all do
+    @view = ActionView::Base.new
+  end
+
+  it "generates a form with the action provided by khipu" do
+    button = Nokogiri::HTML.parse(@view.khipu_button "minimal", 2000)
+    form = button.css('form')
+    form.attribute('action').value.should == 'https://khipu.com/payment/api/createPaymentPage'
+  end
+
+  it "generates a form with the method post" do
+    button = Nokogiri::HTML.parse(@view.khipu_button "minimal", 2000)
+    form = button.css('form')
+    form.attribute('method').value.should == 'post'
+  end
+
+  context "given a form with minimal data was correctly generated, it" do
+    before :all do
+      @receiver_id = KhipuRails::Config.user_id
+      @secret = KhipuRails::Config.api_key
+      @button = Nokogiri::HTML.parse(@view.khipu_button "minimal", 2000)
+    end
+
+    it "has an input called reciever_id" do
+      input = @button.css('form input[name=receiver_id]')
+      input.attribute('value').value.to_i.should == @receiver_id
+    end
+
+    it "has an input called subject" do
+      input = @button.css('form input[name=subject]')
+      input.attribute('value').value.should == 'minimal'
+    end
+
+    it "has an input called body" do
+      input = @button.css('form input[name=body]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called amount" do
+      input = @button.css('form input[name=amount]')
+      input.attribute('value').value.should == '2000'
+    end
+
+    it "has an input called return_url" do
+      input = @button.css('form input[name=return_url]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called cancel_url" do
+      input = @button.css('form input[name=cancel_url]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called transaction_id" do
+      input = @button.css('form input[name=transaction_id]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called custom" do
+      input = @button.css('form input[name=custom]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called payer_email" do
+      input = @button.css('form input[name=payer_email]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called picture_url" do
+      input = @button.css('form input[name=picture_url]')
+      input.attribute('value').value.should == ''
+    end
+
+    it "has an input called hash" do
+      input = @button.css('form input[name=hash]')
+      input.attribute('type').value.should == 'hidden'
+      def get_value attribute
+        @button.css("form input[name=#{attribute}]").attribute('value').value
+      end
+      raw = "receiver_id=#{get_value :receiver_id}&"
+      raw += "subject=#{get_value :subject}&"
+      raw += "body=#{get_value :body}&"
+      raw += "amount=#{get_value :amount}&"
+      raw += "return_url=#{get_value :return_url}&"
+      raw += "cancel_url=#{get_value :cancel_url}&"
+      raw += "custom=#{get_value :custom}&"
+      raw += "transaction_id=#{get_value :transaction_id}&"
+      raw += "picture_url=#{get_value :picture_url}&"
+      raw += "payer_email=#{get_value :payer_email}&"
+      raw += "secret=#{@secret}"
+      input.attribute('value').value.should == Digest::SHA1.hexdigest(raw)
+    end
+
+    it "has an image submit" do
+      input = @button.css('form input[name=submit]')
+      input.attribute('type').value.should == 'image'
+      input.attribute('src').value.should == 'https://s3.amazonaws.com/static.khipu.com/buttons/50x25.png'
+    end
+  end
+end

data/spec/khipu_rails_spec.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe KhipuRails do
+  it "adds the khipu_button helper to the view" do
+    ActionView::Base.method_defined?(:khipu_button).should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] ||= 'test'
+
+require "action_view/railtie"
+require "nokogiri"
+require 'khipu-rails'
+
+KhipuRails::Config.user_id = 1234
+KhipuRails::Config.api_key = '1234567890asdfghjkl'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: khipu-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Klaus Hott Vidal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.10
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: This gem provides a rails wrapper for the khipu api.
+email:
+- klahott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- khipu-rails.gemspec
+- lib/khipu-rails.rb
+- lib/khipu_rails.rb
+- lib/khipu_rails/button_helper.rb
+- lib/khipu_rails/config.rb
+- lib/khipu_rails/version.rb
+- spec/khipu_rails/khipu_helpers_spec.rb
+- spec/khipu_rails_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/janther/khipu-rails
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem provides a rails wrapper for the khipu api.
+test_files:
+- spec/khipu_rails/khipu_helpers_spec.rb
+- spec/khipu_rails_spec.rb
+- spec/spec_helper.rb