fortnox-api 0.5.2 → 0.6.0

data/docs/account.rb

@@ -1,59 +0,0 @@
-require "fortnox/api/models/base"
-
-module Fortnox
-  module API
-    module Entities
-      module Account
-        class Entity < Fortnox::API::Model::Base
-
-          # Direct URL to the record
-          attribute :url, String
-
-          # If the account is actve
-          attribute :acitve, Boolean
-
-          # Opening balance of the account
-          attribute :balancebroughtforward, Float
-
-          # Closing balance of the account
-          attribute :balancecarriedforward, Float
-
-          # Code of the proposed cost center. The code must be of an existing cost center.
-          attribute :costcenter, String
-
-          # Cost center settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED
-          attribute :costcentersettings, String
-
-          # Account description
-          attribute :description, String
-
-          # Account number
-          attribute :number, Integer
-
-          # Number of the proposed project. The number must be of an existing project.
-          attribute :project, Integer
-
-          # Project settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED
-          attribute :projectsettings, String
-
-          # SRU code
-          attribute :sru, String
-
-          # Proposed transaction information
-          attribute :transactioninformation, String
-
-          # Transaction information settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED
-          attribute :transactioninformationsettings, String
-
-          # VAT code
-          attribute :vatcode, String
-
-          # Id of the financial year.
-          attribute :year, Integer
-
-        end
-      end
-    end
-  end
-end
-

data/docs/extraction_script.js

@@ -1,23 +0,0 @@
-o = {};
-
-$('table.target tr').each(function(index, row){
-
-  first_column = $('td', row).first();
-  name = first_column.text().toLowerCase();
-
-  last_column = $('td', row).last().text();
-
-  parts = last_column.split(/\n|,/);
-  parts = parts.map( function( el ){ return el.trim(); });
-
-  type = parts.shift();
-  description = parts.pop();
-  validations = parts.length > 0 ? parts.join(', ') : null;
-  o[ name ] = {
-    "type": type,
-    "validations": validations,
-    "description": description
-  }
-});
-
-JSON.stringify(o);

data/docs/generation_script.rb

@@ -1,43 +0,0 @@
-require 'json'
-
-filename = 'account.json'
-modelname = filename.split('.').first.capitalize
-
-json = File.read( 'json/account.json' )
-hash = JSON.parse( json )
-
-header = <<-RB
-require "fortnox/api/models/base"
-
-module Fortnox
-  module API
-    module Entities
-      module {{ model_name }}
-        class Entity < Fortnox::API::Model::Base
-
-RB
-
-footer = <<-RB
-        end
-      end
-    end
-  end
-end
-
-RB
-
-attribute = <<-RB
-          # {{ description }}
-          attribute :{{ name }}, {{ type }}
-
-RB
-
-generated_class = header.gsub( '{{ model_name }}', modelname )
-
-hash.each do |name, attributes|
-  generated_class << attribute.gsub( '{{ description }}', attributes.fetch( 'description' ) ).gsub( '{{ name }}', name ).gsub( '{{ type }}', attributes.fetch( 'type' ).capitalize )
-end
-
-generated_class << footer
-
-File.write( "#{ modelname.downcase }.rb", generated_class )

data/docs/json/account.json

