xapo_sdk 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66227ffeca0ea2c6c313df33e6bb6e959113b840
-  data.tar.gz: 94613eba6fca7265cea57c6acb86f88de9b025de
+  metadata.gz: fdaab05a3afda55428323f8265651693e3948492
+  data.tar.gz: 7ba9c92091a9cd8a41b570c8a8c8d8aecd450898
 SHA512:
-  metadata.gz: 1290315d1ab8f2bb52f004969f572141488ddc1c8db05dd953a790cd9afff23b75781404f87e4fb444e7ddcb57a95e7329221f03775086119ef52afc2ade6774
-  data.tar.gz: 99208026f43d3b5efbc3abff53ad2e1e7a882f07ff7b3b59d655c7f10c970b92320173816affe1b66dbd49343c2bea75b9b296b8499d553dedbc70c2ae632725
+  metadata.gz: dcb891c258e36aeb2cb4f35aa5ac2b7946a3a5dd4dc9fdc5df0f13c002130a6038e7977d08105eae815da584209d027be1e779468812f5e1e1289c31fea224d7
+  data.tar.gz: 4da60607edf072a52bf30a2d48c9612e547f914c279ee6ca3b252c1a45ff3eed3402396839d61b316bfd68761958a391a1fddb14cd3298a3c52de4cb8d689b7d

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.1 / 2014-11-04
+==================
+
+* Added xapo_api module, including the credit api v0 (this is about to change soon in the incoming v1 api).
+
 0.2.0 / 2014-11-01
 ==================
 

data/README.md

@@ -8,17 +8,21 @@
 
 <!-- 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)
