xapo_sdk 0.0.1.pre.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad2e1b7257d3e2ff993c91b353a676a597c9def1
-  data.tar.gz: c8e76f1f93b6ca221ceec83b22fa75e9e4fd66e7
+  metadata.gz: 66227ffeca0ea2c6c313df33e6bb6e959113b840
+  data.tar.gz: 94613eba6fca7265cea57c6acb86f88de9b025de
 SHA512:
-  metadata.gz: 3cdec2146eabd4eda03bf489575af1d47c6682ac1a0d7b37db539bd17bb7cf79185cf1cbe5a34994f32affd8851de4c431203f73bce0708292c5793fa06600fe
-  data.tar.gz: af2f4663bbb24c9490cbcfb724e4657fa2e513afe467306df97deed5f0aee4d0ed4c71536b486d8c0627302ad9ba033c5cc8365b3c452cc7ed0bdc50b12adc67
+  metadata.gz: 1290315d1ab8f2bb52f004969f572141488ddc1c8db05dd953a790cd9afff23b75781404f87e4fb444e7ddcb57a95e7329221f03775086119ef52afc2ade6774
+  data.tar.gz: 99208026f43d3b5efbc3abff53ad2e1e7a882f07ff7b3b59d655c7f10c970b92320173816affe1b66dbd49343c2bea75b9b296b8499d553dedbc70c2ae632725

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+0.2.0 / 2014-11-01
+==================
+
+  * Having a TPA is not longer mandatory to provide a micro payments widget. Parameters 'app_id' and 'app_secret' are now optional. 
+
+0.0.1 / 2014-10-18
+==================
+
+  * Initial commit
+  * Encryption library
+  * Micro payment `div` and `iframe`

data/README.md

@@ -4,6 +4,8 @@
 
 ---
 
+[Changelog](CHANGELOG.md)
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 ## Table of Contents 
@@ -62,6 +64,8 @@ Micro payment widgets allow to dynamically get a HTML snippet pre-configured and
 - **Pay Object's Id:** `[mandatory]` any unique identifier in the context of the TPA distinguishing the object of the payment.
 - **Pay type:** `[optional]` any of Donate | Pay | Tip | Deposit.
 
