0.01
No commit activity in last 3 years
No release in over 3 years
A little lightweight wrapper for Paypal's Report API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 2.1.2
 Project Readme

PayPal Report

A little lightweight wrapper for Paypal's Report API. All three major API methods run_report_request, get_meta_data_request and get_data_request are exposed. On top of that, higher methods provide extra functionality. For now, this daily, monthly and summery reports.

Usage

Example usage, receiving all report from today:

require 'paypal/report'
api = Paypal::Report.new(user, password, vendor, partner)
puts api.daily.inspect

As an example, the gem provides a small command line tool to easily get today's earnings. Usage:

paypal-report daily -a <partner> -v <vendor> -u <user> -p <password>

Todo

Gem is in an early stage, so lots of stuff to do:

  • introduce more higher level functions (e.g. period)
  • add tests
  • add more examples

Contributing

We'll check out your contribution if you:

  • Provide a comprehensive suite of tests for your fork.
  • Have a clear and documented rationale for your changes.
  • Package these up in a pull request.

We'll do our best to help you out with any contribution issues you may have.

License

The license is included as LICENSE in this directory.