markmcspadden-ruby-kiva 0.1.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/kiva.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'net/https'
+require 'uri'
+require 'json'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'kiva/loan'))

data/lib/kiva/loan.rb

@@ -0,0 +1,55 @@
+module Kiva
+  class Loan
+    
+    def initialize(*args)
+      attrs = {}
+      
+      # Get to the Hash
+      attrs = args.first if args.first.is_a?(Hash)
+      
+      # Cycle through each pair
+      # Creating reader if necessary
+      # Setting value passed on args
+      attrs.each_pair do |k,v|
+        unless self.respond_to?(k.to_sym)
+          self.class.class_eval do
+            attr_reader k
+          end
+        end
+        instance_variable_set("@#{k.to_s}", v)
+      end
+    end
+    
+    class << self
+      # Search the Loans on Kiva
+      # === Accepted Parameters
+      # * :q - a string to query based on
+      # * :status - the payment status: 'fundraising', 'funded', 'in_repayment', 'paid', 'defaulted'
+      # * all the others should work but haven't been verified
+      # === Returns
+      # Hash
+      # * paging - Hash with keys: total, page_size, pages, page
+      # * loans - Array of Hashes with keys cooresponding to Kiva
+      def search(params = {})
+        params_string_array = []
+        params.each_pair { |k,v| params_string_array << "#{k}=#{v}" }
+        params_string = params_string_array.join("&")
+        
+        uri = URI.parse("http://api.kivaws.org/v1/loans/search.json?#{params_string}")
+        
+        response = Net::HTTP.get_response(uri)
+        results = JSON.parse(response.body)
+      end
+      
+      # Produce Kiva::Loan objects from the search 
+      def search_results(params = {})
+        loans = []
+        search(params)["loans"].each do |loan|
+          loans << Kiva::Loan.new(loan)
+        end
+        loans
+      end
+    end
+    
+  end
+end

data/spec/kiva/loan_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module LoanSpecHelper
+  def search_results_raw
+    {"paging"=>{"total"=>32566, "page_size"=>20, "pages"=>1629, "page"=>1}, 
+    "loans"=>[{"borrower_count"=>1, 
+                "status"=>"paid", 
+                "name"=>"Waliholla Ali", 
+                "posted_date"=>"2008-12-30T17:30:20Z", 
+                "activity"=>"Farming", 
+                "paid_amount"=>1050, 
+                "id"=>81893, 
+                "description"=>{"languages"=>["en"]}, 
+                "partner_id"=>34, 
+                "use"=>"To increase his agricultural business.", 
+                "loan_amount"=>1050, 
+                "funded_amount"=>1050, 
+                "image"=>{"template_id"=>1, "id"=>248766}, 
+                "location"=>{"country"=>"Afghanistan", "geo"=>{"type"=>"point", "level"=>"town", "pairs"=>"34.42 70.45"}, 
+                "town"=>"Jalalabad"}, 
+                "sector"=>"Agriculture"}]}
+  end
+end
+
+describe Kiva::Loan do
+  include LoanSpecHelper
+
+  describe "attributes" do
+    before(:each) do
+      @loan = Kiva::Loan.new(:status => "paid", :loan_amount => 1050)
+    end
+    
+    it "should get the status attribute set during initialization" do
+      @loan.status.should == "paid"
+    end
+    
+    it "should get the loan ammount" do
+      @loan.loan_amount.should == 1050
+    end
+    
+    it "should NOT set the loan ammount after initialization (Kiva data is currently read only)" do
+      lambda{@loan.loan_amount = 1150}.should raise_error(NoMethodError)
+    end
+  end # attributes
+  
+  describe "search" do    
+    before(:each) do
+      @response = mock("response", :body => "{}")
+    end
+    
+    it "should make the search request" do
+      Net::HTTP.should_receive(:get_response).with(URI.parse("http://api.kivaws.org/v1/loans/search.json?q=farm")).and_return(@response)
+      Kiva::Loan.search(:q => "farm")      
+    end
+    
+    it "should parse the JSON response" do
+      Net::HTTP.stub!(:get_response).and_return(@response)
+      
+      JSON.should_receive(:parse).with(@response.body)
+      Kiva::Loan.search(:q => "farm")
+    end
+    
+    it "should search loans based on status (fundraising,funded,in_repayment,paid,defaulted)" do
+      Net::HTTP.should_receive(:get_response).with(URI.parse("http://api.kivaws.org/v1/loans/search.json?status=paid")).and_return(@response)
+      Kiva::Loan.search(:status => "paid")
+    end
+    
+    it "should escape any characters that would cause problems in search" do
+      pending "not yet implemented"
+    end
+    
+    it "should handle non 200 OK responses" do
+      pending "not yet implemented"
+    end
+  end # search
+  
+  describe "search results" do
+    before(:each) do
+      Kiva::Loan.should_receive(:search).with(:q => "farm").and_return(search_results_raw)
+      
+      @results = Kiva::Loan.search_results(:q => "farm")
+    end
+    it "should ignore the paging details" do      
+      @results.should_not include(search_results_raw["paging"])
+    end
+    it "should get loans that are of type Kiva::Loan" do
+      @results.first.class.to_s.should == "Kiva::Loan"
+    end
+    it "should handle a raw search result with a loans entry" do
+      pending "not yet implemented"
+    end
+  end # search results
+  
+end # Kiva::Loan

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/kiva.rb'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: markmcspadden-ruby-kiva
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Mcspadden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-04 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A Ruby wrapper for the Kiva API
+email: markmcspadden@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/kiva
+- lib/kiva/loan.rb
+- lib/kiva.rb
+- spec/kiva
+- spec/kiva/loan_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/markmcspadden/ruby-kiva
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby wrapper for the Kiva API
+test_files: []
+