0c0af54a
 Isaac Lewis
error handling; c...
|
1
|
# syspro-ruby
|
31f9a345
 Isaac Lewis
init; some tests
|
2
|
|
|
0c0af54a
Isaac Lewis
error handling; c...
|
3
|
syspro-ruby is an adapter gem to connect to SYSPRO 7 ERP installations. You can use this gem to connect to the SYSPRO 7 WCF Service and build Ruby applications on top of your SYSPRO data.
|
|
31f9a345
Isaac Lewis
init; some tests
|
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'syspro'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install syspro
## Usage
|
|
0c0af54a
Isaac Lewis
error handling; c...
|
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
### Utilities
#### Logon
```rb
user_id = Syspro::Logon.logon(username, password, company_id, company_password)
```
`user_id` will be a `UserId` object that contains the `guid` supplied by SYSPRO. You will use this guid to make further requests to SYSPRO.
#### GetUserProfile
```rb
user_profile = Syspro::GetUserProfile.get_user_profile(guid)
```
`user_profile` will be a `UserProfile` object that contains the following:
- `company_name`
- `operator_code`
- `operator_group`
- `operator_email_address`
- `operator_location`
- `operator_language_code`
- `system_language`
- `accounting_date`
- `company_date`
- `default_ar_branch`
- `default_ap_branch`
- `default_bank`
- `default_warehouse`
- `default_customer`
- `system_site_id`
- `system_nationality_code`
- `local_currency_code`
- `currency_description`
- `default_requisition_user`
- `xml_to_html_transform`
- `css_style`
- `css_suffix`
- `decimal_format`
- `date_format`
- `functional_role`
- `database_type`
- `syspro_version`
- `enet_version`
- `syspro_server_bit_width`
#### Logoff
```rb
logged_off = Syspro::Logoff.logoff(guid)
```
`logged_off` will be `true` if the user has been successfully logged off, and will contain an error string if an error has occured.
|
|
31f9a345
Isaac Lewis
init; some tests
|
74
75
76
|
## Development
|
|
87fd11a1
Isaac Lewis
reorg
|
77
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
31f9a345
Isaac Lewis
init; some tests
|
78
79
80
81
82
|
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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
|
|
0c0af54a
Isaac Lewis
error handling; c...
|
83
|
Bug reports and pull requests are welcome on GitHub at https://github.com/ike/syspro-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
31f9a345
Isaac Lewis
init; some tests
|
84
85
86
87
88
89
90
|
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
|
|
0c0af54a
Isaac Lewis
error handling; c...
|
91
|
Everyone interacting in the Syspro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ike/syspro-ruby/blob/master/CODE_OF_CONDUCT.md).
|
