payfort 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89a03ad1cd448b6a1421b5802e9ea3580b34bf56
+  data.tar.gz: baca6b8a6e67fa85a18aa4b90e82330047d2444b
+SHA512:
+  metadata.gz: 5ad5dd359b2fe9c7af3ed1946900015904cc0eb9f24c82bd9bc58a052160a972e6be964d63609e3e93c1d4c801eb133c37f9930a7dd44d8300bce030db6515cd
+  data.tar.gz: 0ee2753efdda3a83ee1959a6bc7c334b35058ec6b6c7fdff483dba74e8dfa65e0693a0440e2c55a8a3633f1d8b2e57ef8c8c045dacd9225a1d937809688bd083

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+gemspec
+ 
+gem 'httparty'
+ 
+group :test do
+  gem 'minitest'
+  gem 'turn'
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    white_payments (2.0)
+      httparty (~> 0.13)
+      json (~> 1.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    minitest (4.7.5)
+    multi_xml (0.5.5)
+    rake (10.3.2)
+    turn (0.9.7)
+      ansi
+      minitest (~> 4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  minitest
+  rake
+  turn
+  white_payments!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Payfort
+
+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,95 @@
+# White Ruby
+
+White makes accepting payments in the Middle East ridiculously easy. Sign up for an account at [whitepayments.com](http://whitepayments.com).
+
+## Getting Started
+
+Using White with your Ruby project is simple. If you're using [bundler](http://bundler.io) (and really, who isn't these days amirite?), you just need to add one line to your `Gemfile`:
+
+```ruby
+gem 'payfort', require: 'payfort'
+```
+
+Now, running `bundle install` will pull the library directly to your local project.
+
+## Using White
+
+You'll need an account with White if you don't already have one (grab one real quick at [whitepayments.com](http://whitepayments.com) and come back .. we'll wait).
+
+Got an account? Great .. let's get busy.
+
+### 1. Initializing White
+
+To get started, you'll need to initialize White with your secret API key. Here's how that looks (we're using a test key, so no real money will be exchanging hands):
+
+```ruby
+require 'payfort'
+
+Payfort.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+```
+
+That's it! You probably want to do something with the White object though -- it gets really bored when it doesn't have anything to do.
+
+Let's run a transaction, shall we.
+
+### 2. Processing a transaction through White
+
+Now, for the fun part. Here's all the code you need to process a transaction with White:
+
+```ruby
+White::Charge.create(
+    :amount => 5,
+    :currency => "aed",
+    :email => "customer@example.com",
+    :card => {
+      :number => "4242424242424242",
+      :exp_month => 11,
+      :exp_year => 2016,
+      :cvv => 123
+    },
+    :description => "2kg of lizard tails, non-refundable"
+  )
+```
+
+This transaction should be successful since we used the `4242 4242 4242 4242` test credit card. For a complete list of test cards, and their expected output you can check out this link [here](https://whitepayments.com/docs/testing/).
+
+How can you tell that it was successful? Well, if no exception is raised then you're in the clear.
+
+### 3. Handling Errors
+
+Any errors that may occur during a transaction is raised as an Exception. Here's an example of how you can handle errors with White:
+
+```ruby
+begin
+  # Use White's bindings...
+
+rescue White::BankingError => e
+  # Since it's a decline, White::BankingError will be caught
+  puts "Status is: #{e.http_status}"
+  puts "Code is: #{e.code}"
+  puts "Message is: #{e.message}"
+
+rescue White::RequestError => e
+  # Invalid parameters were supplied to White's API
+
+rescue White::AuthenticationError => e
+  # There's something wrong with that API key you passed
+
+rescue White::ProcessingError => e
+  # There's something wrong on White's end
+
+rescue White::WhiteError => e
+  # Display a very generic error to the user, and maybe send
+  # yourself an email
+
+rescue => e
+  # Something else happened, completely unrelated to White
+end
+```
+
+## Testing White
+If you're looking to contribute to White, then grab this repo and run `rake` on your local machine to run the unit tests.
+
+## Contributing
+
+Read our [Contributing Guidelines](CONTRIBUTING.md) for details

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/payfort.rb

@@ -0,0 +1,65 @@
+require "httparty"
+require "payfort/customer"
+require "payfort/charge"
+require "payfort/errors/payfort_error"
+require "payfort/errors/authentication_error"
+require "payfort/errors/banking_error"
+require "payfort/errors/request_error"
+require "payfort/errors/processing_error"
+
+module Payfort
+
+  include HTTParty
+
+  @api_base = 'https://api.start.payfort.com/'
+
+  def self.api_url(url='')
+    @api_base + url
+  end
+
+  def self.handle_response(response)
+    body = JSON.parse(response.body);
+
+    if response.code.between?(200, 299) and !body.key?('error')
+      # The request was successful
+      return body
+    end
+
+    # There was an error .. check the response
+    case body['error']['type']
+    when 'banking'
+      raise Payfort::BankingError.new(body['error']['message'], body['error']['code'], response.code)
+
+    when 'authentication'
+      raise Payfort::AuthenticationError.new(body['error']['message'], body['error']['code'], response.code)
+
+    when 'processing'
+      raise Payfort::ProcessingError.new(body['error']['message'], body['error']['code'], response.code)
+
+    when 'request'
+      raise Payfort::RequestError.new(body['error']['message'], body['error']['code'], response.code)
+    end
+
+    # Otherwise, raise a General error
+    raise Payfort::PayfortError.new(body['error']['message'], body['error']['code'], response.code)
+  end
+
+  def self.post(url, body={})
+    options = {basic_auth: {username: api_key, password: ''}}
+    options.merge!({body: body})
+    response = HTTParty.post(url, options)
+    self.handle_response(response)
+
+  end
+
+  def self.get(url, query={})
+    options = {basic_auth: {username: api_key, password: ''}}
+    options.merge!({query: query})
+    response = HTTParty.get(url, options)
+    JSON.parse(response.body);
+  end
+
+  class << self
+    attr_accessor :api_key
+  end
+end

data/lib/payfort/charge.rb

@@ -0,0 +1,17 @@
+module Payfort
+  class Charge
+
+    def self.create(params={})
+      Payfort.post(Payfort.api_url('charges/'), params)
+    end
+
+    def self.get(id)
+      Payfort.get(Payfort.api_url('charges/' + id.to_s))
+    end
+
+    def self.all
+      Payfort.get(Payfort.api_url('charges/'))
+    end
+
+  end
+end

data/lib/payfort/customer.rb

@@ -0,0 +1,17 @@
+module Payfort
+  class Customer
+
+    def self.create(params={})
+      Payfort.post(Payfort.api_url('customers/'), params)
+    end
+
+    def self.get(id)
+      Payfort.get(Payfort.api_url('customers/' + id.to_s))
+    end
+
+    def self.all
+      Payfort.get(Payfort.api_url('customers/'))
+    end
+
+  end
+end

data/lib/payfort/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Payfort
+  class AuthenticationError < PayfortError
+  end
+end

data/lib/payfort/errors/banking_error.rb

@@ -0,0 +1,4 @@
+module Payfort
+  class BankingError < PayfortError
+  end
+end

data/lib/payfort/errors/payfort_error.rb

@@ -0,0 +1,18 @@
+module Payfort
+  class PayfortError < StandardError
+    attr_reader :message
+    attr_reader :code
+    attr_reader :http_status
+
+    def initialize(message=nil, code=nil, http_status=nil)
+      @message = message
+      @code = code
+      @http_status = http_status
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(#{@code}Error - Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/payfort/errors/processing_error.rb

@@ -0,0 +1,4 @@
+module Payfort
+  class ProcessingError < PayfortError
+  end
+end 

data/lib/payfort/errors/request_error.rb

@@ -0,0 +1,4 @@
+module Payfort
+  class RequestError < PayfortError
+  end
+end

data/lib/payfort/version.rb

@@ -0,0 +1,3 @@
+module Payfort
+  VERSION = '0.1'
+end

data/payfort.gemspec

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'payfort/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'payfort'
+  s.version = Payfort::VERSION
+  s.summary = 'Ruby bindings for the Payfort Start API'
+  s.description = 'Payfort Start is the easiest way to accept payments online in the middle east. See https://start.payfort.com for details.'
+  s.authors = ['Pavel Gabriel','Yazin Alirhayim']
+  s.email = ['pavel@payfort.com','yazin@payfort.com']
+  s.homepage = 'https://start.payfort.com/docs/'
+  s.license = 'MIT'
+
+  s.add_dependency('httparty', '~> 0.13')
+  s.add_dependency('json', '~> 1.8.1')
+
+  s.add_development_dependency('minitest', '~> 4.7.5')
+  s.add_development_dependency('turn', '~> 0.9.7')
+  s.add_development_dependency('rake')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/spec/lib/white/charge_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../../spec_helper'
+ 
+describe White::Charge do
+ 
+  it "must create a new charge" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    response = White::Charge.create(
+      :amount => 400,
+      :currency => "usd",
+      :email => "ahmed@example.com",
+      :card => {
+        :name => "Abdullah Ahmed",
+        :number => "4242424242424242",
+        :exp_month => 11,
+        :exp_year => 2016,
+        :cvc => 123
+      },
+      :description => "Charge for test@example.com"
+    )
+
+    response['captured_amount'].must_equal 400
+  end
+
+   it "must list created charges" do
+    response = White::Charge.all()
+    response.wont_be_empty
+   end
+ 
+end

data/spec/lib/white/customer_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../../spec_helper'
+# require_relative '../../../lib/white/customer'
+ 
+describe White::Customer do
+ 
+  it "must create a new customer" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    response = White::Customer.create(
+      :name => "Abdullah Ahmed",
+      :email => "abdullah@msn.com",
+      :card => {
+        :number => "4242424242424242",
+        :exp_month => 11,
+        :exp_year => 2016,
+        :cvc => 123
+      },
+      :description => "Signed up at the Trade Show in Dec 2014"
+    )
+
+    response['name'].must_equal "Abdullah Ahmed"
+  end
+
+   it "must list created customers" do
+    response = White::Customer.all()
+    response.wont_be_empty
+   end
+ 
+end

data/spec/lib/white/error/authentication_error.rb

@@ -0,0 +1,22 @@
+require_relative '../../../spec_helper'
+
+describe White::AuthenticationError do
+  
+  it "must be thown with an invalid key" do
+    White.api_key = "invalid"
+
+    lambda {
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "4242424242424242",
+          :exp_month => 11,
+          :exp_year => 2016,
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    }.must_raise White::AuthenticationError
+  end
+end

data/spec/lib/white/error/banking_error_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../../../spec_helper'
+
+describe White::BankingError do
+ 
+  it "must be thown with card_declined" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :email => "abdullah@msn.com",
+        :card => {
+          :name => "Abdullah Ahmed",
+          :number => "4000000000000002",
+          :exp_month => 11,
+          :exp_year => 2016,
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::BankingError => e
+      e.code.must_equal 'card_declined'
+      e.http_status.must_equal 402
+    end
+  end
+  
+end

data/spec/lib/white/error/request_error_spec.rb

@@ -0,0 +1,129 @@
+require_relative '../../../spec_helper'
+
+describe White::RequestError do
+
+  # Negative amounts don't raise an error -- TODO: FIX
+  #  
+  # it "must be thown with invalid_request_error" do
+  #   White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+  #   lambda {
+  #     response = White::Charge.create(
+  #       :amount => -1,
+  #       :currency => "usd",
+  #       :card => {
+  #         :number => "4242424242424242",
+  #         :exp_month => 11,
+  #         :exp_year => 2016,
+  #         :cvc => 123
+  #       },
+  #       :description => "Charge for test@example.com"
+  #     )
+  #   }.must_raise White::RequestError
+  # end
+
+  it "must be thrown with invalid_cvc" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "4242424242424242",
+          :exp_month => 11,
+          :exp_year => 2016,
+          :cvc => "abc"
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::RequestError => e
+      e.code.must_equal 'unprocessable_entity'
+      e.http_status.must_equal 422
+    end
+  end
+
+  it "must be thown with expired_card" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "4242424242424242",
+          :exp_month => 11,
+          :exp_year => 1999,
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::RequestError => e
+      e.code.must_equal 'unprocessable_entity'
+      e.http_status.must_equal 422
+    end
+  end
+
+  it "must be thown with invalid_number" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "1234123412341234",
+          :exp_month => 11,
+          :exp_year => 2016,
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::RequestError => e
+      e.code.must_equal 'unprocessable_entity'
+      e.http_status.must_equal 422
+    end
+  end
+
+  it "must be thown with invalid_expiry_month" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "4242424242424242",
+          :exp_month => 15,
+          :exp_year => 2016,
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::RequestError => e
+      e.code.must_equal 'unprocessable_entity'
+      e.http_status.must_equal 422
+    end
+  end
+
+  it "must be thown with invalid_expiry_year" do
+    White.api_key = "test_sec_k_25dd497d7e657bb761ad6"
+
+    begin
+      response = White::Charge.create(
+        :amount => 400,
+        :currency => "usd",
+        :card => {
+          :number => "4242424242424242",
+          :exp_month => 12,
+          :exp_year => "abcd",
+          :cvc => 123
+        },
+        :description => "Charge for test@example.com"
+      )
+    rescue White::RequestError => e
+      e.code.must_equal 'unprocessable_entity'
+      e.http_status.must_equal 422
+    end
+  end
+end

data/spec/lib/white/error/white_error_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../../../spec_helper'
+
+describe White::WhiteError do
+  
+  # Add a test case for a "General Error" -- TODO
+  #
+  # it "must be thown" do
+  #   White.api_key = "sk_test_1234567890abcdefghijklmnopq"
+
+  #   lambda {
+  #     response = White::Charge.create(
+  #       :amount => 400,
+  #       :currency => "usd",
+  #       :card => {
+  #         :number => "3566002020360505",
+  #         :exp_month => 11,
+  #         :exp_year => 2014,
+  #         :cvc => 123
+  #       },
+  #       :description => "Charge for test@example.com"
+  #     )
+  #   }.must_raise White::WhiteError
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+#we need the actual library file
+require_relative '../lib/white'
+# For Ruby < 1.9.3, use this instead of require_relative
+# require(File.expand_path('../../lib/dish', __FILE__))
+ 
+#dependencies
+gem 'minitest'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: payfort
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Pavel Gabriel
+- Yazin Alirhayim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Payfort Start is the easiest way to accept payments online in the middle
+  east. See https://start.payfort.com for details.
+email:
+- pavel@payfort.com
+- yazin@payfort.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/payfort.rb
+- lib/payfort/charge.rb
+- lib/payfort/customer.rb
+- lib/payfort/errors/authentication_error.rb
+- lib/payfort/errors/banking_error.rb
+- lib/payfort/errors/payfort_error.rb
+- lib/payfort/errors/processing_error.rb
+- lib/payfort/errors/request_error.rb
+- lib/payfort/version.rb
+- payfort.gemspec
+- spec/lib/white/charge_spec.rb
+- spec/lib/white/customer_spec.rb
+- spec/lib/white/error/authentication_error.rb
+- spec/lib/white/error/banking_error_spec.rb
+- spec/lib/white/error/request_error_spec.rb
+- spec/lib/white/error/white_error_spec.rb
+- spec/spec_helper.rb
+homepage: https://start.payfort.com/docs/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Payfort Start API
+test_files:
+- spec/lib/white/charge_spec.rb
+- spec/lib/white/customer_spec.rb
+- spec/lib/white/error/authentication_error.rb
+- spec/lib/white/error/banking_error_spec.rb
+- spec/lib/white/error/request_error_spec.rb
+- spec/lib/white/error/white_error_spec.rb
+- spec/spec_helper.rb