just_giving 0.1.0 → 0.2.0

data/lib/just_giving/error.rb

@@ -0,0 +1,9 @@
+module JustGiving
+  class Error < StandardError; end
+  
+  class NotFound < Error; end
+
+  class InternalServerError < Error; end
+
+  class InvalidApplicationId < Error; end
+end

data/lib/just_giving/event.rb

@@ -0,0 +1,17 @@
+module JustGiving
+  class Event < API
+    def initialize(id)
+      @id = id
+    end
+
+    # Get details for an event
+    def details
+      get("v1/event/#{@id}")
+    end
+
+    # Get all pages for an event
+    def pages
+      get("v1/event/#{@id}/pages")
+    end
+  end
+end

data/lib/just_giving/fundraising.rb

@@ -0,0 +1,51 @@
+module JustGiving
+  class Fundraising < API
+    def initialize(short_name=nil)
+      @short_name = short_name
+    end
+    
+    # Get all pages
+    def pages
+      get("v1/fundraising/pages", :basic_auth => true)
+    end
+
+    # Create a new fundraising page
+    def create(params)
+      put("v1/fundraising/pages", {:basic_auth => true}.merge(params))
+    end
+
+    # Check if a short name is registered
+    def short_name_registered?
+      begin
+        head("v1/fundraising/pages/#{@short_name}")
+        return true
+      rescue JustGiving::NotFound
+        return false
+      end
+    end
+
+    # Get a specific page
+    def page
+      get("v1/fundraising/pages/#{@short_name}")
+    end
+
+    # Get all donations per page
+    def donations(page=1, per_page=50)
+      get("v1/fundraising/pages/#{@short_name}/donations?pageNum=#{page}&page_size=#{per_page}",
+        :basic_auth => true)
+    end
+
+    # Update a pages story
+    def update_story(story)
+      post("v1/fundraising/pages/#{@short_name}", {:basic_auth => true}.merge({:storySupplement => story}))
+    end
+
+    def upload_image
+      # TODO
+    end
+
+    def suggest
+      # TODO
+    end
+  end
+end

data/lib/just_giving/request.rb

@@ -0,0 +1,40 @@
+module JustGiving
+  module Request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    def head(path, options={})
+      request(:head, path, options)
+    end
+
+    def post(path, options={})
+      request(:post, path, options)
+    end
+    
+    private
+    
+    def request(method, path, options)
+      basic_auth = options.delete(:basic_auth)
+      response = connection(basic_auth).send(method) do |request|
+        case method.to_sym
+        when :get, :head
+          request.url(path, options)
+        when :put, :post
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      case response.status
+      when 400 #Return errors if 400
+        JustGiving::Response.new(response.body)
+      else
+        response.body
+      end
+    end
+  end
+end

data/lib/just_giving/response.rb

@@ -0,0 +1,9 @@
+module JustGiving
+  class Response
+    attr_accessor :errors
+    def initialize(errors)
+      @errors = []
+      errors.each{|e| @errors << Hashie::Mash.new(e)}
+    end
+  end
+end

data/lib/just_giving/search.rb

@@ -0,0 +1,13 @@
+module JustGiving
+  class Search < API
+    # Search charites
+    def search_charities(query, page=1, per_page=10)
+      get("v1/charity/search?q=#{query}&page=#{page}&pageSize=#{per_page}")
+    end
+
+    # Search events
+    def search_events(query, page=1, per_page=10)
+      get("v1/event/search?q=#{query}&page=#{page}&pageSize=#{per_page}")
+    end
+  end
+end

data/lib/just_giving/simple_donation_integration.rb

@@ -2,13 +2,15 @@ require 'cgi'
 
 module JustGiving
   class SimpleDonationIntegration
+    # Returns url to link to a charity page
     def self.charity_page_url(short_name)
-      "#{JustGiving::Config::BASE_URI}/#{short_name}/donate" 
+      "#{JustGiving::Configuration::BASE_URI}/#{short_name}/donate" 
     end
 
