first_giving_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 990edb07fa3e1a0c737b8c9c91b5b6c6c2f8603d
+  data.tar.gz: 4a4fb6675033cc7a09da14dd4fa44af4a61e60b1
+SHA512:
+  metadata.gz: 98073b3bf89a669f3bf5d65d6661ca20fe3f8c76d52a6426efa5a109c54b20157ea07f47b648e0217e4a20fc2860be9156ec0c4114747ea844e0a7e996e66142
+  data.tar.gz: 8bd0b93f413cbe5efb4957942497c4781e87d6971430374a59c46365cfcb2e6a9c05ec171f0d0c3fba678b9cf3aec4455c3bb1c76fdf5486cf596f66495311af

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+-f documentation
+-c

data/.ruby-gemset

@@ -0,0 +1 @@
+firstgiving

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Omar Shariff Delmo
+
+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,37 @@
+# FirstGivingApi
+
+This is a Wrapper for the API of developers.firstgiving.com
+
+I am a newbie so I would greatly appreciate any feedback or help regarding this project
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'first_giving_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install first_giving_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## TODO
+
+Add class for donations
+
+Refactor Charity search methods
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/first_giving_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'first_giving_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "first_giving_api"
+  spec.version       = FirstGivingApi::VERSION
+  spec.authors       = ["Omar Shariff Delmo"]
+  spec.email         = ["omaruu@gmail.com"]
+  spec.description   = %q{A Ruby Wrapper for the First Giving API}
+  spec.summary       = %q{First Giving API Wrapper}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  
+  #include RSPEC
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'curb'
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'pry'
+  spec.add_runtime_dependency 'crack'
+end

data/lib/first_giving_api.rb

@@ -0,0 +1,20 @@
+require "first_giving_api/version"
+require "first_giving_api/charity"
+require "first_giving_api/configuration"
+
+module FirstGivingApi
+  extend Configuration
+
+  #default lookup method
+  def self.lookup(charity_name)
+    Charity.new.query_contains(charity_name)
+  end
+  #lookup returns set that starts with search term
+  def self.lookup_starting_with(charity_name)
+    Charity.new.query_starts_with(charity_name)
+  end
+  #lookup using UUID
+  def self.lookup_id(charity_uuid)
+    Charity.new.query_uuid(charity_uuid)
+  end
+end

data/lib/first_giving_api/charity.rb

@@ -0,0 +1,86 @@
+require 'curb'
+require 'nokogiri'
+require 'crack'
+
+module FirstGivingApi
+  class Charity
+    BASE_URL = 'http://graphapi.firstgiving.com/v1/list/organization?'
+    UUID_QUERY_URL = 'http://graphapi.firstgiving.com/v1/object/organization/'
+    
+    def initialize
+    end
+
+    def query_starts_with(charity_name)
+      http = Curl.get(BASE_URL+"q=organization_name:#{charity_name}*")
+      response = Crack::XML.parse(http.body_str)
+      result = response["payload"]["payload"].to_a
+      result.each do |subset|
+        subset.shift
+      end
+      result
+    end
+    def query_contains(charity_name)
+      http = Curl.get(BASE_URL+"q=organization_name:#{charity_name}")
+      response = Crack::XML.parse(http.body_str)
+      result = response["payload"]["payload"].to_a
+      result.each do |subset|
+        subset.shift
+      end
+      result
+    end
+    def query_uuid(charity_uuid)
+      http = Curl.get(UUID_QUERY_URL+charity_uuid)
+      response = Crack::XML.parse(http.body_str)
+      result = response["payload"]["payload"]
+    end
+  end
+
+  class ApiResponse
+    # attr_reader :organization_uuid,
+    #             :organization_type_id,
+    #             :government_id,
+    #             :parent_organization_uuid,
+    #             :address_line_1,
+    #             :address_line_2,
+    #             :address_line_3,
+    #             :address_line_full,
+    #             :city,
+    #             :region,
+    #             :postal_code,
+    #             :county,
+    #             :country,
+    #             :address_full,
+    #             :phone_number,
+    #             :area_code,
+    #             :url,
+    #             :category_code,
+    #             :latitude,
+    #             :longitude,
+    #             :revoked
+
+    def initialize(result)
+      # xml = Crack::XML.parse(result) 
+      # @organization_uuid = xml.at('OrganizationUuid').text
+      # @organization_type_id = xml.at('OgranizationTypeId').text
+      # @government_id = xml.at('GovernmentId').text
+      # @parent_organization_uuid = xml.at('ParentOrganizationUuid').text
+      # @address_line_1 = xml.at('AddressLine1').text
+      # @address_line_2 = xml.at('AddressLine2').text
+      # @address_line_3 = xml.at('AddressLine3').text
+      # @address_line_full = xml.at('AddressLineFull').text
+      # @city = xml.at('City').text
+      # @region = xml.at('Region').text
+      # @postal_code = xml.at('PostalCode').text
+      # @county = xml.at('County').text
+      # @country = xml.at('Country').text
+      # @address_full = xml.at('AddressFull').text
+      # @phone_number = xml.at('PhoneNumber').text
+      # @area_code = xml.at('AreaCode').text
+      # @url = xml.at('Url').text
+      # @category_code = xml.at('CategoryCode').text
+      # @latitude = xml.at('Latitude').text
+      # @longitude = xml.at('Longitude').text
+      # @revoked = xml.at('Revoked')
+    end
+  end
+end

