xapo_sdk 0.0.1.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad2e1b7257d3e2ff993c91b353a676a597c9def1
+  data.tar.gz: c8e76f1f93b6ca221ceec83b22fa75e9e4fd66e7
+SHA512:
+  metadata.gz: 3cdec2146eabd4eda03bf489575af1d47c6682ac1a0d7b37db539bd17bb7cf79185cf1cbe5a34994f32affd8851de4c431203f73bce0708292c5793fa06600fe
+  data.tar.gz: af2f4663bbb24c9490cbcfb724e4657fa2e513afe467306df97deed5f0aee4d0ed4c71536b486d8c0627302ad9ba033c5cc8365b3c452cc7ed0bdc50b12adc67

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xapo_sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2014, Xapo
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Xapo SDK & Tools nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,160 @@
+# README
+
+>This is the Ruby version of the Xapo's Widget Tools. These tools allow you (Third Party Application, TPA) to easily embed tools like Payments Buttons, Donation Buttons and other kind of widgets as DIV or iFrame into your web application using your language of choice. In this way, tedious details like encryption and HTML snippet generation are handled for you in a simple and transparent way.  
+
+---
+
+<!-- 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 
+
+- [Table of Contents](#table-of-contents)
+  - [Build](#build)
+  - [Installation](#installation)
+  - [Micro Payment Widgets](#micro-payment-widgets)
+    - [IFrame Widget](#iframe-widget)
+    - [Div Widget](#div-widget)
+    - [Widgets Gallery](#widgets-gallery)
+  - [Contributing](#contributing)
+  - [TODO](#todo)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Build
+
+Ensure that tests pass:
+
+    $ rake test 
+
+Build the gem (output to `./pkg`):
+
+    $ rake build
+
+And finally install de gem:
+
+    $ rake install
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xapo_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xapo_sdk
+
+## Micro Payment Widgets
+Micro payment widgets allow to dynamically get a HTML snippet pre-configured and insert into your web page. Micro payment widgets provides 4 kind of pre-configured actions __Pay, Donate, Tip__ and __Deposit__. The widgets allow the following configurations:
+
+- **Amount BIT:** `[optional]` sets a fixed amount for the intended payment.
+- **Sender's Id:** `[optional]` any identifier used in the TPA context to identify the sender.
+- **Sender's email:** `[optional]` used to pre-load the widget with the user's email.
+- **Sender's cellphone:** `[optional]` used to pre-load the widget with the user's cellphone.
+- **Receiver's Id:** `[mandatory]` any receiver's user unique identifier in the TPA context. 
+- **Receiver's email:** `[mandatory]` the email of the user receiving the payment. It allows XAPO to contact the receiver to claim her payment.
+- **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.
+
+### IFrame Widget
+```ruby
+require 'xapo_tools'
+
+...
+
+micro_payment = XapoTools::MicroPayment.new(
+            XAPO_URL, 
+            APP_ID, 
+            APP_SECRET)
+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
+
+# Get IFRAME snippet
+String iframe = microPayment.buildIframeWidget(request);
+```
+
+With this you get the following snippet:
+
+```html
+<iframe id='tipButtonFrame' scrolling='no' frameborder='0' style='border:none; overflow:hidden; height:22px;' allowTransparency='true' src='http://dev.xapo.com:8089/pay_button/show?customization=%7B%22button_text%22%3A%22Tip%22%7D&app_id=b91014cc28c94841&button_request=C%2F6OaxS0rh3jMhH90kRYyp3y%2BU5ADcCgMLCyz2P5ssFG%2FJoGf55ccvicyRMuIXpU5xhDeHGffpZAvVeMCpJhGFyIPwLFh%2FVdnjnDUjYgJCQeB4mCpGsEW5SC6wNvg69ksgeAtr108Wc5miA8H4JG99EWTTlC7WtIGg5rFKkbjrop15fSJfhv5cTs02jSC5f2BaLlh1mKh5hSPW3HGcWcl%2BdyZj%2F9m1lPB4gKfky2%2FnT0tYjbEFo5aU6WtowWrf2xE8OYejyI0poEFkClBkv2eDkp4Gel4tGb%2Bkwszcyb18ztK89RlBwhe8sX4HeM2KJM8ZaWuDOGH2VW4kbThMCZEw%3D%3D'></iframe>
+```
+
+See the example results in the [widgets gallery](#widgets-gallery).
+
+### Div Widget
+```ruby
+require 'xapo_tools'
+
+...
+
+micro_payment = XapoTools::MicroPayment.new(
+            XAPO_URL, 
+            APP_ID, 
+            APP_SECRET)
+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
+
+# PayType::TIP | PayType::PAY | PayType::DEPOSIT | PayType::DONATE
+config[:pay_type] = PayType::DONATE
+
+# Get DIV snippet
+xapo_tools.build_div_widget(config)
+```
+
+With this you get the following snippet:
+
+```html
+<div id='tipButtonDiv' class='tipButtonDiv'></div>
+<div id='tipButtonPopup' class='tipButtonPopup'></div>
+<script>
+$(document).ready(function() {$('#tipButtonDiv').load('http://dev.xapo.com:8089/pay_button/show?customization=%7B%22button_text%22%3A%22Donate%22%7D&app_id=b91014cc28c94841&button_request=C%2F6OaxS0rh3jMhH90kRYyp3y%2BU5ADcCgMLCyz2P5ssFG%2FJoGf55ccvicyRMuIXpU5xhDeHGffpZAvVeMCpJhGFyIPwLFh%2FVdnjnDUjYgJCQeB4mCpGsEW5SC6wNvg69ksgeAtr108Wc5miA8H4JG99EWTTlC7WtIGg5rFKkbjrop15fSJfhv5cTs02jSC5f2BaLlh1mKh5hSPW3HGcWcl%2BdyZj%2F9m1lPB4gKfky2%2FnT0tYjbEFo5aU6WtowWrf2xE8OYejyI0poEFkClBkv2eDkp4Gel4tGb%2Bkwszcyb18ztK89RlBwhe8sX4HeM2KJMHVfAM8NQXQu8oiIyCAl0vg%3D%3D');});
+</script>
+```
+
+See the example results in the [widgets gallery](#widgets-gallery).
+
+### Widgets Gallery
+
+![payment button](http://developers.xapo.com/images/payment_widget/donate_button.png)
+
+![payment phone](http://developers.xapo.com/images/payment_widget/mpayment1.png)
+
+![payment email](http://developers.xapo.com/images/payment_widget/mpayment2.png)
+
+![payment pin](http://developers.xapo.com/images/payment_widget/mpayment3.png)
+
+## Contributing
+
+1. Fork it ( https://github.com/xapo/ruby-sdk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## TODO
+- ~~Fix style (https://github.com/bbatsov/ruby-style-guide#naming)~~
+- ~~Add unit testing~~
+- Document, document, ~~document~
+- ~~Review naming and organization (with respect to Java & Python?)~~
+- Review `gem` build infraestructure
+- ...

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |task|
+  task.libs << %w(test lib)
+  task.pattern = 'test/test_*.rb'
+end
+ 
+task :default => :test

data/lib/xapo_sdk/version.rb

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

data/lib/xapo_tools.rb

@@ -0,0 +1,81 @@
+require "xapo_sdk/version"
+require "xapo_utils"
+
+require "json"
+require "uri"
+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 => ""]
+    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
+    end
+end
+
+module PayType
+    TIP = "Tip"
+    DONATE = "Donate"
+    PAY = "Pay"
+    DEPOSIT = "Deposit"
+end

data/lib/xapo_utils.rb

@@ -0,0 +1,19 @@
+require "openssl"
+require "base64"
+
+module XapoUtils
+
+    module_function
+            
+    def encrypt(payload, secret)
+        cipher = OpenSSL::Cipher::AES.new("256-ECB")
+        cipher.encrypt
+        cipher.key = secret        
+
+        encrypted = cipher.update(payload) + cipher.final
+
+        return Base64.encode64(encrypted)
+    end
+
+    def timestamp; (Time.now.to_f * 1000).to_i end
+end

data/test/test_xapo_tools.rb

@@ -0,0 +1,46 @@
+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
+end

data/test/test_xapo_utils.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'xapo_utils'
+
+class TestXapoUtils < Minitest::Test
+    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=='
+
+        actual = XapoUtils.encrypt(json, "bc4e142dc053407b0028accffc289c18").tr("\n","")
+        
+        assert_equal(expected, actual)
+    end
+end

data/xapo_sdk.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xapo_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xapo_sdk"
+  spec.version       = XapoSdk::VERSION
+  spec.authors       = ["Federico Repond"]
+  spec.email         = ["federico.repond@leapsight.com"]
+  spec.summary       = %q{Xapo bitcoin sdk & tools.}
+  spec.description   = %q{Xapo bitcoin sdk & tools.}
+  spec.homepage      = ""
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: xapo_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.1
+platform: ruby
+authors:
+- Federico Repond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Xapo bitcoin sdk & tools.
+email:
+- federico.repond@leapsight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xapo_sdk/version.rb
+- lib/xapo_tools.rb
+- lib/xapo_utils.rb
+- test/test_xapo_tools.rb
+- test/test_xapo_utils.rb
+- xapo_sdk.gemspec
+homepage: ''
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Xapo bitcoin sdk & tools.
+test_files:
+- test/test_xapo_tools.rb
+- test/test_xapo_utils.rb
+has_rdoc: