vivapayments 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWNkNWQ2ZTZjOGU0NDI1MzllZTU5YjcxMzUxOTQ4NjI4MjY1MGVlNA==
+  data.tar.gz: !binary |-
+    YzllOWY3YzllZDEyNTcwMzEwZmVkNmM5M2FkNTk5YTZmNTUzZmRkNg==
+SHA512:
+  metadata.gz: !binary |-
+    MDJkYjM3MzkzYjllZTZmZGJmMTIwMDQ5NjA0YWEzMWMyM2Q3ZTc1YzhkZjA4
+    ZThmZjkxMzFjYjdiN2ZmYTFmM2UwMjY4YTUyYzExYzcwYmU5ZjcwNGVhODgx
+    ZTgwYzBjYTRjNmVlZjQ0NTBjMzlmODAzNTliMjFiYzMzMGJjMDI=
+  data.tar.gz: !binary |-
+    ZjYwODg3YjQxMGJjYWZiZDYxNDc3ZWFhOTBlMGUxYTFhNDlhOTBiYjlkZmY1
+    MDU4ZWE3ZDUzZTk0NDY5NThlYmRlNWFmMTJkYjhhY2Q5NDk2NjQwMmJiM2My
+    ZmE2OWFiOTc4NzgyZTYyZjRmNmE1OTc1ZDUxNGNjZDA4ODg2NzM=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    vivapayments (0.0.1)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec
+  vivapayments!

data/README.md

