paypal-report 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.rvmrc

data/CHANGES.md

@@ -0,0 +1,4 @@
+# Changes
+
+## 0.1.0
+- initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in paypal-report.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2011, SoundCloud Ltd., Tobias Bielohlawek
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+- Neither the name of the SoundCloud Ltd. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,40 @@
+# 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.
+
+
+## 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 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.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/paypal-report-daily

@@ -0,0 +1,30 @@
+#!/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"

data/lib/paypal.rb

@@ -0,0 +1 @@
+require 'paypal/report'

data/lib/paypal/report.rb

@@ -0,0 +1,115 @@
+require 'net/https'
+require 'uri'
+require 'builder'
+require 'rexml/document'
+
+module Paypal
+  class Report
+    API_URL = 'https://payments-reports.paypal.com/reportingengine'
+
+    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)
+      time      = time.strftime("%Y-%m-%d") unless time.is_a?(String)
+      report_id = run_report_request('DailyActivityReport', {'report_date' => time}, 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|
+        xml.reportName report_name
+        report_params.each do |name, value|
+          xml.reportParam do
+            xml.paramName name
+            xml.paramValue value
+          end
+        end
+        xml.pageSize page_size
+      end
+
+      response.elements["runReportResponse/reportId"].get_text.value
+    end
+
+    def get_meta_data_request(report_id)
+      response = request 'getMetaDataRequest' do |xml|
+        xml.reportId report_id
+      end
+
+      response.elements["getMetaDataResponse"].inject({}) do |h,e|
+        if text = e.get_text
+          h[e.name] = text.value
+        else
+          h[e.name] ||= []
+          h[e.name] << e.elements["dataName"].get_text.value
+        end
+        h
+      end
+    end
+
+    def get_data_request(report_id, page_num)
+      response = request 'getDataRequest' do |xml|
+        xml.reportId report_id
+        xml.pageNum page_num
+      end
+
+      [].tap do |result|
+        response.elements.each("getDataResponse/reportDataRow") do |data_row|
+          result << [].tap do |row|
+            data_row.elements.each("columnData/data") do |data|
+              row << if text = data.get_text
+                text.value
+              else
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+
+    private
+    def uri
+      @uri ||= URI.parse(API_URL)
+    end
+
+    def http
+      @http ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    def request(type)
+      xml = Builder::XmlMarkup.new
+      xml.tag! 'reportingEngineRequest' do
+        xml.tag! 'authRequest' do
+          xml.user @user
+          xml.vendor @vendor
+          xml.partner @partner
+          xml.password @password
+        end
+        xml.tag! type do
+          yield xml
+        end
+      end
+
+      body = http.post(uri.request_uri, xml.target!).body
+      REXML::Document.new(body).elements['reportingEngineResponse'].tap do |response|
+        code = response.elements['baseResponse/responseCode'].get_text.value.to_i
+        raise response.elements['baseResponse/responseMsg'].get_text.value unless code == 100
+      end
+    end
+
+  end
+end

data/paypal-report.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  ['builder 3.0.0'].each do |gem|
+    s.add_dependency *gem.split(' ')
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: paypal-report
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- SoundCloud
+- Tobias Bielohlawek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: tobi@soundcloud.com
+executables: 
+- paypal-report-daily
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGES.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/paypal-report-daily
+- lib/paypal.rb
+- lib/paypal/report.rb
+- paypal-report.gemspec
+has_rdoc: true
+homepage: http://github.com/rngtng/paypal-report
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A little lightweight wrapper for Paypal's Report API.
+test_files: []
+