simplificator-ruby-kiva 0.1.0

data/lib/ruby-kiva/partner.rb

@@ -0,0 +1,45 @@
+module Kiva
+  class Partner
+    include Api
+    include DynamicInitializer
+    attr_accessor :status, :name, :rating, :delinquency_rate, :id, :total_amount_raised, :default_rate, :loans_posted
+    typed_attr_accessor :image, Kiva::Image
+    typed_attr_accessor :start_date, Time, :parse
+    typed_attr_accessor :countries, Kiva::Country, :new, true
+
+    # Find a partner
+    # either by :id or all of them
+    # Since kiva does not offer pagination or search,
+    # finding by id is implemented in memory/ruby.
+    # Items are cached but can be reloaded by passing :reload => true (caching is suggested by kiva...)
+    def self.find(params = {})
+      if params[:id]
+        find().detect() {|item| item.id == params[:id]}
+      else
+        find_all(params)
+      end
+    end
+
+
+    private
+
+    def self.find_all(params)
+      if params[:reload] || !@partners
+        @partners = json_to_paged_array(get('/partners.json', base_options(params)), 'partners', true)
+      end
+      @partners
+    end
+  end
+end
+
+#{"start_date"=>"2005-04-15T17:00:00Z",
+#{}"rating"=>0,
+#{}"status"=>"closed",
+#{}"name"=>"East Africa Beta",
+#{}"delinquency_rate"=>0,
+#{}"id"=>1,
+#{}"total_amount_raised"=>26600,
+#{}"default_rate"=>9.1917293233083,
+#{}"loans_posted"=>62,
+#{}"countries"=>[{"name"=>"Uganda", "region"=>"Africa", "iso_code"=>"UG", "location"=>{"geo"=>{"type"=>"point", "level"=>"country", "pairs"=>"2 33"}}}, {"name"=>"Kenya", "region"=>"Africa", "iso_code"=>"KE", "location"=>{"geo"=>{"type"=>"point", "level"=>"country", "pairs"=>"1 38"}}}, {"name"=>"Tanzania", "region"=>"Africa", "iso_code"=>"TZ", "location"=>{"geo"=>{"type"=>"point", "level"=>"country", "pairs"=>"-6 35"}}}],
+#{}"image"=>{"template_id"=>1, "id"=>58088}}

data/lib/ruby-kiva/payment.rb

@@ -0,0 +1,11 @@
+module Kiva
+  class Payment
+    include DynamicInitializer
+    attr_accessor :amount
+    typed_attr_accessor :due_date, Time, :parse
+
+    def to_s
+      "<Payment due at #{self.due_date} : #{self.amount}>"
+    end
+  end
+end

data/lib/ruby-kiva/team.rb

@@ -0,0 +1,28 @@
+module Kiva
+  class Team
+    include DynamicInitializer
+    include Api
+
+    attr_accessor :id, :shortname, :name, :category, :image, :whereabouts, :loan_because, :description,
+                  :website_url, :membership_type, :member_count, :loan_count, :loaned_amount
+
+    typed_attr_accessor :team_since, Time, :parse
+    typed_attr_accessor :image, Kiva::Image
+
+    def lenders(params = {})
+      @lenders ||= Lender.find(params.merge({:team_id => self.id}))
+    end
+    def loans(params = {})
+      @loans ||= Loan.find(params.merge({:team_id => self.id}))
+    end
+
+    # find a team by :id or :shortname
+    def self.find(params)
+      if params[:id]
+        json_to_paged_array(get("/teams/#{params[:id]}.json", :query => base_options(params)), 'teams', false)
+      elsif params[:shortname]
+        json_to_paged_array(get("/teams/using_shortname/#{params[:shortname]}.json", :query => base_options(params)), 'teams', false)
+      end
+    end
+  end
+end

data/lib/ruby-kiva/terms.rb

@@ -0,0 +1,20 @@
+module Kiva
+  class Terms
+    include DynamicInitializer
+
+    attr_accessor :disbursal_amount, :loss_liability, :loan_amount, :disbursal_currency
+
+    typed_attr_accessor :disbursal_date, Time, :parse
+    typed_attr_accessor :scheduled_payments, Kiva::Payment, :new, true
+    typed_attr_accessor :local_payments, Kiva::Payment, :new, true
+
+  end
+end
+
+# {"disbursal_date"=>"2010-02-12T08:00:00Z",
+# "scheduled_payments"=>[{"amount"=>"366.67", "due_date"=>"2011-04-01T07:00:00Z"}, {"amount"=>"366.66", "due_date"=>"2012-04-01T07:00:00Z"}, {"amount"=>"366.67", "due_date"=>"2013-04-01T07:00:00Z"}],
+# "disbursal_amount"=>600000,
+# "local_payments"=>[{"amount"=>200000, "due_date"=>"2011-02-12T08:00:00Z"}, {"amount"=>200000, "due_date"=>"2012-02-12T08:00:00Z"}, {"amount"=>200000, "due_date"=>"2013-02-12T08:00:00Z"}],
+# "loss_liability"=>{"currency_exchange_coverage_rate"=>0.2, "nonpayment"=>"lender", "currency_exchange"=>"shared"},
+# "loan_amount"=>1100,
+# "disbursal_currency"=>"CRC"}

