billsafe 0.2.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in billsafe.gemspec
+gemspec
+gem 'hash-deep-merge'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Zaschka
+
+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,114 @@
+# Billsafe
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'billsafe', "0.2.0"
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install billsafe
+
+## Usage
+
+To disable the sandbox for using the API put this in config/initializers/billsafe.rb
+
+    Billsafe.sandbox = false
+    
+The usage of the API is straightforward. First you need a client with your login information:    
+
+    client = Billsafe::Client.new(
+          merchant_id: "your-merchant_id",
+          merchant_license: "your-merchant_license",
+          application_signature: "your-application_signature",
+          application_version: "your-application_version"
+    )
+    
+Then you can use the client to push your calls to the API.    
+    
+    response = client.call("PrepareOrder", attributes)
+
+The attributes hash must be filled with the required parameters for the API call. Attributes are transformed into a query string before the request is made.    
+The available attributes can be read from the full documentation (see link below).
+
+One note on filling the attributes hash:
+
+The BillSAFE API uses keys like _order_number_ and _articleList_0_grossPrice_.
+You don't have to flatten the attributes link this. Instead you can think of the underscores as a new hash:
+
+    attributes = {
+        order: {
+            number: @order.order_id,
+            amount: @order.credit_totals.to_f.precision(2),
+            taxAmount: @order.taxes.to_f.precision(2),
+            currencyCode: "EUR"
+        },
+        articleList: {
+            0 => {
+                number: item.product.sku,
+                name: item.product.name,
+                type: "goods",
+                quantity: item.amount,
+                grossPrice: item.price.to_f.precision(2),
+                tax: "19.00"
+            }
+        }
+    }
+
+This will be transformed to:
+
+    attributes = {
+        order_number: number: @order.order_id,
+        order_amount: @order.credit_totals.to_f.precision(2),
+        order_taxAmount: @order.taxes.to_f.precision(2),
+        order_currencyCode: "EUR",
+        articleList_0_number: item.product.sku,
+        articleList_0_name: item.product.name,
+        articleList_0_type: "goods",
+        articleList_0_quantity: item.amount,
+        articleList_0_grossPrice: item.price.to_f.precision(2),
+        articleList_0_tax: "19.00"
+    }
+    
+The response is a hash with the returned values. You can fetch the values with
+
+    token = response['token']
+    
+The response hash is treated like the attributes hash in a reversed way. So every key containing an underscore is beeing transformed into its own hash.
+
+The full API documentation can be found here: http://www.billsafe.de/integration/manuals/BillSAFE_API.pdf
+
+## Example code
+
+    def checkout
+        response = @client.call("prepareOrder", order_attributes)
+        if response['token']
+          redirect_to Billsafe.payment_url + "?token="+response['token']
+        end
+    end
+    
+    def success
+        response = @client.call("getTransactionResult", token: params[:token])
+        if response['status'] == "ACCEPTED"
+            transaction_id = response['transactionId']
+            ...
+        else
+            error_code = response['declineReason']['code']
+            error_message = response['declineReason']['message']
+            user_error_message = response['declineReason']['buyerMessage']
+            ...
+        end
+    end
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/billsafe.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'billsafe/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "billsafe"
+  gem.version       = Billsafe::VERSION
+  gem.authors       = ["Mike Zaschka"]
+  gem.email         = ["mike.zaschka@gmail.com"]
+  gem.description   = %q{Ruby wrapper for the BillSAFE API}
+  gem.summary       = %q{Ruby wrapper for the BillSAFE API}
+  gem.homepage      = "https://github.com/mikezaschka/ruby-billsafe"
+  
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "activesupport"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
+
+  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"]
+end

