just_giving 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mint Digital
+
+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,45 @@
+just_giving
+===========
+
+A ruby wrapper for the justgiving.com API
+
+Installation
+------------
+
+    gem install just_giving
+    
+Usage
+-----
+
+Just giving provides 2 separate API's - Simple Donation Integration (SDI) for making donations and an XML API for querying and creating data.
+
+This gem currently provides functionality to link to SDI, if you are using rails you can use view helpers like so:
+
+    <%= link_to 'Click to donate', just_giving_charity_page_url('short_name') %>
+    <%= link_to 'Click to donate', just_giving_charity_donation_page_url('id', 
+      {:suggested_amount => 2..100000, :donation_id => 'JUSTGIVING-DONATION-ID', :amount => 2..100000, 
+      :frequency => %w(single monthly), :exit_url => 'http://myredirect.com'}) %>
+    <%= link_to 'Click to donate', just_giving_fundraising_page_url('short_url') %>
+    <%= link_to 'Click to donate', just_giving_fundraising_donation_url('pageId', 
+      {:suggested_amount => 2..100000, :amount => 2..100000, :exit_url => 'http://myredirect.com', 
+      :donation_id => 'JUSTGIVING-DONATION-ID'}) %>)
+    
+As you can see just_giving_charity_donation_page_url and just_giving_fundraising_donation_url take and optional options hash - supply as many or as few of these as you need.
+
+Contributing to just_giving
+---------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Mint Digital. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require 'lib/just_giving/version'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "just_giving"
+  gem.homepage = "http://github.com/mintdigital/just_giving"
+  gem.license = "MIT"
+  gem.summary = %Q{A ruby wrapper for the justgiving.com API}
+  gem.description = %Q{A ruby wrapper for the justgiving.com API}
+  gem.email = "thomas@mintdigital.com"
+  gem.authors = ["Thomas Pomfret"]
+  gem.version = JustGiving::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "just_giving #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/just_giving.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{just_giving}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Pomfret"]
+  s.date = %q{2011-08-12}
+  s.description = %q{A ruby wrapper for the justgiving.com API}
+  s.email = %q{thomas@mintdigital.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "just_giving.gemspec",
+    "lib/just_giving.rb",
+    "lib/just_giving/config.rb",
+    "lib/just_giving/railtie.rb",
+    "lib/just_giving/simple_donation_integration.rb",
+    "lib/just_giving/version.rb",
+    "lib/just_giving/view_helpers.rb",
+    "test/helper.rb",
+    "test/test_simple_donation_integration.rb"
+  ]
+  s.homepage = %q{http://github.com/mintdigital/just_giving}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.1}
+  s.summary = %q{A ruby wrapper for the justgiving.com API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/just_giving/config.rb

@@ -0,0 +1,7 @@
+module JustGiving
+  class Config
+#    cattr_accessor :application_id
+
+    BASE_URI = "http://www.justgiving.com"
+  end
+end

data/lib/just_giving/railtie.rb

@@ -0,0 +1,8 @@
+require 'just_giving/view_helpers'
+module JustGiving
+  class Railtie < Rails::Railtie
+    initializer "just_giving.view_helpers" do
+      ActionView::Base.send :include, JustGiving::ViewHelpers
+    end
+  end
+end

data/lib/just_giving/simple_donation_integration.rb

@@ -0,0 +1,43 @@
+require 'cgi'
+
+module JustGiving
+  class SimpleDonationIntegration
+    def self.charity_page_url(short_name)
+      "#{JustGiving::Config::BASE_URI}/#{short_name}/donate" 
+    end
+
+    def self.charity_donation_url(charity_id, options={})
+      options = self.parse_options(options)
+      url = "#{JustGiving::Config::BASE_URI}/donation/direct/charity/#{charity_id}"
+      url << self.options_to_query(options) if options.any?
+      url
+    end
+
+    class << self
+      alias :fundraising_page_url :charity_page_url
+    end
+
+    def self.fundraising_donation_url(page_id, options={})
+      options = self.parse_options(options)
+      url = "#{JustGiving::Config::BASE_URI}/donation/sponsor/page/#{page_id}"
+      url << self.options_to_query(options) if options.any?
+      url
+    end
+
+    private
+    
+    def self.parse_options(options)
+      available_options = [:amount, :frequency, :exit_url, :donation_id]
+      options.delete_if{|key, value| !available_options.include?(key)}
+    end
+
+    # This is a pretty niave implementation but we control the input so it suffices
+    def self.camelize(snake_case_word)
+      snake_case_word.to_s.gsub(/_(.)/){$1.upcase}
+    end
+
+    def self.options_to_query(options)
+      "?#{options.collect{|k,v| "#{self.camelize(k)}=#{CGI.escape(v.to_s)}"}.join("&")}"
+    end
+  end
+end

data/lib/just_giving/version.rb

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

data/lib/just_giving/view_helpers.rb

@@ -0,0 +1,19 @@
+module JustGiving
+  module ViewHelpers
+    def just_giving_charity_page_url(short_name)
+      SimpleDonationIntegration.charity_page_url(short_name) 
+    end
+
+    def just_giving_charity_donation_page_url(charity_id, options={})
+      SimpleDonationIntegration.charity_donation_url(charity_id, options)
+    end
+
+    def just_giving_fundraising_page_url(short_url)
+      SimpleDonationIntegration.fundraising_page_url(short_url) 
+    end
+
+    def just_giving_fundraising_donation_url(page_id, options={})
+      SimpleDonationIntegration.fundraising_donation_url(page_id, options)
+    end
+  end
+end

data/lib/just_giving.rb

@@ -0,0 +1,3 @@
+require 'just_giving/config'
+require 'just_giving/simple_donation_integration'
+require 'just_giving/railtie' if defined?(Rails)

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'just_giving'
+
+class Test::Unit::TestCase
+end

data/test/test_simple_donation_integration.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestSimpleDonationIntegration < Test::Unit::TestCase
+  should "return charity url" do
+    assert_equal "http://www.justgiving.com/short_name/donate", JustGiving::SimpleDonationIntegration.charity_page_url('short_name') 
+  end
+
+  context "charity donation url" do
+    should "return charity donation url" do
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050", JustGiving::SimpleDonationIntegration.charity_donation_url(2050)
+    end
+
+    should "accept valid options" do
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050?amount=2", JustGiving::SimpleDonationIntegration.charity_donation_url(2050, :amount => 2)
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050?frequency=single", 
+        JustGiving::SimpleDonationIntegration.charity_donation_url(2050, :frequency => 'single')
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050?exitUrl=http%3A%2F%2Fwww.myredirecturl.com%2Fpath", 
+        JustGiving::SimpleDonationIntegration.charity_donation_url(2050, :exit_url => 'http://www.myredirecturl.com/path')
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050?donationId=JUSTGIVING-DONATION-ID", 
+        JustGiving::SimpleDonationIntegration.charity_donation_url(2050, :donation_id => 'JUSTGIVING-DONATION-ID')
+    end
+
+    should "reject unknown options" do
+      assert_equal "http://www.justgiving.com/donation/direct/charity/2050", JustGiving::SimpleDonationIntegration.charity_donation_url(2050, :bogus => 1)
+    end
+  end
+
+  should "return fundraising url" do
+    assert_equal "http://www.justgiving.com/test/donate", JustGiving::SimpleDonationIntegration.fundraising_page_url('test')
+  end
+
+  context "fundraising donation url" do
+    should "return fundraising donation url" do
+      assert_equal "http://www.justgiving.com/donation/sponsor/page/12345", JustGiving::SimpleDonationIntegration.fundraising_donation_url(12345)    
+    end
+
+    should "accept valid options" do
+      assert_equal "http://www.justgiving.com/donation/sponsor/page/12345?amount=2", JustGiving::SimpleDonationIntegration.fundraising_donation_url(12345, :amount => 2)
+      assert_equal "http://www.justgiving.com/donation/sponsor/page/12345?exitUrl=http%3A%2F%2Fwww.myredirecturl.com%2Fpath", 
+        JustGiving::SimpleDonationIntegration.fundraising_donation_url(12345, :exit_url => 'http://www.myredirecturl.com/path')
+      assert_equal "http://www.justgiving.com/donation/sponsor/page/12345?donationId=JUSTGIVING-DONATION-ID", 
+        JustGiving::SimpleDonationIntegration.fundraising_donation_url(12345, :donation_id => 'JUSTGIVING-DONATION-ID')
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: just_giving
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Thomas Pomfret
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: A ruby wrapper for the justgiving.com API
+email: thomas@mintdigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- just_giving.gemspec
+- lib/just_giving.rb
+- lib/just_giving/config.rb
+- lib/just_giving/railtie.rb
+- lib/just_giving/simple_donation_integration.rb
+- lib/just_giving/version.rb
+- lib/just_giving/view_helpers.rb
+- test/helper.rb
+- test/test_simple_donation_integration.rb
+has_rdoc: true
+homepage: http://github.com/mintdigital/just_giving
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the justgiving.com API
+test_files: []
+