justgiving_client 0.2.0

data/lib/justgiving_client.rb

@@ -0,0 +1,9 @@
+module JustGiving
+  ROOT = File.expand_path('..', __FILE__)
+  
+  autoload :Client, ROOT + '/justgiving_client/client'
+  autoload :HttpClient, ROOT + '/justgiving_client/http_client'
+  autoload :Donation, ROOT + '/justgiving_client/donation'
+  autoload :FundraisingPage, ROOT + '/justgiving_client/fundraising_page'
+  autoload :User, ROOT + '/justgiving_client/user'
+end

data/lib/justgiving_client/client.rb

@@ -0,0 +1,30 @@
+module JustGiving
+  # The main client, through which you interact with JustGiving
+  class Client
+    # Create a spangly new client instance
+    #
+    # Example:
+    #   >> client = JustGiving::Client.new(:api_key => "my_key")
+    #   => #<JustGiving::Client:0x000001009c6f98 @api_key="my_key">
+    def initialize(options)
+      @api_key = options[:api_key]
+    end
+    
+    # Get a user by their email
+    def user(email)
+      User.new(http, email)
+    end
+    
+    # Get a donation by it's id
+    def donation(id)
+      response = http.get("/donation/#{id}")
+      Donation.new(response)
+    end
+    
+  private
+    # A class to handle all the nitty-gritty of the web interface
+    def http
+      HttpClient.new
+    end
+  end
+end

data/lib/justgiving_client/donation.rb

@@ -0,0 +1,9 @@
+module JustGiving
+  class Donation
+    attr_reader :message
+    
+    def initialize(response)
+      @message = response["message"]
+    end
+  end
+end

data/lib/justgiving_client/fundraising_page.rb

@@ -0,0 +1,9 @@
+module JustGiving
+  class FundraisingPage
+    attr_reader :title
+    
+    def initialize(hash)
+      @title = hash["pageTitle"]
+    end
+  end
+end

data/lib/justgiving_client/http_client.rb

@@ -0,0 +1,27 @@
+require 'httparty'
+
+module JustGiving
+  class HttpClient
+    include HTTParty
+    
+    format :json
+    base_uri "http://api.justgiving.com"
+    
+    def initialize(api_key, version)
+      @api_key = api_key
+      @version = version
+    end
+    
+    def get(path, params = {})
+      self.class.get(construct_uri(path), :query => params).parsed_response
+    end
+    
+    def post(path, params = {})
+      self.class.post(construct_uri(path), :query => params).parsed_response
+    end
+    
+    def construct_uri(path)
+      "/#{api_key}/#{version}#{path}"
+    end
+  end
+end

data/lib/justgiving_client/user.rb

@@ -0,0 +1,19 @@
+require 'cgi'
+
+module JustGiving
+  class User
+    attr_reader :email
+    
+    def initialize(http_client, email)
+      @http_client = http_client
+      @email       = email
+    end
+    
+    def fundraising_pages
+      response = @http_client.get("/account/#{CGI.escape(@email)}/pages")
+      @pages = response.map do |page_hash|
+        FundraisingPage.new(page_hash)
+      end
+    end
+  end
+end

data/lib/justgiving_client/version.rb

@@ -0,0 +1,3 @@
+module JustGiving
+  VERSION = "0.2.0"
+end

data/spec/justgiving_client/client_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe JustGiving::Client do
+  include SpecHelper
+  
+  before do
+    @client = JustGiving::Client.new(:api_key => api_key)
+    @client.stub(:http).and_return(http_client)
+  end
+  
+  describe :donation do
+    before do
+      http_client.should_receive(:get).with("/donation/1234").
+        and_return({
+          "id"                  => 1234,
+          "image"               => "",
+          "hasImage"            => false,
+          "donationDate"        => "/Date(1321720670900+0000)/",
+          "donorDisplayName"    => "Awesome Guy",
+          "message"             => "Hope you like my donation.",
+          "estimatedTaxReclaim" => 0.56,
+          "amount"              => "2.00",
+          "donorRealName"       => "Peter Queue",
+          "thirdPartyReference" => "1234-my-sdi-ref",
+          "status"              => "Accepted",
+          "source"              => "SponsorshipDonations"
+        })
+    end
+    
+    let(:donation) { @client.donation(1234) }
+    
+    it "returns a Donation" do
+      donation.should be_a(JustGiving::Donation)
+    end
+    
+    it "exposes the donor's real name" do
+      donation.message.should == "Hope you like my donation."
+    end
+  end
+  
+  describe :user do
+    it "returns a User" do
+      user = @client.user("bob@me.com")
+      user.should be_a(JustGiving::User)
+      user.email.should == "bob@me.com"
+    end
+  end
+end

data/spec/justgiving_client/user_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe JustGiving::User do
+  include SpecHelper
+  
+  before do
+    @user = JustGiving::User.new(http_client, "bob@me.com")
+  end
+  
+  describe :fundraising_pages do
+    before do
+      http_client.should_receive(:get).with("/account/bob%40me.com/pages").
+        and_return([
+          {
+            "pageId"                => 1457423,
+            "pageTitle"             => "My Fundraising Page!",
+            "pageStatus"            => "Active",
+            "pageShortName"         => "myJustGivingShortName",
+            "raisedAmount"          => 20.0,
+            "designId"              => 1,
+            "companyAppealId"       => 0,
+            "targetAmount"          => 1000.0,
+            "offlineDonations"      => 10.0,
+            "totalRaisedOnline"     => 50.0,
+            "giftAidPlusSupplement" => 1.25,
+            "pageImages" => [
+              "42010/65f56cc6-3535-436e-927d-eb9c24b82a6e.jpg"
+            ],
+            "eventName"             => "My Awesome Event",
+            "domain"                => "www.justgiving.com",
+            "smsCode"               => "PEJN76",
+            "charityId"             => 1
+          }
+        ])
+    end
+    
+    let(:page) { @user.fundraising_pages.first }
+    
+    it "returns a FundraisingPage" do
+      page.should be_a(JustGiving::FundraisingPage)
+    end
+    
+    it "returns the page title" do
+      page.title.should == "My Fundraising Page!"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require File.expand_path('../../lib/justgiving_client', __FILE__)
+
+module SpecHelper
+  def self.included(spec)
+    spec.let(:api_key)     { "justgivingkey" }
+    spec.let(:http_client) { mock JustGiving::HttpClient }
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: justgiving_client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matt Gibb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: An object-graph interpretation of the JustGiving API in Ruby
+email: matt@mattgibb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- spec/justgiving_client/client_spec.rb
+- spec/justgiving_client/user_spec.rb
+- spec/spec_helper.rb
+- lib/justgiving_client/client.rb
+- lib/justgiving_client/donation.rb
+- lib/justgiving_client/fundraising_page.rb
+- lib/justgiving_client/http_client.rb
+- lib/justgiving_client/user.rb
+- lib/justgiving_client/version.rb
+- lib/justgiving_client.rb
+homepage: https://github.com/mattgibb/justgiving_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: API client for JustGiving
+test_files: []
+