ruby_paypal_nvp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fe00c7ddd7983e5511a992b53f1d9c53bed4807
+  data.tar.gz: 094c8c4e580882e4a39c0643fbb131e0211aa17e
+SHA512:
+  metadata.gz: 3d307941fa46451f7905d40a64a2d73cc3cad7cea855ada278b07341e973057a3487c9a50474ea2a4f0bcb80f1a29c627b4d19026d6632d2de75c10cbac01555
+  data.tar.gz: f89320bd20446303bf864c5b961208b901e29a8f1c5849fc9788f0d09a5dc9f55e02efa5c89d1954a812251d3b80ac74a715cd36d2e711ece6c474b1329a8e2a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+bin/debug_console

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'ruby_paypal_nvp.gemspec'
+    - 'spec/**/*'
+  TargetRubyVersion: 2.3
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 89
+
+Documentation:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0.pre.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrej@antas.cz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby_paypal_nvp.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    ruby_paypal_nvp (0.1.0)
+      activesupport (~> 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    vcr (2.9.3)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  ruby_paypal_nvp!
+  vcr (~> 2.2)
+  webmock
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrej Antas
+
+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,212 @@
+# RubyPaypalNvp
+
+Missing paypal account statements.
+
+As per communication with PayPal this is apart from PDF and CSV reports
+prefered way of downloading e.x. monthly statements if you have too much and
+need to automate the process...
+
+This gem provides you with simple access to specific subject account statement.
+
+## Requirements
+
+- PayPal account of course
+- Paypal credentials for NVP API can be found under:
+  - Login on http://paypal.com/
+  - Go to your Profile and settings (upper right corner menu)
+  - Click on My selling tools
+  - Under first part - Selling online - click on Update API access
+  - At the bottom look up NVP/SOAP APIintegration (Classic)
+  - Click Manage API credentials there
+  - Finally after a while on this page is information needed for you to access
+    NVP API data
+- If you take care of multiple account data like we do, They need to give
+  you access like this:
+  - Login on http://paypal.com/
+  - Click Profile“ → „Profile and settings“
+  - In the menu choose „My selling tools“ and then „API access“ and click on Update
+  - Choose the first option and click on „Grant API permission“
+  - On the next page „Add a new third party“
+  - In the new window fill in ID given to you (is the one from previous part) and click „Lookup“
+  - When the ID was filled in correctly a new menu with permissions will appear („Available Permissions“).
+  - Choose the following options:
+    - Obtain your PayPal account balance.
+    - Obtain information about a single transaction.
+    - Search your transactions for items that match specific criteria and display the results.
+  - Confirm the selection by clicking „Add“.
+
+And after these couple days of setup you are all good to go :)
+
+Important to note here is that in first part is your account and setup and
+stuff...
+
+Second part is you customer (in our case) who wants you to lookup data for them
+and they use your id that you need to send them (is always in email like form
+without @ in it)
+
+Then the `subject` used in search for statements is their email through which
+they granted API access to you...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_paypal_nvp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_paypal_nvp
+
+## Usage
+
+For the time being this gem provides you with Stamtement download for desired
+period.
+
+The weird PayPal pagin and all things considered proven to be correct input for
+accountants to work with.
+
+first step is configuration (either as initializer or if you have it in single
+script or so):
+
+```ruby
+RubyPaypalNvp.configure do |config|
+  config.user = 'YOUR_USER_HERE' # watch out may differ according to setup for sandbox
+  config.password = 'YOUR_PWD_HERE'
+  config.signature = 'YOUR_SIGNATURE_HERE'
+  config.api_url = 'https://api-3t.paypal.com/nvp' # or put 'https://api-3t.andbox.aypal.com/nvp' for sandbox env
+end
+```
+
+Then you are ready to query PayPal
+
+We provide you with Statement class:
+
+```
+RubyPaypalNvp::Statement
+```
+
+Provides search method `where`:
+
+```
+RubyPaypalNvp::Statement.where(
+  date_from: Time.zone.parse('1.9.2017'),
+  date_to: Time.zone.parse('1.9.2017'),
+  subject: 'info@uol.cz',
+  currency: 'CZK',
+  transaction_class: 'BalanceAffecting'
+)
+```
+
+Where
+- `date_from` beginning of interval to search for (beggining of the day - disregards time)
+- `date_to` end of interval to search for (end of the day - disregards time)
+  - Dates and times in particular are converted to utc
+- `subject` is account email you are looking through (as per description in requirements)
+- `currency` is as name says currency of desired account (defaults to `CZK`)
+- `transaction_class` is per description found in docs (here)[https://developer.paypal.com/docs/classic/api/merchant/TransactionSearch_API_Operation_NVP/] defaults to `BalanceAffecting`
+  - most problematic since multiple options you should be able to put the as `All` or `Received` result in `500` from PayPal which we are not able to identify (talking here about accounts with 1k+ transactions monthly)
+  - default setup is provide to be stable and correct for accounting
+
+Response you get from search is in form of Object containing:
+
+```ruby
+#<RubyPaypalNvp::Model::Statement:0x007fe4360ac450
+ @amount_sum=1000.00,
+ @currency_code="CZK",
+ @end_date="2017-09-01T21:59:59Z",
+ @fee_amount_sum=10.00,
+ @items=
+  [#<RubyPaypalNvp::Model::Item:0x007fe43679bf90
+    @amount=1000.00,
+    @currency_code="CZK",
+    @email="test@uol.cz",
+    @fee_amount=10.00,
+    @name="Martin Tester",
+    @net_amount=1010.00,
+    @status="Completed",
+    @timestamp="2017-09-01T12:48:08Z",
+    @timezone="GMT",
+    @transaction_id="9XXXXXXXXXXXXXXXH",
+    @type="Refund">],
+ @items_count=4,
+ @net_amount_sum=1010.00,
+ @start_date="2017-08-31T22:00:00Z",
+ @subject="info@uol.cz",
+ @timestamp="2017-11-02T10:45:07Z">
+```
+
+You can see all the sums and all items which represent all movements on the account in given time period there.
+
+Also `RubyPaypalNvp::Model::Statemnt` result class from query provides you method `#generate_csv` which will create CSV from the data for inspection:
+
+```
+result = RubyPaypalNvp::Statement.where(
+  date_from: Time.zone.parse('1.9.2017'),
+  date_to: Time.zone.parse('30.9.2017'),
+  subject: 'info@uol.cz',
+  currency: 'CZK',
+  transaction_class: 'BalanceAffecting'
+)
+result.generate_csv('location_to_save.csv')
+```
+
+Another thing provided is Balance fetching, where you can ask for balance of
+given account at point in time when asking it... you cannot really ask for
+balance at given point in time, because they simply do not provide it...
+
+For this purpose you have:
+
+```
+RubyPaypalNvp::Balance
+```
+
+it provides you again with simple `.where` method to ask for data:
+
+```
+result = RubyPaypalNvp::Balance
+  .where(subject: 'info@uol.cz', currency: 'CZK')
+```
+
+Where
+- `subject` is account email you are looking through (as per description in requirements)
+- `currency` is as name says currency of desired account (defaults to `CZK`)
+
+Result provides speak for itself:
+
+```
+#<RubyPaypalNvp::Model::Balance:0x007fd8f0a17f90
+  @currency_code="CZK",
+  @opening_balance=58221.0,
+  @subject="info@uol.cz",
+  @timestamp="2017-12-06 10:00:14 +0100">
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_paypal_nvp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## TODO
+
+Pending things that will be done shortly:
+- Rspec
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyPaypalNvp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_paypal_nvp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ruby_paypal_nvp'
+require 'pry'
+
+Pry.start

data/bin/setup

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

data/lib/ruby_paypal_nvp.rb

@@ -0,0 +1,32 @@
+require 'active_support/all'
+require 'net/http'
+
+require 'ruby_paypal_nvp/version'
+require 'ruby_paypal_nvp/configuration'
+
+require 'ruby_paypal_nvp/utils/errors'
+
+require 'ruby_paypal_nvp/fetcher/base'
+require 'ruby_paypal_nvp/fetcher/balance'
+require 'ruby_paypal_nvp/fetcher/statement'
+
+require 'ruby_paypal_nvp/model/statement'
+require 'ruby_paypal_nvp/model/balance'
+require 'ruby_paypal_nvp/model/item'
+
+require 'ruby_paypal_nvp/statement'
+require 'ruby_paypal_nvp/balance'
+
+module RubyPaypalNvp
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ruby_paypal_nvp/balance.rb

@@ -0,0 +1,7 @@
+module RubyPaypalNvp
+  class Balance
+    def self.where(options)
+      ::RubyPaypalNvp::Fetcher::Balance.call(options)
+    end
+  end
+end

data/lib/ruby_paypal_nvp/configuration.rb

@@ -0,0 +1,44 @@
+module RubyPaypalNvp
+  class Configuration
+    attr_writer :version, :user, :password, :signature, :subject, :api_url
+
+    def initialize
+      Time.zone = 'Prague'
+      @version = nil
+      @user = nil
+      @password = nil
+      @signature = nil
+      @subject = nil
+    end
+
+    def version
+      return '204.0' unless @version
+      @version
+    end
+
+    def user
+      raise ConfigNotSet, 'user' unless @user
+      @user
+    end
+
+    def password
+      raise ConfigNotSet, 'password' unless @password
+      @password
+    end
+
+    def signature
+      raise ConfigNotSet, 'signature' unless @signature
+      @signature
+    end
+
+    def subject
+      raise ConfigNotSet, 'subject' unless @subject
+      @subject
+    end
+
+    def api_url
+      raise ConfigNotSet, 'api_url' unless @api_url
+      @api_url
+    end
+  end
+end

data/lib/ruby_paypal_nvp/fetcher/balance.rb

@@ -0,0 +1,41 @@
+module RubyPaypalNvp
+  module Fetcher
+    class Balance < Base
+      RESPONSE_PARAMS = %w[L_AMT L_CURRENCYCODE].freeze
+
+      private
+
+      def process_loaded_data(result)
+        result = filter_current_currency(result)
+        return if result[:values].blank?
+        ::RubyPaypalNvp::Model::Balance.new(result)
+      end
+
+      def filter_current_currency(result)
+        currency_code = result[:meta]['currency_code']
+        balance = result[:values].select do |_key, value|
+          { key: value } if value.values.include?(currency_code)
+        end
+        result[:values] = balance.values.first
+        result
+      end
+
+      def load_response
+        response = load_api_response(request_options)
+        raise response['L_LONGMESSAGE0'] if response['ACK'] == 'Failure'
+        parse(response, increment: 0)
+        result = result_with_meta(timestamp: Time.zone.parse(response['TIMESTAMP']).to_s)
+        @resulting_hash = default_hash
+        result
+      end
+
+      def request_options
+        super.merge! returnallcurrencies: 1
+      end
+
+      def api_method
+        'GetBalance'
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/fetcher/base.rb

@@ -0,0 +1,114 @@
+##
+# Base for fetching data from Paypal NVP API
+#   See docs: https://developer.paypal.com/docs/classic/api/
+##
+module RubyPaypalNvp
+  module Fetcher
+    class Base
+      ##
+      # Input options:
+      #   date_from
+      #   date_to
+      #   currency
+      #   subject
+      #   transaction_class
+      #
+      # rubocop:disable Metrics/AbcSize
+      def initialize(opts)
+        @start_date = opts.fetch(:date_from, Time.zone.now).beginning_of_day.utc.iso8601
+        @end_date = opts.fetch(:date_to, Time.zone.now).end_of_day.utc.iso8601
+        @currency = opts.fetch(:currency, 'CZK')
+        @subject = opts[:subject] || RubyPaypalNvp.configuration.subject
+        @transaction_class = opts.fetch(:transaction_class, 'BalanceAffecting')
+        @resulting_hash = default_hash
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def call
+        result = load_response
+        process_loaded_data(result)
+      rescue NoMethodError
+        raise "Error processing #{self.class} for #{@subject}"
+      end
+
+      def self.call(options)
+        new(options).call
+      end
+
+      def load_api_response(options)
+        uri = URI(RubyPaypalNvp.configuration.api_url)
+        req = Net::HTTP::Post.new(uri)
+        req.set_form_data(options)
+        res = Net::HTTP.start(uri.hostname, uri.port,
+                              use_ssl: uri.scheme == 'https') do |http|
+          http.open_timeout = 6000
+          http.read_timeout = 6000
+          http.request(req)
+        end
+        pretty_json(res.body)
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def parse(body, options = {})
+        @resulting_hash[:values].tap do |parsed_response|
+          param_type = self.class::RESPONSE_PARAMS.first
+          all_for_params_type = body.select { |k, _v| k.start_with?(param_type) }
+          all_for_params_type.each_with_index do |(key, value), index|
+            real_index = index + options[:increment]
+            parsed_response[real_index] ||= {}
+            parsed_response[real_index] = parsed_response[real_index]
+                                          .merge(param_type.to_s => value)
+            key = key.gsub(param_type, '')
+            self.class::RESPONSE_PARAMS.drop(1).each do |attribute_name|
+              pair = { attribute_name => body["#{attribute_name}#{key}"] }
+              parsed_response[real_index] = parsed_response[real_index].merge pair
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      # Implement in each child to save/send data
+      def process_loaded_data(_result)
+        true
+      end
+
+      def result_with_meta(options = {})
+        @resulting_hash[:meta]['timestamp'] = options[:timestamp]
+        @resulting_hash[:meta]['start_date'] = @start_date
+        @resulting_hash[:meta]['end_date'] = @end_date
+        @resulting_hash[:meta]['subject'] = @subject
+        @resulting_hash[:meta]['currency_code'] = @currency
+        @resulting_hash
+      end
+
+      def request_options(_options = {})
+        {
+          method: api_method,
+          version: RubyPaypalNvp.configuration.version,
+          user: RubyPaypalNvp.configuration.user,
+          pwd: RubyPaypalNvp.configuration.password,
+          signature: RubyPaypalNvp.configuration.signature,
+          subject: @subject
+        }
+      end
+
+      # Needs to be specific in each child
+      def api_method
+        ''
+      end
+
+      def pretty_json(body)
+        Hash[URI.decode_www_form(body)]
+      end
+
+      def default_hash
+        { meta: {}, values: {} }
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/fetcher/statement.rb

@@ -0,0 +1,66 @@
+module RubyPaypalNvp
+  module Fetcher
+    class Statement < Base
+      RESPONSE_PARAMS = %w[L_TIMESTAMP L_TIMEZONE L_TYPE L_EMAIL L_NAME
+                           L_TRANSACTIONID L_STATUS L_AMT L_CURRENCYCODE
+                           L_FEEAMT L_NETAMT].freeze
+
+      private
+
+      def process_loaded_data(result)
+        ::RubyPaypalNvp::Model::Statement.new(result)
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def load_response
+        @ack = 'Failure'
+        while @ack != 'Success'
+          enddate = moved_end ? Time.parse(moved_end).utc.iso8601 : nil
+          options = request_options(enddate: enddate)
+          response = load_api_response(options)
+          parse(response, increment: increment)
+
+          @ack = response['ACK']
+          raise response['L_LONGMESSAGE0'] if @ack == 'Failure'
+        end
+        result = result_with_meta(timestamp: response['TIMESTAMP'])
+        @resulting_hash = default_hash
+        result[:values] = result[:values].values
+        result
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Style/GuardClause
+      def moved_end
+        if @resulting_hash[:values].keys.last
+          @resulting_hash[:values].values.last['L_TIMESTAMP']
+        end
+      end
+      # rubocop:enable Style/GuardClause
+
+      def increment
+        if @resulting_hash[:values].keys.last
+          (@resulting_hash[:values].keys.last + 1)
+        else
+          0
+        end
+      end
+
+      def request_options(options = {})
+        additional = {
+          startdate: @start_date,
+          enddate: options[:enddate] || @end_date,
+          transactionclass: @transaction_class,
+          currencycode: @currency
+        }
+        super.merge! additional
+      end
+
+      def api_method
+        'TransactionSearch'
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/model/balance.rb

@@ -0,0 +1,14 @@
+module RubyPaypalNvp
+  module Model
+    class Balance
+      attr_accessor :currency_code, :subject, :timestamp, :opening_balance
+
+      def initialize(result)
+        @currency_code = result[:meta]['currency_code']
+        @subject = result[:meta]['subject']
+        @timestamp = result[:meta]['timestamp']
+        @opening_balance = result[:values]['L_AMT'].to_f
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/model/item.rb

@@ -0,0 +1,39 @@
+module RubyPaypalNvp
+  module Model
+    class Item
+      attr_accessor :timestamp, :timezone, :type, :email, :name,
+                    :transaction_id, :status, :amount, :currency_code, :fee_amount,
+                    :net_amount
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/MethodLength
+      def initialize(hash = {})
+        @timestamp = hash['L_TIMESTAMP'] || nil
+        @timezone = hash['L_TIMEZONE'] || nil
+        @type = hash['L_TYPE'] || nil
+        @email = hash['L_EMAIL'] || nil
+        @name = hash['L_NAME'] || nil
+        @transaction_id = hash['L_TRANSACTIONID'] || nil
+        @status = hash['L_STATUS'] || nil
+        @amount = (hash['L_AMT'] || nil).to_f
+        @currency_code = hash['L_CURRENCYCODE'] || nil
+        @fee_amount = (hash['L_FEEAMT'] || nil).to_f
+        @net_amount = (hash['L_NETAMT'] || nil).to_f
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/MethodLength
+
+      def self.attributes
+        new.instance_variable_names.map { |a| a.delete('@') }
+      end
+
+      def to_csv
+        instance_variables.map { |k| instance_variable_get(k) }
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/model/statement.rb

@@ -0,0 +1,81 @@
+require 'csv'
+
+module RubyPaypalNvp
+  module Model
+    class Statement
+      attr_accessor :timestamp, :start_date, :end_date, :subject,
+                    :currency_code, :items, :amount_sum, :fee_amount_sum,
+                    :net_amount_sum, :items_count
+
+      IGNORED_STATUSES = %w[Cleared Placed Removed].freeze
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def initialize(result)
+        @timestamp = result[:meta]['timestamp']
+        @start_date = result[:meta]['start_date']
+        @end_date = result[:meta]['end_date']
+        @subject = result[:meta]['subject']
+        @currency_code = result[:meta]['currency_code']
+        @items = result[:values].map do |value|
+          Item.new(value) unless IGNORED_STATUSES.include?(value['L_STATUS'])
+        end.compact.uniq(&:transaction_id)
+        @items_count = @items.count
+        @amount_sum = @items.sum(&:amount)
+        @fee_amount_sum = @items.sum(&:fee_amount)
+        @net_amount_sum = @items.sum(&:net_amount)
+        @raw = result
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def generate_csv(filename = nil)
+        raise 'Missing filename/path' unless filename
+        ::CSV.open(filename, 'w') do |csv|
+          csv << ['HEADER']
+          csv << ['', 'timestamp', @timestamp]
+          csv << ['', 'start_date', @start_date]
+          csv << ['', 'end_date', @end_date]
+          csv << ['', 'subject', @subject]
+          csv << ['', 'currency_code', @currency_code]
+          csv << ['', 'items_count', @items_count]
+          csv << ['', 'amount_sum', @amount_sum]
+          csv << ['', 'fee_amount_sum', @fee_amount_sum]
+          csv << ['', 'net_amount_sum', @net_amount_sum]
+          csv << ['ITEMS']
+          csv << RubyPaypalNvp::Model::Item.attributes
+          @items.each do |item|
+            csv << item.to_csv
+          end
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      def to_json
+        raw_items.to_json
+      end
+
+      def to_iis_json
+        {
+          'meta': {
+            'timestamp': @timestamp,
+            'start_date': @start_date,
+            'end_date': @end_date,
+            'subject': @subject,
+            'currency_code': @currency_code
+          },
+          'values': raw_items
+        }.to_json
+      end
+
+      private
+
+      def raw_items
+        @raw[:values].compact.uniq { |i| i['L_TRANSACTIONID'] }
+      end
+    end
+  end
+end

data/lib/ruby_paypal_nvp/statement.rb

@@ -0,0 +1,7 @@
+module RubyPaypalNvp
+  class Statement
+    def self.where(options)
+      ::RubyPaypalNvp::Fetcher::Statement.call(options)
+    end
+  end
+end

data/lib/ruby_paypal_nvp/utils/errors.rb

@@ -0,0 +1,10 @@
+module RubyPaypalNvp
+  class Error < StandardError; end
+
+  class ConfigNotSet < Error
+    def initialize(param)
+      msg = "Please check if you set #{param}, seems it is missing."
+      super(msg)
+    end
+  end
+end

data/lib/ruby_paypal_nvp/version.rb

@@ -0,0 +1,3 @@
+module RubyPaypalNvp
+  VERSION = '0.1.0'.freeze
+end

data/ruby_paypal_nvp.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_paypal_nvp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_paypal_nvp'
+  spec.version       = RubyPaypalNvp::VERSION
+  spec.authors       = ['Andrej Antas']
+  spec.email         = ['andrej@antas.cz']
+
+  spec.summary       = 'Ruby PayPal NVP wrapper'
+  spec.description   = 'Ruby wrapper for PayPal NVP API since there was none'
+  spec.homepage      = 'https://github.com/redrick/ruby_paypal_nvp'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16.a'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr', '~> 2.2'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: ruby_paypal_nvp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrej Antas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for PayPal NVP API since there was none
+email:
+- andrej@antas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_paypal_nvp.rb
+- lib/ruby_paypal_nvp/balance.rb
+- lib/ruby_paypal_nvp/configuration.rb
+- lib/ruby_paypal_nvp/fetcher/balance.rb
+- lib/ruby_paypal_nvp/fetcher/base.rb
+- lib/ruby_paypal_nvp/fetcher/statement.rb
+- lib/ruby_paypal_nvp/model/balance.rb
+- lib/ruby_paypal_nvp/model/item.rb
+- lib/ruby_paypal_nvp/model/statement.rb
+- lib/ruby_paypal_nvp/statement.rb
+- lib/ruby_paypal_nvp/utils/errors.rb
+- lib/ruby_paypal_nvp/version.rb
+- ruby_paypal_nvp.gemspec
+homepage: https://github.com/redrick/ruby_paypal_nvp
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby PayPal NVP wrapper
+test_files: []