eol-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9ca2c43af778808a2e4726db835f1f4f696473a100ffc3bb7b980e568df4cbd
+  data.tar.gz: 8ddacb7b932ff7162ef6e7a24ad14dde73e60d02944ccbcf0b6c932edfaede0b
+SHA512:
+  metadata.gz: ea4d653b89271be4b224912da05d3481e284db13707199ff1a571af10501d165dfff85fe26581672024774150b9ed29aecca15d4033e6f0149c6fdb690ee6366
+  data.tar.gz: 706b7cbb0c64759e603565ef89b82c307498f2dad72161eaa1b3935cb938620a4d66b825de7341e66c3ef866404d7b70134d7d0414ce45e7c272cf297c63b6de

data/.drone.yaml

@@ -0,0 +1,12 @@
+cache:
+  mount:
+    - bundler
+build:
+  image: ruby:2.2.3
+  cache:
+    - bundler
+  commands:
+    - apt-get update -qq
+    - apt-get install -y -qq build-essential &>/dev/null
+    - bundle install --jobs $(nproc) --path bundler
+    - ./script/ci

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.env
+.log
+*.gem
+*.swp
+.idea
+*.iml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,60 @@
+Documentation:
+  Enabled: false
+
+Lint/UriEscapeUnescape:
+  Enabled: false
+
+NAming/FileName:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'spec/**/*'
+    - 'config/**/*'
+
+Metrics/AbcSize:
+  Max: 30
+Metrics/BlockNesting:
+  Max: 3
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+Metrics/CyclomaticComplexity:
+  Max: 6
+Metrics/LineLength:
+  Max: 150
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 13
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 7
+Style/PerlBackrefs:
+  Enabled: false
+Lint/AmbiguousOperator:
+  Enabled: false
+Rails/Delegate:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.5.1
+cache: bundler
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/fe18055a45cdf1a5ecae
+    on_success: change
+    on_failure: always
+    on_start: never

data/Changelog.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- First release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in eol.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end
+
+guard :rubocop, all_on_start: false, cli: ["--format", "clang", "--rails"] do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+  watch("spec/spec_helper.rb")
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [2018] [Hoppinger]
+
+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,247 @@
+# Eol
+
+Eol stand for ExactOnline, it's just an API wrapper for [Exact Online](https://developers.exactonline.com/).
+
+# DISCLAIMER
+
+__As of 25th of May, 2FA will be mandatory for all Exact Online accounts. Therefor the auto authorize method with which you could simulate an App 2 App connection will not work anymore. Hoppinger is working on a new solution. The methods will stay available but probably won't work and will show a deprecation warning. [Read more about it here](https://support.exactonline.com/community/s/knowledge-base#All-All-HNO-Concept-general-security-gen-auth-totpc)__
+
+### Contributors
+
+* [Ahmad](https://github.com/ahmadhasankhan)
+
+Thanks for helping! If you want to contribute read through this readme how to!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eol-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Eol
+
+## Authorization and Setup
+
+You have to have an Exact Online account and an app setup to connect with.
+
+You have to set a few variables to make a connection possible. I'd suggest using environment variables set with [dotenv](https://github.com/bkeepers/dotenv) for that.
+
+Then configure Eol like this (take these values from your app that you setup at apps.exactonline.com)
+
+```ruby
+Eol.configure do |config|
+  config.client_id = ENV['CLIENT_ID']
+  config.client_secret = ENV['CLIENT_SECRET']
+  config.redirect_uri = ENV['REDIRECT_URI']
+end
+```
+
+You then have to retrieve an access token for the user you want to login with. You can setup a user facing OAUTH2 flow or set the `access_token` and/or refresh token on the go.
+
+```ruby
+Eol.configure do |config|
+  config.access_token = "42"
+  config.refresh_token = "42"
+end
+```
+
+Once you've set your access tokens you should be able to do requests. You'll need a division number, you can retrieve that with the following line of code:
+
+```
+get("/Current/Me", no_division: true).results.first.current_division
+```
+
+
+### Logger
+
+The default logger is STDOUT. A custom logger can be be configured.
+
+```ruby
+  dir = File.dirname("./tmp/errors.log")
+  FileUtils.mkdir_p(dir) unless File.directory?(dir)
+
+  Eol.configure do |config|
+    config.logger = ::Logger.new("./tmp/errors.log", "daily")
+  end
+```
+
+## Accessing the API
+
+We can retrieve data from the API using the following syntax.
+
+The query will return an `Eol::ResultSet` which contains up to 60 records and
+a method to retrieve the next page of results. Unfortunately the ExactOnline API
+does not allow us to retrieve a specific page or define how many records we want
+to retrieve at a time.
+
+```ruby
+# Query the API and return an Eol::ResultSet
+accounts = Eol::Account.new.find_all
+
+# Return an array of accounts
+accounts.records
+```
+
+If the query results in more than 60 records the next set can be retrieved using
+the `next_page` method.
+
+```ruby
+# Return an Eol::ResultSet containing the next page's records
+accounts.next_page
+```
+
+### Filter and sort results
+
+Filtering result sets can be done by adding attributes to the initializer and then
+using `find_by`. Filters accept a single value or an array of values.
+
+```ruby
+# Find the account with code 123
+accounts = Eol::Account.new(code: '123').find_by(filters: [:code])
+
+# Find the accounts with code 123 and 345
+accounts = Eol::Account.new(code: ['123', '345']).find_by(filters: [:code])
+```
+
+You can also match on values "greater than" or "less than" by specifying `gt` or `lt`:
+
+```ruby
+# Find all AgingReceivables with an amount greater than 0 in the third age range
+Eol::AgingReceivablesList.new(age_group3_amount: { gt: 0 }).find_by(filters: [:age_group3_amount])
+```
+
+Results can be sorted in the same way
+
+```ruby
+# Return all accounts sorted by first name
+accounts = Eol::Account.new.find_all(order_by: :first_name)
+```
+
+Filters and sorting can also be combined
+
+```ruby
+# Return accounts with code 123 and 345 sorted by first name
+accounts = Eol::Account.new(code: ['123', '345']).find_by(filters: [:code], order_by: :first_name)
+```
+
+To find an individual record by its ID the `find` method can be used
+
+```ruby
+# Return the account with guid
+account = Eol::Account.new(id: '9e3a078e-55dc-40f4-a490-1875400a3e10').find
+```
+
+For more information on this way of selecting data look here http://www.odata.org/
+
+### Creating new records
+
+Use the initializer method followed by 'save' to create a new record:
+
+```ruby
+# Create a new contact
+contact = Eol::Contact.new(first_name: "Karel", last_name: "Appel", account: "8d87c8c5-f1c6-495c-b6af-d5ba396873b5"  )
+contact.save
+```
+
+### Projects and Time Tracking
+
+Project Types:
+
+- :type=>2, :type_description=>"Fixed price"
+- :type=>3, :type_description=>"Time and Material"
+- :type=>4, :type_description=>"Non billable"
+- :type=>5, :type_description=>"Prepaid"
+
+To create a new project
+
+```ruby
+project = Eol::Project.new(code: "PROJ902343", description: "Great project", account: "8d87c8c5-f1c6-495c-b6af-d5ba396873b5", type: 2 )
+project.save
+```
+
+To submit a new time transaction
+
+```ruby
+hours = Eol::TimeTransaction.new(account: "8d87c8c5-f1c6-495c-b6af-d5ba396873b5", item: "eb73942a-53c0-4ee9-bbb2-6d985814a1b1", quantity: 3.0, notes: "")
+hours.save
+```
+
+### SalesInvoice flow
+SalesInvoices have a relationship with SalesInvoiceLines. A SalesInvoice has many
+SalesInvoiceLines and a SalesInvoiceLine belongs to a SalesInvoice. To create a
+valid SalesInvoice you need to embed the SalesInvoiceLines
+
+```ruby
+sales_invoice = Eol::SalesInvoice.new(journal: "id of your journal", ordered_by: "id of customer")
+```
+Now it still needs SalesInvoiceLines
+
+```ruby
+sales_invoice_lines = []
+sales_invoice_lines << Eol::SalesInvoiceLine.new(item: "id of item being sold") # do this for each item you want in the invoice.
+sales_invoice.sales_invoice_lines = sales_invoice_lines
+```
+Now you can save the SalesInvoice and it will be parsed to the following
+```ruby
+sales_invoice.save
+# Sanitized object: {"Journal"=>"id of your journal", "OrderedBy"=>"id of customer", "SalesInvoiceLines"=>[{"Item"=>"id of item being sold"}]}
+```
+
+If you have a SalesInvoice with an id(so saved before already), you can also create invoice lines without embedding
+
+```ruby
+sales_invoice = Eol::SalesInvoice.new({id: "1"}).first
+sales_invoice_line = Eol::SalesInvoiceLine.new(invoice_ID: sales_invoice, item: "42")
+sales_invoice.save
+# Sanitized object: {"Item"=>"42", "InvoiceID"=>"1"}
+```
+
+For many resources there are mandatory attributes, you can see that in the classes
+for every resource. For example for Contact: https://github.com/exactonline/exactonline-api-ruby-client/blob/master/lib/Eol/resources/contact.rb
+
+###Divisions and Endpoints
+
+Usually in the exact wrapper you need a division number, this one will be set on authorization checks (with `/Current/Me` endpoint). Sometimes you need to do a request without the division number, or even without the standard `/api/v1` endpoint. Like so:
+
+```ruby
+response = Eol.get('/api/oauth2/token', no_endpoint: true, no_division: true)
+response = Eol.get('/Current/Me', no_division: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/eol/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Testing
+
+We use Rspec for normal unit testing. We aim for coverage above 90%. Also the current suite should succeed when you commit something.
+We use Rubocop for style checking, this should also succeed before you commit anything.
+
+We're also experimenting with Mutation testing, which alters your code to test if your specs fail when there's faulty code. This is important when you
+alter a vital part of the code, make sure the mutation percentage is higher than 80%. To run a part of the code with mutant run the follwing
+`mutant --include lib/Eol --require Eol --use rspec Eol::ClassYoureWorkingOn`
+
+To test the vital classes run this
+`mutant --include lib --require Eol --use rspec Eol::Response Eol::Client Eol::Utils Eol::Resource Eol::Request Eol::Parser Eol::Config`
+This will take a few minutes
+
+When you're editing code it's advised you run guard, which watches file changes and automatically runs Rspec and Rubocop.
+

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task :rspec do
+  sh "rspec"
+end
+
+task :rubocop do
+  sh "rubocop"
+end
+
+task default: %i[rspec]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eol"
+
+# 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"
+require "dotenv"
+Dotenv.load
+IRB.start