jemquarie 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34388f2aec3d3af4a4821cf685cc5fae4b6cd54e
-  data.tar.gz: 037df292b05aee50342735b33d205ab5d71119da
+  metadata.gz: 4a28a851bb5b04394d353f9f93be6ab95415f29e
+  data.tar.gz: 3bce6fa5363daaea2e6b2aacc2fd60eb95df1327
 SHA512:
-  metadata.gz: 5eed3dd6865208966b511fdb72e34f7c97ab35b346a857080bb1210cf166aeac0e1fc6d4a69b96824261a84ec9f81cbcb7e091bbb005b43b5f4926e3dcd9a2fb
-  data.tar.gz: d3c8f58db1d1df2d16812f022dbe968b57f83c5e941a161f2e3c7f77cc2e31b0353ba390675899cf9e214615b06eceb267131c62b0458691ad578d5bf84f33e3
+  metadata.gz: 9988e37be3a4de4168b64c06f455e0f96855188863bc9c6a96db95cf504e0f94753d350e090efd82edd781d48486a19a27562cf3ffe5ed25d1fe5181d8a9352a
+  data.tar.gz: d2e7ccaf4614d8749bdb386da54c924c1430896c519a5b4720d7f2c5443194f3b83fda6c18ee59866464689681f21932f26726798660d59de57b74cc699ef4f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jemquarie (0.0.4)
+    jemquarie (0.0.5)
       activesupport (>= 3.0)
       savon (~> 2.0)
 

data/README.md