data/lib/first_giving_api/configuration.rb

@@ -0,0 +1,29 @@
+module FirstGivingApi
+  module Configuration
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS    = [:api_key, :format].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ENDPOINT    = nil 
+    DEFAULT_METHOD      = :get
+    DEFAULT_USER_AGENT  = "First Giving API Ruby Gem #{FirstGivingApi::VERSION}".freeze
+ 
+    DEFAULT_API_KEY      = nil
+    DEFAULT_FORMAT       = :json
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+ 
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+ 
+      self.api_key    = DEFAULT_API_KEY
+      self.format     = DEFAULT_FORMAT
+    end
+  end
+end

data/lib/first_giving_api/version.rb

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

data/spec/lib/first_giving_api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'pry'
+
+describe FirstGivingApi do
+  context "configuration" do
+    describe ".app_key" do
+      it "should return default key" do
+        FirstGivingApi.api_key.should eql(FirstGivingApi::Configuration::DEFAULT_API_KEY)
+      end
+    end
+    describe ".format" do
+      it "should return default format" do
+        FirstGivingApi.format.should eql(FirstGivingApi::Configuration::DEFAULT_FORMAT)
+      end
+    end
+    describe ".user_agent" do
+      it "should return default user agent" do
+        FirstGivingApi.user_agent.should eql(FirstGivingApi::Configuration::DEFAULT_USER_AGENT)
+      end
+    end
+    describe ".method" do
+      it "should return default http method" do
+        FirstGivingApi.method.should eql(FirstGivingApi::Configuration::DEFAULT_METHOD)
+      end
+    end
+  end
+  context "charity" do
+    describe "query_contains" do
+      it "should return data for charities containing marijuana" do
+        org_data = FirstGivingApi.lookup("MARIJUANA")
+        org_data.should_not be_nil
+        org_data.each do |org|
+          org[0]["organization_name"].should include("MARIJUANA")
+        end
+      end
+    end
+    describe "query_starts_with" do
+      it "should return data for charities starting with marijuana" do
+        org_data = FirstGivingApi.lookup_starting_with("MARIJUANA")
+        org_data.should_not be_nil
+        org_data.each do |org|
+          org[0]["organization_name"].should start_with("MARIJUANA")
+        end
+      end
+    end
+    describe "query_with_id" do
+      it "should return data for the charity with UUID 0f0e0f80-2024-11e0-a279-4061860da51d" do
+        org_data = FirstGivingApi.lookup_id("0f0e0f80-2024-11e0-a279-4061860da51d")
+        org_data.should_not be_nil
+        org_data["organization_uuid"].should eql("0f0e0f80-2024-11e0-a279-4061860da51d")
+        org_data.keys.should eql(["organization_uuid", "organization_type_id", "organization_name", "government_id", "parent_organization_uuid", "address_line_1", "address_line_2", "address_line_3", "address_line_full", "city", "region", "postal_code", "county", "country", "address_full", "phone_number", "area_code", "url", "category_code", "latitude", "longitude", "revoked"])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'first_giving_api'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: first_giving_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Omar Shariff Delmo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby Wrapper for the First Giving API
+email:
+- omaruu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- first_giving_api.gemspec
+- lib/first_giving_api.rb
+- lib/first_giving_api/charity.rb
+- lib/first_giving_api/configuration.rb
+- lib/first_giving_api/version.rb
+- spec/lib/first_giving_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: First Giving API Wrapper
+test_files:
+- spec/lib/first_giving_api_spec.rb
+- spec/spec_helper.rb