Add BitCoin helper - #50

Author: Corey McCormick

docs/en/README.md

@@ -247,6 +247,22 @@ You can display a PNG image without saving the file by providing a raw string an
 
 Helpers are an easy way to create QrCodes that cause a reader to perform a certain action when scanned.  
 
+#### BitCoin
+
+This helpers generates a scannable bitcoin to send payments.  [More information](https://bitco.in/en/developer-guide#plain-text)
+
+	QrCode::BTC($address, $amount);
+	
+	//Sends a 0.334BTC payment to the address
+	QrCode::BTC('bitcoin address', 0.334);
+	
+	//Sends a 0.334BTC payment to the address with some optional arguments
+	QrCode::size(500)->BTC('address', 0.0034, [
+        'label' => 'my label',
+        'message' => 'my message',
+        'returnAddress' => 'https://www.returnaddress.com'
+    ]);
+
 #### E-Mail
 
 This helper generates an e-mail qrcode that is able to fill in the e-mail address, subject, and body.

src/SimpleSoftwareIO/QrCode/DataTypes/BTC.php

@@ -0,0 +1,134 @@
+<?php
+
+namespace SimpleSoftwareIO\QrCode\DataTypes;
+
+class BTC implements DataTypeInterface
+{
+    /**
+     * The prefix of the QrCode.
+     *
+     * @var string
+     */
+    protected $prefix = 'bitcoin:';
+
+    /**
+     * The separator between the variables.
+     *
+     * @var string
+     */
+    protected $separator = '&';
+
+    /**
+     * The BitCoin address.
+     *
+     * @var string
+     */
+    protected $address;
+
+    /**
+     * The amount to send.
+     *
+     * @var integer
+     */
+    protected $amount;
+
+    /**
+     * The BitCoin transaction label.
+     *
+     * @var string
+     */
+    protected $label;
+
+    /**
+     * The BitCoin message to send.
+     *
+     * @var string
+     */
+    protected $message;
+
+    /**
+     * The BitCoin return URL.
+     *
+     * @var string
+     */
+    protected $returnAddress;
+
+    /**
+     * Generates the DataType Object and sets all of its properties.
+     *
+     * @param $arguments
+     */
+    public function create(array $arguments)
+    {
+        $this->setProperties($arguments);
+    }
+
+    /**
+     * Returns the correct QrCode format.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->buildBitCoinString();
+    }
+
+    /**
+     * Sets the BitCoin arguments.
+     *
+     * @param array $arguments
+     */
+    protected function setProperties(array $arguments)
+    {
+        if (isset($arguments[0])) {
+            $this->address = $arguments[0];
+        }
+
+        if (isset($arguments[1])) {
+            $this->amount = $arguments[1];
+        }
+
+        if (isset($arguments[2])) {
+            $this->setOptions($arguments[2]);
+        }
+    }
+
+    /**
+     * Sets the optional BitCoin options
+     *
+     * @param array $options
+     */
+    protected function setOptions(array $options)
+    {
+        if (isset($options['label'])) {
+            $this->label = $options['label'];
+        }
+
+        if (isset($options['message'])) {
+            $this->message = $options['message'];
+        }
+
+        if (isset($options['returnAddress'])) {
+            $this->returnAddress = $options['returnAddress'];
+        }
+    }
+
+    /**
+     * Builds a BitCoin string.
+     *
+     * @return string
+     */
+    protected function buildBitCoinString()
+    {
+        $query = http_build_query([
+            'amount' => $this->amount,
+            'label' => $this->label,
+            '$message' => $this->message,
+            'r' => $this->returnAddress
+        ]);
+
+        $btc = $this->prefix.$this->address.'?'.$query;
+
+        return $btc;
+    }
+}

tests/DataTypes/BTC.php

@@ -0,0 +1,46 @@
+<?php
+
+use SimpleSoftwareIO\QrCode\DataTypes\BTC;
+
+class BTCTest extends \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        $this->btc = new BTC();
+    }
+
+    public function test_it_generates_a_valid_btc_qrcode_with_an_address_and_amount()
+    {
+        $this->btc->create(['btcaddress', 0.0034]);
+
+        $properFormat = 'bitcoin:btcaddress?amount=0.0034';
+
+        $this->assertEquals($properFormat, strval($this->btc));
+    }
+
+    public function test_it_generates_a_valid_btc_qrcode_with_an_address_amount_and_label()
+    {
+        $this->btc->create(['btcaddress', 0.0034, ['label' => 'label']]);
+
+        $properFormat = 'bitcoin:btcaddress?amount=0.0034&label=label';
+
+        $this->assertEquals($properFormat, strval($this->btc));
+    }
+
+    public function test_it_generates_a_valid_btc_qrcode_with_an_address_amount_label_message_and_return_address()
+    {
+        $this->btc->create([
+            'btcaddress',
+            0.0034,
+            [
+                'label' => 'label',
+                'message' => 'message',
+                'returnAddress' => 'https://www.returnaddress.com'
+            ]
+        ]);
+
+        $properFormat = 'bitcoin:btcaddress?amount=0.0034&label=label&%24message=message&r=' . urlencode('https://www.returnaddress.com');
+
+        $this->assertEquals($properFormat, strval($this->btc));
+    }
+}