@@ -41,12 +41,10 @@ The auth code and password need to be the unhashed values.
   Jemquarie::Importer.new(username, password).cash_transactions(10.years.ago.to_date, Date.today, account_number)
 ```
 
-### Results
-
 ## Success with data
 
 The gem should return an array with formatted data. Here an example:
-```
+```ruby
 [
  {
    :foreign_identifier => "123456",
@@ -71,6 +69,13 @@ It just returns an empty Array
 It returns an Hash {:error => "Invalid credentials"} .
 
 
+### Other available calls are:
+
+- client balances
+- account details
+- expiry of credentials
+
+
 ## Authors ##
 
   * [Claudio Contin](http://github.com/clod81)

data/lib/jemquarie/account_details.rb

@@ -0,0 +1,36 @@
+module Jemquarie
+
+  class AccountDetails < Base
+
+    include Parser::AccountDetails
+
+    def details(date_from = (Date.today - 1.day), date_to = Date.today, account_number = '', include_closed = 'Y')
+      response = @client.call(:generate_xml_extract, :message => create_message(date_from, date_to, account_number, include_closed))
+      return parse_account_details(response) if response.success?
+      {:error => "An error has occured, please try again later"}
+    end
+
+private
+
+    def create_message(date_from, date_to, account_number, include_closed)
+      {
+        :string  => hash_key(Jemquarie.api_key), # base64 encoded of the sha1 hashed api key
+        :string0 => Jemquarie.app_key,
+        :string1 => hash_key(@username),
+        :string2 => hash_key(@password),
+        :string3 => 'your.clients Account Details',
+        :string4 => 'V1.3',
+        :strings => [
+          {
+            :item0 => account_number,                          # Account Number
+            :item1 => date_from.strftime("%Y-%m-%dT%H:%M:%S"), # START DATE
+            :item2 => date_to.strftime("%Y-%m-%dT%H:%M:%S"),   # TO DATE
+            :item3 => include_closed                           # Include closed accounts flag
+          }
+        ]
+      }
+    end
+
+  end
+
+end

data/lib/jemquarie/balance.rb

@@ -0,0 +1,36 @@
+module Jemquarie
+
+  class Balance < Base
+
+    include Parser::Balance
+
+    def balance(account_number = '')
+      response = @client.call(:generate_xml_extract, :message => create_message(account_number))
+      return parse_balance_response(response) if response.success?
+      {:error => "An error has occured, please try again later"}
+    end
+
+private
+
+    def create_message(account_number)
+      {
+        :string  => hash_key(Jemquarie.api_key), # base64 encoded of the sha1 hashed api key
+        :string0 => Jemquarie.app_key,
+        :string1 => hash_key(@username),
+        :string2 => hash_key(@password),
+        :string3 => 'your.clients Balances',
+        :string4 => 'V1.3',
+        :strings => [
+          {
+            :item0 => account_number, # Account Number
+            :item1 => '',
+            :item2 => '',
+            :item3 => ''
+          }
+        ]
+      }
+    end
+
+  end
+
+end

data/lib/jemquarie/base.rb

@@ -0,0 +1,28 @@
+require 'openssl'
+require 'base64'
+
+module Jemquarie
+
+  class Base
+
+    include Parser::Generic
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @client = ::Savon.client do
+        endpoint         Jemquarie::BASE_URI
+        wsdl             File.expand_path("../extract.wsdl", __FILE__)
+        pretty_print_xml true
+      end
+    end
+
+protected
+
+    def hash_key(key)
+      Base64.strict_encode64(OpenSSL::Digest::SHA1.digest(key))
+    end
+
+  end
+
+end

data/lib/jemquarie/expiry.rb

@@ -0,0 +1,29 @@
+module Jemquarie
+
+  class Expiry < Base
+
+    include Parser::Expiry
+
+    def credentials_expiry
+      response = @client.call(:generate_xml_extract, :message => create_message)
+      return parse_expiry_response(response) if response.success?
+      {:error => "An error has occured, please try again later"}
+    end
+
+private
+
+    def create_message
+      {
+        :string  => hash_key(Jemquarie.api_key), # base64 encoded of the sha1 hashed api key
+        :string0 => Jemquarie.app_key,
+        :string1 => hash_key(@username),
+        :string2 => hash_key(@password),
+        :string3 => 'Authentication Expiry',
+        :string4 => 'V1.0',
+        :strings => ''
+      }
+    end
+
+  end
+
+end

data/lib/jemquarie/importer.rb

@@ -1,34 +1,21 @@
-require 'openssl'
-require 'base64'
-
 module Jemquarie
 
-  class Importer
-
-    include Jemquarie::Parser::CashTransactions
+  class Importer < Base
 
-    def initialize(username, password)
-      @username = username
-      @password = password
-      @client = ::Savon.client do
-        endpoint         Jemquarie::BASE_URI
-        wsdl             File.expand_path("../extract.wsdl", __FILE__)
-        pretty_print_xml true
-      end
-    end
+    include Parser::CashTransactions
 
-    def cash_transactions(date_from = (Date.today - 1.day), date_to = Date.today, account_number = '')
+    def cash_transactions(date_from = (Date.today - 1.day), date_to = Date.today, account_number = '', include_closed = 'Y')
       if account_number.blank? && ((date_to - date_from).days > 2.days) # if no account specified, ESI api doesn't allow to ask more than 2 days of transactions
         return {:error => "Cannot request more than 2 days of transactions if not account is specified"}
       end
-      response = @client.call(:generate_xml_extract, :message => create_message(date_from, date_to, account_number))
+      response = @client.call(:generate_xml_extract, :message => create_message(date_from, date_to, account_number, include_closed))
       return parse_cash_transactions_response(response) if response.success?
       {:error => "An error has occured, please try again later"}
     end
 
 private
 
-    def create_message(date_from, date_to, account_number)
+    def create_message(date_from, date_to, account_number, include_closed)
       {
         :string  => hash_key(Jemquarie.api_key), # base64 encoded of the sha1 hashed api key
         :string0 => Jemquarie.app_key,
@@ -41,16 +28,12 @@ private
             :item0 => account_number,                          # Account Number
             :item1 => date_from.strftime("%Y-%m-%dT%H:%M:%S"), # START DATE
             :item2 => date_to.strftime("%Y-%m-%dT%H:%M:%S"),   # TO DATE
-            :item3 => 'Y'                                      # Include closed accounts flag
+            :item3 => include_closed                           # Include closed accounts flag
           }
         ]
       }
     end
 
-    def hash_key(key)
-      Base64.strict_encode64(OpenSSL::Digest::SHA1.digest(key))
-    end
-
   end
 
 end

data/lib/jemquarie/parser/account_details.rb

@@ -0,0 +1,46 @@
+module Jemquarie
+  module Parser
+    module AccountDetails
+
+       def parse_account_details(response)
+        result = generic_request_response(response)
+        return result if result[:error]
+        details = []
+        return details unless result["XMLExtract"]["yourclientsAccountDetails"] && result["XMLExtract"]["yourclientsAccountDetails"]["yourclientsAccountDetail"]
+        xml_details = if result["XMLExtract"]["yourclientsAccountDetails"]["yourclientsAccountDetail"].is_a?(Hash)
+          [result["XMLExtract"]["yourclientsAccountDetails"]["yourclientsAccountDetail"]]
+        else
+          result["XMLExtract"]["yourclientsAccountDetails"]["yourclientsAccountDetail"]
+        end
+        xml_details.each do |detail|
+          details << parse_single_detail(detail)
+        end
+        details
+      end
+
+private
+
+      def parse_single_detail(detail)
+        {
+          :account_number       => detail["AccountNumber"],
+          :account_name         => detail["AccountName"],
+          :account_short_name   => detail["AccountShortName"],
+          :product              => detail["Product"],
+          :product_name         => detail["ProductName"],
+          :address_line_1       => detail["AddressLine1"],
+          :address_line_4       => detail["AddressLine4"],
+          :address_line_5       => detail["AddressLine5"],
+          :address_line_6       => detail["AddressLine6"],
+          :dealer_code          => detail["DealerCode"],
+          :adviser_code         => detail["AdviserCode"],
+          :account_status       => detail["AccountStatus"],
+          :date_modified        => Time.parse(detail["DateModified"] + " UTC"),
+          :bsb                  => detail["Bsb"],
+          :primary_broker_name  => detail["PrimaryBrokerName"],
+          :primary_adviser_name => detail["PrimaryAdviserName"]
+        }
+      end
+
+    end
+  end
+end

data/lib/jemquarie/parser/balance.rb

@@ -0,0 +1,34 @@
+module Jemquarie
+  module Parser
+    module Balance
+
+       def parse_balance_response(response)
+        result = generic_request_response(response)
+        return result if result[:error]
+        balances = []
+        return balances unless result["XMLExtract"] && result["XMLExtract"]["yourclientsBalances"] && result["XMLExtract"]["yourclientsBalances"]["yourclientsBalance"]
+        xml_balances = if result["XMLExtract"]["yourclientsBalances"]["yourclientsBalance"].is_a?(Hash)
+          [result["XMLExtract"]["yourclientsBalances"]["yourclientsBalance"]]
+        else
+          result["XMLExtract"]["yourclientsBalances"]["yourclientsBalance"]
+        end
+        xml_balances.each do |balance|
+          balances << parse_single_balance(balance)
+        end
+        balances
+      end
+
+private
+
+      def parse_single_balance(balance)
+        {
+          :account_number    => balance["AccountNumber"],
+          :ledger_balance    => balance["LedgerBalance"],
+          :available_balance => balance["AvailableBalance"],
+          :as_at_date        => Time.parse(balance["AsAtDate"] + " UTC")
+        }
+      end
+
+    end
+  end
+end

data/lib/jemquarie/parser/cash_transactions.rb

@@ -3,11 +3,8 @@ module Jemquarie
     module CashTransactions
 
       def parse_cash_transactions_response(response)
-        body = response.body
-        return {:error => "Invalid Authentication Code or Authentication Password"} unless
-          body[:generate_xml_extract_response] && body[:generate_xml_extract_response][:result] && body[:generate_xml_extract_response][:result].is_a?(String)
-        result = Hash.from_xml(Nokogiri::XML.fragment(body[:generate_xml_extract_response][:result]).to_s)
-        return {error: result["XMLExtract"]["RequestDetails"]["RequestErrorDetails"]} if result["XMLExtract"]["RequestDetails"]["RequestStatus"] == "Failure"
+        result = generic_request_response(response)
+        return result if result[:error]
         transactions = []
         return transactions unless result["XMLExtract"] && result["XMLExtract"]["yourclientsTransactions"] && result["XMLExtract"]["yourclientsTransactions"]["yourclientsTransaction"]
         xml_transactions = if result["XMLExtract"]["yourclientsTransactions"]["yourclientsTransaction"].is_a?(Hash)

data/lib/jemquarie/parser/expiry.rb

@@ -0,0 +1,14 @@
+module Jemquarie
+  module Parser
+    module Expiry
+
+       def parse_expiry_response(response)
+        result = generic_request_response(response)
+        return result if result[:error]
+        result["XMLExtract"]["ExpiryDate"]
+        Time.parse(result["XMLExtract"]["ExpiryDate"] + " UTC")
+      end
+
+    end
+  end
+end

data/lib/jemquarie/parser/generic.rb

@@ -0,0 +1,16 @@
+module Jemquarie
+  module Parser
+    module Generic
+
+      def generic_request_response(response)
+        body = response.body
+        return {:error => "Invalid Authentication Code or Authentication Password"} unless
+          body[:generate_xml_extract_response] && body[:generate_xml_extract_response][:result] && body[:generate_xml_extract_response][:result].is_a?(String)
+        result = Hash.from_xml(Nokogiri::XML.fragment(body[:generate_xml_extract_response][:result]).to_s)
+        return {error: result["XMLExtract"]["RequestDetails"]["RequestErrorDetails"]} if result["XMLExtract"]["RequestDetails"]["RequestStatus"] == "Failure"
+        result
+      end
+
+    end
+  end
+end

data/lib/jemquarie/version.rb

@@ -1,3 +1,3 @@
 module Jemquarie
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/jemquarie.rb

@@ -1,8 +1,15 @@
 require 'savon'
 require 'active_support/core_ext/hash'
-
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "jemquarie/parser/*.rb")).each {|f| require f}
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "jemquarie/*.rb")).each {|f| require f}
+require 'jemquarie/parser/generic'
+require 'jemquarie/parser/cash_transactions'
+require 'jemquarie/parser/expiry'
+require 'jemquarie/parser/account_details'
+require 'jemquarie/parser/balance'
+require 'jemquarie/base'
+require 'jemquarie/importer'
+require 'jemquarie/expiry'
+require 'jemquarie/account_details'
+require 'jemquarie/balance'
 
 module Jemquarie