@@ -1,77 +0,0 @@
-{
-    "url": {
-        "type": "string",
-        "validations": "read-only",
-        "description": "Direct URL to the record"
-    },
-    "acitve": {
-        "type": "boolean",
-        "validations": null,
-        "description": "If the account is actve"
-    },
-    "balancebroughtforward": {
-        "type": "float",
-        "validations": null,
-        "description": "Opening balance of the account"
-    },
-    "balancecarriedforward": {
-        "type": "float",
-        "validations": "read-only",
-        "description": "Closing balance of the account"
-    },
-    "costcenter": {
-        "type": "string",
-        "validations": null,
-        "description": "Code of the proposed cost center. The code must be of an existing cost center."
-    },
-    "costcentersettings": {
-        "type": "string",
-        "validations": null,
-        "description": "Cost center settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED"
-    },
-    "description": {
-        "type": "string",
-        "validations": "200 characters, required",
-        "description": "Account description"
-    },
-    "number": {
-        "type": "integer",
-        "validations": "4 digits, sortable, required",
-        "description": "Account number"
-    },
-    "project": {
-        "type": "integer",
-        "validations": null,
-        "description": "Number of the proposed project. The number must be of an existing project."
-    },
-    "projectsettings": {
-        "type": "string",
-        "validations": null,
-        "description": "Project settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED"
-    },
-    "sru": {
-        "type": "string",
-        "validations": "4 or 5 digits, searchable",
-        "description": "SRU code"
-    },
-    "transactioninformation": {
-        "type": "string",
-        "validations": "100 characters",
-        "description": "Proposed transaction information"
-    },
-    "transactioninformationsettings": {
-        "type": "string",
-        "validations": null,
-        "description": "Transaction information settings for the account. Can be ALLOWED MANDATORY or NOTALLOWED"
-    },
-    "vatcode": {
-        "type": "string",
-        "validations": null,
-        "description": "VAT code"
-    },
-    "year": {
-        "type": "integer",
-        "validations": "read-only",
-        "description": "Id of the financial year."
-    }
-}

data/lib/fortnox/api/models/document_base.rb

@@ -1,189 +0,0 @@
-require "fortnox/api/types"
-require "fortnox/api/models/label"
-
-module Fortnox
-  module API
-    module Model
-      module DocumentBase
-        # Method length is ignored due to readability.
-        # rubocop:disable Metrics/MethodLength
-        def self.ify( base )
-          base.class_eval do
-
-            # Url Direct url to the record.
-            base.attribute :url, Types::Nullable::String.with( read_only: true )
-
-            # AdministrationFee The document administration fee.
-            base.attribute :administration_fee, Types::Nullable::Float
-
-            # AdministrationFeeVAT VAT of the document administration fee.
-            base.attribute :administration_fee_vat, Types::Nullable::Float.with( read_only: true )
-
-            # Address1 Document address 1. 1024 characters
-            base.attribute :address1, Types::Sized::String[ 1024 ]
-
-            # Address2 Document address 2. 1024 characters
-            base.attribute :address2, Types::Sized::String[ 1024 ]
-
-            # BasisTaxReduction Basis of tax reduction.
-            base.attribute :basis_tax_reduction, Types::Nullable::Float.with( read_only: true )
-
-            # Cancelled If the document is cancelled.
-            base.attribute :cancelled, Types::Nullable::Boolean.with( read_only: true )
-
-            # City City for the document address.
-            base.attribute :city, Types::Sized::String[ 1024 ]
-
-            # Comments Comments of the document
-            base.attribute :comments, Types::Sized::String[ 1024 ]
-
-            # ContributionPercent Document contribution in percent.
-            base.attribute :contribution_percent, Types::Nullable::Float.with( read_only: true )
-
-            # ContributionValue Document contribution in amount.
-            base.attribute :contribution_value, Types::Nullable::Float.with( read_only: true )
-
-            # Country Country for the document address.
-            base.attribute :country, Types::CountryCode
-
-            # CostCenter Code of the cost center.
-            base.attribute :cost_center, Types::Nullable::String
-
-            # Currency Code of the currency.
-            base.attribute :currency, Types::Currency
-
-            # CurrencyRate Currency rate used for the document
-            base.attribute :currency_rate, Types::Nullable::Float
-
-            # CurrencyUnit Currency unit used for the document
-            base.attribute :currency_unit, Types::Nullable::Float
-
-            # CustomerName Name of the customer. 1024 characters
-            base.attribute :customer_name, Types::Sized::String[ 1024 ]
-
-            # CustomerNumber Customer number of the customer. Required
-            base.attribute :customer_number, Types::Required::String
-
-            # DeliveryAddress1 Document delivery address 1.
-            base.attribute :delivery_address1, Types::Sized::String[ 1024 ]
-
-            # DeliveryAddress2 Document delivery address 2.
-            base.attribute :delivery_address2, Types::Sized::String[ 1024 ]
-
-            # DeliveryCity City for the document delivery address.
-            base.attribute :delivery_city, Types::Sized::String[ 1024 ]
-
-            # DeliveryCountry Country for the document delivery address.
-            base.attribute :delivery_country, Types::CountryCode
-
-            # DeliveryDate Date of delivery.
-            base.attribute :delivery_date, Types::Nullable::Date
-
-            # DeliveryName  Name of the recipient of the delivery
-            base.attribute :delivery_name, Types::Sized::String[ 1024 ]
-
-            # DeliveryZipCode ZipCode for the document delivery address.
-            base.attribute :delivery_zip_code, Types::Sized::String[ 1024 ]
-
-            # DocumentNumber The document number.
-            base.attribute :document_number, Types::Nullable::Integer
-
-            # EmailInformation Separete EmailInformation object
-            base.attribute :email_information, Types::EmailInformation
-
-            # ExternalInvoiceReference1 External document reference 1. 80 characters
-            base.attribute :external_invoice_reference1, Types::Sized::String[ 80 ]
-
-            # ExternalInvoiceReference2 External document reference 2. 80 characters
-            base.attribute :external_invoice_reference2, Types::Sized::String[ 80 ]
-
-            # Freight Freight cost of the document. 12 digits (incl. decimals)
-            base.attribute :freight, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
-
-            # FreightVAT VAT of the freight cost.
-            base.attribute :freight_vat, Types::Nullable::Float.with( read_only: true )
-
-            # Gross Gross value of the document
-            base.attribute :gross, Types::Nullable::Float.with( read_only: true )
-
-            # HouseWork If there is any row of the document marked “house work”.
-            base.attribute :house_work, Types::Nullable::Boolean.with( read_only: true )
-
-            base.attribute :labels, Types::Strict::Array.member( Label )
-
-            # Net Net amount
-            base.attribute :net, Types::Nullable::Float.with( read_only: true )
-
-            # NotCompleted If the document is set as not completed.
-            base.attribute :not_completed, Types::Nullable::Boolean
-
-            # OfferReference Reference to the offer, if one exists.
-            base.attribute :offer_reference, Types::Nullable::Integer.with( read_only: true )
-
-            # OrganisationNumber Organisation number of the customer for the
-            # document.
-            base.attribute :organisation_number, Types::Nullable::String.with( read_only: true )
-
-            # OurReference Our reference. 50 characters
-            base.attribute :our_reference, Types::Sized::String[ 50 ]
-
-            # Phone1 Phone number 1 of the customer for the document. 1024 characters
-            base.attribute :phone1, Types::Sized::String[ 1024 ]
-
-            # Phone2 Phone number 2 of the customer for the document. 1024 characters
-            base.attribute :phone2, Types::Sized::String[ 1024 ]
-
-            # PriceList Code of the price list.
-            base.attribute :price_list, Types::Nullable::String
-
-            # PrintTemplate Print template of the document.
-            base.attribute :print_template, Types::Nullable::String
-
-            # Project Code of the project.
-            base.attribute :project, Types::Nullable::String
-
-            # Remarks Remarks of the document. 1024 characters
-            base.attribute :remarks, Types::Sized::String[ 1024 ]
-
-            # RoundOff Round off amount for the document.
-            base.attribute :round_off, Types::Nullable::Float.with( read_only: true )
-
-            # Sent If the document is printed or sent in any way.
-            base.attribute :sent, Types::Nullable::Boolean.with( read_only: true )
-
-            # TaxReduction The amount of tax reduction.
-            base.attribute :tax_reduction, Types::Nullable::Integer.with( read_only: true )
-
-            # TermsOfDelivery Code of the terms of delivery.
-            base.attribute :terms_of_delivery, Types::Nullable::String
-
-            # TermsOfPayment Code of the terms of payment.
-            base.attribute :terms_of_payment, Types::Nullable::String
-
-            # Total The total amount of the document.
-            base.attribute :total, Types::Nullable::Float.with( read_only: true )
-
-            # TotalVAT The total VAT amount of the document.
-            base.attribute :total_vat, Types::Nullable::Float.with( read_only: true )
-
-            # VATIncluded If the price of the document is including VAT.
-            base.attribute :vat_included, Types::Nullable::Boolean
-
-            # WayOfDelivery Code of the way of delivery.
-            base.attribute :way_of_delivery, Types::Nullable::String
-
-            # YourOrderNumber Your order number. 30 characters
-            base.attribute :your_order_number, Types::Sized::String[ 30 ]
-
-            # YourReference Your reference. 50 characters
-            base.attribute :your_reference, Types::Sized::String[ 50 ]
-
-            # ZipCode Zip code of the document. 1024 characters
-            base.attribute :zip_code, Types::Sized::String[ 1024 ]
-          end
-        end
-        # rubocop:enable Metrics/MethodLength
-      end
-    end
-  end
-end

