justgiving 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 330ff0c02a601ad892f6f09d5bc2c210d3fff526
+  data.tar.gz: 90d0cfee0ffba46683b449c4585afa1d86d38f96
+SHA512:
+  metadata.gz: f641934cea354d787e5803bb3d78b3dec139e03b736d2691ee4114c361943f2fedde24d7e10e2fa0cce9b8b4f8d4f0335fdd7fd1a474011d544ca719b67a094b
+  data.tar.gz: c63d6a4032ec7885b6de07689556f2b1e529294fb45a56f49ccca7741fcb2b7b6344dc41e66458c3db5e3b4e7f966de3b315ddb3a1213c888bf17f88b9d0933e

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in justgiving.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jack Dent
+
+MIT License
+
+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,43 @@
+# JustGiving
+
+A Ruby REST client for the JustGiving API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'justgiving'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install justgiving
+
+## Usage
+
+Require the justgiving gem
+
+    require 'justgiving'
+
+Create a new API client instance, passing your api key to the new method. For example,
+
+    client = JustGiving::Search.new({YOUR_API_KEY})
+
+Available clients are: Charity, Country, Currency, Donation, Search. You can then call methods on your client, for example
+
+    client.searchCharities({q: 'Macmillan'})
+
+To view the available methods for each client, browse the /lib/justgiving directory.
+
+Create a new client
+
+## Contributing
+
+1. Fork it ( https://github.com/jackdent/justgiving/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/justgiving.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'justgiving/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "justgiving"
+  spec.version       = JustGiving::VERSION
+  spec.authors       = ["Jack Dent"]
+  spec.email         = ["jack@jackdent.co.uk"]
+  spec.summary       = %q{A Ruby REST client for the JustGiving API}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://www.github.com/jackdent/justgiving"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "curb"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "addressable"
+end

data/lib/justgiving/charity.rb

@@ -0,0 +1,23 @@
+require_relative "client"
+
+module JustGiving
+  class Charity < Client
+
+    def getByCharityId(id)
+      get("charity/#{id}")
+    end
+
+    def getEventsByCharityId(id)
+      get("charity/#{id}/events")
+    end
+
+    def getDonationsByCharityId(id)
+      get("charity/#{id}/donations")
+    end
+
+    def getCharityCategories
+      get("charity/categories")
+    end
+
+  end
+end

data/lib/justgiving/client.rb

@@ -0,0 +1,32 @@
+require 'json'
+require 'curb'
+require "addressable/uri"
+
+module JustGiving
+  class Client
+
+    def initialize(token)
+      @token = token
+      @base_url = "https://api.justgiving.com/#{@token}/v1"
+    end
+
+    protected
+
+      def get(path, query_hash=nil)
+        url = "#{@base_url}/#{path}"
+        url += '?' + query_string_from_hash(query_hash) if query_hash
+        request = Curl.get(url) do |curl| 
+          curl.headers["User-Agent"] = "Ruby REST client"
+          curl.headers["Content-Type"] = "application/json"
+        end
+        JSON.parse request.body_str
+      end
+
+      def query_string_from_hash(query_hash)
+        uri = Addressable::URI.new
+        uri.query_values = query_hash
+        uri.query
+      end
+
+  end
+end

data/lib/justgiving/country.rb

@@ -0,0 +1,11 @@
+require_relative "client"
+
+module JustGiving
+  class Country < Client
+
+    def getCountries
+      get("countries")
+    end
+
+  end
+end

data/lib/justgiving/currency.rb

@@ -0,0 +1,11 @@
+require_relative "client"
+
+module JustGiving
+  class Currency < Client
+
+    def getValidCountryCodes
+      get("fundraising/currencies")
+    end
+
+  end
+end

data/lib/justgiving/donation.rb

@@ -0,0 +1,15 @@
+require_relative "client"
+
+module JustGiving
+  class Donation < Client
+
+    def getDetailsByDonationId(id)
+      get("donation/#{id}")
+    end
+
+    def getStatusByDonationId(id)
+      get("donation/#{id}/status")
+    end
+
+  end
+end

data/lib/justgiving/search.rb

@@ -0,0 +1,27 @@
+require_relative "client"
+
+module JustGiving
+  class Search < Client
+
+    def searchCharities(filters = {})
+      get("charity/search", filters)
+    end
+
+    def searchEvents(filters = {})
+      get("event/search", filters)
+    end
+
+    def searchFundraisers(filters = {})
+      get("fundraising/search", filters)
+    end
+
+    def searchCommemorations(filters = {})
+      get("remember/search", filters)
+    end
+
+    def searchTeams(filters = {})
+      get("team/search", filters)
+    end
+
+  end
+end

data/lib/justgiving/version.rb

@@ -0,0 +1,3 @@
+module JustGiving
+  VERSION = "0.0.1"
+end

data/lib/justgiving.rb

@@ -0,0 +1,9 @@
+module JustGiving
+
+  require_relative "justgiving/charity"
+  require_relative "justgiving/country"
+  require_relative "justgiving/currency"
+  require_relative "justgiving/donation"
+  require_relative "justgiving/search"
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: justgiving
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Dent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jack@jackdent.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- justgiving.gemspec
+- lib/justgiving.rb
+- lib/justgiving/charity.rb
+- lib/justgiving/client.rb
+- lib/justgiving/country.rb
+- lib/justgiving/currency.rb
+- lib/justgiving/donation.rb
+- lib/justgiving/search.rb
+- lib/justgiving/version.rb
+homepage: http://www.github.com/jackdent/justgiving
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby REST client for the JustGiving API
+test_files: []