nfg-client 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDhhZGYxODA1OTNjMTcwNWJiMDVjMzUwOTE5NTgzNzEwOGQ3NDY5Mg==
+  data.tar.gz: !binary |-
+    ZmVjOTFiMWM5ZTA2NGQwMzc5NjNmYWZjNTBlYjllYjlkNDllNmNlMw==
+SHA512:
+  metadata.gz: !binary |-
+    OTU5ZjhlZTQ1NGNlNDNiNDY0MDI1OTI2ODA1N2JhZDk5NGJlNzgxYWQ0Njgy
+    YzRlZGRlOWY0MjA0MmMyYTY4MGE1NDg4ZTk3NmJmNjQ5ODA5MTg3M2U4OThl
+    ODYyODRlNGNjNjQ1ZGI3MjJkZTc0ZGEwNmExZjhiMzBhMzA4YmE=
+  data.tar.gz: !binary |-
+    ODc3MTViZmU1YzBmNzI2NjMwMGVhNWQ5OGRkNzg0MTliNzcyYjc2N2M1NzM2
+    ZTczOTMzYWE1YzQyNTgyNzA0MGE4ODMyMGFiNzc1ZjMxNGNhYmJmZTE1OGVm
+    NTM3NWY3MzAxMTFmZjNjOTA2ZDY2NGJjMDQ0Yjg4ZTk4ZWU2Mzc=

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+/.project
+/nbproject/

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Antonio Ruano Cuesta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,360 @@
+# NFG Client
+
+A client to interact with the NFG (Network for Good) API via SOAP requests.
+
+## Installation
+
+Install the gem:
+
+    gem install nfg-client
+
+Or add it to your Gemfile:
+
+    gem "nfg-client"
+
+## Usage
+
+Create a NFG Client instance using your NFG credentials:
+
+    nfg_client = NFGClient.new(partner_id, partner_password, partner_source, partner_campaign, use_sandbox)
+
+The fifth parameter is optional (defaults to false), and indicates the Client which API URLs to use (sandbox or production).
+
+Use the Client to make calls to the NFG API, each call will take a hash with the parameters you want to send along with it (apart from the NFG credentials).
+
+Example:
+
+    nfg_client.get_donor_cofs({"DonorToken" => donor_token})
+    
+All required parameters for the different calls should have the name specified by the NFG documentation.
+
+For more information, refer to the official NFG documentation:
+
+http://www.thenetworkforgood.org/t5/Developer-Resource-Center/ct-p/Developer
+
+## Supported Calls
+
+Below, the list of supported calls and examples of usage. All functions return a hash with the response from NFG.
+
+### CreateCOF
+
+Creates a Card on File without a transaction.
+
+**_Call_**
+
+    response = nfg_client.create_cof({
+        "DonorToken" => "",
+        "DonorFirstName" => "",
+        "DonorLastName" => "",
+        "DonorEmail" => "",
+        "DonorAddress1" => "",
+        "DonorAddress2" => "",
+        "DonorCity" => "",
+        "DonorState" => "",
+        "DonorZip" => "",
+        "DonorCountry" => "",
+        "DonorPhone" => "",
+        "CardType" => "", # Unk, Visa, Mastercard, Amex or Discover
+        "NameOnCard" => "",
+        "CardNumber" => "",
+        "ExpMonth" => "",
+        "ExpYear" => "",
+        "CSC" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "DonorToken" => "x", 
+        "COFId" => "x" # Integer
+    }
+    
+### GetDonorCOFs
+
+Gets a list of donor Cards on File.
+
+**_Call_**
+
+    response = nfg_client.get_donor_cofs({
+        "DonorToken" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "DonorToken" => "x", 
+        "Cards" => [
+            {
+                "COFId" => "x", # Integer 
+                "CardType" => "x", # e.g. Mastercard 
+                "CCSuffix" => "xxxx", # Last four digits 
+                "CCExpMonth" => "", # 1 or 2 digits 
+                "CCExpYear" => "", # 4 digits
+                "bInUseByLiveRD" => "", # true or false 
+                "COFEmailAddress" => ""
+            },
+            ...
+        ]
+    }
+    
+### DeleteDonorCOF
+
+Removes an existing Card on File.
+
+**_Call_**
+
+    response = nfg_client.delete_donor_cof({
+        "DonorToken" => "",
+        "COFId" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.xx"
+    }
+    
+### MakeCOFDonation
+
+Triggers a one-time or recurring donation to one or more charities with an existing Card on File.
+
+**_Call_**
+
+    response = nfg_client.make_cof_donation({
+        "DonationLineItems" => {
+            "DonationItem1" => {
+                "NpoEin" => "",
+                "donorVis" => "", # ProvideAll, ProvideNameAndEmailOnly or Anonymous
+                "ItemAmount" => "",
+                "RecurType" => "", # NotRecurring, Monthly, Quarterly or Annually
+                "Designation" => ""
+                "Dedication" => ""
+            },
+            "DonationItem2" => {
+                ...
+            },
+            ...
+        },
+        "TotalAmount" => "",
+        "TipAmount" => "",
+        "DonorIpAddress" => "",
+        "DonorToken" => "",
+        "COFId" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "ChargeId" => "x",  # Integer
+        "COFId" => "0"
+    }
+    
+### MakeDonationAddCOF
+
+Triggers a one-time or recurring donation to one or more charities with a new Card on File.
+
+**_Call_**
+
+    response = nfg_client.make_donation_add_cof({
+        "DonationLineItems" => {
+            "DonationItem1" => {
+                "NpoEin" => "",
+                "donorVis" => "", # ProvideAll, ProvideNameAndEmailOnly or Anonymous
+                "ItemAmount" => "",
+                "RecurType" => "", # NotRecurring, Monthly, Quarterly or Annually
+                "Designation" => ""
+                "Dedication" => ""
+            },
+            "DonationItem2" => {
+                ...
+            },
+            ...
+        },
+        "TotalAmount" => "",
+        "TipAmount" => "",
+        "DonorIpAddress" => "",
+        "DonorToken" => "",
+        "COFId" => "",
+        "DonorFirstName" => "",
+        "DonorLastName" => "",
+        "DonorEmail" => "",
+        "DonorAddress1" => "",
+        "DonorAddress2" => "",
+        "DonorCity" => "",
+        "DonorState" => "",
+        "DonorZip" => "",
+        "DonorCountry" => "",
+        "DonorPhone" => "",
+        "CardType" => "", # Unk, Visa, Mastercard, Amex or Discover
+        "NameOnCard" => "",
+        "CardNumber" => "",
+        "ExpMonth" => "",
+        "ExpYear" => "",
+        "CSC" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "ChargeId" => "x",  # Integer
+        "COFId" => "0"
+    }
+    
+### GetFee
+
+Calculates the fee for a transaction that would ultimately be used with payment functions.
+
+**_Call_**
+
+    response = nfg_client.get_fee({
+        "DonationLineItems" => {
+            "DonationItem1" => {
+                "NpoEin" => "",
+                "donorVis" => "", # ProvideAll, ProvideNameAndEmailOnly or Anonymous
+                "ItemAmount" => "",
+                "RecurType" => "", # NotRecurring, Monthly, Quarterly or Annually
+                "Designation" => ""
+                "Dedication" => ""
+            },
+            "DonationItem2" => {
+                ...
+            },
+            ...
+        },
+        "TipAmount" => "",
+        "CardType" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "TotalChargeAmount" => "x.x", 
+        "TotalAddFee" => "x.x", 
+        "TotalDeductFee" => "x.x",
+        "TipAmount" => "x.x"
+     }
+    
+### GetDonorDonationHistory
+
+Gets donor transactions.
+
+**_Call_**
+
+    response = nfg_client.get_donor_donation_history({
+        "DonorToken" => ""
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "DonorToken" => "x", 
+        "Donations"=>[
+            {
+                "DonationDate" => "xxxx-xx-xxTxx:xx:xx.xx", 
+                "RecurType" => "x", # e.g. NotRecurring 
+                "IsTpcAddOnFee" => "", # true or false 
+                "NpoName" => "", # e.g. Smithsonian Institution 
+                "Designation" => "", 
+                "Dedication" => "", 
+                "Amount" => "x.x", 
+                "ChargeId" => "x" # Integer
+            },
+            ...
+        ]
+    }
+
+### GetDonationReport
+
+Returns a report of partner transactions during a specific period of time.
+
+**_Call_**
+
+    response = nfg_client.get_donation_report({
+        "StartDate" => "",
+        "EndDate" => "",
+        "DonationReportType" => "" # All, OneTime or Recurring
+    })
+
+**_Response on Success_**
+
+    {
+        "StatusCode" => "Success", 
+        "Message" => "", # Empty
+        "ErrorDetails" => "", # Empty
+        "CallDuration" => "x.x", 
+        "ReturnCount" => "x", 
+        "ReportResults"=>[
+            {
+                "Source" => "x", 
+                "Campaign" => "x", 
+                "ChargeId" => "x", # Integer 
+                "ShareWithCharity" => "x", # e.g. No Donor Info - Anonymous
+                "DonorEmail" => "x", 
+                "DonorFirstName" => "x",
+                "DonorLastName" => "x", 
+                "DonorAddress1" => "x", 
+                "DonorAddress2" => "x", 
+                "DonorCity" => "x", 
+                "DonorState" => "x", 
+                "DonorZip" => "x", 
+                "DonorCountry" => "x", 
+                "DonorPhone" => "x", 
+                "Designation" => "", 
+                "DonateInName" => "", 
+                "RecurringPeriod" => "", 
+                "EventDate" => "xxxx-xx-xxTxx:xx:xx.xxxZ", 
+                "NpoEIN" => "x", 
+                "NpoName" => "x", 
+                "ChargeStatus" => "", # e.g. CS_SUCCESS 
+                "ChargeAmount" => "x.x", 
+                "NpoTPC" => "x.x", 
+                "DonationItemAmount" => "x.x", 
+                "TotalDonationAmount" => "x.x", 
+                "HistoryRecordId" => "x"
+            },
+            ...
+        ]
+    }
+
+## Failed calls
+
+When a call fails (i.e. the "StatusCode" is different than "Success"), it's usually possible to find out more about the error looking at the "Message" and "ErrorDetails" fields. "Message" is a string, while "ErrorDetails" is a hash with the following format:
+
+    {
+            "StatusCode" => "Other", 
+            "Message" => "x",
+            "ErrorDetails" => {
+                "ErrorInfo"=>{
+                    "ErrCode" => "x", 
+                    "ErrData" => "x"
+                }
+            }
+            "CallDuration" => "x.x",
+            ...
+    }

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/nfg-client.rb

@@ -0,0 +1,3 @@
+require 'nfg-client/version'
+require 'nfg-client/utils'
+require 'nfg-client/client'

data/lib/nfg-client/client.rb

@@ -0,0 +1,321 @@
+module NFGClient
+
+  def self.new(partner_id, partner_password, partner_source, partner_campaign, use_sandbox = false)
+    NFGClient::Client.new(partner_id, partner_password, partner_source, partner_campaign, use_sandbox)
+  end
+
+  class Client
+    include NFGClient::Utils
+
+    def initialize(partner_id, partner_password, partner_source, partner_campaign, use_sandbox)
+      @partner_id = partner_id
+      @partner_password = partner_password
+      @partner_source = partner_source
+      @partner_campaign = partner_campaign
+      @use_sandbox = use_sandbox
+    end
+
+    # Creates a card on file for the given donor token
+    #
+    # Arguments:
+    #   params: (Hash)
+    def create_cof(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('CreateCOF', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        {
+          'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+          'Message' => response.elements['Message'].get_text.to_s,
+          'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+          'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+          'DonorToken' => response.elements['DonorToken'].get_text.to_s,
+          'COFId' => response.elements['CofId'].get_text.to_s
+        }
+      else
+        response
+      end
+    end
+
+    # Deletes a card on file for the given donor token
+    #
+    # Arguments:
+    #   params: (Hash)
+    def delete_donor_cof(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('DeleteDonorCOF', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        if response.elements['StatusCode'].get_text.to_s == 'Success'
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s
+          }
+        else
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => {
+              'ErrorInfo' => {
+                'ErrCode' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrCode'].andand.get_text.andand.to_s,
+                'ErrData' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrData'].andand.get_text.andand.to_s
+              }
+            },
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s
+          }
+        end
+      else
+        response
+      end
+    end
+
+    # Gets a list of the given donor token's cards on file
+    #
+    # Arguments:
+    #   params: (Hash)
+    def get_donor_cofs(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('GetDonorCOFs', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        response_hash = {
+          'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+          'Message' => response.elements['Message'].get_text.to_s,
+          'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+          'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+          'DonorToken' => response.elements['DonorToken'].get_text.to_s
+        }
+        response_hash['Cards'] = Array.new
+        response.elements.each('Cards/COFRecord') do |card|
+          response_hash['Cards'] << {
+            'COFId' => card.elements['COFId'].get_text.to_s,
+            'CardType' => card.elements['CardType'].get_text.to_s,
+            'CCSuffix' => card.elements['CCSuffix'].get_text.to_s,
+            'CCExpMonth' => card.elements['CCExpMonth'].get_text.to_s,
+            'CCExpYear' => card.elements['CCExpYear'].get_text.to_s,
+            'bInUseByLiveRD' => card.elements['bInUseByLiveRD'].get_text.to_s,
+            'COFEmailAddress' => card.elements['COFEmailAddress'].get_text.to_s
+          }
+        end
+        response_hash
+      else
+        response
+      end
+    end
+
+    # Calculates fee tied to transaction
+    #
+    # Arguments:
+    #   params: (Hash)
+    def get_fee(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('GetFee', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        if response.elements['ErrorDetails'].elements['ErrorInfo'].nil?
+          {
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'TotalChargeAmount' => response.elements['TotalChargeAmount'].get_text.to_s,
+            'TotalAddFee' => response.elements['TotalAddFee'].get_text.to_s,
+            'TotalDeductFee' => response.elements['TotalChargeAmount'].get_text.to_s,
+            'TipAmount' => response.elements['TotalAddFee'].get_text.to_s
+          }
+        else
+          {
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => {
+              'ErrorInfo' => {
+                'ErrCode' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrCode'].andand.get_text.andand.to_s,
+                'ErrData' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrData'].andand.get_text.andand.to_s
+              }
+            },
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'TotalChargeAmount' => response.elements['TotalChargeAmount'].get_text.to_s,
+            'TotalAddFee' => response.elements['TotalAddFee'].get_text.to_s,
+            'TotalDeductFee' => response.elements['TotalChargeAmount'].get_text.to_s,
+            'TipAmount' => response.elements['TotalAddFee'].get_text.to_s
+          }
+        end
+      else
+        response
+      end
+    end
+
+    # Makes a donation using the given COF
+    #
+    # Arguments:
+    #   params: (Hash)
+    def make_cof_donation(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('MakeCOFDonation', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        if response.elements['StatusCode'].get_text.to_s == 'Success'
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'ChargeId' => response.elements['ChargeId'].get_text.to_s,
+            'COFId' => response.elements['CofId'].get_text.to_s
+          }
+        else
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => {
+              'ErrorInfo' => {
+                'ErrCode' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrCode'].andand.get_text.andand.to_s,
+                'ErrData' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrData'].andand.get_text.andand.to_s
+              }
+            },
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'ChargeId' => response.elements['ChargeId'].get_text.to_s,
+            'COFId' => response.elements['CofId'].get_text.to_s
+          }
+        end
+      else
+        response
+      end
+    end
+
+    # Makes a donation and stores a COF for the given donor token
+    #
+    # Arguments:
+    #   params: (Hash)
+    def make_donation_add_cof(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('MakeDonationAddCOF', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        if (response.elements['StatusCode'].get_text.to_s == 'Success') || ((response.elements['StatusCode'].get_text.to_s != 'Success') && response.elements['ErrorDetails'].elements['ErrorInfo'].nil?)
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'ChargeId' => response.elements['ChargeId'].get_text.to_s,
+            'COFId' => response.elements['CofId'].get_text.to_s
+          }
+        else
+          {
+            'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+            'Message' => response.elements['Message'].get_text.to_s,
+            'ErrorDetails' => {
+              'ErrorInfo' => {
+                'ErrCode' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrCode'].andand.get_text.andand.to_s,
+                'ErrData' => response.elements['ErrorDetails'].andand.elements.andand['ErrorInfo'].andand.elements.andand['ErrData'].andand.get_text.andand.to_s
+              }
+            },
+            'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+            'ChargeId' => response.elements['ChargeId'].get_text.to_s,
+            'COFId' => response.elements['CofId'].get_text.to_s
+          }
+        end
+      else
+        response
+      end
+    end
+
+    # Retrieves the donation history for a specified donor token
+    #
+    # Arguments:
+    #   params: (Hash)
+    def get_donor_donation_history(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('GetDonorDonationHistory', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        response_hash = {
+          'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+          'Message' => response.elements['Message'].get_text.to_s,
+          'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+          'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+          'DonorToken' => response.elements['DonorToken'].get_text.to_s
+        }
+        response_hash['Donations'] = Array.new
+        response.elements.each('Donations/DonationItemData') do |donation|
+          response_hash['Donations'] << {
+            'DonationDate' => donation.elements['DonationDate'].get_text.to_s,
+            'RecurType' => donation.elements['RecurType'].get_text.to_s,
+            'IsTpcAddOnFee' => donation.elements['IsTpcAddOnFee'].get_text.to_s,
+            'NpoName' => donation.elements['NpoName'].get_text.to_s,
+            'Designation' => donation.elements['Designation'].get_text.to_s,
+            'Dedication' => donation.elements['Dedication'].get_text.to_s,
+            'Amount' => donation.elements['Amount'].get_text.to_s,
+            'ChargeId' => donation.elements['ChargeId'].get_text.to_s,
+          }
+        end
+        response_hash
+      else
+        response
+      end
+    end
+
+    # Retrieves the donation history by date
+    #
+    # Arguments:
+    #   params: (Hash)
+    def get_donation_report(params)
+      call_params = add_credentials_to_params(params)
+      response = nfg_soap_request('GetDonationReport', call_params, @use_sandbox)
+      if response.is_a? REXML::Element
+        response_hash = {
+          'StatusCode' => response.elements['StatusCode'].get_text.to_s,
+          'Message' => response.elements['Message'].get_text.to_s,
+          'ErrorDetails' => response.elements['ErrorDetails'].get_text.to_s,
+          'CallDuration' => response.elements['CallDuration'].get_text.to_s,
+          'ReturnCount' => response.elements['ReturnCount'].get_text.to_s
+        }
+        response_hash['ReportResults'] = Array.new
+        response.elements.each('ReportResults/DonationReportResult') do |donation|
+          response_hash['ReportResults'] << {
+            'Source' => donation.elements['Source'].get_text.to_s,
+            'Campaign' => donation.elements['Campaign'].get_text.to_s,
+            'ChargeId' => donation.elements['ChargeId'].get_text.to_s,
+            'ShareWithCharity' => donation.elements['ShareWithCharity'].get_text.to_s,
+            'DonorEmail' => donation.elements['DonorEmail'].get_text.to_s,
+            'DonorFirstName' => donation.elements['DonorFirstName'].get_text.to_s,
+            'DonorLastName' => donation.elements['DonorLastName'].get_text.to_s,
+            'DonorAddress1' => donation.elements['DonorAddress1'].get_text.to_s,
+            'DonorAddress2' => donation.elements['DonorAddress2'].get_text.to_s,
+            'DonorCity' => donation.elements['DonorCity'].get_text.to_s,
+            'DonorState' => donation.elements['DonorState'].get_text.to_s,
+            'DonorZip' => donation.elements['DonorZip'].get_text.to_s,
+            'DonorCountry' => donation.elements['DonorCountry'].get_text.to_s,
+            'DonorPhone' => donation.elements['DonorPhone'].get_text.to_s,
+            'Designation' => donation.elements['Designation'].get_text.to_s,
+            'DonateInName' => donation.elements['DonateInName'].get_text.to_s,
+            'RecurringPeriod' => donation.elements['RecurringPeriod'].get_text.to_s,
+            'EventDate' => donation.elements['EventDate'].get_text.to_s,
+            'NpoEIN' => donation.elements['NpoEIN'].get_text.to_s,
+            'NpoName' => donation.elements['NpoName'].get_text.to_s,
+            'ChargeStatus' => donation.elements['ChargeStatus'].get_text.to_s,
+            'ChargeAmount' => donation.elements['ChargeAmount'].get_text.to_s,
+            'NpoTPC' => donation.elements['NpoTPC'].get_text.to_s,
+            'DonationItemAmount' => donation.elements['DonationItemAmount'].get_text.to_s,
+            'TotalDonationAmount' => donation.elements['TotalDonationAmount'].get_text.to_s,
+            'HistoryRecordId' => donation.elements['HistoryRecordId'].get_text.to_s
+          }
+        end
+        response_hash
+      else
+        response
+      end
+    end
+
+    private
+
+    # Adds client credentials to hash of parameters
+    #
+    # Arguments:
+    #   params: (Hash)
+    def add_credentials_to_params(params)
+      return params unless params.is_a? Hash
+      credentials = {
+        'PartnerID' => @partner_id,
+        'PartnerPW' => @partner_password,
+        'PartnerSource' => @partner_source,
+        'PartnerCampaign' => @partner_campaign
+      }
+      credentials.merge(params)
+    end
+  end
+end

data/lib/nfg-client/utils.rb

@@ -0,0 +1,91 @@
+require 'net/http'
+require 'rexml/document'
+
+module NFGClient
+  module Utils
+    @@nfg_urls = {
+      'sandbox' => {
+        'host' => 'api-sandbox.networkforgood.org',
+        'url' => 'https://api-sandbox.networkforgood.org/PartnerDonationService/DonationServices.asmx',
+        'wsdl' => 'https://api-sandbox.networkforgood.org/PartnerDonationService/DonationServices.asmx?wsdl'
+      },
+      'production' => {
+        'host' => 'api.networkforgood.org',
+        'url' => 'https://api.networkforgood.org/PartnerDonationService/DonationServices.asmx',
+        'wsdl' => 'https://api.networkforgood.org/PartnerDonationService/DonationServices.asmx?wsdl'
+      }
+    }
+
+    # Makes HTTP POST request to NFG server (sandbox or production) and returns parsed XML response.
+    #
+    # Arguments:
+    #   nfg_method: (String)
+    #   params: (Hash)
+    def nfg_soap_request(nfg_method, params, use_sandbox = false)
+      if (nfg_method.is_a? String) && (params.is_a? Hash)
+        # Build SOAP 1.2 request
+        soap_request = build_nfg_soap_request(nfg_method,params)
+        
+        # Build request URL & header
+        host = use_sandbox ? @@nfg_urls['sandbox']['host'] : @@nfg_urls['production']['host']
+        url = use_sandbox ? @@nfg_urls['sandbox']['url'] : @@nfg_urls['production']['url']
+        headers = {
+          'Host' => host,
+          'Content-Type' => 'application/soap+xml; charset=utf-8',
+          'Content-Length' => soap_request.length.to_s,
+          'SOAPAction' => "#{url}/#{nfg_method}".gsub('.asmx','')
+        }
+
+        return_value = Hash.new
+
+        # Being HTTP Post
+        begin
+          uri = URI.parse(url)
+          https_conn = Net::HTTP.new(uri.host, uri.port)
+          https_conn.use_ssl = true
+          response = https_conn.post(uri.path, soap_request, headers)          
+          if response.code == '200'
+            parsed = REXML::Document.new(response.body)
+            #return response.body
+            # Build return hash parsing XML response
+            if parsed.root.nil?
+              return_value['StatusCode'] = 'MissingParameter'
+              return_value['Message'] = response.body
+              return_value['ErrorDetails'] = nil
+            else
+              return_value = parsed.root.elements['soap:Body'].elements["#{nfg_method}Response"].elements["#{nfg_method}Result"]
+            end
+          else
+            return_value['StatusCode'] = 'UnexpectedError'
+            return_value['Message'] = response.message
+            return_value['ErrorDetails'] = response.body
+          end
+        rescue StandardError => e
+          return_value['StatusCode'] = 'UnexpectedError'
+          return_value['Message'] = e
+          return_value['ErrorDetails'] = e.backtrace.join(' ')
+        end
+
+        return_value
+      else
+        raise ArgumentError.new('http_post requires a nfg_method and a hash of params')
+      end
+    end   
+
+    def build_nfg_soap_request(nfg_method, params)
+      get_nfg_soap_request_template.gsub('|body|',"<#{nfg_method} xmlns=\"http://api.networkforgood.org/partnerdonationservice\">#{hash_to_xml(params)}</#{nfg_method}>")
+    end
+
+    def get_nfg_soap_request_template
+      "<?xml version=\"1.0\" encoding=\"utf-8\"?><soap12:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://www.w3.org/2003/05/soap-envelope\"><soap12:Body>|body|</soap12:Body></soap12:Envelope>"
+    end
+
+    def hash_to_xml(hash)
+      hash.map do |k, v|
+        text = (v.is_a? Hash) ? hash_to_xml(v) : v
+        xml_elem = (v.is_a? Hash) ? k.gsub(/(\d)/, "") : k
+        "<%s>%s</%s>" % [xml_elem, text, xml_elem]
+      end.join
+    end
+  end
+end

data/lib/nfg-client/version.rb

@@ -0,0 +1,3 @@
+module NFGClient
+  VERSION = "1.0.0"
+end

data/nfg-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nfg-client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "nfg-client"
+  gem.version       = NFGClient::VERSION
+  gem.authors       = ["Antonio Ruano Cuesta"]
+  gem.email         = ["ruanest@gmail.com"]
+  gem.description   = %q{Client for the Network for Good SOAP API.}
+  gem.summary       = gem.description
+  gem.licenses      = %w(MIT)
+  gem.homepage      = "https://github.com/aruanoc/nfg-client"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'andand', "~> 1.3.3"
+
+  gem.add_development_dependency 'rspec', '~> 2.13.0'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: nfg-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Antonio Ruano Cuesta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: andand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for the Network for Good SOAP API.
+email:
+- ruanest@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/nfg-client.rb
+- lib/nfg-client/client.rb
+- lib/nfg-client/utils.rb
+- lib/nfg-client/version.rb
+- nfg-client.gemspec
+- spec/nfg_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aruanoc/nfg-client
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Client for the Network for Good SOAP API.
+test_files:
+- spec/nfg_client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: