justgiving 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1e658fde7ceee06bfcd7837ef2022e6210282eb
-  data.tar.gz: 2761b08ee6c72220dae4c3f7f8fdd27d560f965c
+  metadata.gz: d29db277bc2f519dbed192ccea0c26abd46153d7
+  data.tar.gz: 9ad5a323bf3738a7bbe173b17fd25c6ed045cda5
 SHA512:
-  metadata.gz: f798d5e1262583236541a973db3c45d5f445ca506b1a62919a440ca9bd8bed707cc650f5654ebc5276e07225d7446b09942e9b2567ccbc7a97e78efff1b827d4
-  data.tar.gz: 3caa69636a91847acf09d701511b697661f62f8f4d27f7a925e7d19a87bc231f0a1748a1bd7487663a34b498e6ac576e2f67f91db9ec2c7a658bb9483c727302
+  metadata.gz: 56873c41ba229f00db3a0c9ca05d4d3f4e9544d1228a0de07bd150c80f45a6556566f42ff672bd7d0d0410186a239693d344ce063829fbda361359e5bc1f4279
+  data.tar.gz: 936c90d79879b719c5c35d1102cbc499b8dd31707470bbbcaf52ec4ff01218ad029931f58fd1b119af7bab4ba07334f2c4d228f50ad7fd11935502bbf8f6e565

data/lib/justgiving/account.rb

@@ -0,0 +1,23 @@
+require_relative "client"
+
+module JustGiving
+  class Account < Client
+
+    # Todo:
+    # RetrieveAccount
+    # AccountRegistration
+    # Validate
+    # GetFundraisingPagesForUser
+    # GetDonationsForUser
+    # AccountAvailabilityCheck
+    # ChangePassword
+    # RequestPasswordReminder
+    # GetUserContentRatingHistory
+    # RateContent
+    # GetContentFeed
+    # InterestsGet
+    # InterestsAdd
+    # InterestsReplace
+
+  end
+end

data/lib/justgiving/charity.rb

@@ -7,6 +7,10 @@ module JustGiving
       get("charity/#{id}")
     end
 
+    # def authenticate_charity_account(account_details = {})
+    #   post("charity/authenticate", account_details)
+    # end
+
     def get_events_by_charity_id(id)
       get("charity/#{id}/events")
     end
@@ -15,6 +19,12 @@ module JustGiving
       get("charity/#{id}/donations")
     end
 
+    # Todo
+    # CharityDeleteFundraisingPageAttribution
+    # CharityUpdateFundraisingPageAttribution
+    # CharityAppendToFundraisingPageAttribution
+    # CharityGetFundraisingPageAttribution
+
     def get_charity_categories
       get("charity/categories")
     end

data/lib/justgiving/client.rb

@@ -1,13 +1,25 @@
 require "faraday"
 require "faraday_middleware"
 require_relative "error"
+require_relative "logger"
 
 module JustGiving
   class Client
 
-    def initialize(token)
+    def initialize(token, environment=nil)
+      if environment.nil? || environment == :production
+        environment = :production
+        @base_url = "https://api.justgiving.com/#{@token}/v1/"
+      elsif environment == :staging
+        @base_url = "https://api-staging.justgiving.com/#{@token}/v1/"
+      elsif environment == :sandbox
+        @base_url = "https://api-sandbox.justgiving.com/#{@token}/v1/"
+      else
+        raise Error::InvalidEnvironment
+      end
+
       @token = token
-      @base_url = "https://api.justgiving.com/#{@token}/v1/"
+      @environment = environment
       @connection_defaults = {
         url: @base_url,
         headers: {
@@ -15,11 +27,15 @@ module JustGiving
           'Content-Type' => 'application/json'
         }
       }
+
       @connection = Faraday.new(@connection_defaults) do |connection|
+        connection.request  :json
+
         connection.response :json, :content_type => /\bjson$/
-        connection.response :logger
-        connection.adapter   Faraday.default_adapter
-        connection.use       Error::RaiseError
+
+        connection.use      Error::RaiseError
+        connection.use      Logger
+        connection.adapter  Faraday.default_adapter
       end
     end
 
@@ -28,10 +44,33 @@ module JustGiving
       def get(path, query=nil)
         response = @connection.get do |request|
           request.url path
-          request.params.merge! query if query
+          request.params.merge! query unless query.nil?
+        end
+        response.body
+      end
+
+      def post(path, payload=nil)
+        response = @connection.post do |request|
+          request.url path
+          request.body = payload unless payload.nil?
         end
         response.body
       end
 
+      def put(path, payload=nil)
+        response = @connection.put do |request|
+          request.url path
+          request.body = payload unless payload.nil?
+        end
+        response.body
+      end
+
+      def head(path)
+        response = @connection.head do |request|
+          request.url path
+        end
+        true # We expect Error::NoResults to be thrown if the query is unsuccessful
+      end
+
   end
 end

data/lib/justgiving/error.rb

@@ -1,9 +1,13 @@
 module JustGiving
   module Error
 
