wirecard-elastic 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dfbfe4ac51493be85c504c280f35891dd271ed0
-  data.tar.gz: 2aca41a8ad720d5b29d7527d6f7640a434a63a68
+  metadata.gz: 5ad65f0c4a71801ab0563eaa4abe98cb944573ba
+  data.tar.gz: e736a0c468e1e73210fb0d816c7affd3483bd4cc
 SHA512:
-  metadata.gz: 22b83d0b615cc40bae13f7e2ec6404ad6f4383021a60075e60deec803ca23964dbc00ee636e2f49119bf4d01e55bb9d3c00ad9e685e9b7ce10e73e8e9853cb9c
-  data.tar.gz: 6237450ae7354ea5e9a49bc9e082a096b9936aef2b29d7c7ae8cc8f2d0d39e1fe64bb18a9dbfea65878b944bee598e9928c02d4c544ad73234a236fac78c0ffd
+  metadata.gz: 4adc95a95cab5d15e9ce189652e81d296c51f8516e39dc713635b58187072a6100a1bd208cedcfbec696352b176dd79998cc7d4be7aa5962aba7ef9ae4641dea
+  data.tar.gz: 87a5d22947b3eb7bdeb77c0b9c21c60350aa883fc77f5e7872b3aa1322648dbd5441515c64aaddf491058537a5805f611750e775b11ce3cb87a440c8bc244300

data/README.md

@@ -1 +1,130 @@
-# wirecard-elastic
+
+# Wirecard Elastic
+
+![alt text](https://hostbillapp.com/images/wirecard.png "Wirecard GmbH")
+
+This library  integrates the Elastic API for Wirecard Payment Service in Ruby. This library could actually be extended to manage any Elastic API service provider.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wirecard-elastic'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wirecard-elastic
+
+## Configuration
+
+Add the following lines into your `config/initializer/` folder
+
+```ruby
+# use this to configure anything
+# on the wirecard elastic api gem
+Wirecard::Elastic.config do |config|
+
+  # the engine URL must be a full URL to the elastic engine you use
+  # you can add different credentials for each type of payment (Credit Card, China Union Pay, ...)
+  config.creditcard = {
+    :username   => "USERNAME FOR CREDIT CARD",
+    :password   => "PASSWORD FOR CREDIT CARD",
+    :engine_url => "http://api.engine-url.com/"
+  }
+  config.upop = {
+    :username   => "USERNAME FOR UNION PAY",
+    :password   => "PASSWORD FOR UNION PAY",
+    :engine_url => "http://api.engine-url.com/"
+  }
+
+end
+```
+
+## Usage
+
+Recover a transaction or/and refund from the API.
+
+```ruby
+# Any of the following instructions work for both transaction and refund request
+# the payment method can be either :upop or :creditcard for now
+response = Wirecard::Elastic.transaction("MERCHANT ID", "TRANSACTION ID", "PAYMENT METHOD").response
+response = Wirecard::Elastic.refund("MERCHANT ID", "PARENT TRANSACTION ID", "PAYMENT METHOD").response
+```
+
+You can get any result from the API. The results will be processed and converted to symbol / underscore depending on the response current mapping
+
+```ruby
+# different response datas from the API
+response.transaction_state
+response.transaction_type
+response.request_status
+response.requested_amount
+# ... and so forth
+```
+
+You can catch the done request itself without processed response like so
+
+```ruby
+# get request
+request = Wirecard::Elastic.transaction("MERCHANT ID", "TRANSACTION ID", "PAYMENT METHOD").request
+# check the exact query final URL
+request.query
+# see the raw result of the request
+request.feedback
+```
+
+You can also check if the transaction / refund was successful via this small shortcut. It will raise an error if not, you can then use whatever functionality you could normally use
+
+```ruby
+safe_transaction = Wirecard::Elastic.transaction("MERCHANT ID", "TRANSACTION ID", "PAYMENT METHOD").safe
+safe_transaction.request
+safe_transaction.response
+```
+
+Concrete use in your code could look like this
+
+```ruby
+def check
+  puts "Transaction current state : #{response.transaction_state}"
+end
+
+# errors are basically raised and
+# must be catch by yourself
+def response
+  @response ||= Wirecard::Elastic.refund(order_payment.merchant_id, order_payment.transaction_id, order_payment.payment_method).response
+rescue Wirecard::Elastic::Error => exception
+  raise Error, "A problem occurred : #{exception}"
+end
+```
+
+## Development
+
+I created this library for my company. It lacks several functionalities but it's way enough for us ; everything is easily extendable so don't hesitate to add your own needed methods to it.
+
+You will notice there a lot of sub-functionalities which isn't quoted in the instructions. For instance, there's a XML body builder with template system which can be easily extended to other file formats if needed.
+
+It was originally created for [Wirecard](https://www.wirecard.com/) but I see no restriction to use it for any other service with the elastic structure.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wirecard-elastic/fork )
+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 a new Pull Request
+
+## Author
+
+[Laurent Schaffner](http://www.laurentschaffner.com)
+
+## License
+
+MIT License.
+
+## Changelog

data/lib/wirecard/elastic.rb

@@ -1,5 +1,18 @@
-# classes auto loader
-Dir[File.expand_path "lib/**/*.rb"].each { |file| require_relative(file) }
+# we load the classes
+require 'wirecard/elastic/request/body/builder/xml'
+require 'wirecard/elastic/request/body/params/refund'
+require 'wirecard/elastic/request/body/builder'
+require 'wirecard/elastic/request/base'
+require 'wirecard/elastic/request/refund'
+require 'wirecard/elastic/request/transaction'
+require 'wirecard/elastic/response/base'
+require 'wirecard/elastic/response/refund'
+require 'wirecard/elastic/response/transaction'
+require 'wirecard/elastic/configuration'
+require 'wirecard/elastic/error'
+require 'wirecard/elastic/request'
+require 'wirecard/elastic/response'
+require 'wirecard/elastic/version'
 
 # this is the entry point of the gem, here goes the configuration system
 # also the different methods that should be publicly called

data/lib/wirecard/elastic/version.rb

@@ -1,6 +1,6 @@
 # current version of the gem
 module Wirecard
   module Elastic
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wirecard-elastic
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Loschcode