+    # Returns url for the donation page of a charity
     def self.charity_donation_url(charity_id, options={})
       options = self.parse_options(options)
-      url = "#{JustGiving::Config::BASE_URI}/donation/direct/charity/#{charity_id}"
+      url = "#{JustGiving::Configuration::BASE_URI}/donation/direct/charity/#{charity_id}"
       url << self.options_to_query(options) if options.any?
       url
     end
@@ -17,15 +19,17 @@ module JustGiving
       alias :fundraising_page_url :charity_page_url
     end
 
+    # Returns url for the donation page of a fundraising
     def self.fundraising_donation_url(page_id, options={})
       options = self.parse_options(options)
-      url = "#{JustGiving::Config::BASE_URI}/donation/sponsor/page/#{page_id}"
+      url = "#{JustGiving::Configuration::BASE_URI}/donation/sponsor/page/#{page_id}"
       url << self.options_to_query(options) if options.any?
       url
     end
 
     private
     
+    # Remove options we are not interested in
     def self.parse_options(options)
       available_options = [:amount, :frequency, :exit_url, :donation_id]
       options.delete_if{|key, value| !available_options.include?(key)}

data/lib/just_giving/version.rb

@@ -1,7 +1,7 @@
 module JustGiving
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     
     STRING = [MAJOR, MINOR, PATCH].compact.join('.') 

data/test/fixtures/account_create_fail.json

@@ -0,0 +1 @@
+[{"id":"TitleNotSpecified","desc":"The Title field is required."},{"id":"FirstNameNotSpecified","desc":"The FirstName field is required."},{"id":"LastNameNotSpecified","desc":"The LastName field is required."},{"id":"EmailNotSpecified","desc":"The Email field is required."},{"id":"PasswordNotSpecified","desc":"The Password field is required."},{"id":"AcceptTermsAndConditionsNotSpecified","desc":"The AcceptTermsAndConditions field is required."},{"id":"InvalidTitleSpecified","desc":"Please provide your title"},{"id":"AddressNotSpecified","desc":"address is invalid or missing."}]

data/test/fixtures/account_create_success.json

@@ -0,0 +1,3 @@
+{
+  "email": "test@example.com"
+}

data/test/fixtures/account_list_all_pages.json

@@ -0,0 +1,21 @@
+[
+  {
+    "pageId": 1457423,
+    "pageTitle": "Alwyn’s page",
+    "pageStatus": "Active",
+    "pageShortName": "myJustGivingShortName",
+    "raisedAmount": 20.0,
+    "designId": 1,
+    "targetAmount": 1000.0,
+    "offlineDonations": 10.0,
+    "totalRaisedOnline": 50.00,
+    "giftAidPlusSupplement": 1.25,
+    "pageImages": [
+      "42010/65f56cc6-3535-436e-927d-eb9c24b82a6e.jpg"
+    ],
+    "eventName": "My Awesome Event",
+    "domain": "www.justgiving.com",
+    "smsCode": "PEJN76",
+    "charityId": 1
+  }
+]

data/test/fixtures/charity_auth_success.json

@@ -0,0 +1,5 @@
+{
+  "isValid": true,
+  "error": null,
+  "charityId": 1235
+}

data/test/fixtures/charity_get_success.json

@@ -0,0 +1 @@
+{"description":"This charity is for demo purposes only and enables you to build a sample sponsorship page. A 'real' charity would display its purpose and mission here, outlining its achievements and projects. Please do not donate to the Demo Charity! ","id":2050,"logoUrl":"demo.jpg","name":"The Demo Charity","pageShortName":"jgdemo","profilePageUrl":"http:\/\/www.justgiving.com\/jgdemo","registrationNumber":"123456","websiteUrl":"http:\/\/www.democharity.co.uk","smsShortName":"The Demo Charity","mobileAppeals":[{"name":"STEV22-test","smsCode":"TESS22"}]}

data/test/fixtures/donation_status_success.json

@@ -0,0 +1,7 @@
+{
+  "ref": "my-sdi-ref",
+  "donationId": 1234,
+  "donationRef": "35626",
+  "status": "Accepted",
+  "amount": 2.00
+}

