just_giving 0.1.0 → 0.2.0

data/test/test_charity.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestCharity < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+  
+  context 'fetching a charity' do
+    should 'get a charity by id' do
+      stub_get('/v1/charity/2050').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('charity_get_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      charity = JustGiving::Charity.new.get_charity(2050)
+      assert_equal 2050, charity["id"]
+      assert_equal "The Demo Charity", charity["smsShortName"]
+    end
+  end
+  
+  context 'validate a charity' do
+    should '' do
+      stub_post('/v1/charity/authenticate').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('charity_auth_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      auth = JustGiving::Charity.new.validate({:username => "MyCharityUsername",
+        :password => "MyPassword", :pin => "MyPin"})
+      assert auth["isValid"]
+      assert !auth["error"]
+      assert_equal 1235, auth["charityId"]
+    end
+  end
+end

data/test/test_configuration.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestConfiguration < Test::Unit::TestCase
+  should 'allow setting/getting of application_id' do
+    JustGiving::Configuration.application_id = '1234'
+    assert_equal '1234', JustGiving::Configuration.application_id
+    JustGiving::Configuration.application_id = '5678'
+    assert_equal '5678', JustGiving::Configuration.application_id
+  end
+  
+  should 'allow setting the enviroment' do
+    assert_equal :staging, JustGiving::Configuration.environment
+    JustGiving::Configuration.environment = :production
+    assert_equal :production, JustGiving::Configuration.environment
+  end
+  
+  should 'return the api endpoint' do
+    JustGiving::Configuration.environment = :staging    
+    JustGiving::Configuration.application_id = '5678'
+    assert_equal 'https://api.staging.justgiving.com/5678', JustGiving::Configuration.api_endpoint
+    JustGiving::Configuration.environment = :production
+    assert_equal 'https://api.justgiving.com/5678', JustGiving::Configuration.api_endpoint
+  end
+  
+  should 'raise if application id is not set' do
+    JustGiving::Configuration.application_id = nil
+    assert_raise JustGiving::InvalidApplicationId do
+      JustGiving::Configuration.api_endpoint
+    end
+  end
+
+  should 'return the ca_path' do
+    assert_equal '/usr/lib/ssl/certs', JustGiving::Configuration.ca_path
+    JustGiving::Configuration.ca_path = '/System/Library/OpenSSL/certs'
+    assert_equal '/System/Library/OpenSSL/certs', JustGiving::Configuration.ca_path
+  end
+end