data/spec/fortnox/api/types/house_work_types_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-require 'fortnox/api'
-require 'fortnox/api/types'
-require 'fortnox/api/repositories/order'
-require 'fortnox/api/models/order'
-require 'fortnox/api/types/order_row'
-
-# rubocop:disable RSpec/DescribeClass
-describe 'HouseWorkTypes', integration: true do
-  include Helpers::Configuration
-
-  before{ set_api_test_configuration }
-
-  let(:repository){ Fortnox::API::Repository::Order.new }
-  let(:valid_model) do
-    Fortnox::API::Model::Order.new(customer_number: '1', order_rows: [order_row])
-  end
-  let(:order_row){ Fortnox::API::Types::OrderRow.new(ordered_quantity: 1,
-                                                     article_number: '0000',
-                                                     house_work_type: house_work_type)}
-
-  shared_examples_for 'house work type' do |type, legacy: false|
-    subject do
-      -> do
-        VCR.use_cassette( "orders/house_work_type_#{ type.downcase }" ) do
-          repository.save(valid_model)
-        end
-      end
-    end
-
-    let(:error_message){ 'Skattereduktion för en av de valda husarbetestyperna har upphört.' }
-    let(:house_work_type){ Fortnox::API::Types::HouseWorkTypes[type] }
-
-    context "when creating an OrderRow with house_work_type set to #{ type }" do
-      if legacy
-        it 'raises an error' do
-          is_expected.to raise_error(Fortnox::API::RemoteServerError, error_message)
-        end
-      else
-        it{ is_expected.not_to raise_error }
-      end
-    end
-  end
-
-  it_behaves_like 'house work type', 'CONSTRUCTION'
-  it_behaves_like 'house work type', 'ELECTRICITY'
-  it_behaves_like 'house work type', 'GLASSMETALWORK'
-  it_behaves_like 'house work type', 'GROUNDDRAINAGEWORK'
-  it_behaves_like 'house work type', 'MASONRY'
-  it_behaves_like 'house work type', 'PAINTINGWALLPAPERING'
-  it_behaves_like 'house work type', 'HVAC'
-  it_behaves_like 'house work type', 'CLEANING'
-  it_behaves_like 'house work type', 'TEXTILECLOTHING'
-  it_behaves_like 'house work type', 'CLEANING'
-  it_behaves_like 'house work type', 'SNOWPLOWING'
-  it_behaves_like 'house work type', 'GARDENING'
-  it_behaves_like 'house work type', 'BABYSITTING'
-  it_behaves_like 'house work type', 'OTHERCARE'
-  it_behaves_like 'house work type', 'OTHERCOSTS'
-
-  it_behaves_like 'house work type', 'COOKING', legacy: true
-  it_behaves_like 'house work type', 'TUTORING', legacy: true
-end
-# rubocop:enable RSpec/DescribeClass