@@ -0,0 +1,67 @@
+# Vivapayments
+
+Wrapper gem for the Vivapayments API. At the moment it supports creating an
+order, deleting an order and getting the redirect URL to complete a
+transaction.
+
+
+## Installation
+
+### As part of a Gemfile in a Ruby application
+
+Add this line to your application's Gemfile:
+
+    gem 'vivapayments'
+
+And then execute:
+
+    $ bundle install
+  
+### Install the Gem individually
+
+    $ gem install vivapayments
+
+## Usage
+
+Set up config (for example in `initializers/vivapayments.rb`):
+
+    Vivapayments.configure do |config|
+      config.merchant_id = "your_merchant_id"
+      config.api_key = "your_api_key"
+      config.demo = true # true or false
+    end
+
+Creating an order:
+
+    order = Vivapayments::Order.new(:Amount => 100)
+    order.create
+
+Getting the redirect_url:
+
+    order.redirect_url
+
+Deleting an order (given that you have an id already):
+
+    order.delete
+
+Or if you want to give an existing id:
+
+    order = Vivapayments::Order.new
+    order.id = 12345
+    order.delete
+
+You can pass all the params that are mentioned in the documentation:
+[https://github.com/VivaPayments/API/wiki/Optional-Parameters](https://github.com/VivaPayments/API/wiki/Optional-Parameters)
+
+For more information on the documentation visit:
+[https://github.com/VivaPayments/API/wiki](https://github.com/VivaPayments/API/wiki)
+
+
+## Tests
+
+    MERCHANT_ID=your_merchant_id API_KEY=your_api_key rspec
+
+At the moment it doesn't check the type of the variable for each parameter.
+The API silently fails or ignores incorrect parameters, so be sure to check the
+ documentation about the correct input.
+

data/lib/vivapayments.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'json'
+
+require_relative "vivapayments/version"
+require_relative "vivapayments/configuration"
+require_relative "vivapayments/order"
+
+module Vivapayments
+  attr_reader :configuration
+
+  def self.configure(&block)
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/vivapayments/configuration.rb

@@ -0,0 +1,22 @@
+module Vivapayments
+  class Configuration
+    attr_accessor :api_key, :merchant_id, :demo
+    attr_reader :url, :api_url, :redirect_url
+    
+    def initialize
+      @demo = true
+    end
+    
+    def url
+      @url = demo ? "http://demo.vivapayments.com/" : "https://www.vivapayments.com/"
+    end
+    
+    def api_url
+      @api_url = [url, "api/"].join
+    end
+    
+    def redirect_url
+      @redirect_url = [url, "web/checkout"].join
+    end
+  end
+end

data/lib/vivapayments/order.rb

@@ -0,0 +1,94 @@
+module Vivapayments
+  class Order
+    attr_reader :url, :connection, :id
+    attr_accessor :params
+    
+    def initialize(params={})
+      @params     = params
+      @connection = Faraday.new(:url => Vivapayments.configuration.api_url)
+      connection.basic_auth(Vivapayments.configuration.merchant_id, Vivapayments.configuration.api_key)
+      
+    end
+    
+    def id=(value)
+      @id = value
+    end
+    
+    def create
+      raise ArgumentError, "`Amount` param is required." unless params.keys.map(&:to_sym).include?(:Amount)
+      
+      valid_params?
+      
+      content = connection.post("orders", params)
+      if content.status == 200 && JSON.parse(content.body)["ErrorCode"] == 0 && JSON.parse(content.body)["OrderCode"]
+        @id = JSON.parse(content.body)["OrderCode"]
+      else
+        raise "Status: #{content.status} - Message: #{content.body}"
+      end
+    end
+    
+    def delete
+      id_set?
+      
+      content = connection.delete("orders/#{self.id}") 
+      if content.status == 200
+        @id = nil
+        return content
+      else
+        raise "#{content.status} : #{JSON.parse(content.body)["Message"]}"
+      end
+    end
+    
+    def redirect_url
+      id_set?
+      [Vivapayments.configuration.redirect_url, "?ref=#{self.id}"].join
+    end
+    
+    protected
+    
+    def valid_params?
+      invalid_params = []
+      params.keys.each do |key| 
+        invalid_params << key unless accepted_params.include?(key.to_sym)
+      end
+      
+      unless invalid_params.empty?
+        raise ArgumentError, "params `#{invalid_params.join(",")}` are not valid. Accepted params: #{accepted_params.map(&:to_s).join(",")}"
+      else
+        return true
+      end
+    end
+    
+    ##
+    # To keep compatibility with the API, we use the params format given in
+    # the documentation.
+    #
+    def accepted_params
+      [
+        :Amount,
+        :isPreAuth,
+        :ServiceId, 
+        :RequestLang, 
+        :FullName, 
+        :Email, 
+        :Phone, 
+        :MaxInstallments,
+        :MerchantTrns,
+        :CustomerTrns,
+        :SourceCode,
+        :PaymentTimeOut,
+        :ExpirationDate,
+        :AllowRecurring,
+        :Tags,
+        :AllowTaxCard,
+        :ActionUser,
+        :DisableCash,
+        :DisableCard
+      ]
+    end
+    
+    def id_set?
+      raise ArgumentError, "id is not set. Use `create` method or `id=` method." unless self.id
+    end
+  end
+end

data/lib/vivapayments/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'rspec'
+
+require_relative '../lib/vivapayments'
+
+Vivapayments.configure do |config|
+  config.api_key = "foo"
+  config.merchant_id = "bar"
+  config.demo = true
+end
+
+RSpec.configure do |config|
+  config.color = true
+end

data/spec/vivapayments/configuration_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Vivapayments::Configuration do
+  
+  context 'returns correct api_url' do
+    
+    example 'default environment is demo' do
+      Vivapayments.configuration.api_url.should == "http://demo.vivapayments.com/api/"
+      
+      config = Vivapayments::Configuration.new
+      config.api_url.should == "http://demo.vivapayments.com/api/"
+    end
+    
+    example 'production environment' do
+      Vivapayments.configure do |config|
+        config.demo = false
+      end
+      
+      Vivapayments.configuration.api_url.should == "https://www.vivapayments.com/api/"
+      
+      config = Vivapayments::Configuration.new
+      config.demo = false
+      config.api_url.should == "https://www.vivapayments.com/api/"
+    end
+    
+    example 'demo environment' do
+      Vivapayments.configure do |config|
+        config.demo = true
+      end
+      
+      Vivapayments.configuration.api_url.should == "http://demo.vivapayments.com/api/"
+      
+      config = Vivapayments::Configuration.new
+      config.demo = true
+      config.api_url.should == "http://demo.vivapayments.com/api/"
+    end
+  end
+  
+  context 'returns correct redirect_url' do
+    example 'demo environment' do
+      Vivapayments.configure do |config|
+        config.demo = true
+      end
+      Vivapayments.configuration.redirect_url.should == "http://demo.vivapayments.com/web/checkout"
+      
+      config = Vivapayments::Configuration.new
+      config.redirect_url.should == "http://demo.vivapayments.com/web/checkout"
+    end
+    
+    example 'production environment' do
+      Vivapayments.configure do |config|
+        config.demo = false
+      end
+      
+      Vivapayments.configuration.redirect_url.should == "https://www.vivapayments.com/web/checkout"
+      
+      config = Vivapayments::Configuration.new
+      config.demo = false
+      config.redirect_url.should == "https://www.vivapayments.com/web/checkout"
+    end
+  end
+  
+  example 'returns correct api_token' do
+    Vivapayments.configuration.api_key.should == "foo"
+  end
+  
+  example 'returns correct merchant_id' do
+    Vivapayments.configuration.merchant_id.should == "bar"
+  end
+end

data/spec/vivapayments/order_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Vivapayments::Order do
+  
+  context "set ENV['MERCHANT_ID'] and ENV['API_KEY'] for tests" do
+    before :all do
+      Vivapayments.configure do |config|
+        config.api_key = ENV['API_KEY']
+        config.merchant_id = ENV['MERCHANT_ID']
+        config.demo = true
+      end
+    end
+  
+    example 'raise ArgumentError if `Amount` param is missing' do
+      order = Vivapayments::Order.new
+      expect{ order.create}.to raise_error(ArgumentError, "`Amount` param is required.")
+    end
+  
+    example 'raise ArgumentError if invalid param is given' do
+      order = Vivapayments::Order.new(:Amount => 100, :foo => "bar")
+      expect{ order.create}.to raise_error(ArgumentError)
+    end
+  
+    example 'set id correctly' do
+      order = Vivapayments::Order.new
+      order.id = 101
+      order.id.should == 101
+    end
+    
+    example 'get id from create' do
+      order = Vivapayments::Order.new(:Amount => 100)
+      order.create
+      order.id.is_a?(Fixnum).should == true
+    end
+    
+    example 'raise ArgumentError if id is not set on delete' do
+      order = Vivapayments::Order.new
+      expect{ order.delete}.to raise_error(ArgumentError, "id is not set. Use `create` method or `id=` method.")
+    end
+    
+    example 'return nil id after delete' do
+      order = Vivapayments::Order.new(:Amount => 100)
+      order.create
+      order.delete
+      order.id.should == nil
+    end
+    
+    example 'return status 200 on successful delete' do
+      order = Vivapayments::Order.new(:Amount => 100)
+      order.create
+      res = order.delete
+      res.status.should == 200
+    end
+    
+    example 'return correct redirect_url' do
+      order = Vivapayments::Order.new(:Amount => 100)
+      order.create
+      order.redirect_url.should == "http://demo.vivapayments.com/web/checkout?ref=#{order.id}"
+    end
+  end
+end

data/vivapayments.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path('../lib/vivapayments/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name                  = 'vivapayments'
+  gem.version               = Vivapayments::VERSION
+  gem.authors               = ['Giannis Melidis']
+  gem.email                 = ['gmelidis@engineer.com']
+  gem.summary               = 'Wrapper for the Vivapayments API.'
+  gem.description           = gem.summary
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.files = `git ls-files`.split("\n").sort
+
+  gem.add_dependency 'faraday'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: vivapayments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Giannis Melidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !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: pry
+  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'
+description: Wrapper for the Vivapayments API.
+email:
+- gmelidis@engineer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/vivapayments.rb
+- lib/vivapayments/configuration.rb
+- lib/vivapayments/order.rb
+- lib/vivapayments/version.rb
+- spec/spec_helper.rb
+- spec/vivapayments/configuration_spec.rb
+- spec/vivapayments/order_spec.rb
+- vivapayments.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Vivapayments API.
+test_files: []
+has_rdoc: