liberty_reserve 0.1.0

data/LICENSE

@@ -0,0 +1 @@
+License goes here

data/README.md

@@ -0,0 +1,2 @@
+= Liberty Reserve API client
+This gem makes it easy to connect to the Liberty Reserve interface and perform the operations exposed by the XML API.

data/lib/liberty_reserve.rb

@@ -0,0 +1,3 @@
+# -*- encoding: utf-8 -*-
+require 'liberty_reserve/version'
+require 'liberty_reserve/client'

data/lib/liberty_reserve/client.rb

@@ -0,0 +1,238 @@
+# -*- encoding: utf-8 -*-
+require 'cgi'
+require 'nokogiri'
+require 'digest'
+require 'bigdecimal'
+require 'net/https'
+
+module LibertyReserve #:nodoc:
+  
+  # The Liberty Reserve client, you must instantiate a client for each account API you are using.
+  #
+  # <b>Usage example :</b>
+  #
+  #   lr = LibertyReserve::Client("U6542567", "MySecret", "My API name")
+  #   lr.get_balance("LRUSD").to_f
+  #   => 42.0
+  class Client
+    # Default Liberty Reserve API URI
+    API_URI = "https://api.libertyreserve.com/"
+    
+    # Instantiates a client which will authenticate against the Liberty Reserve API
+    # using the supplied credentials : 
+    # * +account+ : The Liberty Reserve account
+    # * +secret+ : The secret word defined for the particular API
+    # * +api_name+ : The API name defined in its parameters
+    #
+    # Returns a client instance to query the Liberty Reserve API.
+    #
+    # <b>Note</b> : all the API calls must be explicitly allowed in the Liberty Reserve API settings.
+    def initialize(account, secret, api_name, options = {})
+      super
+      
+      defaults = {
+        api_uri: API_URI,
+        verify_peer: true
+      }
+      
+      @account = account
+      @secret = secret
+      @api_name = api_name
+      @options = defaults.merge options
+    end
+
+    # Returns the details of a given Liberty Reserve transaction given its ID
+    #
+    #   lr = LibertyReserve::Client("U6542567", "MySecret", "My API name")
+    #   lr.get_transaction("R836232")
+    #   => {
+    #     currency: "LRUSD",
+    #     receipt_id: "R836232",
+    #     payer_account: "U3832029",
+    #     fee: BigDecimal("1.0"),
+    #     transferred_amount: BigDecimal("100.0"),
+    #     net_amount: BigDecimal("99.0")
+    #   }    
+    def get_transaction(transaction_id)
+      account_id = @account
+
+      r = send_request("history") do |xml|
+        xml.HistoryRequest :id => random_id do
+          authentication_block(xml)
+          
+          xml.History do
+            xml.AccountId account_id
+            xml.ReceiptId transaction_id
+          end
+        end
+      end
+
+      format_transaction(r["HistoryResponse"]["Receipt"])
+    end
+
+    # Returns the current balance of the account in the supplied currency (LRUSD, LREUR or LRGLD)
+    #
+    #   lr = LibertyReserve::Client("U6542567", "MySecret", "My API name")
+    #   lr.get_balance("LRUSD").to_f
+    #   => 340.35
+    def get_balance(currency)
+      account_id = @account
+
+      r = send_request("balance") do |xml|
+        xml.BalanceRequest :id => random_id do
+          authentication_block(xml)
+          
+          xml.Balance do
+            xml.CurrencyId currency.to_s.upcase
+            xml.AccountId account_id
+          end
+        end
+      end
+
+      r["BalanceResponse"]["Balance"]["Value"].to_d
+    end
+    
+    # Performs and account-to-account transfer to an aribitrary account, a memo can optionnally be supplied
+    # 
+    #  lr = LibertyReserve::Client("U6542567", "MySecret", "My API name")
+    #  lr.transfer("U987655", 42.0, "LRUSD", :memo => "Hi there!")
+    #  => "R345241"
+    def transfer(account, amount, currency, options = {})      
+      send_request("transfer") do |xml|
+        xml.TransferRequest :id => random_id do
+          authentication_block(xml)
+
+          xml.Transfer do
+            xml.TransferType "transfer"
+            xml.Payer @account
+            xml.Payee account
+            xml.CurrencyId currency
+            xml.Amount amount
+            xml.Anonymous "false"
+            xml.Memo(options[:memo] || "")
+          end
+        end
+      end
+    end
+
+    # Returns the name of an account given its account number
+    #
+    #   lr = LibertyReserve::Client("U6542567", "MySecret", "My API name")
+    #   lr.get_name("U7262182")
+    #   => "Alice"    
+    def get_name(account)
+      r = send_request("accountname") do |xml|
+        xml.AccountNameRequest :id => random_id do
+          authentication_block(xml)
+          xml.AccountName do
+            xml.AccountId @account
+            xml.AccountToRetrieve account
+          end
+        end
+      end
+
+      r["AccountNameResponse"]["AccountName"]["Name"]
+    end
+
+    # Returns the history for an account given a currency as an array of transactions,
+    # see +get_transaction+ for the transaction format.
+    # Direction
+    # +direction+ can be any of :incoming, :outgoing, :any
+    def get_history(currency, till = DateTime.now, from = DateTime.now.advance(days: -14), options = {})
+      defaults = {
+        direction: 'any',
+        page_size: 20,
+        page_number: 1
+      }
+      
+      opts = defaults.merge(options)
+      
+      raise ArgumentError unless [:any, :outgoing, :incoming].include?(opts[:direction].to_sym)
+      
+      r = send_request("history") do |xml|
+        xml.HistoryRequest :id => random_id do
+          authentication_block(xml)
+          xml.History do
+            xml.CurrencyId currency
+            xml.From from.strftime("%Y-%d-%m 00:00:00")
+            xml.Till till.strftime("%Y-%d-%m 23:59:59")
+            xml.CorrespondingAccountId opts[:corresponding_account_id] if opts[:corresponding_account_id]
+            xml.TransferType opts[:transfer_type] if opts[:transfer_type]
+            xml.Source opts[:source] if opts[:source]
+            xml.Direction opts[:direction].to_s
+            xml.AccountId @account
+            xml.Pager do |pager|
+              pager.PageSize opts[:page_size]
+              pager.PageNumber opts[:page_number]
+            end
+          end
+        end
+      end
+
+      if r["HistoryResponse"]["Pager"]["TotalCount"] != "0"
+        [r["HistoryResponse"]["Receipt"]].flatten.map { |t| format_transaction(t) }.compact
+      else
+        []
+      end
+    end
+
+
+    private
+
+    def send_request(operation)
+      result = nil
+      uri = URI.parse(@options[:api_uri])
+
+      connection = Net::HTTP.new(uri.host, '443')
+      connection.use_ssl = true
+      connection.verify_mode = OpenSSL::SSL::VERIFY_PEER if @options[:verify_peer]
+
+      connection.start do |http|
+        req = Net::HTTP::Get.new("/xml/#{operation}.aspx?req=#{generate_xml{ |xml| yield(xml) }}")
+        response = http.request(req)
+        result = Hash.from_xml(response.body)
+        puts response.body
+      end
+
+      op = operation == "accountname" ? "account_name" : operation
+
+      if result["#{op.camelize}Response"]['Error']
+        raise "#{result["#{op.camelize}Response"]['Error']['Code']} - #{result["#{op.camelize}Response"]['Error']['Text']}"
+      end
+
+      result
+    end
+
+    def generate_xml
+      request = Nokogiri::XML::Builder.new { |xml| yield(xml) } 
+      puts request.to_xml
+      CGI::escape(request.to_xml)
+    end
+
+    def format_transaction(t)
+      {
+        currency: t["Transfer"]["CurrencyId"],
+        receipt_id: t["ReceiptId"],
+        payer_account: t["Transfer"]["Payer"],
+        fee: BigDecimal(t["Fee"]),
+        transferred_amount: BigDecimal(t["Amount"]),
+        net_amount: BigDecimal(t["Amount"]) - BigDecimal(t["Fee"]),      
+      }
+    end
+  
+    def authentication_block(xml)
+      token = "#{@secret}:#{DateTime.now.new_offset(0).strftime("%Y%m%d:%H")}"
+      token = Digest::SHA2.hexdigest(token).upcase
+
+      xml.Auth do
+        xml.ApiName @api_name
+        xml.Token token
+      end
+    end
+    
+    def random_id
+      (rand * 10 ** 9).to_i
+    end
+  end
+end
+

data/lib/liberty_reserve/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+module LibertyReserve
+  # Liberty Reserve gem version
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: liberty_reserve
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David FRANCOIS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70170790609540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70170790609540
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70170790609160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70170790609160
+description: Accesses the Liberty Reserve API
+email:
+- david@bitcoin-central.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/liberty_reserve/client.rb
+- lib/liberty_reserve/version.rb
+- lib/liberty_reserve.rb
+- LICENSE
+- README.md
+homepage: https://github.com/davout/liberty_reserve
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A Liberty Reserve API client for Ruby and Rails
+test_files: []