+## Table of Contents
+
+- [Build](#build)
+- [Installation](#installation)
+- [API](#api)
+  - [Credit](#credit)
+    - [Parameters](#parameters)
+    - [Result](#result)
+    - [Usage Example](#usage-example)
+- [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 -->
 
@@ -52,6 +56,79 @@ Or install it yourself as:
 
     $ gem install xapo_sdk
 
+## API
+
+The of the API allows third party application to interact with Xapo wallets and resources in a simple and intuitive way.
+
+
+Development Environment:
+
+> http://dev.xapo.com/api/v1
+
+### Credit
+
+The Credit API allows any Third Party Application (TPA) to load Bitcoins into any Xapo Wallet using a secure App_ID + App_Shared_Key authentication method.
+
+#### Parameters
+
+- **To:** ``(string, mandatory)`` any e­mail, BTC address or mobile number.
+- **Currency:** ``(Currency, mandatory)`` any of ``Currency.BTC`` or ``Currency.SAT`` .
+- **Amount:** ``(numeric, mandatory)`` amount to be credited.
+- **Comments:** ``(string, optional)`` note or message to attach to the transaction.
+- **Subject:** ``(string, optional)`` if specified, will be used as email subject (when crediting an email address) or SMS text (when crediting a mobile #). 
+- **Timestamp:** ``(int, mandatory)`` UTC Unix Timestamp. The request will be rejected if using a timestamp not equal or greater than the last used by previous request.
+- **Resquest Id:** ``(string, mandatory)`` any ID that uniquely identifies this request. Cannot be repeated with any new request.    
+
+#### Result
+
+The result is a dictionary containing:
+
+| Key     | Type    | Description |
+|---------| ------- | ----------- |
+| success | boolean | Indicates whether the request was successfully processed or not | 
+| code    | string  | A response |
+| message | string  | Description of the result |
+
+Error codes:
+
+| Code            | Message |
+| --------------- | ------- |
+Success           | Wallet successfully credited |
+InvalidRequest    | Either the App token or Hash are invalid |
+ExpiredRequest    | The request timestamp and/or unique_request_id have expired |
+InvalidWallet     | Wallet not linked with this APP |
+InvalidEmail      | The destination email is invalid |
+InvalidBTCAddress | The destination BTC address is invalid |
+InvalidCellphone  | The destination mobile number is invalid |
+InvalidCurrency   | The currency is invalid |
+InvalidAmount     | The amount to deposit is invalid |
+MinimumAmount     | The amount to deposit must be at least XXX |
+InsufficientFunds | The wallet you are withdrawing from does not have enough available balance to fulfill the Deposit |
+
+
+#### Usage Example
+
+```ruby
+
+    require "xapo_api"
+    require "securerandom"
+
+    ...
+
+    # config the api
+    api = Xapo::API.new(SERVICE_URL, APP_ID, APP_SECRET)
+
+    ...
+
+    # call cerdit service
+    res = api.credit('sample@xapo.com', 0.5, SecureRandom.hex,
+                     currency: Xapo::Currency::BTC, 
+                     comments: "Sample deposit")
+
+    puts(res)
+```
+
+
 ## 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:
 

data/lib/xapo_api.rb

@@ -0,0 +1,58 @@
+require "xapo_sdk/version"
+require "xapo_utils"
+
+require "json"
+require "uri"
+require "net/http"
+
+# Xapo's API.
+#
+# This class allows the interaction with bitcoins APIs provided with Xapo.
+#
+# 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.
+module Xapo
+
+  module_function
+
+  module Currency
+    BTC = "BTC"
+    SAT = "SAT"
+  end
+  
+  class API    
+    def initialize(service_url, app_id, app_secret)
+      @service_url = service_url
+      @app_id = app_id
+      @app_secret = app_secret
+      @credit_resource = '/credit/'
+    end
+
+    def credit(to, amount, request_id, currency: Xapo::Currency::BTC, 
+               comments: "", subject: "")
+      timestamp = XapoUtils.timestamp
+      payload = {
+                  :to => to,
+                  :currency => currency,
+                  :amount => amount,
+                  :comments => comments,
+                  :subject => subject,
+                  :timestamp => timestamp,
+                  :unique_request_id => request_id
+                }
+      
+      json_payload = JSON.generate(payload)
+      encrypted_payload = XapoUtils.encrypt(json_payload, @app_secret, false)
+      
+      uri = URI(@service_url + @credit_resource)
+      query = URI.encode_www_form(:appID => @app_id,
+                                  :hash => encrypted_payload)
+      uri.query = query
+      res = Net::HTTP.get_response(uri)
+
+      return JSON.parse(res.body)
+    end
+  end
+end

data/lib/xapo_sdk/version.rb

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

data/lib/xapo_tools.rb

@@ -29,11 +29,17 @@ module XapoTools
   #      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 => ""]
+    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.
@@ -58,16 +64,16 @@ module XapoTools
       
       if @app_secret == nil || @app_id == nil
         query_str = URI.encode_www_form(
-          "payload" => json_config,
-          "customization" => JSON.generate({"button_text" => config[:pay_type]})
+          :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]})
+          :app_id => @app_id, 
+          :button_request => encrypted_config,
+          :customization => JSON.generate({:button_text => config[:pay_type]})
         )
       end
 

data/lib/xapo_utils.rb

@@ -8,15 +8,23 @@ module XapoUtils
   # 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.
-  #
+  #   payload (str): The text to encode.
+  #   secret (str): the encoding key.
+  #   default_padding (bool): whether it uses default padding or not 
+  #   
   # Returns:
   #  str: The padded bytestring.
-  def encrypt(payload, secret)
+  def encrypt(payload, secret, default_padding=true)
     cipher = OpenSSL::Cipher::AES.new("256-ECB")
     cipher.encrypt
-    cipher.key = secret        
+    cipher.key = secret
+
+    # TODO zero padding is not handled correctly, it's too specific
+    #      and inflexible making it hard to change.
+    if !default_padding
+      cipher.padding = 0
+      payload = zero_padding(payload)
+    end        
 
     encrypted = cipher.update(payload) + cipher.final
 
@@ -24,4 +32,11 @@ module XapoUtils
   end
 
   def timestamp; (Time.now.to_f * 1000).to_i end
+
+  def zero_padding(payload)
+    l = 16 - payload.length % 16
+    res = payload + "\0" * l
+
+    return res 
+  end
 end

data/test/test_xapo_api.rb

@@ -0,0 +1,41 @@
+require "minitest/autorun"
+require "xapo_api"
+require "securerandom"
+
+class TestXapoAPI < Minitest::Test
+  def setup     
+    @api = Xapo::API.new(
+      "http://dev.xapo.com/api/v1", 
+      "b91014cc28c94841", 
+      "c533a6e606fb62ccb13e8baf8a95cbdc"
+    )
+  end
+
+  def test_credit()
+    res = @api.credit('sample@xapo.com', 1, SecureRandom.hex, 
+                      currency: Xapo::Currency::SAT,
+                      comments: "Sample deposit")
+
+    puts("test_credit -> ", res)
+
+    assert(res["success"])
+  end
+
+  def test_credit_bad_ammount()
+    res = @api.credit('sample@xapo.com', -0.5, SecureRandom.hex)
+
+    puts("test_credit -> ", res)
+
+    refute(res["success"])
+    assert_equal("InvalidAmount", res["code"])
+  end
+
+  def test_credit_missing_to()
+    res = @api.credit('', -0.5, SecureRandom.hex)
+
+    puts("test_credit -> ", res)
+
+    refute(res["success"])
+    assert_equal("Failure", res["code"])
+  end
+end

data/test/test_xapo_tools.rb

@@ -24,6 +24,7 @@ class TestXapoTools < Minitest::Test
     config[:pay_type] = PayType::DONATE
 
     actual = @xapo_tools.build_iframe_widget(config)
+    puts("test_build_iframe_widget -> ", actual)
 
     assert_match(/<iframe(.*)button_request(.*)>(.*)<\/iframe>\n/m, actual)
   end
@@ -39,6 +40,7 @@ class TestXapoTools < Minitest::Test
     config[:pay_type] = PayType::DONATE
 
     actual = @xapo_tools_notpa.build_iframe_widget(config)
+    puts("test_build_iframe_widget_notpa -> ", actual)
 
     assert_match(/<iframe(.*)payload(.*)>(.*)<\/iframe>\n/m, actual)
   end
@@ -59,6 +61,7 @@ class TestXapoTools < Minitest::Test
             /mx
 
     actual = @xapo_tools.build_div_widget(config)
+    puts("test_build_div_widget -> ", actual)
 
     assert_match(regex, actual)
   end
@@ -79,6 +82,7 @@ class TestXapoTools < Minitest::Test
             /mx
 
     actual = @xapo_tools_notpa.build_div_widget(config)
+    puts("test_build_div_widget_notpa -> ", actual)
 
     assert_match(regex, actual)
   end

data/test/test_xapo_utils.rb

@@ -22,6 +22,7 @@ class TestXapoUtils < Minitest::Test
             'GB++p7zK4NmOdrGEX9f+EwBjYuyKSsNez7kXPAWzwEvoi1o8gu4bxA1ng=='
 
     actual = XapoUtils.encrypt(json, "bc4e142dc053407b0028accffc289c18").tr("\n","")
+    puts("test_encrypt -> \n", json, actual)
     
     assert_equal(expected, actual)
   end

data/xapo_sdk.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 1.6.2"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapo_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Federico Repond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
 description: Xapo bitcoin sdk & tools.
 email:
 - federico.repond@leapsight.com
@@ -46,14 +60,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/xapo_api.rb
 - lib/xapo_sdk/version.rb
 - lib/xapo_tools.rb
 - lib/xapo_utils.rb
+- test/test_xapo_api.rb
 - test/test_xapo_tools.rb
 - test/test_xapo_utils.rb
 - xapo_sdk.gemspec
@@ -82,6 +99,7 @@ signing_key:
 specification_version: 4
 summary: Xapo bitcoin sdk & tools.
 test_files:
+- test/test_xapo_api.rb
 - test/test_xapo_tools.rb
 - test/test_xapo_utils.rb
 has_rdoc: