skv_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fd4ecad8c4ea82f45641e416b37f9046fe39048b7bde532e2998f3ede8d934b
+  data.tar.gz: e359d4e13c9ca9a311c06bb3450cb7d0f008f80b9d5ada0dbdfded8b3aef50ec
+SHA512:
+  metadata.gz: c5bcf4cafe1ba9310c2f17c356414346608ec9fd3c17bf65b2e53ddc3d300f8c4156ad3fdb4fbdb1a8b26d4dd3246cc114841d77235e21fcb4be051c6403ba33
+  data.tar.gz: 14ea05feda440ea52e57a38e2c6ff670cb15321e577461534fc19ee1c95f8c74ae17b1a62eb2a726d446cb7d9150994e256ffc102936259eaae3ef11c29fd406

data/.github/workflows/gempush.yml

@@ -0,0 +1,41 @@
+name: Gem push
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  github:
+    name: Build + Publish to GitHub
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.5
+    - name: Publish to GitHub
+      uses: jstastny/publish-gem-to-github@master
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        owner: standout
+
+  rubygems:
+    name: Build + Publish to Rubygems
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.5
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 80
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/NestedGroups:
+  Max: 4

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in moss_generator.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'pry-byebug'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-performance', '~> 1.9'
+gem 'rubocop-rake', '~> 0.5'
+gem 'rubocop-rspec', '~> 2.1'

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    skv_report (0.1.0)
+      money (~> 6.14)
+      valvat (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.5)
+      rack
+      socksify
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    money (6.14.0)
+      i18n (>= 0.6.4, <= 2)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    nori (2.6.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    unicode-display_width (1.7.0)
+    valvat (1.1.0)
+      savon (>= 2.3.0)
+    wasabi (3.6.1)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-performance (~> 1.9)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.1)
+  skv_report!
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 frdrkolsson
+
+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,61 @@
+# SKVReport
+
+Generate CSV-formatted string from specified data to be able to create a
+[Periodisk Sammanställningsrapport](https://www.skatteverket.se/foretagochorganisationer/moms/deklareramoms/periodisksammanstallning.4.58d555751259e4d661680001093.html) file for Skatteverket.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skv_report'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install skv_report
+
+## Usage
+
+### Stripe
+```ruby
+# charges - array of charges in json-format from stripe
+# period - for which period of the year this report should be for
+# year - corresponding year for the period
+# company_information - needs to contain the following information:
+# {
+#   vat_number: String, # vat number of the selling company
+#   name: String, # contact name on selling company
+#   phone: String, # phone to contact on selling company
+#   email: String, # optional email to contact on selling company
+#   type_of_sales: String, # one of the following three
+#                            ['wares', 'third_party', 'services']
+# }
+# rates - object containing exchange rates
+
+SKVReport::Stripe.call(charges, period, year, company_information, rates)
+```
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Exchange rates
+
+Exchange rates needs to be passed.
+[exchangerateapi](https://exchangeratesapi.io) gives us a JSON-object suited for
+this gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/standout/skv_report.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'skv_report'
+
+# 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(__FILE__)

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/skv_report.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'skv_report/version'
+require_relative 'skv_report/stripe'
+require_relative 'skv_report/exchange_rates'
+
+# Generate CSV-formatted string for SKV report
+module SKVReport
+  Money.default_currency = Money::Currency.new('SEK')
+  Money.rounding_mode = BigDecimal::ROUND_HALF_UP
+end

data/lib/skv_report/exchange_rates.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module SKVReport
+  # Fetches relevant exchange rate for given date and given currency
+  class ExchangeRates
+    class NoRatesForDateError < StandardError; end
+
+    class NoRateForCurrencyError < StandardError; end
+
+    attr_reader :rates, :start_at, :base, :end_at
+
+    def initialize(rates = {})
+      @rates = rates['rates']
+      @base_currency = rates['base']
+      @start_at = Date.parse(rates['start_at'])
+      @end_at = Date.parse(rates['end_at'])
+    end
+
+    def rate_for(to_currency, date)
+      date_for_rate = find_previous_existing_date(Date.parse(date))
+      raise_no_rates_for_date_error(date) if date_for_rate.nil?
+
+      rate = rates.dig(date_for_rate.to_s, to_currency.upcase)
+      return rate unless rate.nil?
+
+      raise NoRateForCurrencyError, "currency: #{to_currency}\nrates: #{rates}"
+    end
+
+    private
+
+    # Test number of times this recursive method is called?
+    def find_previous_existing_date(date)
+      return nil if date_outside_of_range?(date)
+
+      rates[date.to_s].nil? ? find_previous_existing_date(date - 1) : date
+    end
+
+    def date_outside_of_range?(date)
+      date < start_at || date > end_at
+    end
+
+    def raise_no_rates_for_date_error(date)
+      raise NoRatesForDateError,
+            "date: #{date}\nstart_at: #{start_at}\nend_at: #{end_at}"
+    end
+  end
+end

data/lib/skv_report/stripe.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'skv_report/stripe_charge_row'
+
+module SKVReport
+  # Generate SKV CSV string from Stripe charge
+  class Stripe
+    class NoTurnoverCountryError < StandardError; end
+
+    class UndefinedTypeOfSalesError < StandardError; end
+
+    attr_reader :charges, :period, :year, :company_information, :rates
+
+    #
+    # company_information needs to contain the following information
+    # {
+    #   vat_number: String, # vat number of the selling company
+    #   name: String, # contact name on selling company
+    #   phone: String, # phone to contact on selling company
+    #   email: String, # optional email to contact on selling company
+    #   type_of_sales: String, # one of the following three
+    #                            ['wares', 'third_party', 'services']
+    # }
+    #
+    # Send rates to ImportExchangeRates, and send the object to stripe charge
+    # row, and then call rate for in there? Nah...
+    def initialize(charges, period, year, company_information = {}, rates = {})
+      @charges = charges
+      @company_information = company_information
+      @period = period
+      @year = year
+      @rates = rates
+    end
+
+    def self.call(charges, period, year, company_information = {}, rates = {})
+      new(charges, period, year, company_information, rates).call
+    end
+
+    def call
+      CSV.generate(csv_options) do |csv|
+        csv << first_row
+        csv << second_row
+        generate_charge_rows(csv)
+      end
+    end
+
+    private
+
+    def first_row
+      ['SKV574008']
+    end
+
+    def second_row
+      [company_information['vat_number'],
+       year_and_period,
+       company_information['name'][0...35],
+       sanitized_phone,
+       company_information['email']]
+    end
+
+    def generate_charge_rows(csv)
+      build_charge_rows.each { |row| csv << row }
+    end
+
+    def group_charge_rows
+      charge_rows = charges.map do |charge|
+        charge_row = SKVReport::StripeChargeRow.new(charge, exchange_rates)
+        next if charge_row.skippable?
+
+        charge_row
+      end.compact
+
+      charge_rows.group_by(&:buyer_vat_number)
+    end
+
+    def build_charge_rows
+      group_charge_rows.map do |vat_number, charges|
+        sales_row(vat_number, charges)
+      end
+    end
+
+    def sales_row(vat_number, charges)
+      [vat_number].concat(evaluate_amount_position(charges))
+    end
+
+    def evaluate_amount_position(charges)
+      case company_information['type_of_sales']
+      when 'wares' then [charges.sum(&:sales_amount), nil, nil]
+      when 'third_party' then [nil, charges.sum(&:sales_amount), nil]
+      when 'services' then [nil, nil, charges.sum(&:sales_amount)]
+      else
+        raise UndefinedTypeOfSalesError,
+              "#{company_information['type_of_sales']} is not valid"
+      end
+    end
+
+    def csv_options
+      { col_sep: column_separator, row_sep: row_separator }
+    end
+
+    def row_separator
+      ";\r\n"
+    end
+
+    def column_separator
+      ';'
+    end
+
+    def year_and_period
+      "#{year_short}-#{period}"
+    end
+
+    def year_short
+      Date.new(year).strftime('%y')
+    end
+
+    def sanitized_phone
+      company_information['phone'].gsub(/[^0-9\-+]/, '')[0...17]
+    end
+
+    def exchange_rates
+      @exchange_rates ||= ExchangeRates.new(rates)
+    end
+  end
+end

data/lib/skv_report/stripe_charge_row.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'money'
+require 'valvat/local'
+require 'date'
+
+module SKVReport
+  # Parse charge data from single Stripe charge
+  # Sales amount will not contain any cents, so we round
+  # All amounts should be handled as without vat
+  class StripeChargeRow
+    class AmountNotInSwedishKronorError < StandardError; end
+
+    attr_reader :charge, :buyer_vat_number, :exchange_rates
+
+    #
+    # charge: a stripe charge
+    # exchange_rates: a SKVReport::ExchangeRates object
+    #
+    def initialize(charge, exchange_rates)
+      @charge = charge
+      @buyer_vat_number = charge.dig('customer', 'tax_info', 'tax_id') || ''
+      @exchange_rates = exchange_rates
+    end
+
+    def sales_amount
+      Money.new(amount).dollars.to_f.round
+    end
+
+    def skippable?
+      swedish_buyer? || !valid_vat_number? || not_completed? || refunded?
+    end
+
+    private
+
+    def swedish_buyer?
+      buyer_vat_number[0...2].casecmp?('SE')
+    end
+
+    def valid_vat_number?
+      Valvat::Syntax.validate(buyer_vat_number)
+    end
+
+    def amount
+      currency = charge['currency']
+      return charge['amount'] if currency.casecmp?('sek')
+
+      date = Time.at(charge['created']).to_date.to_s
+      convert_amount_to_sek(exchange_rates.rate_for(currency, date))
+    end
+
+    def convert_amount_to_sek(exchange_rate)
+      (charge['amount'] * exchange_rate).round
+    end
+
+    def not_completed?
+      charge['status'] != 'succeeded'
+    end
+
+    def refunded?
+      charge['refunded']
+    end
+  end
+end

data/lib/skv_report/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SKVReport
+  VERSION = '0.1.0'
+end

data/skv_report.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/skv_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'skv_report'
+  spec.version       = SKVReport::VERSION
+  spec.authors       = ['frdrkolsson']
+  spec.email         = ['fredrik.olsson@standout.se']
+
+  spec.summary       = 'Generates CSV complete string for Skatteverkets '\
+                       'Periodisk Sammanfattning'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/standout/skv_report'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_dependency to register a new dependency of your gem
+  spec.add_dependency 'money', '~> 6.14'
+  spec.add_dependency 'valvat', '~> 1.1'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: skv_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- frdrkolsson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.14'
+- !ruby/object:Gem::Dependency
+  name: valvat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Generates CSV complete string for Skatteverkets Periodisk Sammanfattning
+email:
+- fredrik.olsson@standout.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/skv_report.rb
+- lib/skv_report/exchange_rates.rb
+- lib/skv_report/stripe.rb
+- lib/skv_report/stripe_charge_row.rb
+- lib/skv_report/version.rb
+- skv_report.gemspec
+homepage: https://github.com/standout/skv_report
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/standout/skv_report
+  source_code_uri: https://github.com/standout/skv_report
+  changelog_uri: https://github.com/standout/skv_report
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Generates CSV complete string for Skatteverkets Periodisk Sammanfattning
+test_files: []