firstgiving 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a6851db81358b18da79f91eddc7d506c891ac2f
+  data.tar.gz: ebda58663a88fad10c5274b5633519c3aca1b132
+SHA512:
+  metadata.gz: 4c66bc3913b0dcedc174fd58a6699f7263c029b5c1aa99da25fb3d4aae1568c2f9eb8fb00d47343c415253087caef84cfdffe1ac104716905dfd2443340ba4dd
+  data.tar.gz: 62d3afb72ee953eeba799b0584ffd8c6cea06d0b0c4ea6d6add7be675c4886a1ba2ef82ad17f84b9e53c71ddefb4ecb16bd6245e55b9217726219587247f4bbf

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format progress
+--backtrace
+--default_path spec
+--pattern **/*.spec               

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', :require => false
+# Specify your gem's dependencies in firstgiving.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Faizal Zakaria
+
+MIT License
+
+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,52 @@
+# FirstGiving
+
+FirstGiving Ruby Client Open Source.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firstgiving'
+
+Or install it yourself as:
+
+    $ gem install firstgiving
+
+## Usage
+
+    
+    FirstGiving.configure do |config|
+        config.application_key = APPLICATION_KEY
+        config.security_token  = SECURITY_TOKEN
+        config.options = OPTIONS
+    end
+
+# Lookup API
+
+    FG.lookup.list(params)
+    FG.lookup.detail(params)
+
+# Donation API
+
+    FG.donation.creditcard(params)
+    FG.donation.verify(params)
+    FG.donation.recurring_creditcard_profile(params)
+    
+# Search API
+    
+    FG.search.query(params)
+
+    
+    
+## Test
+
+    rake spec
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task :default => :spec

data/firstgiving.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firstgiving/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firstgiving"
+  spec.version       = FirstGiving::VERSION
+  spec.authors       = ["Faizal Zakaria"]
+  spec.email         = ["phaibusiness@gmail.com"]
+  spec.description   = %q{FirstGiving Ruby API client}
+  spec.summary       = %q{FirstGiving API client}
+  spec.homepage      = "https://github.com/boosterllc/firstgiving_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "crack"
+  spec.add_development_dependency "faraday"
+end

data/lib/firstgiving.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'firstgiving/version'
+require 'firstgiving/base'
+require 'firstgiving/donation'
+require 'firstgiving/lookup'
+require 'firstgiving/search'
+
+# Donation API
+# Transaction API
+# Search API
+
+module FirstGiving
+
+  class Configuration
+    attr_accessor :application_key, :security_token, :options
+
+    def initialize
+      self.application_key = nil
+      self.security_token  = nil
+      self.options         = {}
+      set_defaults
+    end
+
+    def set_defaults
+      self.options[:verbose] ||= false
+      self.options[:read_timeout] ||= 30
+      self.options[:use_ssl] ||= false
+      self.options[:use_staging] ||= true
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.lookup
+    @lookup ||= Lookup.new
+  end
+
+  def self.search
+    @search ||= Search.new
+  end
+
+  def self.donation
+    @donation ||= Donation.new
+  end
+
+end
+
+FG = FirstGiving

data/lib/firstgiving/base.rb

@@ -0,0 +1,57 @@
+require 'faraday'
+
+module FirstGiving
+
+  module Base
+
+    DONATION_SANDBOX_ENDPOINT    = "http://usapisandbox.fgdev.net"
+    DONATION_PRODUCTION_ENDPOINT = "https://api.firstgiving.com"
+    SEARCH_ENDPOINT = "http://graphapi.firstgiving.com"
+
+    def headers_json
+      {
+        'User-Agent'        => 'FirstGiving Ruby SDK',
+        'Content-Type'      => 'application/json'
+      }
+    end
+
+    def headers_security
+      {
+        'JG_APPLICATIONKEY' => "#{FirstGiving.configuration.application_key}",
+        'JG_SECURITYTOKEN'  => "#{FirstGiving.configuration.security_token}"
+      }
+    end
+
+    def post_call(api_endpoint, action, params, headers)
+      conn = Faraday.new(:url => api_endpoint) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+
+      response = conn.post do |req|
+        req.url action
+        req.params = params
+        req.headers = headers
+      end
+    end
+
+    def get_call(api_endpoint, action, params, headers)
+      conn = Faraday.new(:url => api_endpoint) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      response = conn.get do |req|
+        req.url action
+        req.params = params
+        req.headers = headers
+      end
+    end
+
+    def logging(msg)
+      puts "[FG-LOG] #{msg}" if FirstGiving.configuration.options[:verbose]
+    end
+
+  end
+end
+

data/lib/firstgiving/donation.rb

@@ -0,0 +1,44 @@
+require 'crack'
+
+module FirstGiving
+
+  class Donation
+
+    include Base
+
+    module Actions
+      CREDITCARD = "/donation/creditcard"
+      RECURRING_CREDITCARD_PROFILE = "/donation/recurringcreditcardprofile"
+      VERIFY = "/verify"
+    end
+
+    def initialize
+      @api_endpoint = DONATION_PRODUCTION_ENDPOINT
+      @api_endpoint = DONATION_SANDBOX_ENDPOINT if FirstGiving.configuration.options[:use_staging]
+    end
+
+    def headers
+      headers_json.merge!(headers_security)
+    end
+
+    def creditcard(params)
+      response = post_call(@api_endpoint, Actions::CREDITCARD, params, headers)
+      parse(response.body)
+    end
+
+    def verify(params)
+      response = get_call(@api_endpoint, Actions::VERIFY, params, headers)
+      parse(response.body)
+    end
+
+    def recurring_creditcard_profile(params)
+      call(Actions::RECURRING_CREDITCARD_PROFILE, params, headers)
+    end
+
+    def parse(body)
+      Crack::XML.parse(body)
+    end
+  end
+
+end
+

data/lib/firstgiving/lookup.rb

@@ -0,0 +1,42 @@
+require 'crack'
+# lookup API
+
+module FirstGiving
+
+  class Lookup
+
+    include Base
+
+    module Actions
+      TRANSACTION_LIST = "/transaction/list"
+      TRANSACTION_DETAIL = "/transaction/detail"
+    end
+
+    def initialize
+      @api_endpoint = DONATION_PRODUCTION_ENDPOINT
+      @api_endpoint = DONATION_SANDBOX_ENDPOINT if FirstGiving.configuration.options[:use_staging]
+    end
+
+    def headers
+      headers_json.merge!(headers_security)
+    end
+
+    def call(action, params, _headers)
+      response = get_call(@api_endpoint, action, params, _headers)
+      parse(response.body)
+    end
+
+    def detail(params)
+      call(Actions::TRANSACTION_DETAIL, params, headers)
+    end
+
+    def list(params)
+      call(Actions::TRANSACTION_LIST, params, headers)
+    end
+
+    def parse(body)
+      Crack::XML.parse(body)
+    end
+  end
+
+end

data/lib/firstgiving/search.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+# Search API
+
+module FirstGiving
+
+  class Search
+
+    include Base
+
+    module Actions
+      LIST_ORGANIZATION = "/v1/list/organization"
+    end
+
+    def initialize
+      @api_endpoint = SEARCH_ENDPOINT
+    end
+
+    def headers
+      {'Accept' => 'application/json'}
+    end
+
+    def query(params)
+      response = get_call(@api_endpoint, Actions::LIST_ORGANIZATION, params, headers)
+      parse(response.body)
+    end
+
+    def parse(body)
+      response = JSON.parse(body)
+      response['payload']
+    end
+  end
+
+end

data/lib/firstgiving/version.rb

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

data/spec/first_giving_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe FirstGiving do
+
+  APPLICATION_KEY = "ADD YOUR APP KEY HERE"
+  SECURITY_TOKEN  = "ADD YOUR SECURITY TOKEN HERE"
+
+  OPTIONS = {
+    :use_staging => true
+  }
+
+  FirstGiving.configure do |config|
+    config.application_key = APPLICATION_KEY
+    config.security_token  = SECURITY_TOKEN
+    config.options = OPTIONS
+  end
+
+  @transacionId = "a-a8ca75adcda6874abd9c5b"
+
+  describe "Test Donation API" do
+
+    it "should donate" do
+      params = {
+        :ccNumber            => "4457010000000009",
+        :ccType              => "VI",
+        :ccExpDateMonth      => "01",
+        :ccExpDateYear       => "14",
+        :billToAddressLine1  => "1 Main St.",
+        :billToCity          => "Burlington",
+        :billToState         => "MA",
+        :billToZip           => "01803",
+        :remoteAddr          => "120.138.91.2",
+        :amount              => "10.00",
+        :currencyCode        => "USD",
+        :charityId           => "1234",
+        :description         => "Test transaction",
+        :ccCardValidationNum => "349",
+        :billToFirstName     => "Smith",
+        :billToLastName      => "John",
+        :billToCountry       => "US",
+        :billToEmail         => "test@example.com"
+      }
+
+      response = FG.donation.creditcard(params)
+      ## Response should success
+      assert_acknowledgement(response)
+      ## Response should contain transaction ID
+      @transactionId = response["firstGivingDonationApi"]["firstGivingResponse"]["transactionId"]
+      @transactionId.should_not be_nil
+    end
+
+    it "should verify" do
+      params = {
+        :message   => "value1",
+        :signature => "value2"
+      }
+
+      response = FG.donation.verify(params)
+      ## Response should return the same message and signature
+      response["firstGivingDonationApi"]["firstGivingResponse"]["signature"] == "value2"
+      response["firstGivingDonationApi"]["firstGivingResponse"]["message"] == "value1"
+    end
+
+    it "shoould recure the payment" do
+    end
+
+  end
+
+  describe "Test Lookup API" do
+
+    it "should return a list of transactions" do
+      params = {
+        page_size: 10,
+        date_from: "1388707200",
+        count: 100,
+        page: 1
+      }
+      resp = FG.lookup.list(params)
+      assert_acknowledgement(resp)
+    end
+
+    it "should return a transaction detail" do
+      params = {
+        transactionId: "a-0070dde28ca48048a1fc24"
+      }
+      resp = FG.lookup.detail(params)
+      assert_acknowledgement(resp)
+    end
+
+  end
+
+  context "Test Search API" do
+
+    describe "retrieving a charity by EIN" do
+      it "should return data for charities" do
+        params = {
+          q: "government_id:260046127"
+        }
+
+        response = FG.search.query(params)
+        response.should_not be_nil
+        response[0]["government_id"].should eq "260046127"
+      end
+    end
+
+    describe "searching for records by organization name" do
+      it "exact name matching and partial or name start" do
+        params = {
+          q: "organization_name:humane society"
+        }
+
+        response = FG.search.query(params)
+        response.should_not be_nil
+        response[0]["organization_name"].should include "HUMANE SOCIETY"
+      end
+
+      it "country constraints" do
+        params = {
+          q: "organization_name:bat AND country:US"
+        }
+
+        response = FG.search.query(params)
+        response.should_not be_nil
+        response[0]["organization_name"].should include "BAT"
+        response[0]["country"].should eq "US"
+      end
+
+      it "pagination" do
+        params = {
+          q: "organization_name:bat AND country:US",
+          page_size: "10",
+          page: 1
+        }
+
+        response = FG.search.query(params)
+        response.should_not be_nil
+        response[0]["organization_name"].should include "BAT"
+        response[0]["country"].should eq "US"
+        response.count.should eq 10
+      end
+    end
+  end
+
+  private
+
+  def assert_acknowledgement(response)
+    response["firstGivingDonationApi"]["firstGivingResponse"]["acknowledgement"].should eq "Success"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'firstgiving'
+require 'coveralls'
+require 'faraday'
+Coveralls.wear!
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: firstgiving
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Faizal Zakaria
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: crack
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: FirstGiving Ruby API client
+email:
+- phaibusiness@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- firstgiving.gemspec
+- lib/firstgiving.rb
+- lib/firstgiving/base.rb
+- lib/firstgiving/donation.rb
+- lib/firstgiving/lookup.rb
+- lib/firstgiving/search.rb
+- lib/firstgiving/version.rb
+- spec/first_giving_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/boosterllc/firstgiving_ruby
+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.1.11
+signing_key: 
+specification_version: 4
+summary: FirstGiving API client
+test_files:
+- spec/first_giving_spec.rb
+- spec/spec_helper.rb