just_giving 0.1.0 → 0.2.0

data/Gemfile

@@ -3,6 +3,13 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
+gem "faraday"
+gem "faraday_middleware"
+gem "hashie"
+gem "multi_json", "~> 1.0.1"
+gem "yajl-ruby"
+
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
@@ -10,4 +17,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
+  gem "webmock"
 end

data/README.md

@@ -1,7 +1,7 @@
 just_giving
 ===========
 
-A ruby wrapper for the justgiving.com API
+A ruby wrapper for the justgiving.com API (https://api.justgiving.com/docs)
 
 Installation
 ------------
@@ -11,6 +11,8 @@ Installation
 Usage
 -----
 
+### Simple Donation Integration
+
 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:
@@ -26,6 +28,43 @@ This gem currently provides functionality to link to SDI, if you are using rails
     
 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.
 
+### API
+
+#### Configure
+
+JustGiving::Configuration.application_id = YOUR_APP_ID
+
+JustGiving::Configuration.ca_path = "/System/Library/OpenSSL/certs" # (defaults to "/usr/lib/ssl/certs")
+
+JustGiving::Configuration.environment = :production (defaults to :staging)
+
+JustGiving::Configuration.username = 'test@example.com' # Needed for actions that require auth
+
+JustGiving::Configuration.password = 'secret' # Needed for actions that require auth
+
+#### Account calls
+JustGiving::Account.new(YOUR_EMAIL).pages
+
+JustGiving::Account.new.create({:title => 'Mr', :firstName => 'Test', :lastName => 'McTest', :address => {:line1 => 'Unit 100', :townOrCity => 'London', :country => 'UK', :postcodeOrZipcode => 'ec1r 0jh'}, :email => 'test@example.com', :password => 'password', :acceptTermsAndConditions => true})
+
+#### Fundraising calls
+JustGiving::Fundraising.new('short-name').donations
+
+For further examples please check the tests
+
+Note that a 404 will raise a JustGiving::NotFound error
+
+A 400 response means the params supplied are wrong - this will return an errors collection with the details, eg:
+
+response = JustGiving::Account.new('unkown@unkown.com').password_reminder
+
+response.errors # errors array
+
+TODO
+----
+
+* Finish off all calls
+
 Contributing to just_giving
 ---------------------------
  

data/just_giving.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{just_giving}
-  s.version = "0.1.0"
+  s.version = "0.2.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.authors = [%q{Thomas Pomfret}]
+  s.date = %q{2011-08-23}
   s.description = %q{A ruby wrapper for the justgiving.com API}
   s.email = %q{thomas@mintdigital.com}
   s.extra_rdoc_files = [
@@ -23,40 +23,91 @@ Gem::Specification.new do |s|
     "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"
   ]
   s.homepage = %q{http://github.com/mintdigital/just_giving}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.1}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
   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_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.0.1"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
       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"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
     else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<multi_json>, ["~> 1.0.1"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
       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"])
+      s.add_dependency(%q<webmock>, [">= 0"])
     end
   else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<faraday_middleware>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<multi_json>, ["~> 1.0.1"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
     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"])
+    s.add_dependency(%q<webmock>, [">= 0"])
   end
 end
 

data/lib/faraday/raise_http_4xx.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 404
+          raise JustGiving::NotFound, error_message(response)
+        end
+      end
+    end
+    
+    private
+
+    def error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} #{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      body = MultiJson.decode(body)
+      if body.nil?
+        nil
+      elsif body.any?
+        body.collect{|error| "#{error['id']} #{error['desc']}"}
+      end
+    end
+  end
+end

data/lib/faraday/raise_http_5xx.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseHttp5xx < Response::Middleware
+    def on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 500
+          raise JustGiving::InternalServerError, error_message(response)
+        end
+      end
+    end
+    
+    private
+
+    def error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} #{error_body(response[:body])}"
+    end
+    
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        body['error']['id']
+      end
+    end
+  end
+end

data/lib/just_giving.rb

@@ -1,3 +1,12 @@
-require 'just_giving/config'
+require 'just_giving/error'
+require 'just_giving/response'
+require 'just_giving/configuration'
 require 'just_giving/simple_donation_integration'
-require 'just_giving/railtie' if defined?(Rails)
+require 'just_giving/api'
+require 'just_giving/account'
+require 'just_giving/charity'
+require 'just_giving/event'
+require 'just_giving/fundraising'
+require 'just_giving/search'
+require 'just_giving/donation'
+require 'just_giving/railtie' if defined?(Rails)

data/lib/just_giving/account.rb

@@ -0,0 +1,43 @@
+module JustGiving
+  class Account < API
+    def initialize(email=nil)
+      @email = email
+    end
+
+    # This lists all the fundraising pages for the supplied email
+    def pages
+      get("v1/account/#{@email}/pages")
+    end
+
+    # This creates an user account with Just Giving
+    def create(params)
+      put('v1/account', params)
+    end
+
+    # This validates a username/password
+    def validate(params)
+      post('v1/account/validate', params)
+    end
+
+    # Confirm if an email is available or not
+    def available?
+      begin
+        head("v1/account/#{@email}")
+        return false
+      rescue JustGiving::NotFound
+        return true
+      end
+    end
+
+    # Update password
+    def change_password(params)
+      post('v1/account/changePassword', params)
+    end
+
+    # Send password reminder
+    def password_reminder
+      response = get("v1/account/#{@email}/requestpasswordreminder")
+      (response && response.errors) ? response : true
+    end
+  end
+end

data/lib/just_giving/api.rb

@@ -0,0 +1,9 @@
+require 'just_giving/connection'
+require 'just_giving/request'
+
+module JustGiving
+  class API
+    include Connection
+    include Request
+  end
+end

data/lib/just_giving/charity.rb

@@ -0,0 +1,13 @@
+module JustGiving
+  class Charity < API
+    # Get charity by id
+    def get_charity(id)
+      get("v1/charity/#{id}")
+    end
+
+    # Validate charity username/password
+    def validate(params)
+      post('v1/charity/authenticate', params)
+    end
+  end
+end

data/lib/just_giving/configuration.rb

@@ -0,0 +1,59 @@
+module JustGiving
+  class Configuration
+    BASE_URI = "http://www.justgiving.com"
+
+    @@application_id = nil
+    @@environment = :staging
+    @@ca_path =  "/usr/lib/ssl/certs"
+
+    ## This is your Just Giving application id
+    def self.application_id
+      @@application_id
+    end
+
+    def self.application_id=(id)
+      @@application_id = id
+    end
+
+    ## This can be either :staging or :production and sets what endpoint to use
+    def self.environment=(env)
+      @@environment = env
+    end
+
+    def self.environment
+      @@environment
+    end
+
+    ## The API endpoint
+    def self.api_endpoint
+      raise JustGiving::InvalidApplicationId.new if !application_id
+      environment == :staging ? "https://api.staging.justgiving.com/#{application_id}" : "https://api.justgiving.com/#{application_id}"
+    end
+
+    ## Path to the systems CA cert bundles
+    def self.ca_path=(path)
+      @@ca_path = path
+    end
+    
+    def self.ca_path
+      @@ca_path
+    end
+
+    ## Username/password for basic auth
+    def self.username
+      @@username
+    end
+
+    def self.username=(username)
+      @@username = username
+    end
+
+    def self.password=(password)
+      @@password = password
+    end
+
+    def self.password
+      @@password
+    end
+  end
+end

data/lib/just_giving/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+require 'faraday/raise_http_4xx'
+require 'faraday/raise_http_5xx'
+
+module JustGiving
+  module Connection
+    private
+    
+    def connection(basic_auth=false)
+      options = {
+        :headers => {'Accept' => "application/json"},
+        :url => JustGiving::Configuration.api_endpoint,
+        :ssl => {:ca_path => JustGiving::Configuration.ca_path, :verify => false}
+      }
+
+      connection = Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::JSON
+        connection.use Faraday::Adapter::NetHttp
+        connection.use Faraday::Response::ParseJson
+        connection.use Faraday::Response::RaiseHttp4xx
+        connection.use Faraday::Response::RaiseHttp5xx
+        connection.use Faraday::Response::Mashify
+      end
+      connection.basic_auth(JustGiving::Configuration.username, JustGiving::Configuration.password) if basic_auth
+      connection
+    end
+  end
+end

data/lib/just_giving/donation.rb

@@ -0,0 +1,17 @@
+module JustGiving
+  class Donation < API
+    def initialize(id)
+      @id = id
+    end
+    
+    # Get the details of a specific donation
+    def details
+      get("v1/donation/#{@id}")
+    end
+
+    # Get the status of a specific donation
+    def status
+      get("v1/donation/#{@id}/status")
+    end
+  end
+end