data/test/fixtures/event_get_success.json

@@ -0,0 +1,8 @@
+{
+  "name": "Playing Mario for 48 hours for charity",
+  "description": "Playing Mario for charity",
+  "id": 12356,
+  "completionDate": "\/Date(1345213305272+0100)\/",
+  "expiryDate": "\/Date(1345213305272+0100)\/",
+  "startDate": "\/Date(1313763705272+0100)\/"
+}

data/test/fixtures/event_pages_success.json

@@ -0,0 +1,26 @@
+{
+  "eventId": 1234,
+  "totalFundraisingPages": 1,
+  "totalPages": 1,
+  "fundraisingPages": [
+    {
+      "pageId": 1457423,
+      "pageTitle": "My Fundraising Page!",
+      "pageStatus": "Active",
+      "pageShortName": "myJustGivingShortName",
+      "raisedAmount": 20.0,
+      "designId": 1,
+      "targetAmount": 1000.0,
+      "offlineDonations": 10.0,
+      "totalRaisedOnline": 50.00,
+      "giftAidPlusSupplement": 1.25,
+      "pageImages": [
+        "42010/65f56cc6-3535-436e-927d-eb9c24b82a6e.jpg"
+      ],
+      "eventName": "My Awesome Event",
+      "domain": "www.justgiving.com",
+      "smsCode": "PEJN76",
+      "charityId": 1
+    }
+  ]
+}

data/test/fixtures/fundraising_donations_success.json

@@ -0,0 +1 @@
+{"donations":[],"id":"test","pagination":{"pageNumber":1,"pageSizeRequested":25,"pageSizeReturned":0,"totalPages":1}}

data/test/fixtures/fundraising_get_page_success.json

@@ -0,0 +1 @@
+{"activityId":"512239","activityType":1,"branding":{"buttonColour":"00A246","buttonTextColour":"FFFFFF","headerTextColour":"005C46","thermometerBackgroundColour":"005C46","thermometerFillColour":"00A246","thermometerTextColour":"FFFFFF"},"charity":{"description":"Macmillan Cancer Support improves the lives of people affected by cancer. We provide practical, medical, emotional and financial support and push for better cancer care. One in three of us will get cancer. Two million of us are living with it. We are all affected by cancer. We can all help. We are Macmillan.","logoUrl":"macmillan_logo_large.gif","name":"Macmillan Cancer Support","profilePageUrl":null,"registrationNumber":"261017"},"currencySymbol":"£","domain":"v3.staging.justgiving.com","eventDate":"\/Date(1315090800000+0100)\/","eventName":"Great Scottish Run 2011","expiryDate":"\/Date(1322956800000+0000)\/","fundraisingTarget":"0.00","grandTotalRaisedExcludingGiftAid":"0.0000","image":{"caption":"","url":"Stock\/oldtrainers.jpg"},"imageCount":"1","media":{"images":[{"caption":"","url":"Stock\/oldtrainers.jpg"}]},"owner":"test","pageId":"2938879","pageShortName":"test","showEventDate":"True","showExpiryDate":"False","smsCode":"TPNP50","status":"Active","story":"<p class=\"iphone-update\">Updated on Aug 17th 2011 at 1:46 PM from the JustGiving API<\/p><p>test<\/p><p>Thanks for taking the time to visit my JustGiving page.<\/p><p>Donating through JustGiving is simple, fast and totally secure. Your details are safe with JustGiving – they’ll never sell them on or send unwanted emails. Once you donate, they’ll send your money directly to the charity and make sure Gift Aid is reclaimed on every eligible donation by a UK taxpayer. So it’s the most efficient way to donate - I raise more, whilst saving time and cutting costs for the charity.<\/p><p>So please dig deep and donate now.<\/p>","title":"thomas's page","totalEstimatedGiftAid":"0","totalRaisedOffline":"0.0000","totalRaisedOnline":"0","totalRaisedPercentageOfFundraisingTarget":"0"}