data/billsafe.iml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="RVM: ruby-1.9.2-p320" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v3.2.11, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v3.2.11, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="addressable (v2.3.3, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.0.4, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.2.0, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="crack (v0.3.2, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.1.3, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v0.6.1, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.5.0, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.0.3, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v2.12.0, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v2.12.2, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v2.12.1, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v2.12.2, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="webmock (v1.9.3, RVM: ruby-1.9.2-p320) [gem]" level="application" />
+  </component>
+</module>
+

data/lib/billsafe/client.rb

@@ -0,0 +1,17 @@
+module Billsafe
+
+	class Client
+	  
+    attr_accessor :base_attributes
+
+    def initialize(base_attributes = {})
+      @base_attributes = base_attributes
+    end
+
+    def call(method, attributes)
+      response = Billsafe.request(method, base_attributes.merge(attributes))
+      response
+    end
+
+  end
+end

data/lib/billsafe/version.rb

@@ -0,0 +1,3 @@
+module Billsafe
+  VERSION = "0.2.0"
+end

data/lib/billsafe.rb

@@ -0,0 +1,93 @@
+require "billsafe/version"
+require 'active_support/all'
+
+module Billsafe
+
+  API_BASE          = "nvp.billsafe.de/"
+  API_BASE_SANDBOX  = "sandbox-nvp.billsafe.de"
+  API_VERSION       = "V208"
+
+  PAYMENT_BASE          = "payment.billsafe.de"
+  PAYMENT_BASE_SANDBOX  = "sandbox-payment.billsafe.de"
+  PAYMENT_VERSION       = "V200"
+
+  @@sandbox = true
+
+	autoload :Client, "billsafe/client"
+
+  class BillsafeError < StandardError
+  end
+
+  class AuthenticationError < BillsafeError; end
+  class APIError            < BillsafeError; end
+  class ArgumentError       < BillsafeError; end
+
+  class << self
+    def sandbox?
+      @@sandbox
+    end
+
+    def sandbox=(sandbox)
+      @@sandbox = sandbox
+    end
+
+    def payment_url
+      api_base = Billsafe.sandbox? ? PAYMENT_BASE_SANDBOX : PAYMENT_BASE
+      "https://#{api_base}/#{PAYMENT_VERSION}"
+    end
+
+    def request(api_method, data)
+      api_base = Billsafe.sandbox? ? API_BASE_SANDBOX : API_BASE
+      https = Net::HTTP.new(api_base , Net::HTTP.https_default_port)
+      https.use_ssl = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.start do |connection|
+        path = "/#{API_VERSION}"
+        https_request = Net::HTTP::Post.new(path)
+        https_request.body = nvp_params(data.merge(method: api_method, format: 'JSON'))
+        @response = https.request(https_request)
+      end
+      raise AuthenticationError if @response.code.to_i == 401
+      raise APIError if @response.code.to_i >= 500
+
+      data = JSON.parse(@response.body)
+      raise APIError.new(data['errorList'].
+                             map{ |err| [err['code'], err['message']].join(" ")}.join("\r\n")) if data["ack"] == "ERROR"
+      deflatten_params(data)
+    end
+
+    def nvp_params(params)
+      flattened_params = flatten_params(params)
+      URI.encode_www_form(flattened_params)
+    end
+
+    def flatten_params(hash, prefix = "")
+      new_hash = {}
+      hash.each_pair do |key, val|
+        if val.is_a?(Hash)
+          new_hash.merge!(flatten_params(val, prefix + key.to_s + "_"))
+        else
+          new_hash[prefix + key.to_s] = val
+        end
+      end
+      new_hash
+    end
+
+    def deflatten_params(hash)
+      new_hash = {}
+      hash.each_pair do |key, val|
+        if key.include? "_"
+          parts = key.split("_")
+          parts.reverse.each do |part|
+            val = { part => val }
+          end
+        else 
+          val = { key => val }
+        end
+        new_hash.deep_merge!(val)  
+      end        
+      new_hash
+    end
+
+  end
+end

data/spec/billsafe/client_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+require "request_spec_helper"
+
+describe Billsafe::Client do
+  include RequestSpecHelper
+
+  let(:valid_attributes) do
+    { merchant_id: "meid", merchant_license: "meli", application_signature: "appsig", application_version: "appve" }
+  end
+
+  let (:client) do
+    Billsafe::Client.new(valid_attributes)
+  end
+
+end

data/spec/billsafe_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Billsafe do
+  
+  let(:deflattened_hash) do
+    {
+      "items" => {
+        "0" => "ruby",
+        "1" => "bi",
+        "nested" => {
+          "0" => "ruby"
+        }
+      },
+      "status" => "OK"
+    }
+  end
+  
+  let(:flattened_hash) do
+    { 
+      "items_0" => "ruby", 
+      "items_1" => "bi", 
+      "items_nested_0"=>"ruby",
+      "status" => "OK"
+    }
+  end
+  
+  it "should flatten params" do
+    Billsafe.send(:flatten_params, deflattened_hash).should eql(flattened_hash)
+  end
+
+  it "should deflatten params" do
+    Billsafe.send(:deflatten_params, flattened_hash).should eql(deflattened_hash)
+  end
+
+end

data/spec/request_spec_helper.rb

@@ -0,0 +1,25 @@
+module RequestSpecHelper
+
+  def stub_ok_request(token, status = 200)
+    stub_request(:get, "https://sandbox-nvp.billsafe.de/V209?Order_currencyCode=EUR&format=json&method=PrepareOrder").
+        with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => '{
+          "ack":"OK",
+          "status":"ACCEPTED",
+          "transactionId":"987654321",
+          "token":"' + token + '"}', :headers => {})
+  end
+
+  def stub_error_request()
+    stub_request(:get, "https://sandbox-nvp.billsafe.de/V209?Order_currencyCode=EUR&format=json&method=PrepareOrder").
+        with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => '{
+            "ack":"ERROR",
+            "errorList":[
+              { "code":"123", "message":"Fehler 1" },
+              { "code":"456", "message":"Fehler 2"}
+            ]
+        }', :headers => {})
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'billsafe'
+require 'rspec/autorun'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: billsafe
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Zaschka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activesupport
+  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: rspec
+  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: webmock
+  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'
+description: Ruby wrapper for the BillSAFE API
+email:
+- mike.zaschka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- billsafe.gemspec
+- billsafe.iml
+- lib/billsafe.rb
+- lib/billsafe/client.rb
+- lib/billsafe/version.rb
+- spec/billsafe/client_spec.rb
+- spec/billsafe_spec.rb
+- spec/request_spec_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikezaschka/ruby-billsafe
+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: Ruby wrapper for the BillSAFE API
+test_files:
+- spec/billsafe/client_spec.rb
+- spec/billsafe_spec.rb
+- spec/request_spec_helper.rb
+- spec/spec_helper.rb