payneteasy-payneteasyapi 0.1.0 → 0.1.1

data/doc/library-internals/01-payment-processor.md

@@ -1,12 +1,12 @@
 # Фронтенд библиотеки, PaymentProcessor
 
-Фронтенд библиотеки представляет класс **[PaynetEasy\PaynetEasyApi\PaymentProcessor](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php)**. Класс предоставляет следующие возможности:
-* **[executeQuery()](#executeQuery)**: простое выполнение запроса к PaynetEasy
-* **[processCustomerReturn()](#processCustomerReturn)**: простая обработка данных, полученных от PaynetEasy при возвращении пользователя с платежного шлюза
-* **[processPaynetEasyCallback()](#processPaynetEasyCallback)**: простая обработка данных, полученных от PaynetEasy при поступлении коллбэка от PaynetEasy
-* **[setHandlers()](#setHandlers)**: установка обработчиков для различных событий, происходящих при обработке платежной транзакции
+Фронтенд библиотеки представлен классом **[PaynetEasy::PaynetEasyApi::PaymentProcessor](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb)**. Класс предоставляет следующие методы:
+* **[execute_query()](#execute_query)**: выполнение запроса к PaynetEasy
+* **[process_customer_return()](#process_customer_return)**: обработка данных, полученных от PaynetEasy при возвращении пользователя с платежного шлюза
+* **[process_paynet_easy_callback()](#process_paynet_easy_callback)**: обработка данных, полученных от PaynetEasy при поступлении коллбэка от PaynetEasy
+* **[set_handlers()](#set_handlers)**: установка обработчиков для различных событий, происходящих при обработке платежной транзакции
 
-### <a name="executeQuery"></a>executeQuery(): простое выполнение запроса к PaynetEasy
+### <a name="execute_query"></a>execute_query(): выполнение запроса к PaynetEasy
 
 Некоторые сценарии обработки платежа имеют асинхронную природу и состоят из нескольких запросов. Так, некоторые запросы не возвращают результат платежа сразу и требуют многократного выполнения запроса **status**, после которого клиент может быть отправлен на шлюз PaynetEasy для проведения дополнительных шагов авторизации. После возвращения клиента на сервис мерчанта необходима обработка данных, полученных от шлюза.
 <a name="async_queries_list"></a>Cписок асинхронных запросов:
@@ -18,12 +18,12 @@
 * transfer-by-ref
 
 Ознакомиться с обработкой таких запросов можно в следующих файлах:
-* [Пример выполнения запроса sale](../../example/sale.php)
-* [Пример выполнения запроса preauth](../../example/preauth.php)
-* [Пример выполнения запроса capture](../../example/capture.php)
-* [Пример выполнения запроса return](../../example/return.php)
-* [Пример выполнения запроса make-rebill](../../example/make-rebill.php)
-* [Пример выполнения запроса transfer-by-ref](../../example/transfer-by-ref.php)
+* [Пример выполнения запроса sale](../../example/sale.rb)
+* [Пример выполнения запроса preauth](../../example/preauth.rb)
+* [Пример выполнения запроса capture](../../example/capture.rb)
+* [Пример выполнения запроса return](../../example/return.rb)
+* [Пример выполнения запроса make-rebill](../../example/make-rebill.rb)
+* [Пример выполнения запроса transfer-by-ref](../../example/transfer-by-ref.rb)
 
 Отдельный сценарий обработки необходим и при интеграции платежной формы. Запрос к шлюзу возвращает ссылку на платежную форму, на которую должен быть отправлен клиент. После заполнения и отправки данных шлюз обрабатывает платежную форму и возвращает клиента на сервис мерчанта. После возвращения клиента на сервис мерчанта необходима обработка данных, полученных от шлюза.
 <a name="form_queries_list"></a>Список запросов для интеграции платежной формы:
@@ -32,9 +32,9 @@
 * transfer-form
 
 Ознакомиться с обработкой таких запросов можно в следующих файлах:
-* [Пример выполнения запроса sale-form](../../example/sale-form.php)
-* [Пример выполнения запроса preauth-form](../../example/preauth-form.php)
-* [Пример выполнения запроса transfer-form](../../example/transfer-form.php)
+* [Пример выполнения запроса sale-form](../../example/sale-form.rb)
+* [Пример выполнения запроса preauth-form](../../example/preauth-form.rb)
+* [Пример выполнения запроса transfer-form](../../example/transfer-form.rb)
 
 Некоторые операции с платежами не требуют сложных сценариев обработки и выполняются с помощью одного запроса.
 Список простых операций над платежом:
@@ -43,50 +43,50 @@
 * status
 
 Ознакомиться с обработкой таких запросов можно в следующих файлах:
-* [Пример выполнения запроса create-card-ref](../../example/create-card-ref.php)
-* [Пример выполнения запроса get-card-info](../../example/get-card-info.php)
-* [Пример выполнения запроса status](../../example/status.php)
+* [Пример выполнения запроса create-card-ref](../../example/create-card-ref.rb)
+* [Пример выполнения запроса get-card-info](../../example/get-card-info.rb)
+* [Пример выполнения запроса status](../../example/status.rb)
 
-Для удобного выполнения запросов к PaynetEasy в **PaymentProcessor** реализован метод **[executeQuery()](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L114)**.
+Для удобного выполнения запросов к PaynetEasy в **PaymentProcessor** реализован метод **[execute_query()](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L62)**.
 Метод принимает два параметра:
 * Название запроса
 * Платежная транзакция для обработки
 
-### <a name="processCustomerReturn"></a>processCustomerReturn(): простая обработка данных, полученных от PaynetEasy
+### <a name="process_customer_return"></a>process_customer_return(): обработка данных, полученных от PaynetEasy при возвращении клиента
 
-Каждый [асинхронный запрос](#async_queries_list) может завершиться перенаправлением пользователя на платежный шлюз для выполнения дополнительных действий, а каждый [запрос для интеграции платежной формы](#form_queries_list) обязательно содержит такое перенаправление. Каждый раз при возвращении пользователя на сервис мерчанта передаются данные с результатом обработки платежа. Также, если в [конфигурации стартового запроса](../00-basic-tutorial.md#stage_1_step_3) был задан ключ **server_callback_url**, то через некоторое время PaynetEasy вызовет этот url и передаст ему данные, описанные в wiki PaynetEasy в разделе [Merchant Callbacks](http://wiki.payneteasy.com/index.php/PnE:Merchant_Callbacks). Для удобной обработки этих данных в **PaymentProcessor** реализован метод **[executeCallback()](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L161)**.
+Каждый [асинхронный запрос](#async_queries_list) может завершиться перенаправлением пользователя на платежный шлюз для выполнения дополнительных действий, а каждый [запрос для интеграции платежной формы](#form_queries_list) обязательно содержит такое перенаправление. Каждый раз при возвращении пользователя на сервис мерчанта передаются данные с результатом обработки платежа. Также, если в [конфигурации стартового запроса](../00-basic-tutorial.md#stage_1_step_3) был задан ключ **server_callback_url**, то через некоторое время PaynetEasy вызовет этот url и передаст ему данные, описанные в wiki PaynetEasy в разделе [Merchant Callbacks](http://wiki.payneteasy.com/index.php/PnE:Merchant_Callbacks). Для удобной обработки этих данных в **PaymentProcessor** реализован метод **[process_customer_return()](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L85)**.
 Метод принимает два параметра:
 * Объект с данными, полученными при возвращении пользователя от PaynetEasy
 * Платежная транзакция для обработки
 
 Ознакомиться с использованием данного метода можно в следующих файлах:
 * [Базовый пример использования библиотеки](../00-basic-tutorial.md#stage_2)
-* [Пример выполнения запроса sale](../../example/sale.php#L91)
-* [Пример выполнения запроса preauth](../../example/preauth.php#L91)
-* [Пример выполнения запроса sale-form](../../example/sale-form.php#L70)
-* [Пример выполнения запроса preauth-form](../../example/preauth-form.php#70)
-* [Пример выполнения запроса transfer-form](../../example/transfer-form.php#70)
+* [Пример выполнения запроса sale](../../example/sale.rb#L91)
+* [Пример выполнения запроса preauth](../../example/preauth.rb#L91)
+* [Пример выполнения запроса sale-form](../../example/sale-form.rb#L70)
+* [Пример выполнения запроса preauth-form](../../example/preauth-form.rb#70)
+* [Пример выполнения запроса transfer-form](../../example/transfer-form.rb#70)
 
-### <a name="processPaynetEasyCallback"></a>processPaynetEasyCallback(): простая обработка данных, полученных от PaynetEasy
+### <a name="process_paynet_easy_callback"></a>process_paynet_easy_callback(): обработка удаленного вызова от PaynetEasy
 
-После выполнения [асинхронного запроса](#async_queries_list) или [запроса для интеграции платежной формы](#form_queries_list), если в [конфигурации стартового запроса](../00-basic-tutorial.md#stage_1_step_3) был задан ключ **server_callback_url**, то через некоторое время PaynetEasy вызовет этот url и передаст ему данные, описанные в wiki PaynetEasy в разделе [Merchant Callbacks](http://wiki.payneteasy.com/index.php/PnE:Merchant_Callbacks). Для удобной обработки этих данных в **PaymentProcessor** реализован метод **[processPaynetEasyCallback()](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L176)**.
+После выполнения [асинхронного запроса](#async_queries_list) или [запроса для интеграции платежной формы](#form_queries_list), если в [конфигурации стартового запроса](../00-basic-tutorial.md#stage_1_step_3) был задан ключ **server_callback_url**, то через некоторое время PaynetEasy вызовет этот url и передаст ему данные, описанные в wiki PaynetEasy в разделе [Merchant Callbacks](http://wiki.payneteasy.com/index.php/PnE:Merchant_Callbacks). Для удобной обработки этих данных в **PaymentProcessor** реализован метод **[process_paynet_easy_callback()](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L96)**.
 Метод принимает два параметра:
 * Объект с данными, полученными при возвращении пользователя от PaynetEasy
 * Платежная транзакция для обработки
 
 Ознакомиться с использованием данного метода можно в следующих файлах:
-* [Пример выполнения запроса sale](../../example/sale.php#L102)
-* [Пример выполнения запроса preauth](../../example/preauth.php#L102)
-* [Пример выполнения запроса sale-form](../../example/sale-form.php#L81)
-* [Пример выполнения запроса preauth-form](../../example/preauth-form.php#81)
-* [Пример выполнения запроса transfer-form](../../example/transfer-form.php#81)
+* [Пример выполнения запроса sale](../../example/sale.rb#L102)
+* [Пример выполнения запроса preauth](../../example/preauth.rb#L102)
+* [Пример выполнения запроса sale-form](../../example/sale-form.rb#L81)
+* [Пример выполнения запроса preauth-form](../../example/preauth-form.rb#81)
+* [Пример выполнения запроса transfer-form](../../example/transfer-form.rb#81)
 
-### <a name="setHandlers"></a> setHandlers(): установка обработчиков для различных событий, происходящих при обработке заказа
+### <a name="set_handlers"></a> set_handlers(): установка обработчиков для различных событий, происходящих при обработке заказа
 
-**PaymentProcessor** скрывает от конечного пользователя алгоритм обработки заказа в методах **[executeWorkflow()](#executeWorkflow)**, **[executeQuery()](#executeQuery)** и **[executeCallback()](#executeCallback)**. При этом во время обработки заказа возникают ситуации, обработка которых должна быть реализована на стороне сервиса мерчанта. Для обработки таких ситуаций в **PaymentProcessor** реализована система событий и их обработчиков. Обработчики могут быть установлены тремя разными способами:
-* Передача массива обработчиков в [конструктор класса **PaymentProcessor**](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L101)
-* Передача массива обработчиков в метод [**setHandlers()**](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L273)
-* Установка обработчиков по одному с помощью метода **[setHandler()](../../source/PaynetEasy/PaynetEasyApi/PaymentProcessor.php#L249)**
+**PaymentProcessor** скрывает от конечного пользователя алгоритм обработки заказа в методах **[execute_query()](#execute_query)**, **[process_customer_return()](#process_customer_return)** и **[process_paynet_easy_callback()](process_paynet_easy_callback)**. При этом во время обработки заказа возникают ситуации, обработка которых должна быть реализована на стороне сервиса мерчанта. Для обработки таких ситуаций в **PaymentProcessor** реализована система событий и их обработчиков. Обработчики могут быть установлены тремя разными способами:
+* Передача хэша с обработчиками в [конструктор класса **PaymentProcessor**](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L51)
+* Передача хэша с обработчиками в метод [**set_handlers()**](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L150)
+* Установка обработчиков по одному с помощью метода **[set_handler()](../../lib/paynet_easy/paynet_easy_api/payment_processor.rb#L140)**
 
 Список обработчиков событий:
 * **HANDLER_SAVE_CHANGES** - обработчик для сохранения платежной транзакции. Вызывается, если данные платежной транзакции изменены. Должен реализовывать сохранение платежной транзакции в хранилище. Принимает следующие параметры:
@@ -110,54 +110,56 @@
     * Ответ от PaynetEasy (опционально, не доступен, если произошла ошибка на этапе формирования или выполнения запроса к PaynetEasy)
 
 Метод принимает один параметр:
-* Массив с обработчиками событий. Ключами элементов массива являются названия обработчиков, заданные в константах класса, значениями - любые значения типа [callable](http://php.net/manual/en/language.types.callable.php)
+* Хэш с обработчиками событий. Ключами элементов хэша являются названия обработчиков, заданные в константах класса, значениями - любые значения типа [Proc](http://www.ruby-doc.org/core-2.0.0/Proc.html)
 
 Пример вызова метода с простейшими обработчиками:
 
-```php
-use PaynetEasy\PaynetEasyApi\PaymentProcessor;
-use PaynetEasy\PaynetEasyApi\PaymentData\PaymentTransaction;
-use PaynetEasy\PaynetEasyApi\Transport\Response;
-use Exception;
-
-$paymentProcessor = new PaymentProcessor;
-$paymentProcessor->setHandlers(array
-(
-    PaymentProcessor::HANDLER_SAVE_CHANGES      => function(PaymentTransaction $paymentTransaction)
-    {
-        start_session();
-        $_SESSION['payment_transaction'] = serialize($paymentTransaction);
-    },
-    PaymentProcessor::HANDLER_STATUS_UPDATE     => function()
-    {
-        header("Location: http://{$_SERVER['HTTP_HOST']}/{$_SERVER['REQUEST_URI']}?stage=updateStatus");
-        exit;
-    },
-    PaymentProcessor::HANDLER_SHOW_HTML         => function(Response $response)
-    {
-        print $response->getHtml();
-        exit;
-    },
-    PaymentProcessor::HANDLER_REDIRECT          => function(Response $response)
-    {
-        header("Location: {$response->getRedirectUrl()}");
-        exit;
-    },
-    PaymentProcessor::HANDLER_FINISH_PROCESSING => function(PaymentTransaction $paymentTransaction)
-    {
-        print "<pre>";
-        print "Payment processing finished.\n";
-        print "Payment status: '{$paymentTransaction->getPayment()->getStatus()}'.\n";
-        print "Payment transaction status: '{$paymentTransaction->getStatus()}'.\n";
-        print "</pre>";
-    },
-    PaymentProcessor::HANDLER_CATCH_EXCEPTION   => function(Exception $exception)
-    {
-        print "<pre>";
-        print "Exception catched.\n";
-        print "Exception message: '{$exception->getMessage()}'.\n";
-        print "Exception traceback: \n{$exception->getTraceAsString()}\n";
-        print "</pre>";
-    }
-));
+```ruby
+require 'paynet_easy_api'
+require 'cgi'
+require 'cgi/session'
+
+$_CGI     = CGI.new('html5')
+$_SESSION = CGI::Session.new $_CGI
+
+paymentProcessor = PaymentProcessor.new
+paymentProcessor.set_handlers(
+{
+    PaymentProcessor::HANDLER_SAVE_CHANGES      => ->(payment_transaction, response) do
+      $_SESSION['payment_transaction'] = Marshal.dump payment_transaction
+    end,
+    PaymentProcessor::HANDLER_STATUS_UPDATE     => ->(response, payment_transaction) do
+      current_location = "http://#{ENV['HTTP_HOST']}/#{ENV['REQUEST_URI']}?stage=updateStatus"
+      puts $_CGI.header('status' => 'REDIRECT', 'location' => current_location)
+    end,
+    PaymentProcessor::HANDLER_SHOW_HTML         => ->(response, payment_transaction) do
+      puts $_CGI.header
+      puts response.html
+    end,
+    PaymentProcessor::HANDLER_REDIRECT          => ->(response, payment_transaction) do
+      puts $_CGI.header('status' => 'REDIRECT', 'location' => response.redirect_url)
+      exit
+    end,
+    PaymentProcessor::HANDLER_FINISH_PROCESSING => ->(payment_transaction, response = nil) do
+      puts $_CGI.header
+      puts <<HTML
+        <pre>
+          Payment processing finished.
+          Payment status: '#{payment_transaction.payment.status}'
+          Payment transaction status: '#{payment_transaction.status}'
+        </pre>
+HTML
+    end,
+    PaymentProcessor::HANDLER_CATCH_EXCEPTION   => ->(exception, payment_transaction, response = nil) do
+      puts $_CGI.header
+      puts <<HTML
+        <pre>
+          Exception catched.
+          Exception message: '#{exception.message}'
+          Exception backtrace:
+          #{exception.backtrace}
+        </pre>
+HTML
+    end
+})
 ```

data/doc/library-internals/02-validator.md

@@ -1,31 +1,31 @@
 # Валидатор данных, Validator
 
-Статический класс **[PaynetEasy\PaynetEasyApi\Util\Validator](../../source/PaynetEasy/PaynetEasyApi/Util/Validator.php)** предоставляет следующие методы для валидации данных:
-* **[validateByRule()](#validateByRule)**: валидация с помощью предопределенного правила или регулярного выражения
+Модуль **[PaynetEasy::PaynetEasyApi::Util::Validator](../../lib/paynet_easy/paynet_easy_api/util/validator.rb)** предоставляет следующие методы для валидации данных:
+* **[validate_by_rule()](#validate_by_rule)**: валидация с помощью предопределенного правила или регулярного выражения
 
-### <a name="validateByRule"></a>validateByRule(): валидация с помощью предопределнного правила
+### <a name="validate_by_rule"></a>validate_by_rule(): валидация с помощью предопределнного правила
 
-Для удобной валидации данных в **[Validator](../../source/PaynetEasy/PaynetEasyApi/Util/Validator.php)** реализован метод **[validateByRule()](../../source/PaynetEasy/PaynetEasyApi/Util/Validator.php#L126)** и набор констант с правилами валидации. Список доступных правил:
+Для удобной валидации данных в **[Validator](../../lib/paynet_easy/paynet_easy_api/util/validator.rb)** реализован метод **[validate_by_rule()](../../lib/paynet_easy/paynet_easy_api/util/validator.rb#L87)** и набор констант с правилами валидации. Список доступных правил:
 
 Константа                       |Правило валидации          |Описание
 --------------------------------|---------------------------|--------
-Validator::EMAIL                |[FILTER_VALIDATE_EMAIL](http://www.php.net/manual/en/filter.filters.validate.php)|Validate value as email
-Validator::IP                   |[FILTER_VALIDATE_IP](http://www.php.net/manual/en/filter.filters.validate.php)|Validate value as IP address
-Validator::URL                  |[FILTER_VALIDATE_URL](http://www.php.net/manual/en/filter.filters.validate.php)|Validate value as URL
-Validator::MONTH                |0 < month < 13             |Validate value as month
-Validator::YEAR                 |#^[0-9]{1,2}$#i            |Validate value as year
-Validator::PHONE                |#^[0-9\-\+\(\)\s]{6,15}$#i |Validate value as phone number
-Validator::AMOUNT               |#^[0-9\.]{1,11}$#i         |Validate value as payment amount
-Validator::CURRENCY             |#^[A-Z]{1,3}$#i            |Validate value as currency
-Validator::CVV2                 |#^[\S\s]{3,4}$#i           |Validate value as card verification value
-Validator::ZIP_CODE             |#^[\S\s]{1,10}$#i          |Validate value as zip code
-Validator::COUNTRY              |#^[A-Z]{1,2}$#i            |Validate value as two-letter country or state code
-Validator::DATE                 |#^[0-9]{6}$#i              |Validate value as date in format MMDDYY
-Validator::SSN                  |#^[0-9]{1,4}$#i            |Validate value as last four digits of social security number
-Validator::CREDIT_CARD_NUMBER   |#^[0-9]{1,20}$#i           |Validate value as credit card number
-Validator::ID                   |#^[\S\s]{1,20}$#i          |Validate value as ID (client, paynet, card-ref, etc.)
-Validator::LONG_STRING          |#^[\S\s]{1,128}$#i         |Validate value as long string
-Validator::MEDIUM_STRING        |#^[\S\s]{1,50}$#i          |Validate value as medium string
+Validator::EMAIL                |/@+/                       |Validate value as email
+Validator::IP                   |URI::ABS_URI === ip        |Validate value as IP address
+Validator::URL                  |!!IPAddr.new(url)          |Validate value as URL
+Validator::MONTH                |(1..12).include? month.to_i|Validate value as month
+Validator::YEAR                 |/^[0-9]{1,2}$/i            |Validate value as year
+Validator::PHONE                |/^[0-9\-\+\(\)\s]{6,15}$/i |Validate value as phone number
+Validator::AMOUNT               |/^[0-9\.]{1,11}$/i         |Validate value as payment amount
+Validator::CURRENCY             |/^[A-Z]{1,3}$/i            |Validate value as currency
+Validator::CVV2                 |/^[\S\s]{3,4}$/i           |Validate value as card verification value
+Validator::ZIP_CODE             |/^[\S\s]{1,10}$/i          |Validate value as zip code
+Validator::COUNTRY              |/^[A-Z]{1,2}$/i            |Validate value as two-letter country or state code
+Validator::DATE                 |/^[0-9]{6}$/i              |Validate value as date in format MMDDYY
+Validator::SSN                  |/^[0-9]{1,4}$/i            |Validate value as last four digits of social security number
+Validator::CREDIT_CARD_NUMBER   |/^[0-9]{1,20}$/i           |Validate value as credit card number
+Validator::ID                   |/^[\S\s]{1,20}$/i          |Validate value as ID (client, paynet, card-ref, etc.)
+Validator::LONG_STRING          |/^[\S\s]{1,128}$/i         |Validate value as long string
+Validator::MEDIUM_STRING        |/^[\S\s]{1,50}$/i          |Validate value as medium string
 
 Метод принимает три параметра:
 * Значение для валидации
@@ -35,21 +35,20 @@ Validator::MEDIUM_STRING        |#^[\S\s]{1,50}$#i          |Validate value as m
     * **false** - будет возвращен булевый результат проверки
 Пример использования метода:
 
-```php
-use PaynetEasy\PaynetEasyApi\Util\Validator;
-use PaynetEasy\PaynetEasyApi\Exception\ValidationException;
-
-var_dump(Validator::validateByRule('test@mail.com', Validator::EMAIL, false));  // true
-var_dump(Validator::validateByRule('some string', '#\d#', false));              // false
-
-// prints 'invalid'
-try
-{
-    Validator::validateByRule('test[at]mail.com', Validator::EMAIL);
-    print 'valid';
-}
-catch (ValidationException $e)
-{
-    print 'invalid';
-}
+```ruby
+require 'paynet_easy_api'
+require 'util/validator'
+
+include PaynetEasy::PaynetEasyApi::Util
+
+p Validator.validate_by_rule('test@mail.com', Validator::EMAIL, false)  # true
+p Validator.validate_by_rule('some string', '#\d#', false)              # false
+
+# prints 'invalid'
+begin
+  Validator.validate_by_rule('test[at]mail.com', Validator::EMAIL)
+  puts 'valid'
+rescue ValidationError
+  puts 'invalid'
+end
 ```

data/doc/library-internals/03-property-accessor.md

@@ -1,12 +1,12 @@
-# Класс для работы с цепочками свойств, PropertyAccessor
+# Модуль для работы с цепочками свойств, PropertyAccessor
 
-В процессе работы с данными платежа возникает необходимость читать и изменять свойства объектов, хранящихся в Payment. Например, для чтения email клиента необходимо вызвать `$payment->getCustomer()->getEmail()`, а для записи - `$payment->getCustomer()->setEmail()`. Для удобного выполнения этих операций в классе **[PaynetEasy\PaynetEasyApi\Util\PropertyAccessor](../../source/PaynetEasy/PaynetEasyApi/Util/PropertyAccessor.php)** реализованы следующие методы:
-* **[getValue()](#getValue)**: удобное чтение данных по цепочке свойств
-* **[setValue()](#setValue)**: удобная запись данных по цепочке свойств
+В процессе работы с данными платежа возникает необходимость читать и изменять свойства объектов, хранящихся в PaymentTransaction. Например, для чтения email клиента необходимо вызвать `payment_transaction.payment.customer.email`, а для записи - `payment_transaction.payment.customer.email = ''`. Для удобного выполнения этих операций в модуле **[PaynetEasy::PaynetEasyApi::Util::PropertyAccessor](../../lib/paynet_easy/paynet_easy_api/util/property_accessor.rb)** реализованы следующие методы:
+* **[get_value()](#get_value)**: удобное чтение данных по цепочке свойств
+* **[set_value()](#set_value)**: удобная запись данных по цепочке свойств
 
-### <a name="getValue"></a> getValue(): удобное чтение данных по цепочке свойств
+### <a name="get_value"></a> get_value(): удобное чтение данных по цепочке свойств
 
-Метод предназначен для чтения данных из цепочки свойств. Цепочка свойств описывает порядок получения свойств из переданного объекта. Так, для цепочки `billingAddress.firstLine` будет получено значение свойства `firstLine` из объекта, хранящегося в свойстве `billingAddress`. Для получения свойств используются методы-геттеры, названия которых образованы добавлением префикса `get` к имени свойства. Таким образом, получение данных для цепочки `billingAddress.firstLine` приведет к вызову кода `$payment->getBillingAddress()->getFirstLine()`.
+Метод предназначен для чтения данных из цепочки свойств. Цепочка свойств описывает порядок получения свойств из переданного объекта. Так, для цепочки `payment.billing_address.first_line` будет получено значение свойства `first_line` из объекта, хранящегося в свойстве `billing_address`, хранящегося в свойстве `payment`. Для получения свойств используются методы-геттеры полей объекта.
 Метод принимает три параметра:
 * Объект, цепочку свойств которого можно прочитать
 * Цепочка свойств
@@ -15,62 +15,74 @@
     * **false** - будет возвращен `null`
 
 Пример использования метода:
-```php
-use PaynetEasy\PaynetEasyApi\Util\PropertyAccessor;
-use PaynetEasy\PaynetEasyApi\PaymentData\Payment;
-use PaynetEasy\PaynetEasyApi\PaymentData\CreditCard;
-use RuntimeException;
+```ruby
+require 'paynet_easy_api'
+require 'util/property_accessor'
 
-$creditCard = (new CreditCard)->setExpireYear(2014);
-$payment    = (new Payment)->setCreditCard($creditCard);
+include PaynetEasy::PaynetEasyApi::PaymentData
+include PaynetEasy::PaynetEasyApi::Util
 
-var_dump(PropertyAccessor::getValue($payment, 'creditCard.expireYear')); // 2014
-var_dump(PropertyAccessor::getValue($payment, 'creditCard.expireMonth', false)); // null
-
-// prints 'empty'
-try
-{
-    PropertyAccessor::getValue($payment, 'creditCard.expireMonth');
-}
-catch (RuntimeException $e)
+payment_transaction = PaymentTransaction.new(
 {
-    print 'empty';
-}
+  'payment' => Payment.new(
+  {
+    'credit_card' => CreditCard.new(
+    {
+      'expire_year' => '14'
+    })
+  })
+})
+
+p PropertyAccessor.get_value(payment_transaction, 'payment.credit_card.expire_year') # 2014
+p PropertyAccessor.get_value(payment_transaction, 'payment.credit_card.expire_month', false) # nil
+
+# prints 'empty'
+begin
+  PropertyAccessor.get_value(payment_transactions, 'payment.creditCard.expireMonth')
+rescue RuntimeError
+  puts 'empty'
+end
 ```
 
-### <a name="setValue"></a> setValue(): удобное изменение данных по цепочке свойств
+### <a name="set_value"></a> set_value(): удобное изменение данных по цепочке свойств
 
-Метод предназначен для изменения данных по цепочке свойств. Цепочка свойств описывает порядок получения свойств из переданного объекта. Так, для цепочки `billingAddress.firstLine` будет изменено значение свойства `firstLine` из объекта, хранящегося в свойстве `billingAddress`. Для получения свойств используются методы-геттеры, названия которых образованы добавлением префикса `get` к имени свойства, для изменения - методы-сеттеры, названия которых образованы добавлением префикса `set` к имени свойства. Таким образом, изменение данных для цепочки `billingAddress.firstLine` приведет к вызову кода `$payment->getBillingAddress()->setFirstLine($firstLine)`.
+Метод предназначен для изменения данных по цепочке свойств. Цепочка свойств описывает порядок получения свойств из переданного объекта. Так, для цепочки `payment.billing_address.first_line` будет изменено значение свойства `first_line` из объекта, хранящегося в свойстве `billing_address`, хранящегося в свойстве `payment`. Для получения свойств используются методы-геттеры для полей объекта, для изменения - методы-сеттеры, названия которых образованы добавлением префикса `set` к имени свойства. Таким образом, изменение данных для цепочки `payment.billingAddress.
 Метод принимает четыре параметра:
 * Объект, цепочку свойств которого можно прочитать
 * Цепочка свойств
 * Новое значение
 * Флаг, определяющий поведение метода в том случае, если геттер или сеттер для свойства не был найден или если свойство, в котором ожидался объект, пустое:
     * **true** - будет брошено исключение
-    * **false** - будет возвращен `null`
+    * **false** - будет возвращен `nil`
 
 Пример использования метода:
-```php
-use PaynetEasy\PaynetEasyApi\Util\PropertyAccessor;
-use PaynetEasy\PaynetEasyApi\PaymentData\Payment;
-use PaynetEasy\PaynetEasyApi\PaymentData\CreditCard;
-use RuntimeException;
+```ruby
+require 'paynet_easy_api'
+require 'util/property_accessor'
 
-$creditCard = (new CreditCard)->setExpireYear(2014);
-$payment    = (new Payment)->setCreditCard($creditCard);
+include PaynetEasy::PaynetEasyApi::PaymentData
+include PaynetEasy::PaynetEasyApi::Util
 
-PropertyAccessor::setValue($payment, 'creditCard.expireYear', 2015);
-var_dump(PropertyAccessor::getValue($payment, 'creditCard.expireYear')); // 2015
+payment_transaction = PaymentTransaction.new(
+{
+  'payment' => Payment.new(
+  {
+    'credit_card' => CreditCard.new(
+    {
+      'expire_year' => '14'
+    })
+  })
+})
 
-PropertyAccessor::setValue($payment, 'creditCard.nonExistentProperty', 'value', false); // nothing will happen
+PropertyAccessor.set_value(payment_transaction, 'payment.credit_card.expire_year', 15)
+p PropertyAccessor.get_value(payment_transaction, 'payment.credit_card.expire_year') # 15
 
-// prints 'nonexistent property'
-try
-{
-    PropertyAccessor::setValue($payment, 'creditCard.nonExistentProperty', 'value');
-}
-catch (RuntimeException $e)
-{
-    print 'nonexistent property';
-}
+PropertyAccessor.set_value(payment_transaction, 'payment.credit_card.non_existent_property', 'value', false) # nothing will happen
+
+# prints 'nonexistent property'
+begin
+  PropertyAccessor.set_value(payment_transaction, 'payment.credit_card.non_existent_property', 'value')
+rescue RuntimeError
+  puts 'nonexistent property'
+end
 ```