xero-ruby 2.4.1 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +240 -189
- data/lib/xero-ruby.rb +10 -4
- data/lib/xero-ruby/api/accounting_api.rb +1308 -920
- data/lib/xero-ruby/api/asset_api.rb +15 -14
- data/lib/xero-ruby/api/files_api.rb +204 -85
- data/lib/xero-ruby/api/payroll_au_api.rb +121 -93
- data/lib/xero-ruby/api/payroll_nz_api.rb +307 -240
- data/lib/xero-ruby/api/payroll_uk_api.rb +317 -254
- data/lib/xero-ruby/api/project_api.rb +71 -59
- data/lib/xero-ruby/api_client.rb +182 -128
- data/lib/xero-ruby/api_error.rb +4 -4
- data/lib/xero-ruby/configuration.rb +17 -5
- data/lib/xero-ruby/models/accounting/account.rb +25 -12
- data/lib/xero-ruby/models/accounting/account_type.rb +1 -2
- data/lib/xero-ruby/models/accounting/accounts.rb +25 -11
- data/lib/xero-ruby/models/accounting/accounts_payable.rb +25 -11
- data/lib/xero-ruby/models/accounting/accounts_receivable.rb +25 -11
- data/lib/xero-ruby/models/accounting/action.rb +25 -11
- data/lib/xero-ruby/models/accounting/actions.rb +25 -11
- data/lib/xero-ruby/models/accounting/address.rb +27 -14
- data/lib/xero-ruby/models/accounting/address_for_organisation.rb +484 -0
- data/lib/xero-ruby/models/accounting/allocation.rb +25 -11
- data/lib/xero-ruby/models/accounting/allocations.rb +25 -11
- data/lib/xero-ruby/models/accounting/attachment.rb +25 -11
- data/lib/xero-ruby/models/accounting/attachments.rb +25 -11
- data/lib/xero-ruby/models/accounting/balance_details.rb +25 -11
- data/lib/xero-ruby/models/accounting/balances.rb +25 -11
- data/lib/xero-ruby/models/accounting/bank_transaction.rb +25 -11
- data/lib/xero-ruby/models/accounting/bank_transactions.rb +25 -11
- data/lib/xero-ruby/models/accounting/bank_transfer.rb +25 -11
- data/lib/xero-ruby/models/accounting/bank_transfers.rb +25 -11
- data/lib/xero-ruby/models/accounting/batch_payment.rb +41 -15
- data/lib/xero-ruby/models/accounting/batch_payment_details.rb +25 -11
- data/lib/xero-ruby/models/accounting/batch_payments.rb +25 -11
- data/lib/xero-ruby/models/accounting/bill.rb +25 -11
- data/lib/xero-ruby/models/accounting/branding_theme.rb +25 -11
- data/lib/xero-ruby/models/accounting/branding_themes.rb +25 -11
- data/lib/xero-ruby/models/accounting/budget.rb +327 -0
- data/lib/xero-ruby/models/accounting/budget_balance.rb +267 -0
- data/lib/xero-ruby/models/accounting/budget_line.rb +244 -0
- data/lib/xero-ruby/models/{files/file_response204.rb → accounting/budgets.rb} +40 -24
- data/lib/xero-ruby/models/accounting/cis_org_setting.rb +26 -12
- data/lib/xero-ruby/models/accounting/cis_org_settings.rb +224 -0
- data/lib/xero-ruby/models/accounting/cis_setting.rb +26 -12
- data/lib/xero-ruby/models/accounting/cis_settings.rb +25 -11
- data/lib/xero-ruby/models/accounting/contact.rb +25 -11
- data/lib/xero-ruby/models/accounting/contact_group.rb +25 -11
- data/lib/xero-ruby/models/accounting/contact_groups.rb +25 -11
- data/lib/xero-ruby/models/accounting/contact_person.rb +25 -11
- data/lib/xero-ruby/models/accounting/contacts.rb +25 -11
- data/lib/xero-ruby/models/accounting/conversion_balances.rb +25 -11
- data/lib/xero-ruby/models/accounting/conversion_date.rb +25 -11
- data/lib/xero-ruby/models/accounting/country_code.rb +1 -2
- data/lib/xero-ruby/models/accounting/credit_note.rb +62 -16
- data/lib/xero-ruby/models/accounting/credit_notes.rb +25 -11
- data/lib/xero-ruby/models/accounting/currencies.rb +25 -11
- data/lib/xero-ruby/models/accounting/currency.rb +25 -11
- data/lib/xero-ruby/models/accounting/currency_code.rb +1 -2
- data/lib/xero-ruby/models/accounting/element.rb +25 -11
- data/lib/xero-ruby/models/accounting/employee.rb +25 -11
- data/lib/xero-ruby/models/accounting/employees.rb +25 -11
- data/lib/xero-ruby/models/accounting/error.rb +25 -11
- data/lib/xero-ruby/models/accounting/expense_claim.rb +25 -11
- data/lib/xero-ruby/models/accounting/expense_claims.rb +25 -11
- data/lib/xero-ruby/models/accounting/external_link.rb +25 -11
- data/lib/xero-ruby/models/accounting/history_record.rb +25 -11
- data/lib/xero-ruby/models/accounting/history_records.rb +25 -11
- data/lib/xero-ruby/models/accounting/import_summary.rb +25 -11
- data/lib/xero-ruby/models/accounting/import_summary_accounts.rb +33 -19
- data/lib/xero-ruby/models/accounting/import_summary_object.rb +25 -11
- data/lib/xero-ruby/models/accounting/import_summary_organisation.rb +25 -11
- data/lib/xero-ruby/models/accounting/invoice.rb +37 -28
- data/lib/xero-ruby/models/accounting/invoice_reminder.rb +25 -11
- data/lib/xero-ruby/models/accounting/invoice_reminders.rb +25 -11
- data/lib/xero-ruby/models/accounting/invoices.rb +25 -11
- data/lib/xero-ruby/models/accounting/item.rb +25 -11
- data/lib/xero-ruby/models/accounting/items.rb +25 -11
- data/lib/xero-ruby/models/accounting/journal.rb +25 -11
- data/lib/xero-ruby/models/accounting/journal_line.rb +25 -11
- data/lib/xero-ruby/models/accounting/journals.rb +25 -11
- data/lib/xero-ruby/models/accounting/line_amount_types.rb +1 -2
- data/lib/xero-ruby/models/accounting/line_item.rb +36 -12
- data/lib/xero-ruby/models/accounting/line_item_tracking.rb +25 -11
- data/lib/xero-ruby/models/accounting/linked_transaction.rb +25 -11
- data/lib/xero-ruby/models/accounting/linked_transactions.rb +25 -11
- data/lib/xero-ruby/models/accounting/manual_journal.rb +25 -11
- data/lib/xero-ruby/models/accounting/manual_journal_line.rb +25 -11
- data/lib/xero-ruby/models/accounting/manual_journals.rb +25 -11
- data/lib/xero-ruby/models/accounting/online_invoice.rb +25 -11
- data/lib/xero-ruby/models/accounting/online_invoices.rb +25 -11
- data/lib/xero-ruby/models/accounting/organisation.rb +26 -14
- data/lib/xero-ruby/models/accounting/organisations.rb +25 -11
- data/lib/xero-ruby/models/accounting/overpayment.rb +25 -11
- data/lib/xero-ruby/models/accounting/overpayments.rb +25 -11
- data/lib/xero-ruby/models/accounting/payment.rb +36 -12
- data/lib/xero-ruby/models/accounting/payment_delete.rb +25 -11
- data/lib/xero-ruby/models/accounting/payment_service.rb +25 -11
- data/lib/xero-ruby/models/accounting/payment_services.rb +25 -11
- data/lib/xero-ruby/models/accounting/payment_term.rb +25 -11
- data/lib/xero-ruby/models/accounting/payment_term_type.rb +1 -2
- data/lib/xero-ruby/models/accounting/payments.rb +25 -11
- data/lib/xero-ruby/models/accounting/phone.rb +25 -11
- data/lib/xero-ruby/models/accounting/prepayment.rb +38 -12
- data/lib/xero-ruby/models/accounting/prepayments.rb +25 -11
- data/lib/xero-ruby/models/accounting/purchase.rb +25 -11
- data/lib/xero-ruby/models/accounting/purchase_order.rb +25 -11
- data/lib/xero-ruby/models/accounting/purchase_orders.rb +25 -11
- data/lib/xero-ruby/models/accounting/quote.rb +25 -11
- data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +1 -2
- data/lib/xero-ruby/models/accounting/quote_status_codes.rb +1 -2
- data/lib/xero-ruby/models/accounting/quotes.rb +25 -11
- data/lib/xero-ruby/models/accounting/receipt.rb +25 -11
- data/lib/xero-ruby/models/accounting/receipts.rb +25 -11
- data/lib/xero-ruby/models/accounting/repeating_invoice.rb +25 -11
- data/lib/xero-ruby/models/accounting/repeating_invoices.rb +25 -11
- data/lib/xero-ruby/models/accounting/report.rb +26 -22
- data/lib/xero-ruby/models/accounting/report_attribute.rb +25 -11
- data/lib/xero-ruby/models/accounting/report_cell.rb +25 -11
- data/lib/xero-ruby/models/accounting/report_fields.rb +25 -11
- data/lib/xero-ruby/models/accounting/report_row.rb +25 -11
- data/lib/xero-ruby/models/accounting/report_rows.rb +25 -11
- data/lib/xero-ruby/models/accounting/report_with_row.rb +26 -12
- data/lib/xero-ruby/models/accounting/report_with_rows.rb +25 -11
- data/lib/xero-ruby/models/accounting/reports.rb +25 -11
- data/lib/xero-ruby/models/accounting/request_empty.rb +25 -11
- data/lib/xero-ruby/models/accounting/row_type.rb +1 -2
- data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +25 -11
- data/lib/xero-ruby/models/accounting/schedule.rb +25 -11
- data/lib/xero-ruby/models/accounting/setup.rb +25 -11
- data/lib/xero-ruby/models/accounting/tax_component.rb +25 -11
- data/lib/xero-ruby/models/accounting/tax_rate.rb +25 -11
- data/lib/xero-ruby/models/accounting/tax_rates.rb +25 -11
- data/lib/xero-ruby/models/accounting/tax_type.rb +1 -2
- data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +25 -11
- data/lib/xero-ruby/models/accounting/time_zone.rb +1 -2
- data/lib/xero-ruby/models/accounting/tracking_categories.rb +25 -11
- data/lib/xero-ruby/models/accounting/tracking_category.rb +25 -11
- data/lib/xero-ruby/models/accounting/tracking_option.rb +25 -11
- data/lib/xero-ruby/models/accounting/tracking_options.rb +25 -11
- data/lib/xero-ruby/models/accounting/user.rb +25 -11
- data/lib/xero-ruby/models/accounting/users.rb +25 -11
- data/lib/xero-ruby/models/accounting/validation_error.rb +25 -11
- data/lib/xero-ruby/models/assets/asset.rb +25 -11
- data/lib/xero-ruby/models/assets/asset_status.rb +1 -2
- data/lib/xero-ruby/models/assets/asset_status_query_param.rb +1 -2
- data/lib/xero-ruby/models/assets/asset_type.rb +25 -11
- data/lib/xero-ruby/models/assets/assets.rb +25 -11
- data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +25 -11
- data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +25 -11
- data/lib/xero-ruby/models/assets/error.rb +25 -11
- data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +26 -12
- data/lib/xero-ruby/models/assets/pagination.rb +25 -11
- data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +26 -12
- data/lib/xero-ruby/models/assets/setting.rb +25 -11
- data/lib/xero-ruby/models/files/association.rb +25 -11
- data/lib/xero-ruby/models/files/file_object.rb +25 -11
- data/lib/xero-ruby/models/files/files.rb +25 -11
- data/lib/xero-ruby/models/files/folder.rb +25 -11
- data/lib/xero-ruby/models/files/folders.rb +25 -11
- data/lib/xero-ruby/models/files/object_group.rb +1 -2
- data/lib/xero-ruby/models/files/object_type.rb +1 -2
- data/lib/xero-ruby/models/files/{inline_object.rb → upload_object.rb} +43 -14
- data/lib/xero-ruby/models/files/user.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/account.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/account_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/allowance_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/api_exception.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/bank_account.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/calendar_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/deduction_line.rb +25 -16
- data/lib/xero-ruby/models/payroll_au/deduction_type.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/earnings_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/earnings_type.rb +2 -2
- data/lib/xero-ruby/models/payroll_au/employee.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/employee_status.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/employees.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/employment_basis.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/home_address.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_application.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_applications.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_balance.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/leave_lines.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_period.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/leave_type.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/opening_balances.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/pay_item.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/pay_items.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/pay_run.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/pay_runs.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/pay_template.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payslip.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payslip_lines.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payslip_object.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payslip_summary.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/payslips.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/rate_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/residency_status.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/settings.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/settings_object.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/state.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/super_fund.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/super_fund_product.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/super_fund_products.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/super_funds.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/super_line.rb +26 -12
- data/lib/xero-ruby/models/payroll_au/super_membership.rb +26 -12
- data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/superannuation_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/tax_declaration.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/tax_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/timesheet.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/timesheet_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/timesheet_object.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +1 -2
- data/lib/xero-ruby/models/payroll_au/timesheets.rb +25 -11
- data/lib/xero-ruby/models/payroll_au/validation_error.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/account.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/accounts.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/address.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/bank_account.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/benefit.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/calendar_type.rb +0 -1
- data/lib/xero-ruby/models/payroll_nz/deduction.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/deduction_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/deduction_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/deductions.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/earnings_order.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_orders.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_rates.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_template.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_leaves.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employees.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employment.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/employment_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/invalid_field.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/leave_period.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_periods.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_type.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_type_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/leave_types.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pagination.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_run.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_run_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_runs.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/pay_slips.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/payment_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/payment_method.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/payment_method_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/problem.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/reimbursements.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +28 -13
- data/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/settings.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +0 -1
- data/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/superannuation_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/superannuations.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/tax_code.rb +0 -1
- data/lib/xero-ruby/models/payroll_nz/tax_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/timesheet.rb +28 -13
- data/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +25 -11
- data/lib/xero-ruby/models/payroll_nz/timesheet_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/timesheet_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/timesheets.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/tracking_categories.rb +24 -10
- data/lib/xero-ruby/models/payroll_nz/tracking_category.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/account.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/accounts.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/address.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/bank_account.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/benefit.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/benefit_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/benefit_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/benefits.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/court_order_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/deduction.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/deduction_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/deduction_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/deductions.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_order.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_orders.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +34 -12
- data/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_rates.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_template.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_leaves.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +25 -11
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_tax.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employees.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employment.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/employment_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/invalid_field.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_period.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_periods.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_type.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_type_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/leave_types.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pagination.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_run.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_run_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/pay_runs.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payment_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payment_method.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payment_method_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payslip.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payslip_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/payslips.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/problem.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/reimbursement.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/reimbursements.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +27 -12
- data/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/settings.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +0 -1
- data/lib/xero-ruby/models/payroll_uk/tax_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/timesheet.rb +25 -11
- data/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/timesheet_line.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/timesheet_object.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/timesheets.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/tracking_categories.rb +24 -10
- data/lib/xero-ruby/models/payroll_uk/tracking_category.rb +24 -10
- data/lib/xero-ruby/models/projects/amount.rb +24 -10
- data/lib/xero-ruby/models/projects/charge_type.rb +0 -1
- data/lib/xero-ruby/models/projects/currency_code.rb +0 -1
- data/lib/xero-ruby/models/projects/error.rb +24 -10
- data/lib/xero-ruby/models/projects/pagination.rb +24 -10
- data/lib/xero-ruby/models/projects/project.rb +24 -10
- data/lib/xero-ruby/models/projects/project_create_or_update.rb +24 -10
- data/lib/xero-ruby/models/projects/project_patch.rb +24 -10
- data/lib/xero-ruby/models/projects/project_status.rb +0 -1
- data/lib/xero-ruby/models/projects/project_user.rb +24 -10
- data/lib/xero-ruby/models/projects/project_users.rb +24 -10
- data/lib/xero-ruby/models/projects/projects.rb +24 -10
- data/lib/xero-ruby/models/projects/task.rb +24 -10
- data/lib/xero-ruby/models/projects/task_create_or_update.rb +24 -10
- data/lib/xero-ruby/models/projects/tasks.rb +24 -10
- data/lib/xero-ruby/models/projects/time_entries.rb +24 -10
- data/lib/xero-ruby/models/projects/time_entry.rb +27 -12
- data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +24 -10
- data/lib/xero-ruby/string_serialization.rb +52 -0
- data/lib/xero-ruby/version.rb +3 -3
- data/lib/xero-ruby/where.rb +65 -0
- data/spec/api_client_spec.rb +292 -14
- data/spec/api_error_spec.rb +45 -0
- data/spec/configuration_spec.rb +26 -16
- data/spec/files/models/inline_object_spec.rb +3 -3
- data/spec/helper_methods_spec.rb +110 -0
- data/spec/where_spec.rb +82 -0
- metadata +43 -12
- data/spec/files/models/file_response204_spec.rb +0 -41
@@ -3,7 +3,6 @@
|
|
3
3
|
|
4
4
|
#This is the Xero Projects API
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.6.0
|
7
6
|
Contact: api@xero.com
|
8
7
|
Generated by: https://openapi-generator.tech
|
9
8
|
OpenAPI Generator version: 4.3.1
|
@@ -231,38 +230,53 @@ module XeroRuby::Projects
|
|
231
230
|
|
232
231
|
# Returns the object in the form of hash
|
233
232
|
# @return [Hash] Returns the object in the form of hash
|
234
|
-
def to_hash
|
233
|
+
def to_hash(downcase: false)
|
235
234
|
hash = {}
|
236
235
|
self.class.attribute_map.each_pair do |attr, param|
|
237
236
|
value = self.send(attr)
|
238
237
|
next if value.nil?
|
239
|
-
|
238
|
+
key = downcase ? attr : param
|
239
|
+
hash[key] = _to_hash(value, downcase: downcase)
|
240
240
|
end
|
241
241
|
hash
|
242
242
|
end
|
243
243
|
|
244
|
+
# Returns the object in the form of hash with snake_case
|
245
|
+
def to_attributes
|
246
|
+
to_hash(downcase: true)
|
247
|
+
end
|
248
|
+
|
244
249
|
# Outputs non-array value in the form of hash
|
245
250
|
# For object, use to_hash. Otherwise, just return the value
|
246
251
|
# @param [Object] value Any valid value
|
247
252
|
# @return [Hash] Returns the value in the form of hash
|
248
|
-
def _to_hash(value)
|
253
|
+
def _to_hash(value, downcase: false)
|
249
254
|
if value.is_a?(Array)
|
250
|
-
value.
|
255
|
+
value.map do |v|
|
256
|
+
v.to_hash(downcase: downcase)
|
257
|
+
end
|
251
258
|
elsif value.is_a?(Hash)
|
252
259
|
{}.tap do |hash|
|
253
|
-
value.
|
260
|
+
value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
|
254
261
|
end
|
255
262
|
elsif value.respond_to? :to_hash
|
256
|
-
value.to_hash
|
263
|
+
value.to_hash(downcase: downcase)
|
257
264
|
else
|
258
265
|
value
|
259
266
|
end
|
260
267
|
end
|
261
268
|
|
262
|
-
# customized data_parser
|
263
269
|
def parse_date(datestring)
|
264
|
-
|
265
|
-
|
270
|
+
if datestring.include?('Date')
|
271
|
+
date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
|
272
|
+
original, date, timezone = *date_pattern.match(datestring)
|
273
|
+
date = (date.to_i / 1000)
|
274
|
+
Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
|
275
|
+
elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
|
276
|
+
Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
|
277
|
+
else # handle date 'types' for small subset of payroll API's
|
278
|
+
Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
|
279
|
+
end
|
266
280
|
end
|
267
281
|
end
|
268
282
|
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
module XeroRuby
|
2
|
+
module StringSerialization
|
3
|
+
# START - Re-serializes snake_cased params to PascalCase required by XeroAPI
|
4
|
+
def to_camel_keys(value = self)
|
5
|
+
case value
|
6
|
+
when Array
|
7
|
+
value.map { |v| to_camel_keys(v) }
|
8
|
+
when Hash
|
9
|
+
Hash[value.map { |k, v| [camelize_key(k), to_camel_keys(v)] }]
|
10
|
+
else
|
11
|
+
value
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
def camelize_key(key, first_upper = true)
|
16
|
+
if key.is_a? Symbol
|
17
|
+
camelize(key.to_s, first_upper).to_sym
|
18
|
+
elsif key.is_a? String
|
19
|
+
camelize(key, first_upper)
|
20
|
+
else
|
21
|
+
key # can't camelize anything except strings and symbols
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def camelize(word, first_upper = true)
|
26
|
+
if first_upper
|
27
|
+
str = word.to_s
|
28
|
+
str = gsubbed(str, /(?:^|_)([^_\s]+)/)
|
29
|
+
str = gsubbed(str, %r{/([^/]*)}, "::")
|
30
|
+
str
|
31
|
+
else
|
32
|
+
parts = word.split("_", 2)
|
33
|
+
parts[0] << camelize(parts[1]) if parts.size > 1
|
34
|
+
parts[0] || ""
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
def gsubbed(str, pattern, extra = "")
|
39
|
+
key_map_scronyms = {}
|
40
|
+
str = str.gsub(pattern) do
|
41
|
+
extra + (key_map_scronyms[Regexp.last_match(1)] || capitalize_first(Regexp.last_match(1)))
|
42
|
+
end
|
43
|
+
str
|
44
|
+
end
|
45
|
+
|
46
|
+
def capitalize_first(word)
|
47
|
+
split = word.split('')
|
48
|
+
"#{split[0].capitalize}#{split[1..-1].join}"
|
49
|
+
end
|
50
|
+
# END - Re-serializes snake_cased params to PascalCase required by XeroAPI
|
51
|
+
end
|
52
|
+
end
|
data/lib/xero-ruby/version.rb
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
=begin
|
2
|
-
#Accounting API
|
2
|
+
#Xero Accounting API
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.6.0
|
7
6
|
Contact: api@xero.com
|
8
7
|
Generated by: https://openapi-generator.tech
|
9
8
|
OpenAPI Generator version: 4.3.1
|
10
9
|
|
10
|
+
The version of the XeroOpenAPI document: 2.13.2
|
11
11
|
=end
|
12
12
|
|
13
13
|
module XeroRuby
|
14
|
-
VERSION = '2.
|
14
|
+
VERSION = '3.2.1'
|
15
15
|
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
module XeroRuby
|
2
|
+
class Where
|
3
|
+
include StringSerialization
|
4
|
+
|
5
|
+
UUID_REGEXP = /\A[0-9a-f]{8}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{12}\Z/i
|
6
|
+
STRING_FUNCTIONS = %w(Contains StartsWith EndsWith)
|
7
|
+
|
8
|
+
attr_reader :where_opts
|
9
|
+
|
10
|
+
def initialize(where_opts)
|
11
|
+
@where_opts = where_opts
|
12
|
+
end
|
13
|
+
|
14
|
+
def to_param
|
15
|
+
where_opts.map { |key, value| parameterize_option(key, value) }.join(' AND ')
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
|
20
|
+
def parameterize_option(key, value)
|
21
|
+
quoted_key = quote_key(key)
|
22
|
+
|
23
|
+
case value
|
24
|
+
when Array
|
25
|
+
operator, query = value
|
26
|
+
|
27
|
+
if STRING_FUNCTIONS.include?(camelize_key(operator))
|
28
|
+
"#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
|
29
|
+
else
|
30
|
+
"#{quoted_key} #{operator} #{quote_value(query)}"
|
31
|
+
end
|
32
|
+
when Range
|
33
|
+
"#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
|
34
|
+
when /^\./
|
35
|
+
"#{quoted_key}#{value}"
|
36
|
+
else
|
37
|
+
"#{quoted_key} #{value}"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def quote_key(key)
|
42
|
+
case key
|
43
|
+
when :contact_id
|
44
|
+
'Contact.ContactID'
|
45
|
+
when :contact_number
|
46
|
+
'Contact.ContactNumber'
|
47
|
+
else
|
48
|
+
camelize_key(key)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def quote_value(value)
|
53
|
+
case value
|
54
|
+
when DateTime, Date, Time
|
55
|
+
"DateTime(#{value.strftime("%Y,%m,%d")})"
|
56
|
+
when Numeric, false, true
|
57
|
+
value.to_s
|
58
|
+
when UUID_REGEXP
|
59
|
+
%{guid("#{value}")}
|
60
|
+
else
|
61
|
+
%{"#{value.to_s.gsub('"', '""')}"}
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
data/spec/api_client_spec.rb
CHANGED
@@ -1,20 +1,8 @@
|
|
1
|
-
|
2
|
-
#Accounting API
|
3
|
-
|
4
|
-
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 2.1.3
|
7
|
-
Contact: api@xero.com
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 4.3.0
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require './spec_helper'
|
1
|
+
require 'spec_helper'
|
14
2
|
|
15
3
|
describe XeroRuby::ApiClient do
|
16
4
|
context 'initialization' do
|
17
|
-
context 'URL
|
5
|
+
context 'URL config' do
|
18
6
|
context 'host' do
|
19
7
|
it 'removes http from host' do
|
20
8
|
XeroRuby.configure { |c| c.host = 'http://example.com' }
|
@@ -48,6 +36,158 @@ describe XeroRuby::ApiClient do
|
|
48
36
|
expect(XeroRuby::Configuration.default.base_path).to eq('')
|
49
37
|
end
|
50
38
|
end
|
39
|
+
|
40
|
+
context "creates a valid authorization_url" do
|
41
|
+
it "passes through attributes" do
|
42
|
+
creds = {
|
43
|
+
client_id: 'abc',
|
44
|
+
client_secret: '123',
|
45
|
+
redirect_uri: 'https://mydomain.com/callback',
|
46
|
+
scopes: 'openid profile email accounting.transactions accounting.settings',
|
47
|
+
state: 'i-am-customer-state'
|
48
|
+
}
|
49
|
+
api_client = XeroRuby::ApiClient.new(credentials: creds)
|
50
|
+
expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https%3A%2F%2Fmydomain.com%2Fcallback&scope=openid+profile+email+accounting.transactions+accounting.settings&state=i-am-customer-state')
|
51
|
+
end
|
52
|
+
|
53
|
+
it "Does not append state if it is not provided" do
|
54
|
+
creds = {
|
55
|
+
client_id: 'abc',
|
56
|
+
client_secret: '123',
|
57
|
+
redirect_uri: 'https://mydomain.com/callback',
|
58
|
+
scopes: 'openid profile email accounting.transactions accounting.settings'
|
59
|
+
}
|
60
|
+
api_client = XeroRuby::ApiClient.new(credentials: creds)
|
61
|
+
expect(api_client.authorization_url).to eq('https://login.xero.com/identity/connect/authorize?response_type=code&client_id=abc&redirect_uri=https%3A%2F%2Fmydomain.com%2Fcallback&scope=openid+profile+email+accounting.transactions+accounting.settings')
|
62
|
+
end
|
63
|
+
|
64
|
+
it "Validates state on callback matches @config.state" do
|
65
|
+
creds = {
|
66
|
+
client_id: 'abc',
|
67
|
+
client_secret: '123',
|
68
|
+
redirect_uri: 'https://mydomain.com/callback',
|
69
|
+
scopes: 'openid profile email accounting.transactions accounting.settings',
|
70
|
+
state: "custom-state"
|
71
|
+
}
|
72
|
+
api_client = XeroRuby::ApiClient.new(credentials: creds)
|
73
|
+
altered_state = {'state': 'not-original-state'}
|
74
|
+
expect{api_client.validate_state(altered_state)}.to raise_error(StandardError, 'WARNING: @config.state: custom-state and OAuth callback state: do not match!')
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
context "Creates a valid client_credentials client" do
|
79
|
+
|
80
|
+
it "But still defaults to grant_type: authorization_code" do
|
81
|
+
creds = {
|
82
|
+
client_id: 'abc',
|
83
|
+
client_secret: '123',
|
84
|
+
}
|
85
|
+
api_client = XeroRuby::ApiClient.new(credentials: creds)
|
86
|
+
expect(api_client.grant_type).to eq('authorization_code')
|
87
|
+
end
|
88
|
+
|
89
|
+
it "Sets grant_type correctly" do
|
90
|
+
creds = {
|
91
|
+
client_id: 'abc',
|
92
|
+
client_secret: '123',
|
93
|
+
grant_type: 'client_credentials'
|
94
|
+
}
|
95
|
+
api_client = XeroRuby::ApiClient.new(credentials: creds)
|
96
|
+
expect(api_client.grant_type).to eq('client_credentials')
|
97
|
+
end
|
98
|
+
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
describe 'api_client helper functions' do
|
104
|
+
let(:api_client) { XeroRuby::ApiClient.new }
|
105
|
+
let(:token_set) { {'access_token': 'eyx.authorization.data', 'id_token': 'eyx.authentication.data', 'refresh_token': 'REFRESHMENTS'} }
|
106
|
+
let(:connections) {
|
107
|
+
[{
|
108
|
+
"id" => "xxx-yyy-zzz",
|
109
|
+
"tenantId" => "xxx-yyy-zzz",
|
110
|
+
"tenantType" => "ORGANISATION",
|
111
|
+
"tenantName" => "Demo Company (US)",
|
112
|
+
"createdDateUtc" => "2019-11-01T20:08:03.0766400",
|
113
|
+
"updatedDateUtc" => "2020-04-15T22:37:10.4943410"
|
114
|
+
}]
|
115
|
+
}
|
116
|
+
|
117
|
+
before do
|
118
|
+
allow(api_client).to receive(:token_request).and_return(token_set)
|
119
|
+
end
|
120
|
+
|
121
|
+
it "#set_token_set" do
|
122
|
+
api_client.set_token_set(token_set)
|
123
|
+
expect(api_client.token_set).to eq(token_set.with_indifferent_access)
|
124
|
+
end
|
125
|
+
|
126
|
+
it "#set_access_token" do
|
127
|
+
api_client.set_access_token(token_set['access_token'])
|
128
|
+
expect(api_client.access_token).to eq(token_set['access_token'])
|
129
|
+
end
|
130
|
+
|
131
|
+
it "#set_id_token" do
|
132
|
+
api_client.set_id_token(token_set['id_token'])
|
133
|
+
expect(api_client.id_token).to eq(token_set['id_token'])
|
134
|
+
end
|
135
|
+
|
136
|
+
it "#refresh_token_set" do
|
137
|
+
expect(api_client.refresh_token_set(token_set)).to eq(token_set)
|
138
|
+
end
|
139
|
+
|
140
|
+
it "#connections" do
|
141
|
+
expect(api_client).to receive(:call_api).and_return(connections)
|
142
|
+
expect(api_client.config.base_url).to eq(nil)
|
143
|
+
expect(api_client.connections).to eq(connections[0])
|
144
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com')
|
145
|
+
end
|
146
|
+
|
147
|
+
it "#disconnect" do
|
148
|
+
expect(api_client).to receive(:call_api).and_return(connections)
|
149
|
+
expect(api_client).to receive(:connections).and_return(connections[0])
|
150
|
+
expect(api_client.disconnect(connections[0]['id'])).to eq(connections[0])
|
151
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com')
|
152
|
+
end
|
153
|
+
|
154
|
+
it "sets and resets the base url based on endpoint usage of the same client" do
|
155
|
+
expect(api_client).to receive(:call_api).and_return(connections)
|
156
|
+
|
157
|
+
api_client.accounting_api
|
158
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/api.xro/2.0')
|
159
|
+
|
160
|
+
api_client.asset_api
|
161
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/assets.xro/1.0')
|
162
|
+
|
163
|
+
api_client.project_api
|
164
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/projects.xro/2.0/')
|
165
|
+
|
166
|
+
api_client.files_api
|
167
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/files.xro/1.0/')
|
168
|
+
|
169
|
+
api_client.payroll_au_api
|
170
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/1.0/')
|
171
|
+
|
172
|
+
api_client.payroll_nz_api
|
173
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/2.0/')
|
174
|
+
|
175
|
+
api_client.payroll_uk_api
|
176
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com/payroll.xro/2.0/')
|
177
|
+
|
178
|
+
api_client.connections
|
179
|
+
expect(api_client.config.base_url).to eq('https://api.xero.com')
|
180
|
+
end
|
181
|
+
|
182
|
+
it "does not mutate the original opts hash" do
|
183
|
+
expect(api_client).to receive(:call_api).and_return('')
|
184
|
+
opts = {
|
185
|
+
where: {
|
186
|
+
invoice_number: ['=', "INV-0060"]
|
187
|
+
}
|
188
|
+
}
|
189
|
+
api_client.accounting_api.get_invoices('active_tenant_id', opts)
|
190
|
+
expect(opts).to eq({:where=>{:invoice_number=>["=", "INV-0060"]}})
|
51
191
|
end
|
52
192
|
end
|
53
193
|
|
@@ -272,4 +412,142 @@ describe XeroRuby::ApiClient do
|
|
272
412
|
expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
|
273
413
|
end
|
274
414
|
end
|
415
|
+
|
416
|
+
describe 'token helper methods' do
|
417
|
+
let(:api_client) { XeroRuby::ApiClient.new }
|
418
|
+
let(:id_token){'eyJhbGciOiJSUzI1NiIsImtpZCI6IjFDQUY4RTY2NzcyRDZEQzAyOEQ2NzI2RkQwMjYxNTgxNTcwRUZDMTkiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJISy1PWm5jdGJjQW8xbkp2MENZVmdWY09fQmsifQ.eyJuYmYiOjE2MTk3MTQwNDMsImV4cCI6MTYxOTcxNDM0MywiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS54ZXJvLmNvbSIsImF1ZCI6IkFEQjVBNzdEQTZCNjRFOTI4RDg0MDkwOTlBMzlDQTdCIiwiaWF0IjoxNjE5NzE0MDQzLCJhdF9oYXNoIjoiMXJNamVvUTJiOUxUNFU0ZlBXbEZJZyIsInNpZCI6ImY0YTY4ZDc0ZmM3OTQzMjc4YTgzMTg0NGM5ZWRmNzFiIiwic3ViIjoiZGI0ZjBmMzdiNTg1NTMwZTkxZjNiOWNiYjUwMzQwZTgiLCJhdXRoX3RpbWUiOjE2MTk3MTM5ODcsInhlcm9fdXNlcmlkIjoiZmFhODNlYzktZjZhNy00ODlmLTg5MTEtZTNmY2UwM2ExMTg2IiwiZ2xvYmFsX3Nlc3Npb25faWQiOiJmNGE2OGQ3NGZjNzk0MzI3OGE4MzE4NDRjOWVkZjcxYiIsInByZWZlcnJlZF91c2VybmFtZSI6ImNocmlzLmtuaWdodEB4ZXJvLmNvbSIsImVtYWlsIjoiY2hyaXMua25pZ2h0QHhlcm8uY29tIiwiZ2l2ZW5fbmFtZSI6IkNocmlzdG9waGVyIiwiZmFtaWx5X25hbWUiOiJLbmlnaHQifQ.hF04tCE1Qd-al355fQyCjWqTVWKnguor4RD1sC7rKH7zV3r3_nGwnGLMm2A96fov06fig0zusTX8onev0qFLZy-jlEXDp1f19LHhT15sBy0KH6dB0lGMrM14BnDuEP4NUGeP06nAPhQHHLw2oCc9hzYXorRVOSFDw43jgAC0vxRgDvJwgKgv6TDVEmpvwP0S4R7A0VbnFemHP_HY8gLHd7RpN7rrYmpJC4cofztdptDNLTF8Qup8qVlFdQgpJPQEQ95N1m6W-unvrh_dlO6AVMjXBjC1BJ10IGzoCCr8DSVyz2UMPnUT3oIYFVTlDc2K-ZJYkW86pigITMCdvR1hKg'}
|
419
|
+
let(:access_token){'eyJhbGciOiJSUzI1NiIsImtpZCI6IjFDQUY4RTY2NzcyRDZEQzAyOEQ2NzI2RkQwMjYxNTgxNTcwRUZDMTkiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJISy1PWm5jdGJjQW8xbkp2MENZVmdWY09fQmsifQ.eyJuYmYiOjE2MTk3MTQwNDMsImV4cCI6MTYxOTcxNTg0MywiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS54ZXJvLmNvbSIsImF1ZCI6Imh0dHBzOi8vaWRlbnRpdHkueGVyby5jb20vcmVzb3VyY2VzIiwiY2xpZW50X2lkIjoiQURCNUE3N0RBNkI2NEU5MjhEODQwOTA5OUEzOUNBN0IiLCJzdWIiOiJkYjRmMGYzN2I1ODU1MzBlOTFmM2I5Y2JiNTAzNDBlOCIsImF1dGhfdGltZSI6MTYxOTcxMzk4NywieGVyb191c2VyaWQiOiJmYWE4M2VjOS1mNmE3LTQ4OWYtODkxMS1lM2ZjZTAzYTExODYiLCJnbG9iYWxfc2Vzc2lvbl9pZCI6ImY0YTY4ZDc0ZmM3OTQzMjc4YTgzMTg0NGM5ZWRmNzFiIiwianRpIjoiZmFmNGNkYzQ5MjM0YzhmZDE0OTA0ZjRlOWEyMWY4YmYiLCJhdXRoZW50aWNhdGlvbl9ldmVudF9pZCI6IjI0MmRjNWIyLTIwZTMtNGFjNS05NjU3LWExMGI5ZTI0ZGI1NSIsInNjb3BlIjpbImVtYWlsIiwicHJvZmlsZSIsIm9wZW5pZCIsImFjY291bnRpbmcucmVwb3J0cy5yZWFkIiwiZmlsZXMiLCJwYXlyb2xsLmVtcGxveWVlcyIsInBheXJvbGwucGF5cnVucyIsInBheXJvbGwucGF5c2xpcCIsInBheXJvbGwudGltZXNoZWV0cyIsInByb2plY3RzLnJlYWQiLCJwcm9qZWN0cyIsImFjY291bnRpbmcuc2V0dGluZ3MiLCJhY2NvdW50aW5nLmF0dGFjaG1lbnRzIiwiYWNjb3VudGluZy50cmFuc2FjdGlvbnMiLCJhY2NvdW50aW5nLmpvdXJuYWxzLnJlYWQiLCJhc3NldHMucmVhZCIsImFzc2V0cyIsImFjY291bnRpbmcuY29udGFjdHMiLCJwYXlyb2xsLnNldHRpbmdzIiwib2ZmbGluZV9hY2Nlc3MiXX0.vNV-YsgHFWKFBmyYdhg7tztdsPc9ykObadQcGFoFXJ8qCBerR3h7XXKzWAP3KzFzhOCcIpWU8Q081zuYBNxahPeeLRLUuc_3MwgwE72esE5vGuxa2_-_QidtNvMCgsX-ie_LcX7FE_KI-sXB_EZ8fDk6WAMIPC9d3GejgeuH5Uh6rZkhowN2jm5pZjEOEy_QE7PScBO0XEbiZNUsarvBUSdKuSTvVVLHzHzs0bHMRfgKEkqZySNtZlac-oyaL3PVba1S7A_vbRcNWpYR_VrKGf2g9LHSI3EA5j3Beto4pKukU-bk6rLBGul37u4tM17U-wyJLsFmt6ZC_SEJKgmluQ'}
|
420
|
+
let(:tkn_set) {{'id_token': id_token, 'access_token': access_token, 'refresh_token': 'abc123xyz'}}
|
421
|
+
|
422
|
+
before do
|
423
|
+
api_client.set_token_set(tkn_set)
|
424
|
+
end
|
425
|
+
|
426
|
+
it '#token_expired? for an expired token' do
|
427
|
+
expect(api_client.token_expired?).to eq(true)
|
428
|
+
end
|
429
|
+
|
430
|
+
it '#token_expired? for a just expired token' do
|
431
|
+
allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>Time.now.to_i})
|
432
|
+
expect(api_client.token_expired?).to eq(true)
|
433
|
+
end
|
434
|
+
|
435
|
+
it '#token_expired? for a non-expired token' do
|
436
|
+
allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>(Time.now + 30.minutes).to_i})
|
437
|
+
expect(api_client.token_expired?).to eq(false)
|
438
|
+
end
|
439
|
+
|
440
|
+
it '#token_expired? for an almost expired token' do
|
441
|
+
allow(api_client).to receive(:decoded_access_token).and_return({"exp"=>(Time.now + 30.seconds).to_i})
|
442
|
+
expect(api_client.token_expired?).to eq(false)
|
443
|
+
end
|
444
|
+
|
445
|
+
it '#validate_tokens' do
|
446
|
+
expect(api_client.validate_tokens(tkn_set)).to eq(true)
|
447
|
+
end
|
448
|
+
it '#access_token' do
|
449
|
+
expect(api_client.access_token).to eq(access_token)
|
450
|
+
end
|
451
|
+
it '#decoded_access_token' do
|
452
|
+
expect(api_client.decoded_access_token['aud']).to eq("https://identity.xero.com/resources")
|
453
|
+
end
|
454
|
+
it '#id_token' do
|
455
|
+
expect(api_client.id_token).to eq(tkn_set[:id_token])
|
456
|
+
end
|
457
|
+
it '#decoded_id_token' do
|
458
|
+
expect(api_client.decoded_id_token['email']).to eq('chris.knight@xero.com')
|
459
|
+
end
|
460
|
+
|
461
|
+
it 'decoding an invalid access_token' do
|
462
|
+
api_client.set_access_token("#{access_token}.NotAValidJWTstring")
|
463
|
+
expect{api_client.decoded_access_token}.to raise_error(JSON::JWT::InvalidFormat)
|
464
|
+
end
|
465
|
+
|
466
|
+
it 'decoding an invalid id_token' do
|
467
|
+
api_client.set_id_token("#{id_token}.NotAValidJWTstring")
|
468
|
+
expect{api_client.decoded_id_token}.to raise_error(JSON::JWT::InvalidFormat)
|
469
|
+
end
|
470
|
+
end
|
471
|
+
|
472
|
+
|
473
|
+
describe 'thread safety in the XeroClient' do
|
474
|
+
let(:creds) {{
|
475
|
+
client_id: 'abc',
|
476
|
+
client_secret: '123',
|
477
|
+
redirect_uri: 'https://mydomain.com/callback',
|
478
|
+
scopes: 'openid profile email accounting.transactions'
|
479
|
+
}}
|
480
|
+
let(:api_client_1) {XeroRuby::ApiClient.new(credentials: creds)}
|
481
|
+
let(:api_client_2) {XeroRuby::ApiClient.new(credentials: creds)}
|
482
|
+
let(:api_client_3) {XeroRuby::ApiClient.new(credentials: creds)}
|
483
|
+
|
484
|
+
let(:tkn_set_1){{'id_token': "abc.123.1", 'access_token': "xxx.yyy.zzz.111"}}
|
485
|
+
let(:tkn_set_2){{'id_token': "efg.456.2", 'access_token': "xxx.yyy.zzz.222"}}
|
486
|
+
|
487
|
+
describe 'when configuration is changed, other instantiations of the client are not affected' do
|
488
|
+
it 'applies to #set_access_token' do
|
489
|
+
expect(api_client_1.access_token).to eq(nil)
|
490
|
+
expect(api_client_2.access_token).to eq(nil)
|
491
|
+
expect(api_client_3.access_token).to eq(nil)
|
492
|
+
|
493
|
+
api_client_1.set_access_token("ACCESS_TOKEN_1")
|
494
|
+
expect(api_client_1.access_token).to eq("ACCESS_TOKEN_1")
|
495
|
+
expect(api_client_2.access_token).to eq(nil)
|
496
|
+
expect(api_client_3.access_token).to eq(nil)
|
497
|
+
|
498
|
+
api_client_2.set_access_token("ACCESS_TOKEN_2")
|
499
|
+
expect(api_client_1.access_token).to eq("ACCESS_TOKEN_1")
|
500
|
+
expect(api_client_2.access_token).to eq("ACCESS_TOKEN_2")
|
501
|
+
expect(api_client_3.access_token).to eq(nil)
|
502
|
+
|
503
|
+
api_client_3.set_access_token("ACCESS_TOKEN_3")
|
504
|
+
expect(api_client_1.access_token).to eq("ACCESS_TOKEN_1")
|
505
|
+
expect(api_client_2.access_token).to eq("ACCESS_TOKEN_2")
|
506
|
+
expect(api_client_3.access_token).to eq("ACCESS_TOKEN_3")
|
507
|
+
end
|
508
|
+
|
509
|
+
it 'applies to #set_id_token' do
|
510
|
+
expect(api_client_1.id_token).to eq(nil)
|
511
|
+
expect(api_client_2.id_token).to eq(nil)
|
512
|
+
|
513
|
+
api_client_1.set_id_token("id_token_1")
|
514
|
+
expect(api_client_1.id_token).to eq("id_token_1")
|
515
|
+
expect(api_client_2.id_token).to eq(nil)
|
516
|
+
|
517
|
+
api_client_2.set_id_token("id_token_2")
|
518
|
+
expect(api_client_1.id_token).to eq("id_token_1")
|
519
|
+
expect(api_client_2.id_token).to eq("id_token_2")
|
520
|
+
end
|
521
|
+
|
522
|
+
it 'applies to #set_token_set' do
|
523
|
+
expect(api_client_1.token_set).to eq(nil)
|
524
|
+
expect(api_client_2.token_set).to eq(nil)
|
525
|
+
|
526
|
+
api_client_1.set_token_set(tkn_set_1)
|
527
|
+
expect(api_client_1.token_set).to eq(tkn_set_1.with_indifferent_access)
|
528
|
+
expect(api_client_2.token_set).to eq(nil)
|
529
|
+
|
530
|
+
api_client_2.set_token_set(tkn_set_2)
|
531
|
+
expect(api_client_1.token_set).to eq(tkn_set_1.with_indifferent_access)
|
532
|
+
expect(api_client_2.token_set).to eq(tkn_set_2.with_indifferent_access)
|
533
|
+
end
|
534
|
+
|
535
|
+
it 'applies to #base_url' do
|
536
|
+
expect(api_client_1.config.base_url).to eq(nil)
|
537
|
+
expect(api_client_2.config.base_url).to eq(nil)
|
538
|
+
|
539
|
+
api_client_1.accounting_api
|
540
|
+
expect(api_client_1.config.base_url).to eq(api_client_1.config.accounting_url)
|
541
|
+
expect(api_client_2.config.base_url).to eq(nil)
|
542
|
+
|
543
|
+
api_client_2.files_api
|
544
|
+
expect(api_client_1.config.base_url).to eq(api_client_1.config.accounting_url)
|
545
|
+
expect(api_client_2.config.base_url).to eq(api_client_1.config.files_url)
|
546
|
+
|
547
|
+
api_client_2.project_api
|
548
|
+
expect(api_client_1.config.base_url).to eq(api_client_1.config.accounting_url)
|
549
|
+
expect(api_client_2.config.base_url).to eq(api_client_1.config.project_url)
|
550
|
+
end
|
551
|
+
end
|
552
|
+
end
|
275
553
|
end
|