kiva_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65cd1ab8ebc34a3b117354afecae696bb6051d29
+  data.tar.gz: d4d4b75f3c048e8241e897ca369d6f58b67b1a68
+SHA512:
+  metadata.gz: 748cd3db64581809c5297ce33fb01183c413d9f18a3eab61860479b5ebd87198e034b45041ed1ef40092469b8b5a028b376a4af9194e90b537bfe739c577a17e
+  data.tar.gz: 9d9b731618c74f28d737aea4ff1a8e45607eea78c2d508fbbae9c3e74905fb10f01ec0ab7a8735ec4d97b2a0814747564bfcf690e06393bc81a71134a51b746d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steven Magelowitz
+
+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,70 @@
+# KivaApi
+
+Get Loan data from Kiva's API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kiva_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kiva_api
+
+## Usage
+
+### Initializing the object
+
+When initializing the KivaApi::Loan object, you can optionally add the loan ID
+to the initialization.
+
+
+```ruby
+require 'kiva_api'
+
+loan_api = KivaApi::Loan.new(92464)
+# => #<KivaApi::Loan:0x007ff09b9daa88 @host="https://api.kivaws.org/v2", @loan_number=92464>
+
+loan_api.get_data # this will hit the @host on Kiva for the loan number that you specify
+
+loan_response = loan_api.response
+loan_response.parsed_body
+# => {"class"=>["Loan_Partner", "Loan"], "properties"=>{"id"=>92464...
+loan_response.state
+# => :ended
+loan_response.loan_amount
+# => "825.00"
+loan_response.funded_amount
+# => "825.00"
+loan_response.basket_amount
+# => "0.00"
+loan_response.paid_amount
+# => "825.00"
+
+terms = loan_api.terms_response
+terms.expected_payments
+# => [{:amount=>"35.87", :effective_date=>"2009-04-08T07:00:00Z", :due_to_kiva_date=>"2009-06-01T07:00:00Z"}, ...]
+```
+
+### Bad Responses
+
+```ruby
+loan_api = KivaApi::Loan.new(1)
+loan_api.get_data
+# => #<HTTParty::Response:0x7fa2ab088658 parsed_response={"class"=>["error", "SirenE....
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/stevepm/kiva_api/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kiva_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kiva_api.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kiva_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kiva_api"
+  spec.version       = KivaApi::VERSION
+  spec.authors       = ["Steven Magelowitz"]
+  spec.email         = ["steven.magelowitz@gmail.com"]
+
+  spec.summary       = %q{Get Loan data from Kiva's API}
+  spec.description   = %q{Get Loan data from Kiva's API}
+  spec.homepage      = "https://github.com/kiva/Kiva-API-Ruby-Gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', '~> 0.13.5'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.21.0"
+end

data/lib/kiva_api/loan.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+
+class KivaApi::Loan
+  attr :host, :loan_number
+  attr_reader :response, :terms_response
+  DEFAULT_HOST = 'https://api.kivaws.org/v2'
+
+  def initialize(loan_number = nil, host = nil)
+    set_host(host)
+    if loan_number
+      @loan_number = loan_number
+    end
+  end
+
+  def get_data
+    @response = KivaApi::LoanResponse.new(HTTParty.get("#{@host}/loan/#{@loan_number}/"))
+    @terms_response = KivaApi::TermsResponse.new(HTTParty.get("#{@host}/loan/#{@loan_number}/terms"))
+  end
+
+  private
+  def set_host(host)
+    if host
+      @host = host
+    else
+      @host = DEFAULT_HOST
+    end
+  end
+end

data/lib/kiva_api/loan_response.rb

@@ -0,0 +1,51 @@
+class KivaApi::LoanResponse
+  attr_reader :response
+
+  STATES = {
+      'deleted' => 'deleted',
+      'refunded' => 'refunded',
+      'inactive' => 'hidden',
+      'inactive_expired' => 'hidden',
+      'fundRaising' => 'fundraising',
+      'expired' => 'expired',
+      'raised' => 'raised',
+      'payingBack' => 'paying_back',
+      'ended' => 'ended',
+      'reviewed' => 'review',
+      'issue' => 'review',
+      'defaulted' => 'paying_back_defaulted'
+  }
+
+  def initialize(response)
+    @response = response
+  end
+
+  def parsed_body
+    @response.parsed_response
+  end
+
+  def state
+    kiva_state_to_zip(parsed_body['properties']['status'])
+  end
+
+  def loan_amount
+    parsed_body['properties']['loanAmount']['amount']
+  end
+
+  def funded_amount
+    parsed_body['properties']['fundedAmount']['amount']
+  end
+
+  def basket_amount
+    parsed_body['properties']['basketAmount']['amount']
+  end
+
+  def paid_amount
+    parsed_body['properties']['paidAmount']['amount']
+  end
+
+  private
+  def kiva_state_to_zip(state)
+    STATES[state].to_sym
+  end
+end

data/lib/kiva_api/terms_response.rb

@@ -0,0 +1,19 @@
+class KivaApi::TermsResponse
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def expected_payments
+    payments = []
+    response['properties']['expectedPayments'].each do |payment|
+      payments << {
+          amount: payment['amount']['amount'],
+          effective_date: payment['effectiveDate'],
+          due_to_kiva_date: payment['dueToKivaDate']
+      }
+    end
+    payments
+  end
+end

data/lib/kiva_api/version.rb

@@ -0,0 +1,3 @@
+module KivaApi
+  VERSION = "0.1.0"
+end

data/lib/kiva_api.rb

@@ -0,0 +1,7 @@
+require "kiva_api/version"
+require 'kiva_api/loan'
+require 'kiva_api/loan_response'
+require 'kiva_api/terms_response'
+
+module KivaApi
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: kiva_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Magelowitz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+description: Get Loan data from Kiva's API
+email:
+- steven.magelowitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kiva_api.gemspec
+- lib/kiva_api.rb
+- lib/kiva_api/loan.rb
+- lib/kiva_api/loan_response.rb
+- lib/kiva_api/terms_response.rb
+- lib/kiva_api/version.rb
+homepage: https://github.com/kiva/Kiva-API-Ruby-Gem
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Get Loan data from Kiva's API
+test_files: []