data/test/fixtures/fundraising_pages_success.json

@@ -0,0 +1 @@
+[{"designId":1,"domain":"v3.staging.justgiving.com","eventName":"Event: Great Scottish Run 2011, Fundraiser: Macmillan Cancer Support, Revenue Stream: Macmillan - Donations & other ad hoc Events","giftAidPlusSupplement":0,"offlineDonations":0.0000,"pageId":2938879,"pageImages":["Stock\/oldtrainers.jpg"],"pageShortName":"test","pageStatus":"Active","pageTitle":"thomas's page","raisedAmount":0.0000,"targetAmount":0.0000,"totalRaisedOnline":0,"smsCode":"TPNP50","charityId":2116}]

data/test/fixtures/fundraising_update_story_success.json

@@ -0,0 +1 @@
+{}

data/test/fixtures/search_success.json

@@ -0,0 +1 @@
+{"charitySearchResults":[{"charityId":"311","description":"The Motor Neurone Disease (MND) Association is the only national\u000aorganisation in England, Wales and Northern Ireland dedicated to the\u000asupport of people with MND and those who care for them.\u000a\u000a\u000a\u000aOur mission is to fund and promote research to bring about an end to\u000aMND. Until then we will do all that we can to enable everyone with MND\u000ato receive the best care, achieve the highest quality of life possible,\u000aand die with dignity. We will also do all that we can to support the\u000afamilies and carers of people with MND.\u000a\u000a\u000a\u000aOur vision is of a world free of MND.","logoFileName":"\/Utils\/imaging.ashx?imageType=charitybrandinglogo&img=73debe79-18c9-4ab2-a98a-33835da5145f.jpg&width=120&height=120","name":"Motor Neurone Disease Association","registrationNumber":"294354"}],"next":{"rel":"http:\/\/api.staging.justgiving.com\/77253a18\/v1\/charity\/search?q=test&page=1&pagesize=1","uri":"http:\/\/api.staging.justgiving.com\/77253a18\/v1\/charity\/search?q=test&page=2&pagesize=1","type":"text\/xml"},"numberOfHits":100,"prev":null,"query":"test","sugguestedQuery":null,"totalPages":100}

data/test/helper.rb

@@ -8,11 +8,40 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'test/unit'
+require 'webmock/test_unit'
 require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'just_giving'
 
+def stub_get(path, basic_auth=nil)
+  stub_request(:get, make_url(path, basic_auth))
+end
+
+def stub_put(path, basic_auth=nil)
+  stub_request(:put, make_url(path, basic_auth))
+end
+
+def stub_post(path, basic_auth=nil)
+  stub_request(:post, make_url(path, basic_auth))
+end
+
+def stub_head(path)
+  stub_request(:head, JustGiving::Configuration.api_endpoint + path)
+end
+
+def make_url(path, basic_auth)
+  if basic_auth
+    JustGiving::Configuration.api_endpoint.gsub('https://', "https://#{basic_auth}@") + path
+  else
+    JustGiving::Configuration.api_endpoint + path
+  end
+end
+
+def fixture(file)
+  File.new(File.expand_path("../fixtures", __FILE__) + '/' + file)
+end
+
 class Test::Unit::TestCase
 end

data/test/test_account.rb

