PageRenderTime 72ms CodeModel.GetById 32ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/index.html

https://github.com/dmilith/payments-pl
HTML | 170 lines | 151 code | 19 blank | 0 comment | 0 complexity | f669c7cec771b88ba604335f45e640fb MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4.   <head>
    5. 

  5.     <meta name="Content-Type" content="text/html; charset=utf-8" />
    6. 

  6. <title>payments-pl 0.4.1
    7. 

  7. </title>
    8. 

  8. <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
    9. 

  9. <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
    10. 

  10. 

  11. <script type="text/javascript" charset="utf-8">
    12. 

  12.   relpath = '';
    13. 

  13.   if (relpath != '') relpath += '/';
    14. 

  14. </script>
    15. 

  15. <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
    16. 

  16. <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
    17. 

  17. 

  18.   </head>
    19. 

  19.   <body>
    20. 

  20.     <script type="text/javascript" charset="utf-8">
    21. 

  21.       if (window.top.frames.main) document.body.className = 'frames';
    22. 

  22.     </script>
    23. 

  23.     
    24. 

  24.     <div id="header">
    25. 

  25.       <div id="menu">
    26. 

  26.   
    27. 

  27.     <a href="_index.html" title="Index">Index</a> &raquo; 
    28. 

  28.     <span class="title">File: README</span>
    29. 

  29.   
    30. 

  30.   
    31. 

  31.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
    32. 

  32. </div>
    33. 

  33. 

  34.       <div id="search">
    35. 

  35.   <a id="class_list_link" href="#">Class List</a>
    36. 

  36.   <a id="method_list_link" href="#">Method List</a>
    37. 

  37.   <a id ="file_list_link" href="#">File List</a>
    38. 

  38. </div>
    39. 

  39. 

  40.       <div class="clear"></div>
    41. 

  41.     </div>
    42. 

  42.     
    43. 

  43.     <iframe id="search_frame"></iframe>
    44. 

  44.     
    45. 

  45.     <div id="content"><div id='filecontents'><h1>payments-pl</h1>
    46. 

  46. <p>
    47. 

  47. Simple library for handling payments via platnosci.pl
    48. 

  48. </p>
    49. 

  49. <h2>Features</h2>
    50. 

  50. <ul>
    51. 

  51. <li>Simple configuration (multiple POS-es)
    52. 

  52. 

  53. </li>
    54. 

  54. <li>Transactions: create, get state, confirm, cancel
    55. 

  55. 

  56. </li>
    57. 

  57. <li>View helper for generating payment form
    58. 

  58. 

  59. </li>
    60. 

  60. </ul>
    61. 

  61. <h2>Installation</h2>
    62. 

  62. <p>
    63. 

  63. Install gem:
    64. 

  64. </p>
    65. 

  65. <pre class="code">
    66. 

  66.   <span class='sudo identifier id'>sudo</span> <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='payments identifier id'>payments</span><span class='minus op'>-</span><span class='pl identifier id'>pl</span>
    67. 

  67. </pre>
    68. 

  68. <p>
    69. 

  69. And add it n your environment.rb file:
    70. 

  70. </p>
    71. 

  71. <pre class="code">
    72. 

  72.   <span class='config identifier id'>config</span><span class='dot token'>.</span><span class='gem identifier id'>gem</span> <span class='string val'>'payments-pl'</span><span class='comma token'>,</span> <span class='symbol val'>:lib</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'payments_pl'</span>
    73. 

  73. </pre>
    74. 

  74. <h2>Configuration</h2>
    75. 

  75. <p>
    76. 

  76. First add POS informations in config/payments.yml file:
    77. 

  77. </p>
    78. 

  78. <pre class="code">
    79. 

  79.   <span class='bank identifier id'>bank</span><span class='colon op'>:</span>
    80. 

  80.     <span class='pos_id identifier id'>pos_id</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    81. 

  81.     <span class='pos_auth_key identifier id'>pos_auth_key</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    82. 

  82.     <span class='key1 identifier id'>key1</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    83. 

  83.     <span class='key2 identifier id'>key2</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    84. 

  84.     <span class='type identifier id'>type</span><span class='colon op'>:</span> <span class='express_gateway identifier id'>express_gateway</span>
    85. 

  85. 

  86.   <span class='sms identifier id'>sms</span><span class='colon op'>:</span>
    87. 

  87.     <span class='pos_id identifier id'>pos_id</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    88. 

  88.     <span class='pos_auth_key identifier id'>pos_auth_key</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    89. 

  89.     <span class='key1 identifier id'>key1</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    90. 

  90.     <span class='key2 identifier id'>key2</span><span class='colon op'>:</span> <span class='XXX constant id'>XXX</span>
    91. 

  91.     <span class='type identifier id'>type</span><span class='colon op'>:</span> <span class='sms_premium identifier id'>sms_premium</span>
    92. 

  92. </pre>
    93. 

  93. <p>
    94. 

  94. Next add some routes so platnosci.pl can send messages to your application:
    95. 

  95. </p>
    96. 

  96. <pre class="code">
    97. 

  97.   <span class='map identifier id'>map</span><span class='dot token'>.</span><span class='connect identifier id'>connect</span> <span class='string val'>'/payments/ok'</span><span class='comma token'>,</span>     <span class='symbol val'>:controller</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'payments'</span><span class='comma token'>,</span> <span class='symbol val'>:action</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'ok'</span>
    98. 

  98.   <span class='map identifier id'>map</span><span class='dot token'>.</span><span class='connect identifier id'>connect</span> <span class='string val'>'/payments/error'</span><span class='comma token'>,</span>  <span class='symbol val'>:controller</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'payments'</span><span class='comma token'>,</span> <span class='symbol val'>:action</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'error'</span>
    99. 

  99.   <span class='map identifier id'>map</span><span class='dot token'>.</span><span class='connect identifier id'>connect</span> <span class='string val'>'/payments/report'</span><span class='comma token'>,</span> <span class='symbol val'>:controller</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'payments'</span><span class='comma token'>,</span> <span class='symbol val'>:action</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'report'</span>
    100. 

  100. </pre>
    101. 

  101. <p>
    102. 

  102. These urls must be the same as those you entered on platnosci.pl site.
    103. 

  103. </p>
    104. 

  104. <h2>Usage</h2>
    105. 

  105. <p>
    106. 

  106. Creating new transaction in controller:
    107. 

  107. </p>
    108. 

  108. <pre class="code">
    109. 

  109.   <span class='def def kw'>def</span> <span class='some_action identifier id'>some_action</span>
    110. 

  110.     <span class='@transaction ivar id'>@transaction</span> <span class='assign token'>=</span> <span class='Payments constant id'>Payments</span><span class='lbrack token'>[</span><span class='string val'>'bank'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='new_transaction identifier id'>new_transaction</span><span class='lparen token'>(</span><span class='symbol val'>:amount</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='integer val'>100</span><span class='comma token'>,</span> <span class='symbol val'>:desc</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'Abonament'</span><span class='comma token'>,</span> <span class='symbol val'>:client_ip</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='request identifier id'>request</span><span class='dot token'>.</span><span class='remote_addr identifier id'>remote_addr</span><span class='comma token'>,</span> <span class='symbol val'>:js</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'0'</span><span class='rparen token'>)</span>
    111. 

  111.   <span class='end end kw'>end</span>
    112. 

  112. </pre>
    113. 

  113. <p>
    114. 

  114. Rendering payment form:
    115. 

  115. </p>
    116. 

  116. <pre class="code">
    117. 

  117.   <span class='minus op'>-</span> <span class='form_tag identifier id'>form_tag</span> <span class='@transaction ivar id'>@transaction</span><span class='dot token'>.</span><span class='new_url identifier id'>new_url</span> <span class='do do kw'>do</span>
    118. 

  118.     <span class='assign token'>=</span> <span class='transaction_hidden_fields identifier id'>transaction_hidden_fields</span> <span class='@transaction ivar id'>@transaction</span>
    119. 

  119.     <span class='assign token'>=</span> <span class='submit_tag identifier id'>submit_tag</span> <span class='string val'>'Pay'</span>
    120. 

  120. </pre>
    121. 

  121. <p>
    122. 

  122. Controller for receiving messages from platnosci.pl:
    123. 

  123. </p>
    124. 

  124. <pre class="code">
    125. 

  125.   <span class='class class kw'>class</span> <span class='PaymentsController constant id'>PaymentsController</span> <span class='lt op'>&lt;</span> <span class='ApplicationController constant id'>ApplicationController</span>
    126. 

  126.     <span class='skip_before_filter identifier id'>skip_before_filter</span> <span class='symbol val'>:verify_authenticity_token</span>
    127. 

  127. 

  128.     <span class='def def kw'>def</span> <span class='error identifier id'>error</span>
    129. 

  129.       <span class='render identifier id'>render</span> <span class='symbol val'>:text</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='Payments constant id'>Payments</span><span class='dot token'>.</span><span class='error_text identifier id'>error_text</span><span class='lparen token'>(</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:error</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
    130. 

  130.     <span class='end end kw'>end</span>
    131. 

  131. 

  132.     <span class='def def kw'>def</span> <span class='ok identifier id'>ok</span>
    133. 

  133.       <span class='render identifier id'>render</span> <span class='symbol val'>:text</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'Payment OK'</span>
    134. 

  134.     <span class='end end kw'>end</span>
    135. 

  135. 

  136.     <span class='def def kw'>def</span> <span class='report identifier id'>report</span>
    137. 

  137.       <span class='status identifier id'>status</span><span class='comma token'>,</span> <span class='transaction identifier id'>transaction</span> <span class='assign token'>=</span> <span class='Payments constant id'>Payments</span><span class='lbrack token'>[</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:pos_id</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='get identifier id'>get</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:session_id</span><span class='rbrack token'>]</span>
    138. 

  138.       <span class='if if kw'>if</span> <span class='status identifier id'>status</span> <span class='eq op'>==</span> <span class='string val'>'OK'</span>
    139. 

  139.         <span class='if if kw'>if</span> <span class='transaction identifier id'>transaction</span><span class='dot token'>.</span><span class='trans_status identifier id'>trans_status</span> <span class='eq op'>==</span> <span class='string val'>'99'</span>
    140. 

  140.           <span class='comment val'># paid, money received</span>
    141. 

  141.         <span class='else else kw'>else</span>
    142. 

  142.           <span class='comment val'># other stuff</span>
    143. 

  143.         <span class='end end kw'>end</span>
    144. 

  144.       <span class='end end kw'>end</span>
    145. 

  145.       <span class='render identifier id'>render</span> <span class='symbol val'>:text</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'OK'</span>
    146. 

  146.     <span class='end end kw'>end</span>
    147. 

  147.   <span class='end end kw'>end</span>
    148. 

  148. </pre>
    149. 

  149. <p>
    150. 

  150. Cancelling and confirming transaction is similar to getting transaction
    151. 

  151. state:
    152. 

  152. </p>
    153. 

  153. <pre class="code">
    154. 

  154.   <span class='status identifier id'>status</span><span class='comma token'>,</span> <span class='transaction identifier id'>transaction</span> <span class='assign token'>=</span> <span class='Payments constant id'>Payments</span><span class='lbrack token'>[</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:pos_id</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='cancel identifier id'>cancel</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:session_id</span><span class='rbrack token'>]</span>
    155. 

  155.   <span class='status identifier id'>status</span><span class='comma token'>,</span> <span class='transaction identifier id'>transaction</span> <span class='assign token'>=</span> <span class='Payments constant id'>Payments</span><span class='lbrack token'>[</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:pos_id</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='confirm identifier id'>confirm</span> <span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='symbol val'>:session_id</span><span class='rbrack token'>]</span>
    156. 

  156. </pre>
    157. 

  157. <h2>Copyright</h2>
    158. 

  158. <p>
    159. 

  159. Copyright &#169; 2010 Michał Młoźniak. See LICENSE for details.
    160. 

  160. </p>
    161. 

  161. </div></div>
    162. 

  162.     
    163. 

  163.     <div id="footer">
    164. 

  164.   Generated on Wed Aug 18 22:12:44 2010 by 
    165. 

  165.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
    166. 

  166.   0.5.8 (ruby-1.8.7).
    167. 

  167. </div>
    168. 

  168. 

  169.   </body>
    170. 

  170. </html>
    171.