paypal-report 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,7 @@
 # PayPal Report
 
 A little lightweight wrapper for [Paypal's Report API](https://cms.paypal.com/cms_content/US/en_US/files/developer/PP_Reporting_Guide.pdf). 
-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 only _daily_ reports.
+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
@@ -13,7 +13,7 @@ Example usage, receiving all report from today:
 
 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>
+    paypal-report daily -a <partner> -v <vendor> -u <user> -p <password>
 
 
 ## Todo
@@ -21,7 +21,7 @@ Gem is in an early stage, so lots of stuff to do:
 
 - introduce more higher level functions (e.g. period)
 - add tests
-- add examples
+- add more examples
 
 
 ## Contributing

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/paypal-report

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'date'
+require 'optparse'
+require 'paypal/report'
+
+partner    = vendor = user = password = nil
+time       = Date.today.prev_day.strftime("%Y-%m-%d")
+
+prev_month = Date.today.prev_month
+start_date = Date.parse("#{prev_month.year}-#{prev_month.month}-01")
+next_month = start_date.next_month.prev_day
+end_date   = Date.parse("#{prev_month.year}-#{prev_month.month}-#{next_month.day}")
+
+start_date = start_date.strftime("%Y-%m-%d 00:00:00")
+end_date   = end_date.strftime("%Y-%m-%d 23:59:59")
+
+opts = ARGV.options do |opts|
+   opts.on("-p",  "--password=PASSWORD", "Password - required!")              { |p| password   = p}
+   opts.on("-u",  "--user=USER",         "User     - default: #{user}")       { |u| user       = u}
+   opts.on("-v",  "--vendor=VENDOR",     "Vendor   - default: #{vendor}")     { |v| vendor     = v}
+   opts.on("-a",  "--partner=PARTNER",   "Partner  - default: #{partner}")    { |a| partner    = a}
+
+   opts.on("-d",  "--date=DATE",         "Date     - default: #{time}")       { |t| time       = t}
+
+   opts.on("-f",  "--start_date=DATE",   "Date     - default: #{start_date}") { |t| start_date = t}
+   opts.on("-t",  "--end_date=DATE",     "Date     - default: #{end_date}")   { |t| end_date   = t}
+
+   opts.on_tail("-h", "--help", "Show this help message.") { $stderr.puts opts; exit }
+end
+opts.parse!
+
+abort "No password given: \n #{opts}" unless password
+
+api = Paypal::Report.new(user, password, vendor, partner)
+
+if ARGV.include?('daily')
+  amount = 0
+  report = api.daily(time, 5000)
+  report.each do |row|
+    amount += row[6].to_i
+  end
+
+  puts "Report for #{time}: #{report.size} Entries - #{amount / 100.0} EUR"
+end
+
+if ARGV.include?('monthly')
+  amount = 0
+  report = api.monthly(start_date, end_date, 5000)
+  report.each do |row|
+    amount += row[6].to_i
+  end
+
+  puts "Report for #{start_date} - #{end_date}: #{report.size} Entries - #{amount / 100.0} EUR"
+end

data/lib/paypal/report.rb

@@ -2,6 +2,7 @@ require 'net/https'
 require 'uri'
 require 'builder'
 require 'rexml/document'
+require 'date'
 
 module Paypal
   class Report
@@ -10,9 +11,9 @@ module Paypal
     def initialize(user, password, vendor, partner = 'PayPalUK')
       @user, @password, @vendor, @partner = user, password, vendor, partner
     end
-    
+
     #high level functions
-    def daily(time = Time.now, page_size = 50)
+    def daily(time = Date.today, page_size = 50)
       time      = time.strftime("%Y-%m-%d") unless time.is_a?(String)
       report_id = run_report_request('DailyActivityReport', {'report_date' => time}, page_size)
 
@@ -24,7 +25,38 @@ module Paypal
       end
       data
     end
-   
+
+    def monthly(start_date, end_date = Date.today, page_size = 50)
+      start_date = Date.parse(start_date) if start_date.is_a?(String)
+      start_date = start_date.to_date if start_date.is_a?(Time)
+
+      end_date = Date.parse(end_date) if end_date.is_a?(String)
+      end_date = end_date.to_date if end_date.is_a?(Time)
+
+      data = []
+      while(start_date <= end_date)
+        puts start_date.strftime("%Y-%m-%d")
+        data += daily(start_date, page_size)
+        start_date = start_date.next_day
+      end
+      data
+    end
+
+    def transaction_summary(start_date, end_date = Time.now, page_size = 50)
+      start_date = start_date.strftime("%Y-%m-%d 00:00:00") unless start_date.is_a?(String)
+      end_date   = end_date.strftime("%Y-%m-%d 23:59:59") unless end_date.is_a?(String)
+      report_id  = run_report_request('TransactionSummaryReport', {'start_date' => start_date, 'end_date' => end_date}, page_size)
+
+      meta_data = get_meta_data_request(report_id)
+
+      data = []
+      meta_data["numberOfPages"].to_i.times do |page_num|
+        data += get_data_request(report_id, page_num + 1) #it's zero indexed
+      end
+      data
+    end
+
+
     #low level functions
     def run_report_request(report_name, report_params = {}, page_size = 50)
       response = request 'runReportRequest' do |xml|

data/paypal-report.gemspec

@@ -2,13 +2,13 @@
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "paypal-report"
-  s.version     = File.read("VERSION").to_s
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["SoundCloud", "Tobias Bielohlawek"]
-  s.email       = %q{tobi@soundcloud.com}
-  s.homepage    = "http://github.com/rngtng/paypal-report"
-  s.summary     = %q{A little lightweight wrapper for Paypal's Report API.}
+  s.name          = "paypal-report"
+  s.version       = File.read("VERSION").to_s
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["SoundCloud", "Tobias Bielohlawek"]
+  s.email         = %q{tobi@soundcloud.com}
+  s.homepage      = "http://github.com/rngtng/paypal-report"
+  s.summary       = %q{A little lightweight wrapper for Paypal's Report API.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -2,7 +2,7 @@
 name: paypal-report
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - SoundCloud
@@ -11,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +02:00
-default_executable: 
+date: 2011-05-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -28,7 +27,7 @@ dependencies:
 description: 
 email: tobi@soundcloud.com
 executables: 
-- paypal-report-daily
+- paypal-report
 extensions: []
 
 extra_rdoc_files: []
@@ -41,11 +40,10 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- bin/paypal-report-daily
+- bin/paypal-report
 - lib/paypal.rb
 - lib/paypal/report.rb
 - paypal-report.gemspec
-has_rdoc: true
 homepage: http://github.com/rngtng/paypal-report
 licenses: []
 
@@ -69,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
 summary: A little lightweight wrapper for Paypal's Report API.

data/bin/paypal-report-daily

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require 'paypal/report'
-
-partner = vendor = user = password = nil
-time    = (Time.now - 60*60*24).strftime("%Y-%m-%d")
-
-opts = ARGV.clone.options do |opts|
-   opts.on("-p",  "--password=PASSWORD", "Password - required!")           { |p| password = p}
-   opts.on("-d",  "--date=DATE",         "Date     - default: #{time}")    { |t| time     = t} 
-   opts.on("-u",  "--user=USER",         "User     - default: #{user}")    { |u| user     = u}
-   opts.on("-v",  "--vendor=VENDOR",     "Vendor   - default: #{vendor}")  { |v| vendor   = v}
-   opts.on("-a",  "--partner=PARTNER",   "Partner  - default: #{partner}") { |a| partner  = a}
-
-   opts.on_tail("-h", "--help", "Show this help message.") { $stderr.puts opts; exit }
-end
-opts.parse!
-
-abort "No password given: \n #{opts}" unless password
-
-api = Paypal::Report.new(user, password, vendor, partner)
-
-amount = 0
-report = api.daily(time, 5000)
-report.each do |row|
-  amount += row[6].to_i
-end
-
-puts "Report for #{time}: #{report.size} Entries - #{amount / 100.0} EUR"