@@ -0,0 +1,110 @@
+require 'helper'
+
+class TestAccount < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+  
+  context 'Getting pages' do
+    should 'get pages for account' do
+      stub_get('/v1/account/test@example.com/pages').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('account_list_all_pages.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      account = JustGiving::Account.new('test@example.com')
+      pages = account.pages
+      assert_equal 'Alwyn’s page', pages.first['pageTitle']
+      assert_equal 'Active', pages.first['pageStatus']
+      assert_equal 1, pages.first['designId']
+    end
+
+    should 'raise 404 on account not found' do
+      stub_get('/v1/account/test@example.com/pages').to_raise(JustGiving::NotFound)
+      account = JustGiving::Account.new('test@example.com')
+      assert_raise JustGiving::NotFound do
+        account.pages
+      end
+    end
+  end
+
+  context 'Creating account' do
+    should 'create account successfully' do
+      stub_put('/v1/account').with({'Accept'=>'application/json', 'Content-Length'=>'0'}).to_return(
+        :body => fixture('account_create_success.json'),
+        :headers =>  {:content_type =>  'application/json; charset=utf-8'})
+      account = JustGiving::Account.new.create({:registration => {:email => 'test@example.com'}})
+      assert_equal 'test@example.com', account["email"]
+    end
+
+    should 'not create account with bad params' do
+      stub_put('/v1/account').to_return(:body => fixture('account_create_fail.json'),
+        :headers =>  {:content_type =>  'text/xml; charset=utf-8'}, :status => 400)
+      account = JustGiving::Account.new.create({})
+      assert account.errors
+    end
+  end
+
+  context 'Validate account' do
+    should 'return invalid account' do
+      stub_post('/v1/account/validate').with({'Accept'=>'application/json'}).to_return(
+        :body => "{\"consumerId\":0,\"isValid\":false}", :headers => {:content_type =>  'application/json; charset=utf-8'})
+      account = JustGiving::Account.new.validate(:email => 'test@example.com', :password => 'secret')
+      assert !account["isValid"]
+    end
+
+    should 'return valid account' do
+      stub_post('/v1/account/validate').with({'Accept'=>'application/json'}).to_return(
+        :body => "{\"consumerId\":1,\"isValid\":true}", :headers => {:content_type =>  'application/json; charset=utf-8'})
+      account = JustGiving::Account.new.validate(:email => 'test@example.com', :password => 'secret')
+      assert account["isValid"]
+      assert_equal 1, account["consumerId"]
+    end
+  end
+
+  context 'Checking if an email is available' do
+    should 'return email is not available' do
+      stub_head('/v1/account/test@example.com').with({'Accept'=>'application/json'}).to_return(
+        :status => 200, :headers => {:content_type =>  'application/json; charset=utf-8'})
+      assert !JustGiving::Account.new('test@example.com').available?
+    end
+
+    should 'return email is available' do
+      stub_head('/v1/account/test@example.com').with({'Accept'=>'application/json'}).to_return(
+        :status => 404, :headers => {:content_type =>  'application/json; charset=utf-8'})
+      assert JustGiving::Account.new('test@example.com').available?
+    end
+  end
+
+  context 'Changing password' do
+    should 'change password' do
+      stub_post('/v1/account/changePassword').with({'Accept'=>'application/json'}).to_return(
+        :body => "{\"success\": true}", :headers => {:content_type =>  'application/json; charset=utf-8'})
+      response = JustGiving::Account.new.change_password(:emailAddress => 'test@example.com', :newPassword => 'secret',
+        :currentPassword => 'password')
+      assert response["success"]
+    end
+
+    should 'not change password' do
+      stub_post('/v1/account/changePassword').with({'Accept'=>'application/json'}).to_return(
+        :body => "{\"success\": false}", :headers => {:content_type =>  'application/json; charset=utf-8'})
+      response = JustGiving::Account.new.change_password(:emailAddress => 'test@example.com', :newPassword => 'secret',
+        :currentPassword => 'password')
+      assert !response["success"]
+    end
+  end
+
+  context 'Password reminder' do
+    should 'send password reminder' do
+      stub_get('/v1/account/test@example.com/requestpasswordreminder').with({'Accept'=>'application/json'}).to_return(
+        :status => 200, :headers => {:content_type =>  'application/json; charset=utf-8'})
+      assert JustGiving::Account.new('test@example.com').password_reminder
+    end
+
+    should 'not sent password reminder' do
+      stub_get('/v1/account/test@example.com/requestpasswordreminder').with({'Accept'=>'application/json'}).to_return(
+        :status => 400, :body => "[{\"id\":\"AccountNotFound\",\"desc\":\"An account with that email address could not be found\"}",
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      response = JustGiving::Account.new('test@example.com').password_reminder
+      assert response.errors
+    end
+  end
+end