data/lib/ruby-kiva/video.rb

@@ -0,0 +1,7 @@
+module Kiva
+  class Video
+    include DynamicInitializer
+    attr_accessor :youtube_id, :id
+  end
+end
+#{"youtube_id"=>"LH8Izddvgds", "id"=>1025}

data/lib/simplificator-ruby-kiva.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'httparty'
+
+%w( dynamic_initializer api payment borrower location country image paged_array video terms loan
+   lender partner lending_action journal_entry comment team).each do |name|
+  require File.join(File.dirname(__FILE__), 'ruby-kiva', name)
+end

data/simplificator-ruby-kiva.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simplificator-ruby-kiva}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["simplificator"]
+  s.date = %q{2010-04-12}
+  s.description = %q{a ruby wrapper for the kiva.org api}
+  s.email = %q{info@simplificator.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/ruby-kiva/api.rb",
+     "lib/ruby-kiva/borrower.rb",
+     "lib/ruby-kiva/comment.rb",
+     "lib/ruby-kiva/country.rb",
+     "lib/ruby-kiva/dynamic_initializer.rb",
+     "lib/ruby-kiva/image.rb",
+     "lib/ruby-kiva/journal_entry.rb",
+     "lib/ruby-kiva/lender.rb",
+     "lib/ruby-kiva/lending_action.rb",
+     "lib/ruby-kiva/loan.rb",
+     "lib/ruby-kiva/location.rb",
+     "lib/ruby-kiva/paged_array.rb",
+     "lib/ruby-kiva/partner.rb",
+     "lib/ruby-kiva/payment.rb",
+     "lib/ruby-kiva/team.rb",
+     "lib/ruby-kiva/terms.rb",
+     "lib/ruby-kiva/video.rb",
+     "lib/simplificator-ruby-kiva.rb",
+     "simplificator-ruby-kiva.gemspec",
+     "test/helper.rb",
+     "test/test_simplificator-ruby-kiva.rb",
+     "test/unit/borrower_test.rb",
+     "test/unit/comment_test.rb",
+     "test/unit/country_test.rb",
+     "test/unit/image_test.rb",
+     "test/unit/journal_entry_test.rb",
+     "test/unit/lender_test.rb",
+     "test/unit/payment_test.rb"
+  ]
+  s.homepage = %q{http://github.com/simplificator/simplificator-ruby-kiva}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{a ruby wrapper for the kiva.org api}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_simplificator-ruby-kiva.rb",
+     "test/unit/borrower_test.rb",
+     "test/unit/comment_test.rb",
+     "test/unit/country_test.rb",
+     "test/unit/image_test.rb",
+     "test/unit/journal_entry_test.rb",
+     "test/unit/lender_test.rb",
+     "test/unit/payment_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplificator-ruby-kiva'
+include Kiva
+
+class Test::Unit::TestCase
+end

data/test/test_simplificator-ruby-kiva.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimplificatorRubyKiva < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/unit/borrower_test.rb

@@ -0,0 +1,50 @@
+require '../helper'
+class BorrowerTest < Test::Unit::TestCase
+  DATA = {"gender"=>"M", "pictured"=>true, "first_name"=>"José Manuel", "last_name"=>"Blanco Chinchilla"}
+
+  context 'a new borrower' do
+    setup do
+      @borrower = Borrower.new()
+    end
+    should 'have nil amount and due_date' do
+      assert !@borrower.gender
+      assert !@borrower.pictured
+      assert !@borrower.first_name
+      assert !@borrower.last_name
+    end
+
+    should 'neither be male nor female' do
+      assert !@borrower.male?
+      assert !@borrower.female?
+    end
+
+    should 'not be pictured?' do
+      assert !@borrower.pictured?
+    end
+
+  end
+
+  context 'a new borrower with data' do
+    setup do
+      @borrower = Borrower.new(DATA)
+    end
+
+    should 'be pictured?' do
+      assert @borrower.pictured?
+    end
+
+    should 'be male' do
+      assert @borrower.male?
+    end
+
+    should 'have a first name' do
+      assert_equal 'José Manuel', @borrower.first_name
+    end
+
+    should 'have a last name' do
+      assert_equal 'Blanco Chinchilla', @borrower.last_name
+    end
+
+  end
+
+end

data/test/unit/comment_test.rb

@@ -0,0 +1,43 @@
+require '../helper'
+class CommentTest < Test::Unit::TestCase
+  DATA = {"body"=>"Ana,\r\n\r\nI wish you continued success with your business.  Keep up the great work!\r\n\r\n", "date"=>"2007-11-23T06:31:45Z", "author"=>"Dee", "id"=>29197, "whereabouts"=>"Monroe, WA  USA"}
+
+  context 'a new comment' do
+    setup do
+      @comment = Comment.new()
+    end
+    should 'have nil values' do
+      assert !@comment.body
+      assert !@comment.date
+      assert !@comment.author
+      assert !@comment.id
+      assert !@comment.whereabouts
+    end
+  end
+
+  context 'a new comment with data' do
+    setup do
+      @comment = Comment.new(DATA)
+    end
+
+    should 'have a body' do
+      assert @comment.body
+    end
+
+    should 'have a date' do
+      assert_equal Time.parse('2007-11-23T06:31:45Z'), @comment.date
+    end
+
+    should 'have an author' do
+      assert_equal 'Dee', @comment.author
+    end
+
+    should 'have an id' do
+      assert_equal 29197, @comment.id
+    end
+
+    should 'have whereabouts' do
+      assert_equal 'Monroe, WA  USA', @comment.whereabouts
+    end
+  end
+end

data/test/unit/country_test.rb

@@ -0,0 +1,39 @@
+require '../helper'
+class CountryTest < Test::Unit::TestCase
+  DATA = {"name"=>"Uganda", "region"=>"Africa", "iso_code"=>"UG", "location"=>{"geo"=>{"type"=>"point", "level"=>"country", "pairs"=>"2 33"}}}
+
+  context 'a new country' do
+    setup do
+      @country = Country.new()
+    end
+    should 'have nil attributes' do
+      assert !@country.name
+      assert !@country.region
+      assert !@country.iso_code
+      assert !@country.location
+    end
+  end
+
+  context 'a new country with data' do
+    setup do
+      @country = Country.new(DATA)
+    end
+
+    should 'have a code' do
+      assert_equal 'UG',@country.iso_code
+    end
+
+    should 'have a name' do
+      assert_equal 'Uganda', @country.name
+    end
+
+    should 'have a region' do
+      assert_equal 'Africa', @country.region
+    end
+
+    should 'have a location' do
+      assert @country.location
+    end
+  end
+
+end

data/test/unit/image_test.rb

@@ -0,0 +1,48 @@
+require '../helper'
+class ImageTest < Test::Unit::TestCase
+  DATA = {:template_id => 1, :id => 1234}
+  context 'a new image' do
+    setup do
+      @image = Kiva::Image.new()
+    end
+    should 'have nil attributes' do
+      assert !@image.id
+      assert !@image.template_id
+    end
+
+    should 'raise when calling url' do
+      assert_raise RuntimeError do
+        @image.url
+      end
+    end
+  end
+
+  context 'a new image with data' do
+    setup do
+      @image = Kiva::Image.new(DATA)
+    end
+
+    should 'have an id' do
+      assert_equal 1234, @image.id
+    end
+
+    should 'have a template_id' do
+      assert_equal 1, @image.template_id
+    end
+
+    should 'generate image url for default size' do
+      assert_equal 'http://www.kiva.org/img/w80h80/1234.jpg', @image.url
+    end
+
+    should 'generate image url for default w200h200' do
+      assert_equal 'http://www.kiva.org/img/w200h200/1234.jpg', @image.url(:w200h200)
+    end
+
+    should 'raise on unknown size' do
+      assert_raise RuntimeError do
+        @image.url(:foobar)
+      end
+    end
+  end
+
+end

data/test/unit/journal_entry_test.rb

@@ -0,0 +1,60 @@
+require '../helper'
+class JournalEntryTest < Test::Unit::TestCase
+  DATA = {"id" => 46861, "subject" => "Loan Refunded","body" => "This loan has been refunded for the following reason: \n\nDue to an administrative error, the loan amount posted was incorrect.  We apologize for any inconvenience.\n","date" => "2008-04-01T19:47:28Z","author" => "Daniel Kahn","bulk" => true,"comment_count" => 0,"recommendation_count" =>0}
+
+  context 'a new journal entry' do
+    setup do
+      @journal_entry = JournalEntry.new()
+    end
+    should 'have nil attributes' do
+      assert !@journal_entry.id
+      assert !@journal_entry.subject
+      assert !@journal_entry.body
+      assert !@journal_entry.date
+      assert !@journal_entry.author
+      assert !@journal_entry.bulk
+      assert !@journal_entry.comment_count
+      assert !@journal_entry.recommendation_count
+    end
+  end
+
+  context 'a new Journal Entry with data' do
+    setup do
+      @journal_entry = JournalEntry.new(DATA)
+    end
+
+    should 'have an ID' do
+      assert_equal 46861, @journal_entry.id
+    end
+
+    should 'have a subject' do
+      assert_equal 'Loan Refunded', @journal_entry.subject
+    end
+
+    should 'have a body' do
+      assert @journal_entry.body
+    end
+
+    should 'be bulk' do
+      assert @journal_entry.bulk?
+    end
+
+    should 'have a date' do
+      assert_equal Time.parse('2008-04-01T19:47:28Z'), @journal_entry.date
+    end
+
+    should 'have an author' do
+      assert_equal 'Daniel Kahn', @journal_entry.author
+    end
+
+    should 'have recommendation count of 0' do
+      assert_equal 0, @journal_entry.recommendation_count
+    end
+
+    should 'have a comment count of 0' do
+      assert_equal 0, @journal_entry.comment_count
+    end
+
+  end
+
+end

data/test/unit/lender_test.rb

@@ -0,0 +1,82 @@
+require '../helper'
+class LenderTest < Test::Unit::TestCase
+  DATA =  {"loan_count"=>93, "occupation"=>"Entrepreneur", "country_code"=>"US",
+   "name"=>"Matt",
+   "loan_because"=>"I love the stories. ",
+   "lender_id"=>"matt",
+   "invitee_count"=>23,
+   "occupational_info"=>"I co-founded a startup nonprofit (this one!) and I work with an amazing group of people dreaming up ways to alleviate poverty through personal lending. ",
+   "personal_url"=>"www.socialedge.org/blogs/kiva-chronicles",
+   "uid"=>"matt",
+   "whereabouts"=>"San Francisco CA",
+   "image"=>{"template_id"=>1, "id"=>12829},
+   "member_since"=>"2006-01-01T09:01:01Z"}
+
+  context 'a new lender' do
+    setup do
+      @lender = Lender.new()
+    end
+    should 'have nil attributes' do
+      assert !@lender.loan_count
+      assert !@lender.occupation
+      assert !@lender.country_code
+      assert !@lender.name
+      assert !@lender.loan_because
+      assert !@lender.lender_id
+      assert !@lender.invitee_count
+      assert !@lender.occupational_info
+      assert !@lender.personal_url
+      assert !@lender.uid
+      assert !@lender.whereabouts
+      assert !@lender.image
+      assert !@lender.member_since
+    end
+  end
+
+  context 'a new lender with data' do
+    setup do
+      @lender = Lender.new(DATA)
+    end
+
+
+    should 'have a name' do
+      assert_equal 'Matt', @lender.name
+    end
+    should 'have reason for the loans' do
+      assert_equal 'I love the stories. ', @lender.loan_because
+    end
+
+    should 'have a lender_id' do
+      assert_equal 'matt', @lender.lender_id
+    end
+
+    should 'have an invitee count' do
+      assert 23, @lender.invitee_count
+    end
+
+    should 'have occupational_info' do
+      assert @lender.occupational_info
+    end
+
+    should 'have a personal_url' do
+      assert @lender.personal_url
+    end
+
+    should 'have an uid' do
+      assert_equal 'matt', @lender.uid
+    end
+
+    should 'have whereabouts' do
+      assert_equal 'San Francisco CA', @lender.whereabouts
+    end
+
+    should 'have an image' do
+      assert @lender.image
+    end
+
+    should 'have member_since' do
+      assert_equal Time.parse('2006-01-01T09:01:01Z'), @lender.member_since
+    end
+  end
+
+end

data/test/unit/payment_test.rb

@@ -0,0 +1,28 @@
+require '../helper'
+class PaymentTest < Test::Unit::TestCase
+  DATA = {"amount"=> 366.67, "due_date"=>"2011-04-01T07:00:00Z"}
+
+  context 'a new payment' do
+    setup do
+      @payment = Payment.new()
+    end
+    should 'have nil amount and due_date' do
+      assert !@payment.amount
+      assert !@payment.due_date
+    end
+  end
+
+  context 'a new payment with data' do
+    setup do
+      @payment = Payment.new(DATA)
+    end
+    should 'have an amount of 366.67' do
+      assert_equal 366.67, @payment.amount
+    end
+
+    should 'have a due date' do
+      assert_equal Time.parse('2011-04-01T07:00:00Z'), @payment.due_date
+    end
+  end
+
+end