data/test/test_donation.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestDonation < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+
+  context 'getting a donation' do
+    should 'return known donation' do
+      stub_get('/v1/donation/1/status').to_return(
+        :body => fixture('donation_status_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      donation = JustGiving::Donation.new(1).status
+      assert_equal 2.0, donation['amount']
+      assert_equal 1234, donation['donationId']
+      assert_equal "Accepted", donation['status']
+    end
+
+    should 'not return unkown donation' do
+      stub_get('/v1/donation/1/status').to_raise(JustGiving::NotFound)
+      assert_raise JustGiving::NotFound do
+        donation = JustGiving::Donation.new(1).status
+      end
+    end
+  end
+end

data/test/test_event.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestEvent < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+  context 'with an event' do
+    setup do
+      @event = JustGiving::Event.new(1)
+    end
+    
+    should 'get details' do
+      stub_get('/v1/event/1').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('event_get_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      details = @event.details
+      assert_equal 12356, details["id"]
+      assert_equal "Playing Mario for charity", details["description"]
+    end
+    
+    should 'get pages' do
+      stub_get('/v1/event/1/pages').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('event_pages_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      pages = @event.pages
+      assert_equal 1234, pages["eventId"]
+      assert_equal 1457423, pages["fundraisingPages"].first["pageId"]
+    end
+  end
+end

data/test/test_fundraising.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class TestFundraising < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+
+  context 'using basic auth' do
+    setup do
+      JustGiving::Configuration.username = 'test'
+      JustGiving::Configuration.password = 'secret'
+    end
+
+    should 'get pages' do
+      stub_get('/v1/fundraising/pages', 'test:secret').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('fundraising_pages_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      pages = JustGiving::Fundraising.new.pages
+    end
+
+    should 'get donations' do
+      stub_get('/v1/fundraising/pages/test/donations?pageNum=1&page_size=50', 'test:secret').with(
+        :headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('fundraising_donations_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      pages = JustGiving::Fundraising.new('test').donations
+    end
+
+    should 'set pagination options for donations' do
+      stub_get('/v1/fundraising/pages/test/donations?pageNum=2&page_size=10', 'test:secret').with(
+        :headers => {'Accept'=>'application/json'}).to_return(
+        :body => fixture('fundraising_donations_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      pages = JustGiving::Fundraising.new('test').donations(2, 10)
+    end
+
+    should 'create page' do
+      stub_put('/v1/fundraising/pages', 'test:secret').with(:headers => {'Accept'=>'application/json'}).to_return(
+      :body => fixture('fundraising_pages_success.json'),
+      :headers => {:content_type =>  'application/json; charset=utf-8'}, :status => 201)
+      page = JustGiving::Fundraising.new.create({})
+    end
+
+    should 'update story' do
+      stub_post('/v1/fundraising/pages/test', 'test:secret').with(:headers => {'Accept'=>'application/json',
+      'Content-Type'=>'application/json'}, :body => '{"storySupplement":"new story"}').to_return(
+      :body => fixture('fundraising_update_story_success.json'),
+      :headers => {:content_type =>  'application/json; charset=utf-8'}, :status => 200)
+      page = JustGiving::Fundraising.new('test').update_story('new story')
+    end
+  end
+
+  context 'with no basic auth' do
+    should 'check if short name is registered' do
+      stub_head('/v1/fundraising/pages/test').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :status => 200, :headers => {:content_type =>  'application/json; charset=utf-8'})
+      assert JustGiving::Fundraising.new('test').short_name_registered?
+    end
+
+    should 'check if short name is registered when not found' do
+      stub_head('/v1/fundraising/pages/test').with(:headers => {'Accept'=>'application/json'}).to_return(
+        :status => 404, :headers => {:content_type =>  'application/json; charset=utf-8'})
+      assert !JustGiving::Fundraising.new('test').short_name_registered?
+    end
+
+    should 'get fundraising page' do
+      stub_get('/v1/fundraising/pages/test').with(:headers => {'Accept'=>'application/json'}).to_return(
+      :body => fixture('fundraising_get_page_success.json'), :status => 200,
+      :headers => {:content_type =>  'application/json; charset=utf-8'})
+      page = JustGiving::Fundraising.new('test').page
+      assert_equal "00A246", page["branding"]["buttonColour"]
+      assert_equal "261017", page["charity"]["registrationNumber"]
+    end
+  end
+end

data/test/test_search.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestSearch < Test::Unit::TestCase
+  def setup
+    JustGiving::Configuration.application_id = '2345'
+  end
+
+  context 'searching' do
+    should 'search with default options' do
+      stub_get('/v1/charity/search?q=test&page=1&pageSize=10').to_return(
+        :body => fixture('search_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      search = JustGiving::Search.new.search_charities('test')
+      assert_equal "311", search['charitySearchResults'].first['charityId']
+    end
+
+    should 'use supplied page/per_page' do
+      stub_get('/v1/charity/search?q=test&page=2&pageSize=1').to_return(
+        :body => fixture('search_success.json'),
+        :headers => {:content_type =>  'application/json; charset=utf-8'})
+      search = JustGiving::Search.new.search_charities('test', 2, 1)
+      assert_equal "311", search['charitySearchResults'].first['charityId']
+    end
+
+    should 'not search with invalid options' do
+      stub_get('/v1/charity/search?q=&page=2&pageSize=1').to_raise(JustGiving::NotFound)
+      assert_raise JustGiving::NotFound do
+        search = JustGiving::Search.new.search_charities('', 2, 1)
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: just_giving
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thomas Pomfret
@@ -15,14 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-12 00:00:00 +01:00
-default_executable: 
+date: 2011-08-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: faraday
   prerelease: false
-  name: shoulda
-  type: :development
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +41,70 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
+  version_requirements: *id002
+  name: faraday_middleware
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: hashie
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  version_requirements: *id004
+  name: multi_json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: yajl-ruby
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: shoulda
   prerelease: false
-  name: bundler
   type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +115,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *id007
+  name: bundler
   prerelease: false
-  name: jeweler
   type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +131,26 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *id008
+  name: jeweler
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id009
   name: rcov
+  prerelease: false
   type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,7 +159,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  version_requirements: *id010
+  name: webmock
+  prerelease: false
+  type: :development
 description: A ruby wrapper for the justgiving.com API
 email: thomas@mintdigital.com
 executables: []
@@ -94,15 +179,47 @@ files:
 - README.md
 - Rakefile
 - just_giving.gemspec
+- lib/faraday/raise_http_4xx.rb
+- lib/faraday/raise_http_5xx.rb
 - lib/just_giving.rb
-- lib/just_giving/config.rb
+- lib/just_giving/account.rb
+- lib/just_giving/api.rb
+- lib/just_giving/charity.rb
+- lib/just_giving/configuration.rb
+- lib/just_giving/connection.rb
+- lib/just_giving/donation.rb
+- lib/just_giving/error.rb
+- lib/just_giving/event.rb
+- lib/just_giving/fundraising.rb
 - lib/just_giving/railtie.rb
+- lib/just_giving/request.rb
+- lib/just_giving/response.rb
+- lib/just_giving/search.rb
 - lib/just_giving/simple_donation_integration.rb
 - lib/just_giving/version.rb
 - lib/just_giving/view_helpers.rb
+- test/fixtures/account_create_fail.json
+- test/fixtures/account_create_success.json
+- test/fixtures/account_list_all_pages.json
+- test/fixtures/charity_auth_success.json
+- test/fixtures/charity_get_success.json
+- test/fixtures/donation_status_success.json
+- test/fixtures/event_get_success.json
+- test/fixtures/event_pages_success.json
+- test/fixtures/fundraising_donations_success.json
+- test/fixtures/fundraising_get_page_success.json
+- test/fixtures/fundraising_pages_success.json
+- test/fixtures/fundraising_update_story_success.json
+- test/fixtures/search_success.json
 - test/helper.rb
+- test/test_account.rb
+- test/test_charity.rb
+- test/test_configuration.rb
+- test/test_donation.rb
+- test/test_event.rb
+- test/test_fundraising.rb
+- test/test_search.rb
 - test/test_simple_donation_integration.rb
-has_rdoc: true
 homepage: http://github.com/mintdigital/just_giving
 licenses: 
 - MIT
@@ -132,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: A ruby wrapper for the justgiving.com API