donors_choose 0.0.4 → 0.9.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+script: "rspec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - ree

data/README.md

@@ -1,6 +1,8 @@
 # DonorsChoose
 
-TODO: Write a gem description
+DonorsChoose.org is an online charity that makes it easy for anyone to help students in need.
+
+This is a gem that wraps [their API](http://developer.donorschoose.org/home).
 
 ## Installation
 
@@ -18,7 +20,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The first thing you should do is [request an API
+key](http://developer.donorschoose.org/help-contact). They provide a test key,
+"DONORSCHOOSE", that will occasionally be turned off. So be nice and get your
+own. :)
+
+We're currently developing support for the full API, but right now, there are
+just two methods.
+
+    DonorsChoose.api_key = "DONORSCHOOSE"
+
+    projects = DonorsChoose.projects_near_me("40.4405556", "-79.9961111")
+    projects = DonorsChoose.projects_by_zip("15232")
+
+Projects will be an array of objects that contain all of the data returned by
+the request. You can learn about these objects through introspection:
+
+    > (projects.first.methods - Object.new.methods)
+    => [:id, ...
+ 
+For example. These objects are dynamically created based on the response, so
+minor API updates may change the attributes.
 
 ## Contributing
 

data/cassettes/DonorsChoose_Request.yml

@@ -0,0 +1,36 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.donorschoose.org:80/common/json_feed.html?APIKey=DONORSCHOOSE&community=1007:3&state=NC
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      content-type:
+      - text/plain;charset=UTF-8
+      content-language:
+      - en-US
+      cache-control:
+      - private, max-age=600
+      expires:
+      - Tue, 14 Feb 2012 20:01:14 GMT
+      date:
+      - Tue, 14 Feb 2012 19:51:14 GMT
+      content-length:
+      - '796'
+      connection:
+      - keep-alive
+      x-n:
+      - S
+    body: ! "\r\n \r\n\r\n\r\n\r\n\r\n\r\n\r\n \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\t\r\n\r\n\t
+      \ \t\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n{\"searchTerms\":\"+cityid:1007 AND +statecode:NC
+      AND +historical:fall +_val_:"add(product(10.0,staticNewbie),add(product(100.0,recal(add(ms(NOW,explorationth),3.16911),3.16e-11,1,1)),add(product(10000.0,add(product(1.25,sun(5.0,
+      static)),product(0.75,stationor))),add(product(100000.0,stationeri),add(product(1000000.0,sun(10.0,staticNeedBinary)),0)))))"
+      > Many Farms, Arizona\",\"searchURL\":\"http://www.donorschoose.org/donors/search.html?community=1007%3a3&state=NC&utm_source=api&utm_medium=feed&utm_content=searchlink&utm_campaign=DONORSCHOOSE\",\"totalProposals\":\"0\",\"index\":\"0\",\"max\":\"10\",\"proposals\":[]}\r\n"
+    http_version: '1.1'

data/donors_choose.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "json"
 
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
 end

data/lib/donors_choose.rb

@@ -1,16 +1,19 @@
 require 'donors_choose/version'
 require 'donors_choose/request'
-require 'json'
-require 'ostruct'
 
 module DonorsChoose
   extend self
-  attr_accessor :api_key
+
+  attr_writer :api_key
+  def api_key
+    @api_key || "DONORSCHOOSE"
+  end
 
   def projects_near_me(latitude, longitude)
-    request = Request.new(:centerLat => latitude, :centerLong => longitude)
-    data = JSON.parse(request.fetch)["proposals"]
+    Request.get(:centerLat => latitude, :centerLong => longitude)
+  end
 
-    data.collect {|datum| OpenStruct.new(datum)}
+  def projects_by_zip(zipcode)
+    Request.get(:keyword => zipcode)
   end
 end

data/lib/donors_choose/request.rb

@@ -1,12 +1,23 @@
 require 'cgi'
 require 'uri'
 require 'net/http'
+require 'json'
+require 'ostruct'
 
 class DonorsChoose::Request
+   def self.get(params)
+    new(params).get
+  end
+
   def initialize(params)
     @params = params
   end
 
+  def get
+    data = JSON.parse(fetch)["proposals"]
+    data.collect {|datum| OpenStruct.new(datum)}
+  end
+
   def fetch
     base_uri = 'http://api.donorschoose.org/common/json_feed.html'
     uri_params = @params.collect do |key, value|

data/lib/donors_choose/version.rb

@@ -1,3 +1,3 @@
 module DonorsChoose
-  VERSION = "0.0.4"
+  VERSION = "0.9.0"
 end

data/spec/donors_choose_spec.rb

@@ -8,13 +8,27 @@ describe DonorsChoose do
     DonorsChoose.api_key.should eql(key)
   end
 
-  it "is able to find projects near me" do
-    request = double
-    request.should_receive(:fetch).and_return('{"proposals":  [{"title": "A test project"}]}')
+  context "requesting data" do
+    let(:test_title) { "A test project" }
 
-    DonorsChoose::Request.should_receive(:new).and_return(request)
+    it "is able to find projects near me" do
+      projects = [double]
+      DonorsChoose::Request.should_receive(:get).
+        with(:centerLat => "40.4405556", :centerLong => "-79.9961111").
+        and_return(projects)
 
-    projects = DonorsChoose.projects_near_me("40.4405556", "-79.9961111")
-    projects.first.title.should eql("A test project")
+      results = DonorsChoose.projects_near_me("40.4405556", "-79.9961111")
+      results.should eq(projects)
+    end
+
+    it "is able to find projects by zip code" do
+      projects = [double]
+      DonorsChoose::Request.should_receive(:get).
+        with(:keyword => "15232").
+        and_return(projects)
+
+      results = DonorsChoose.projects_by_zip("15232")
+      results.should eq(projects)
+    end
   end
 end

data/spec/request_spec.rb

@@ -1,7 +1,20 @@
 $:.unshift("lib")
 require 'donors_choose/request'
 
+require 'vcr'
+require 'webmock'
+VCR.config do |c|
+  c.stub_with :webmock
+  c.cassette_library_dir = 'cassettes'
+end
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+end
+
 describe DonorsChoose::Request do
+  use_vcr_cassette
+
   it "is able to request data from the API" do
     DonorsChoose.api_key = "DONORSCHOOSE"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: donors_choose
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70347294684420 !ruby/object:Gem::Requirement
+  requirement: &70326897943640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70347294684420
+  version_requirements: *70326897943640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70347294683700 !ruby/object:Gem::Requirement
+  requirement: &70326897943120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70347294683700
+  version_requirements: *70326897943120
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70326897942580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70326897942580
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70326897941960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70326897941960
 description: A gem to wrap the DonorsChoose.org API.
 email:
 - steve@steveklabnik.com
@@ -42,10 +64,12 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- cassettes/DonorsChoose_Request.yml
 - donors_choose.gemspec
 - lib/donors_choose.rb
 - lib/donors_choose/request.rb