+Be aware that micro payments could be optionally configured with your own application id and secret (`app_id`/`app_secret`). Configuring the micro payment with your application credentials allows you to charge a transaction fee for example.
+
 ### IFrame Widget
 ```ruby
 require 'xapo_tools'
@@ -69,9 +73,10 @@ require 'xapo_tools'
 ...
 
 micro_payment = XapoTools::MicroPayment.new(
-            XAPO_URL, 
-            APP_ID, 
-            APP_SECRET)
+                                            XAPO_URL, 
+                                            APP_ID,    # optional
+                                            APP_SECRET # optional
+                                           )
 config = XapoTools.micro_payment_config
 
 config[:sender_user_email] = "sender@xapo.com"
@@ -101,9 +106,10 @@ require 'xapo_tools'
 ...
 
 micro_payment = XapoTools::MicroPayment.new(
-            XAPO_URL, 
-            APP_ID, 
-            APP_SECRET)
+                                            XAPO_URL, 
+                                            APP_ID,     # optional 
+                                            APP_SECRET  # optional
+                                           )
 config = XapoTools.micro_payment_config
 
 config[:sender_user_email] = "sender@xapo.com"
@@ -154,7 +160,7 @@ See the example results in the [widgets gallery](#widgets-gallery).
 ## TODO
 - ~~Fix style (https://github.com/bbatsov/ruby-style-guide#naming)~~
 - ~~Add unit testing~~
-- Document, document, ~~document~
+- Document, document, ~~document~~
 - ~~Review naming and organization (with respect to Java & Python?)~~
-- Review `gem` build infraestructure
-- ...
+- ~~Review `gem` build infraestructure~~
+- ...

data/lib/xapo_sdk/version.rb

@@ -1,3 +1,3 @@
 module XapoSdk
-  VERSION = "0.0.1-1"
+  VERSION = "0.2.0"
 end

data/lib/xapo_tools.rb

@@ -7,75 +7,129 @@ require "yaml"
 
 module XapoTools
 
-    module_function 
-
-    def micro_payment_config
-        return Hash[:sender_user_id => "", :sender_user_email => "", 
-                    :sender_user_cellphone => "", :receiver_user_id => "", 
-                    :receiver_user_email => "", :pay_object_id => "", 
-                    :amount_BIT => 0, :timestamp => XapoUtils.timestamp, 
-                    :pay_type => ""]
+  module_function 
+
+  # Micro payment button configuration options.
+  #
+  # This function is intended to be a helper for creating empty micro
+  # payments buttons configuration but also serves for documenting. A 
+  # hash with the intended fields would give the same results.
+  #
+  # Attributes:
+  #      sender_user_id (str): The id of the user sending the payment.
+  #      sender_user_email (str, optional): The email of the user sending
+  #          the payment.
+  #      sender_user_cellphone (str, optional): The celphone number of the user
+  #          sending the payment.
+  #      receiver_user_id (str): The id of the user receiving the payment.
+  #      receiver_user_email (str): The email of the user receiving the payment.
+  #      pay_object_id (str): A payment identifier in the TPA context.
+  #      amount_BIT (float, optional): The amount of bitcoins to be payed by the
+  #          widget. If not specified here, it must be entered on payment basis.
+  #      pay_type (str): The string representing the type of operation
+  #          ("Tip", "Pay", "Deposit" or "Donate").
+  def micro_payment_config
+    return Hash[:sender_user_id => "", :sender_user_email => "", 
+                :sender_user_cellphone => "", :receiver_user_id => "", 
+                :receiver_user_email => "", :pay_object_id => "", 
+                :amount_BIT => 0, :timestamp => XapoUtils.timestamp, 
+                :pay_type => ""]
+  end
+
+  # Xapo's payment buttons snippet builder.
+  #
+  # This class allows the construction of 2 kind of widgets, *div* and
+  # *iframe*. The result is a HTML snippet that could be embedded in a
+  # web page for doing micro payments though a payment button.
+  #
+  # Attributes:
+  #    service_url (str): The endpoint URL that returns the payment widget.
+  #    app_id (str, optional): The id of the TPA for which the widget will be created.
+  #    app_secret (str, optional): The TPA secret used to encrypt widget configuration.
+  class MicroPayment    
+    def initialize(service_url, app_id=nil, app_secret=nil)
+      @service_url = service_url
+      @app_id = app_id
+      @app_secret = app_secret
     end
 
-    class MicroPayment
-        def initialize(service_url, app_id, app_secret)
-            @service_url = service_url
-            @app_id = app_id
-            @app_secret = app_secret
-        end
-
-        def build_url(config)
-            json_config = JSON.generate(config)
-            encrypted_config = XapoUtils.encrypt(json_config, @app_secret)
-
-            query_str = URI.encode_www_form(
-                "app_id" => @app_id, 
-                "button_request" => encrypted_config,
-                "customization" => JSON.generate({"button_text" => config[:pay_type]}))
-
-            widget_url = @service_url + "?" + query_str
-
-            return widget_url
-        end
-
-        def build_iframe_widget(config)
-            widget_url = build_url(config)
-
-            snippet = YAML::load(<<-END)
-            |
-                <iframe id="tipButtonFrame" scrolling="no" frameborder="0"
-                    style="border:none; overflow:hidden; height:22px;"
-                    allowTransparency="true" src="#{widget_url}">
-                </iframe>
-            END
-
-            return snippet
-        end
-
-        def build_div_widget(config)
-            widget_url = build_url(config)
-
-            snippet = YAML::load(<<-END)
-            |
-                <div id="tipButtonDiv" class="tipButtonDiv"></div>
-                <div id="tipButtonPopup" class="tipButtonPopup"></div>
-                <script>
-                    $(document).ready(function() {{
-                        $("#tipButtonDiv").load("#{widget_url}");
-                    }});
-                </script>
-            END
-
-            return snippet
-        end
-
-        private :build_url
+    def build_url(config)
+      json_config = JSON.generate(config)
+      
+      if @app_secret == nil || @app_id == nil
+        query_str = URI.encode_www_form(
+          "payload" => json_config,
+          "customization" => JSON.generate({"button_text" => config[:pay_type]})
+        )
+      else
+        encrypted_config = XapoUtils.encrypt(json_config, @app_secret)
+
+        query_str = URI.encode_www_form(
+          "app_id" => @app_id, 
+          "button_request" => encrypted_config,
+          "customization" => JSON.generate({"button_text" => config[:pay_type]})
+        )
+      end
+
+      widget_url = @service_url + "?" + query_str
+
+      return widget_url
     end
+
+    # Build an iframe HTML snippet in order to be embedded in apps.
+    #
+    # Args:
+    #   config (MicroPaymentConfig): The button configuration options.
+    #   See @MicroPaymentConfig.
+    #
+    # Returns:
+    #   string: the iframe HTML snippet ot be embedded in a page.
+    def build_iframe_widget(config)
+      widget_url = build_url(config)
+
+      snippet = YAML::load(<<-END)
+      |
+          <iframe id="tipButtonFrame" scrolling="no" frameborder="0"
+              style="border:none; overflow:hidden; height:22px;"
+              allowTransparency="true" src="#{widget_url}">
+          </iframe>
+      END
+
+      return snippet
+    end
+
+    # Build div HTML snippet in order to be embedded in apps.
+    #
+    # Args:
+    #   config (MicroPaymentConfig): The button configuration options.
+    #   See @MicroPaymentConfig.
+    #
+    # Returns:
+    #   string: the div HTML snippet ot be embedded in a page.
+    def build_div_widget(config)
+      widget_url = build_url(config)
+
+      snippet = YAML::load(<<-END)
+      |
+          <div id="tipButtonDiv" class="tipButtonDiv"></div>
+          <div id="tipButtonPopup" class="tipButtonPopup"></div>
+          <script>
+              $(document).ready(function() {{
+                  $("#tipButtonDiv").load("#{widget_url}");
+              }});
+          </script>
+      END
+
+      return snippet
+    end
+
+    private :build_url
+  end
 end
 
 module PayType
-    TIP = "Tip"
-    DONATE = "Donate"
-    PAY = "Pay"
-    DEPOSIT = "Deposit"
+  TIP = "Tip"
+  DONATE = "Donate"
+  PAY = "Pay"
+  DEPOSIT = "Deposit"
 end

data/lib/xapo_utils.rb

@@ -3,17 +3,25 @@ require "base64"
 
 module XapoUtils
 
-    module_function
-            
-    def encrypt(payload, secret)
-        cipher = OpenSSL::Cipher::AES.new("256-ECB")
-        cipher.encrypt
-        cipher.key = secret        
+  module_function
+          
+  # Do PKCS#7 padding and encrypting.
+  #
+  # Args:
+  #   bytestring (str): The text to encode.
+  #   k (int, optional): The padding block size. It defaults to k=16.
+  #
+  # Returns:
+  #  str: The padded bytestring.
+  def encrypt(payload, secret)
+    cipher = OpenSSL::Cipher::AES.new("256-ECB")
+    cipher.encrypt
+    cipher.key = secret        
 
-        encrypted = cipher.update(payload) + cipher.final
+    encrypted = cipher.update(payload) + cipher.final
 
-        return Base64.encode64(encrypted)
-    end
+    return Base64.encode64(encrypted)
+  end
 
-    def timestamp; (Time.now.to_f * 1000).to_i end
+  def timestamp; (Time.now.to_f * 1000).to_i end
 end

data/test/test_xapo_tools.rb

@@ -2,45 +2,84 @@ require "minitest/autorun"
 require "xapo_tools"
 
 class TestXapoTools < Minitest::Test
-    def setup     
-        @xapo_tools = XapoTools::MicroPayment.new(
-            "http://dev.xapo.com:8089/pay_button/show", 
-            "b91014cc28c94841", 
-            "c533a6e606fb62ccb13e8baf8a95cbdc")
-    end
-
-    def test_build_iframe_widget()
-        config = XapoTools.micro_payment_config
-        config[:sender_user_email] = "sender@xapo.com"
-        config[:sender_user_cellphone] = "+5491112341234"
-        config[:receiver_user_id] = "r0210"
-        config[:receiver_user_email] = "fernando.taboada@xapo.com"
-        config[:pay_object_id] = "to0210"
-        config[:amount_BIT] = 0.01
-        config[:pay_type] = PayType::DONATE
-
-        actual = @xapo_tools.build_iframe_widget(config)
-
-        assert_match(/<iframe(.*)>(.*)<\/iframe>\n/m, actual)
-    end
-
-    def test_build_div_widget()
-        config = XapoTools.micro_payment_config
-        config[:sender_user_email] = "sender@xapo.com"
-        config[:sender_user_cellphone] = "+5491112341234"
-        config[:receiver_user_id] = "r0210"
-        config[:receiver_user_email] = "fernando.taboada@xapo.com"
-        config[:pay_object_id] = "to0210"
-        config[:amount_BIT] = 0.01
-        config[:pay_type] = PayType::TIP
-        regex = /
-                    <div\sid="tipButtonDiv"\sclass="tipButtonDiv"><\/div>\n
-                    <div\sid="tipButtonPopup"\sclass="tipButtonPopup"><\/div>\n
-                    <script>(.*)<\/script>\n
-                /mx
-
-        actual = @xapo_tools.build_div_widget(config)
-
-        assert_match(regex, actual)
-    end
+  def setup     
+    @xapo_tools = XapoTools::MicroPayment.new(
+      "http://dev.xapo.com:8089/pay_button/show", 
+      "b91014cc28c94841", 
+      "c533a6e606fb62ccb13e8baf8a95cbdc"
+    )
+    @xapo_tools_notpa = XapoTools::MicroPayment.new(
+      "http://dev.xapo.com:8089/pay_button/show"
+    )
+  end
+
+  def test_build_iframe_widget()
+    config = XapoTools.micro_payment_config
+    config[:sender_user_email] = "sender@xapo.com"
+    config[:sender_user_cellphone] = "+5491112341234"
+    config[:receiver_user_id] = "r0210"
+    config[:receiver_user_email] = "fernando.taboada@xapo.com"
+    config[:pay_object_id] = "to0210"
+    config[:amount_BIT] = 0.01
+    config[:pay_type] = PayType::DONATE
+
+    actual = @xapo_tools.build_iframe_widget(config)
+
+    assert_match(/<iframe(.*)button_request(.*)>(.*)<\/iframe>\n/m, actual)
+  end
+
+  def test_build_iframe_widget_notpa()
+    config = XapoTools.micro_payment_config
+    config[:sender_user_email] = "sender@xapo.com"
+    config[:sender_user_cellphone] = "+5491112341234"
+    config[:receiver_user_id] = "r0210"
+    config[:receiver_user_email] = "fernando.taboada@xapo.com"
+    config[:pay_object_id] = "to0210"
+    config[:amount_BIT] = 0.01
+    config[:pay_type] = PayType::DONATE
+
+    actual = @xapo_tools_notpa.build_iframe_widget(config)
+
+    assert_match(/<iframe(.*)payload(.*)>(.*)<\/iframe>\n/m, actual)
+  end
+
+  def test_build_div_widget()
+    config = XapoTools.micro_payment_config
+    config[:sender_user_email] = "sender@xapo.com"
+    config[:sender_user_cellphone] = "+5491112341234"
+    config[:receiver_user_id] = "r0210"
+    config[:receiver_user_email] = "fernando.taboada@xapo.com"
+    config[:pay_object_id] = "to0210"
+    config[:amount_BIT] = 0.01
+    config[:pay_type] = PayType::TIP
+    regex = /
+                <div\sid="tipButtonDiv"\sclass="tipButtonDiv"><\/div>\n
+                <div\sid="tipButtonPopup"\sclass="tipButtonPopup"><\/div>\n
+                <script>(.*)button_request(.*)<\/script>\n
+            /mx
+
+    actual = @xapo_tools.build_div_widget(config)
+
+    assert_match(regex, actual)
+  end
+
+  def test_build_div_widget_notpa()
+    config = XapoTools.micro_payment_config
+    config[:sender_user_email] = "sender@xapo.com"
+    config[:sender_user_cellphone] = "+5491112341234"
+    config[:receiver_user_id] = "r0210"
+    config[:receiver_user_email] = "fernando.taboada@xapo.com"
+    config[:pay_object_id] = "to0210"
+    config[:amount_BIT] = 0.01
+    config[:pay_type] = PayType::TIP
+    regex = /
+                <div\sid="tipButtonDiv"\sclass="tipButtonDiv"><\/div>\n
+                <div\sid="tipButtonPopup"\sclass="tipButtonPopup"><\/div>\n
+                <script>(.*)payload(.*)<\/script>\n
+            /mx
+
+    actual = @xapo_tools_notpa.build_div_widget(config)
+
+    assert_match(regex, actual)
+  end
 end

data/test/test_xapo_utils.rb

@@ -2,27 +2,27 @@ require 'minitest/autorun'
 require 'xapo_utils'
 
 class TestXapoUtils < Minitest::Test
-    def setup     
-    end
+  def setup     
+  end
 
-    def test_encrypt()
-        json = '{"sender_user_id":"s160901",' +
-                '"sender_user_email":"fernando.taboada@gmail.com",' +
-                '"sender_user_cellphone":"",' +
-                '"receiver_user_id":"r160901",' +
-                '"receiver_user_email":"fernando.taboada@xapo.com",' +
-                '"tip_object_id":"to160901",' +
-                '"amount_SAT":"",' +
-                '"timestamp":1410973639125}'
-        expected = 'rjiFHpE3794U23dEKNyEz3ukF5rhVxtKzxEnZq8opuHoRH5eA' +
-                '/XOEbROEzf5AYmyQ5Yw6cQLSVMx/JgENrNKVK268n3o1kOIxEpupaha2wYX' +
-                'LqIqU8Ye7LFQz7NvQNPzfyOSPWnBQ/JUCSKsCiCz45VoK511B/RMz33mjJM' +
-                'F7s2a6FEk6YOwf3hrvYwFt1frXLDwxsAwMXKUutIdfnrM2c6MYOFXTSGqZc' +
-                '2gS8DXmwHyIrXKUFCt7Ax3DMk0ao7iAE8MiXWaSSSZRVBQ7d1a9JDRoNtzq' +
-                'GB++p7zK4NmOdrGEX9f+EwBjYuyKSsNez7kXPAWzwEvoi1o8gu4bxA1ng=='
+  def test_encrypt()
+    json = '{"sender_user_id":"s160901",' +
+            '"sender_user_email":"fernando.taboada@gmail.com",' +
+            '"sender_user_cellphone":"",' +
+            '"receiver_user_id":"r160901",' +
+            '"receiver_user_email":"fernando.taboada@xapo.com",' +
+            '"tip_object_id":"to160901",' +
+            '"amount_SAT":"",' +
+            '"timestamp":1410973639125}'
+    expected = 'rjiFHpE3794U23dEKNyEz3ukF5rhVxtKzxEnZq8opuHoRH5eA' +
+            '/XOEbROEzf5AYmyQ5Yw6cQLSVMx/JgENrNKVK268n3o1kOIxEpupaha2wYX' +
+            'LqIqU8Ye7LFQz7NvQNPzfyOSPWnBQ/JUCSKsCiCz45VoK511B/RMz33mjJM' +
+            'F7s2a6FEk6YOwf3hrvYwFt1frXLDwxsAwMXKUutIdfnrM2c6MYOFXTSGqZc' +
+            '2gS8DXmwHyIrXKUFCt7Ax3DMk0ao7iAE8MiXWaSSSZRVBQ7d1a9JDRoNtzq' +
+            'GB++p7zK4NmOdrGEX9f+EwBjYuyKSsNez7kXPAWzwEvoi1o8gu4bxA1ng=='
 
-        actual = XapoUtils.encrypt(json, "bc4e142dc053407b0028accffc289c18").tr("\n","")
-        
-        assert_equal(expected, actual)
-    end
+    actual = XapoUtils.encrypt(json, "bc4e142dc053407b0028accffc289c18").tr("\n","")
+    
+    assert_equal(expected, actual)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapo_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Repond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,9 +72,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.2