-    class BadRequest < StandardError; end
-    class NoResults < StandardError; end
-    class InternalServerError < StandardError; end
+    class ConfigurationError < StandardError; end
+    class InvalidEnvironment < ConfigurationError; end
+
+    class RequestError < StandardError; end
+    class BadRequest < RequestError; end
+    class NoResults < RequestError; end
+    class InternalServerError < RequestError; end
 
     class RaiseError < Faraday::Response::Middleware
    

data/lib/justgiving/event.rb

@@ -0,0 +1,19 @@
+require_relative "client"
+
+module JustGiving
+  class Event < Client
+
+    def get_by_event_id(id)
+      get("event/#{id}")
+    end
+
+    def get_pages_by_event_id(id, filters = {})
+      get("event/#{id}/pages")
+    end
+
+    # def register_event(payload = {})
+    #   post("event", payload)
+    # end
+
+  end
+end

data/lib/justgiving/fundraising.rb

@@ -0,0 +1,34 @@
+require_relative "client"
+
+module JustGiving
+  class Fundraising < Client
+
+    def check_if_page_exists_by_name(name)
+      head("fundraising/pages/#{name}")
+    end
+
+    def suggest_page_short_names(preferred)
+      get("fundraising/pages/suggest", {'preferredName' => preferred})
+    end
+
+    # Todo:
+    # RegisterFundraisingPage
+    # GetFundraisingPageDetails
+    # GetFundraisingPages
+    # GetFundraisingPageDonations
+    # UpdateFundraisingPage
+    # PageUpdates
+    # PageUpdateById
+    # PageUpdatesAddPost
+    # DeleteFundraisingPageAttribution
+    # UpdateFundraisingPageAttribution
+    # AppendToFundraisingPageAttribution
+    # GetFundraisingPageAttribution
+    # UploadImage
+    # AddImageToFundraisingPage
+    # GetImagesForFundraisingPage
+    # AddVideoToFundraisingPage
+    # GetVideosForFundraisingPage
+
+  end
+end

data/lib/justgiving/logger.rb

@@ -0,0 +1,16 @@
+require "faraday"
+
+module JustGiving
+  class Logger < Faraday::Middleware
+
+    def call(env)
+      puts "Request: #{env[:method].to_s.upcase} #{env[:url]}"
+      puts "Request body: #{env[:body]}" unless env[:body].nil?
+
+      @app.call(env).on_complete do
+        puts "Response: #{env[:status]} #{env[:body]}" unless env[:status] == 200
+      end
+    end
+
+  end
+end

data/lib/justgiving/project.rb

@@ -0,0 +1,11 @@
+require_relative "client"
+
+module JustGiving
+  class Project < Client
+
+    def get_global_project_by_id(id)
+      get("project/global/#{id}")
+    end
+
+  end
+end

data/lib/justgiving/search.rb

@@ -7,6 +7,10 @@ module JustGiving
       get("charity/search", filters)
     end
 
+    def search_commemorations(filters = {})
+      get("remember/search", filters)
+    end
+
     def search_events(filters = {})
       get("event/search", filters)
     end
@@ -15,8 +19,8 @@ module JustGiving
       get("fundraising/search", filters)
     end
 
-    def search_commemorations(filters = {})
-      get("remember/search", filters)
+    def search_projects(filters = {})
+      get("project", filters)
     end
 
     def search_teams(filters = {})

data/lib/justgiving/team.rb

@@ -0,0 +1,19 @@
+require_relative "client"
+
+module JustGiving
+  class Team < Client
+
+    def get_team_by_name(name)
+      get("team/#{name}")
+    end
+
+    def check_if_team_exists_by_name(name)
+      head("team/#{name}")
+    end
+
+    # Todo:
+    # CreateOrUpdateTeam
+    # JoinTeam
+
+  end
+end

data/lib/justgiving/version.rb

@@ -1,3 +1,3 @@
 module JustGiving
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/justgiving.rb

@@ -1,11 +1,16 @@
 module JustGiving
 
   # Clients
+  require_relative "justgiving/account"
   require_relative "justgiving/charity"
   require_relative "justgiving/country"
   require_relative "justgiving/currency"
   require_relative "justgiving/donation"
+  require_relative "justgiving/event"
+  require_relative "justgiving/fundraising"
+  require_relative "justgiving/project"
   require_relative "justgiving/search"
+  require_relative "justgiving/team"
 
   require_relative "justgiving/error"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justgiving
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jack Dent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,13 +80,19 @@ files:
 - Rakefile
 - justgiving.gemspec
 - lib/justgiving.rb
+- lib/justgiving/account.rb
 - lib/justgiving/charity.rb
 - lib/justgiving/client.rb
 - lib/justgiving/country.rb
 - lib/justgiving/currency.rb
 - lib/justgiving/donation.rb
 - lib/justgiving/error.rb
+- lib/justgiving/event.rb
+- lib/justgiving/fundraising.rb
+- lib/justgiving/logger.rb
+- lib/justgiving/project.rb
 - lib/justgiving/search.rb
+- lib/justgiving/team.rb
 - lib/justgiving/version.rb
 homepage: http://www.github.com/jackdent/justgiving
 licenses: