README.md in economic-rest-0.3.6 vs README.md in economic-rest-0.4.0
- old
+ new
@@ -1,8 +1,8 @@
# Economic::Rest
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/economic/rest`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://semaphoreci.com/api/v1/traels-it/economic-rest/branches/master/badge.svg)](https://semaphoreci.com/traels-it/economic-rest)
Ruby wrapper for the e-conomic REST API, that aims at making working with the API bearable.
E-conomic is a web-based accounting system. For their marketing speak, see http://www.e-conomic.co.uk/about/. More details about their API at http://www.e-conomic.co.uk/integration/integration-partner/'.
The documentation can be found at https://restdocs.e-conomic.com
@@ -23,36 +23,43 @@
$ gem install economic-rest
## Usage
+```ruby
require 'economic/rest'
Economic::Demo.hello
+```
Filter text can be added to the all query to avoid getting everything. e.g. a method for finding an accounting year for a specific date
+```ruby
def get_accounting_year(date)
Economic::AccountingYearRepo.all(filter_text: "toDate$gte:#{date}$and:fromDate$lte:#{date}")
end
+```
note: you need to use Lower Camel Case for variable names.
-Filter Operators
+### Filter Operators
+
The allowed filtering operators are:
-Operator Syntax
-Equals “$eq:”
-Not equals “$ne:”
-Greater than “$gt:”
-Greater than or equal “$gte:”
-Less than “$lt:”
-Less than or equal “$lte:”
-Substring match “$like:”
-And also “$and:”
-Or else “$or:”
-In “$in:”
-Not In “$nin:”
+| Operator | Syntax |
+| -------- | --------- |
+| Equals | `$eq:` |
+| Not equals | `$ne:` |
+| Greater than | `$gt:` |
+| Greater than or equal | `$gte:` |
+| Less than | `$lt:` |
+| Less than or equal | `$lte:` |
+| Substring match | `$like:` |
+| And also | `$and:` |
+| Or else | `$or:` |
+| In | `$in:` |
+| Not In | `$nin:` |
+
copy pasta from https://restdocs.e-conomic.com/#specifying-operator-affinity
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` or 'bundle exec m' to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.