paylane 0.0.3 → 1.0.0

data/README.md

@@ -1,16 +1,99 @@
 # Paylane
 
-Ruby client for [PayLane](http://paylane.com) service.
+Ruby client for [PayLane](http://www.paylane.com) payments.
 
 ## Installation
 
-**It's strongly recommended to NOT install current version - development in progress**
+    $ gem install paylane
 
-TODO: Write installation instructions here
+or
 
-## Usage
+    gem 'paylane'
 
-TODO: Write usage instructions here
+## Usage - API
+
+Start from create a client for API.
+
+    gateway = PayLane::Gateway.new('login, 'password')
+    client = PayLane::API.new(gateway.connect)
+
+Now all methods from [original API](http://devzone.paylane.com/wp-content/uploads/2012/05/paylane_direct_system.pdf) are available in the client object.
+
+    params = {
+      "payment_method" => {
+        "card_data" => {
+          "card_number" => 4111111111111111,
+          "card_code" => 123,
+          "expiration_month" => 12,
+          "expiration_year" => 2020,
+          "name_on_card" => "John Smith"
+          }
+        },
+      "customer" => {
+        "name" => "John Smith",
+        "email" => "johnsmith@example.com",
+        "ip" => "127.0.0.1",
+        "address" => {
+          "street_house" => "1st Avenue",
+          "city" => "Lodz",
+          "state" => "Lodz",
+          "zip" => "00-000",
+          "country_code" => "PL"
+        }
+      },
+      "amount" => 9.99,
+      "currency_code" => "EUR",
+      "product" => {
+        "description" => "paylane_api_test"
+      }
+    }
+
+    client.multi_sale(params) #=> {ok: {id_sale: "2772323"}, data: {fraud_score: "8.76"}}
+
+If something went wrong `PayLane::ConnectionError` error will be raised.
+
+## Usage - custom methods
+
+Gem provides custom methods to simplify an implementation of payments in your app.
+
+### Configuration
+
+Firstly you need to set up credential settings. For Rails put it in initializer `config/initializers/paylane.rb`.
+
+    PayLane.login = 'login'
+    PayLane.password = 'password'
+
+Besides `login` and `password` you can also set `currency` ('EUR' by default) and `logger`.
+
+### Usage
+
+Inherit your class from `PayLane::Payment` and overload `card_data` (or `account_data`) and `customer` methods. This is how it should looks for `params` from the previous example.
+
+    class Payment < PayLane::Payment
+      def initialize(params, options = {})
+        super(options)
+        @params = params
+      end
+
+      def card_data
+        params[:payment_method][:card_data]
+      end
+
+      def customer
+        params[:customer]
+      end
+    end
+
+    payment = Payment.new(params, product: 'Additional pylon')
+    payment.charge_card(9.99) #=> {ok: {id_sale: "2772323"}, data: {fraud_score: "8.76"}}
+
+It works similar for recurring payments
+
+    class RecurringPayment < PayLane::RecurringPayment
+    end
+
+    recurring_payment = RecurringPayment.new(2772323, product: 'Subscription')
+    recurring_payment.charge_card(30.00) #=> {ok: {id_sale: "3131151"}, data: {fraud_score: "7.00"}}
 
 ## Contributing
 

data/lib/paylane/version.rb

@@ -1,3 +1,3 @@
 module PayLane
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paylane
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon