ruby-upwork-oauth2 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.docgen +1 -0
- data/.gitignore +22 -0
- data/.travis.yml +19 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +176 -0
- data/README.md +80 -0
- data/Rakefile +12 -0
- data/example/example.rb +65 -0
- data/lib/upwork/api.rb +29 -0
- data/lib/upwork/api/client.rb +184 -0
- data/lib/upwork/api/config.rb +41 -0
- data/lib/upwork/api/logger.rb +35 -0
- data/lib/upwork/api/routers/activities/engagement.rb +63 -0
- data/lib/upwork/api/routers/activities/team.rb +117 -0
- data/lib/upwork/api/routers/auth.rb +38 -0
- data/lib/upwork/api/routers/freelancers/profile.rb +52 -0
- data/lib/upwork/api/routers/freelancers/search.rb +43 -0
- data/lib/upwork/api/routers/hr/clients/applications.rb +55 -0
- data/lib/upwork/api/routers/hr/clients/offers.rb +64 -0
- data/lib/upwork/api/routers/hr/contracts.rb +64 -0
- data/lib/upwork/api/routers/hr/engagements.rb +52 -0
- data/lib/upwork/api/routers/hr/freelancers/applications.rb +54 -0
- data/lib/upwork/api/routers/hr/freelancers/offers.rb +64 -0
- data/lib/upwork/api/routers/hr/interviews.rb +44 -0
- data/lib/upwork/api/routers/hr/jobs.rb +79 -0
- data/lib/upwork/api/routers/hr/milestones.rb +100 -0
- data/lib/upwork/api/routers/hr/roles.rb +49 -0
- data/lib/upwork/api/routers/hr/submissions.rb +63 -0
- data/lib/upwork/api/routers/jobs/profile.rb +43 -0
- data/lib/upwork/api/routers/jobs/search.rb +43 -0
- data/lib/upwork/api/routers/messages.rb +129 -0
- data/lib/upwork/api/routers/metadata.rb +65 -0
- data/lib/upwork/api/routers/organization/companies.rb +67 -0
- data/lib/upwork/api/routers/organization/teams.rb +49 -0
- data/lib/upwork/api/routers/organization/users.rb +49 -0
- data/lib/upwork/api/routers/payments.rb +42 -0
- data/lib/upwork/api/routers/reports/finance/accounts.rb +56 -0
- data/lib/upwork/api/routers/reports/finance/billings.rb +86 -0
- data/lib/upwork/api/routers/reports/finance/earnings.rb +86 -0
- data/lib/upwork/api/routers/reports/time.rb +114 -0
- data/lib/upwork/api/routers/snapshot.rb +62 -0
- data/lib/upwork/api/routers/workdays.rb +54 -0
- data/lib/upwork/api/routers/workdiary.rb +42 -0
- data/lib/upwork/api/version.rb +18 -0
- data/ruby-upwork-oauth2.gemspec +27 -0
- data/test/helper.rb +22 -0
- data/test/test_activities_engagement.rb +26 -0
- data/test/test_activities_team.rb +46 -0
- data/test/test_auth.rb +16 -0
- data/test/test_client.rb +48 -0
- data/test/test_config.rb +27 -0
- data/test/test_freelancers_profile.rb +22 -0
- data/test/test_freelancers_search.rb +16 -0
- data/test/test_hr_clients_applications.rb +21 -0
- data/test/test_hr_clients_offers.rb +26 -0
- data/test/test_hr_contracts.rb +26 -0
- data/test/test_hr_engagements.rb +21 -0
- data/test/test_hr_freelancers_applications.rb +21 -0
- data/test/test_hr_freelancers_offers.rb +26 -0
- data/test/test_hr_interviews.rb +16 -0
- data/test/test_hr_jobs.rb +36 -0
- data/test/test_hr_milestones.rb +46 -0
- data/test/test_hr_roles.rb +21 -0
- data/test/test_hr_submissions.rb +26 -0
- data/test/test_jobs_profile.rb +16 -0
- data/test/test_jobs_search.rb +16 -0
- data/test/test_logger.rb +15 -0
- data/test/test_messages.rb +56 -0
- data/test/test_metadata.rb +36 -0
- data/test/test_organization_companies.rb +31 -0
- data/test/test_organization_teams.rb +21 -0
- data/test/test_organization_users.rb +21 -0
- data/test/test_payments.rb +16 -0
- data/test/test_reports_finance_accounts.rb +21 -0
- data/test/test_reports_finance_billings.rb +36 -0
- data/test/test_reports_finance_earnings.rb +36 -0
- data/test/test_reports_time.rb +41 -0
- data/test/test_snapshot.rb +26 -0
- data/test/test_workdays.rb +21 -0
- data/test/test_workdiary.rb +16 -0
- metadata +230 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1f950287c9a08d380f4911c57feb1ed858341264e52f34037f2d9f83223f02af
|
4
|
+
data.tar.gz: 39ea135cbab5433dcbee0febcd68a90dc49fa4b5cf9ad7c0e314b990e77f61b6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 02a09a90a058d02cb7aaf06e111355dcf469aab4884f9c98f6f243d50aad5dfb74ac480da327677cbbcb8b68726a4829f3e7eec13eb3f3bf07238b1c3da5e56a
|
7
|
+
data.tar.gz: da5e2095a70f08564f10126b901fb98a3336bf8135806e0ba5bd08e8ab2a112a38d996b182404b12a018976e942e465d5934fe66fd254ea2108fab573da55a46
|
data/.docgen
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
rdoc
|
data/.gitignore
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
.yardoc
|
6
|
+
Gemfile.lock
|
7
|
+
InstalledFiles
|
8
|
+
_yardoc
|
9
|
+
coverage
|
10
|
+
doc/
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
18
|
+
*.bundle
|
19
|
+
*.so
|
20
|
+
*.o
|
21
|
+
*.a
|
22
|
+
mkmf.log
|
data/.travis.yml
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
language: ruby
|
2
|
+
script: rake
|
3
|
+
rvm:
|
4
|
+
- 2.2.2
|
5
|
+
- 2.3.0
|
6
|
+
- 2.4.3
|
7
|
+
- 2.5.0
|
8
|
+
- jruby-head
|
9
|
+
- ruby-head
|
10
|
+
install: gem install oauth2 test-unit mocha
|
11
|
+
matrix:
|
12
|
+
allow_failures:
|
13
|
+
- rvm: ruby-head
|
14
|
+
fast_finish: true
|
15
|
+
notifications:
|
16
|
+
email:
|
17
|
+
recipients:
|
18
|
+
- apisupport@upwork.com
|
19
|
+
on_failure: change
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
data/README.md
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
Ruby bindings for Upwork API (OAuth2)
|
2
|
+
============
|
3
|
+
|
4
|
+
[![License](http://img.shields.io/packagist/l/upwork/php-upwork.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
|
5
|
+
[![Gem Version](https://badge.fury.io/rb/upwork-api.svg)](http://badge.fury.io/rb/upwork-api)
|
6
|
+
[![GitHub release](https://img.shields.io/github/release/upwork/ruby-upwork.svg)](https://github.com/upwork/ruby-upwork/releases)
|
7
|
+
[![Build Status](https://travis-ci.org/upwork/ruby-upwork.svg)](https://travis-ci.org/upwork/ruby-upwork)
|
8
|
+
[![Stories in Ready](http://badge.waffle.io/upwork/ruby-upwork.png)](http://waffle.io/upwork/ruby-upwork)
|
9
|
+
|
10
|
+
# Upwork::Api
|
11
|
+
|
12
|
+
This project provides a set of resources of Upwork API from http://developers.upwork.com
|
13
|
+
based on OAuth 2.0.
|
14
|
+
|
15
|
+
# Features
|
16
|
+
These are the supported API resources:
|
17
|
+
|
18
|
+
* My Info
|
19
|
+
* Custom Payments
|
20
|
+
* Hiring
|
21
|
+
* Job and Freelancer Profile
|
22
|
+
* Search Jobs and Freelancers
|
23
|
+
* Organization
|
24
|
+
* Messages
|
25
|
+
* Time and Financial Reporting
|
26
|
+
* Metadata
|
27
|
+
* Snapshot
|
28
|
+
* Team
|
29
|
+
* Workd Diary
|
30
|
+
* Activities
|
31
|
+
|
32
|
+
# License
|
33
|
+
|
34
|
+
Copyright 2018 Upwork Corporation. All Rights Reserved.
|
35
|
+
|
36
|
+
ruby-upwork is licensed under the Apache License, Version 2.0 (the "License");
|
37
|
+
you may not use this file except in compliance with the License.
|
38
|
+
You may obtain a copy of the License at
|
39
|
+
|
40
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
41
|
+
|
42
|
+
Unless required by applicable law or agreed to in writing, software
|
43
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
44
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
45
|
+
See the License for the specific language governing permissions and
|
46
|
+
limitations under the License.
|
47
|
+
|
48
|
+
## SLA
|
49
|
+
The usage of this API is ruled by the Terms of Use at:
|
50
|
+
|
51
|
+
https://developers.upwork.com/api-tos.html
|
52
|
+
|
53
|
+
# Application Integration
|
54
|
+
To integrate this library you need to have:
|
55
|
+
|
56
|
+
* Ruby >= 1.9.3
|
57
|
+
* OAuth2 Extension installed (use `gem install oauth2`)
|
58
|
+
|
59
|
+
## Installation
|
60
|
+
|
61
|
+
Add this line to your application's Gemfile:
|
62
|
+
|
63
|
+
gem 'upwork-api'
|
64
|
+
|
65
|
+
And then execute:
|
66
|
+
|
67
|
+
$ bundle
|
68
|
+
|
69
|
+
Or install it yourself as:
|
70
|
+
|
71
|
+
$ gem install upwork-api
|
72
|
+
|
73
|
+
## Usage
|
74
|
+
|
75
|
+
1.
|
76
|
+
Follow instructions from the `Installation` section.
|
77
|
+
|
78
|
+
2.
|
79
|
+
Open `example.rb` and type the `client_id` (a.k.a. consumer key), `client_secret` (a.k.a. consumer secret) and `redirect_uri` that you previously got from the API Center.
|
80
|
+
***That's all. Run your app as `ruby example.rb` and have fun.***'
|
data/Rakefile
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
|
2
|
+
$LOAD_PATH << File.dirname(__FILE__) + '/lib'
|
3
|
+
require 'bundler/gem_tasks'
|
4
|
+
require 'oauth2'
|
5
|
+
|
6
|
+
Rake::TestTask.new do |t|
|
7
|
+
t.libs << "test"
|
8
|
+
t.test_files = FileList['test/*test_*.rb']
|
9
|
+
t.verbose = true
|
10
|
+
end
|
11
|
+
|
12
|
+
task :default => :test
|
data/example/example.rb
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
|
3
|
+
$:.unshift '../lib'
|
4
|
+
|
5
|
+
$LOAD_PATH << File.dirname(__FILE__)
|
6
|
+
|
7
|
+
require 'upwork/api'
|
8
|
+
require 'upwork/api/routers/auth'
|
9
|
+
require 'upwork/api/routers/messages'
|
10
|
+
require 'upwork/api/routers/reports/time'
|
11
|
+
require 'upwork/api/routers/freelancers/search'
|
12
|
+
|
13
|
+
# initiate config
|
14
|
+
config = Upwork::Api::Config.new({
|
15
|
+
'client_id' => 'xxxxxxxx',
|
16
|
+
'client_secret' => 'xxxxxxxx',
|
17
|
+
'redirect_uri' => 'https://a.callback.url',
|
18
|
+
# 'access_token' => 'xxxxxxxx',
|
19
|
+
# 'refresh_token' => 'xxxxxxxx',
|
20
|
+
# 'expires_in' => '86399'
|
21
|
+
# 'expires_at' => '1518017490',
|
22
|
+
# 'debug' => true
|
23
|
+
})
|
24
|
+
|
25
|
+
# setup client
|
26
|
+
client = Upwork::Api::Client.new(config)
|
27
|
+
|
28
|
+
# run authorization in case we haven't done it yet
|
29
|
+
# and do not have an access and refresh token pair
|
30
|
+
if !config.access_token and !config.refresh_token
|
31
|
+
authz_url = client.get_authorization_url
|
32
|
+
|
33
|
+
puts "Visit the authorization url and provide [authorization code] for further authorization"
|
34
|
+
puts authz_url
|
35
|
+
authz_code = gets.strip
|
36
|
+
@token = client.get_access_token(authz_code)
|
37
|
+
# store access token data in safe place!
|
38
|
+
end
|
39
|
+
|
40
|
+
# WARNING: the access token will be refreshed automatically for you
|
41
|
+
# in case it's expired, i.e. expires_at < time(). Make sure you replace the
|
42
|
+
# old token accordingly in your security storage. Call client.get_actual_config
|
43
|
+
# periodically to sync-up the data
|
44
|
+
@actual_access_token_data = client.get_actual_config
|
45
|
+
|
46
|
+
# get my auth data
|
47
|
+
#auth = Upwork::Api::Routers::Auth.new(client)
|
48
|
+
#info = auth.get_user_info
|
49
|
+
#p info['server_time']
|
50
|
+
|
51
|
+
# work with timereports
|
52
|
+
#report = Upwork::Api::Routers::Reports::Time.new(client)
|
53
|
+
#report_response = report.get_by_freelancer_limited('xxxxxxxx', {'tqx' => 'out:json', 'tq' => "select task where worked_on >= '2018-01-01' AND worked_on <= '2018-01-10' order by worked_on"})
|
54
|
+
|
55
|
+
# work with search
|
56
|
+
#params = {'q' => 'python AND java AND (perl OR php)'}
|
57
|
+
#freelancers = Upwork::Api::Routers::Freelancers::Search.new(client)
|
58
|
+
#p freelancers.find(params)
|
59
|
+
|
60
|
+
# work with messages
|
61
|
+
#messages = Upwork::Api::Routers::Messages.new(client)
|
62
|
+
#params = {
|
63
|
+
# 'story' => '{"message": "test message from api", "userId": "~xxxxxxxx", "orgId": "xxxxxxxx"}'
|
64
|
+
#}
|
65
|
+
#messages.send_message_to_room 'company-xxxxxxxx', 'room-xxxxxxxx', params
|
data/lib/upwork/api.rb
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# Licensed under the Upwork's API Terms of Use;
|
2
|
+
# you may not use this file except in compliance with the Terms.
|
3
|
+
#
|
4
|
+
# Unless required by applicable law or agreed to in writing, software
|
5
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
6
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
7
|
+
# See the License for the specific language governing permissions and
|
8
|
+
# limitations under the License.
|
9
|
+
#
|
10
|
+
# Author:: Maksym Novozhylov (mnovozhilov@upwork.com)
|
11
|
+
# Copyright:: Copyright 2014(c) Upwork.com
|
12
|
+
# License:: See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
|
13
|
+
|
14
|
+
require 'oauth2'
|
15
|
+
|
16
|
+
require 'upwork/api/version'
|
17
|
+
require 'upwork/api/logger'
|
18
|
+
require 'upwork/api/config'
|
19
|
+
require 'upwork/api/client'
|
20
|
+
|
21
|
+
module Upwork # :nodoc:
|
22
|
+
module Api
|
23
|
+
# define some constants
|
24
|
+
BASE_HOST = 'https://www.upwork.com'
|
25
|
+
DEFAULT_EPOINT = 'api'
|
26
|
+
|
27
|
+
$LOG = Logger.new
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,184 @@
|
|
1
|
+
# Licensed under the Upwork's API Terms of Use;
|
2
|
+
# you may not use this file except in compliance with the Terms.
|
3
|
+
#
|
4
|
+
# Unless required by applicable law or agreed to in writing, software
|
5
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
6
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
7
|
+
# See the License for the specific language governing permissions and
|
8
|
+
# limitations under the License.
|
9
|
+
#
|
10
|
+
# Author:: Maksym Novozhylov (mnovozhilov@upwork.com)
|
11
|
+
# Copyright:: Copyright 2018(c) Upwork.com
|
12
|
+
# License:: See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
|
13
|
+
|
14
|
+
require 'json'
|
15
|
+
require 'uri'
|
16
|
+
|
17
|
+
module Upwork
|
18
|
+
module Api
|
19
|
+
# Client for accessing API
|
20
|
+
class Client
|
21
|
+
DATA_FORMAT = 'json'
|
22
|
+
OVERLOAD_VAR = "http_method"
|
23
|
+
|
24
|
+
URI_AUTH = "/ab/account-security/oauth2/authorize"
|
25
|
+
URI_RTOKEN = "/api/v3/oauth2/token" # refresh
|
26
|
+
URI_ATOKEN = "/api/v3/oauth2/token" # access
|
27
|
+
|
28
|
+
attr_accessor :epoint
|
29
|
+
attr_reader :url_auth, :url_rtoken, :url_atoken
|
30
|
+
|
31
|
+
# Init client
|
32
|
+
#
|
33
|
+
# Arguments:
|
34
|
+
# config: (Config)
|
35
|
+
def initialize(config)
|
36
|
+
$LOG.i('initializing client')
|
37
|
+
@config = config
|
38
|
+
@epoint = Upwork::Api::DEFAULT_EPOINT
|
39
|
+
@url_auth, @url_rtoken, @url_atoken = URI_AUTH, URI_RTOKEN, URI_ATOKEN
|
40
|
+
|
41
|
+
@oauth2_client = OAuth2::Client.new(
|
42
|
+
@config.client_id,
|
43
|
+
@config.client_secret,
|
44
|
+
:site => Upwork::Api::BASE_HOST,
|
45
|
+
:authorize_url => @url_auth,
|
46
|
+
:token_url => @url_atoken
|
47
|
+
)
|
48
|
+
end
|
49
|
+
|
50
|
+
# Start auth process and get authorization URL
|
51
|
+
def get_authorization_url
|
52
|
+
$LOG.i "requesting authorization URL"
|
53
|
+
|
54
|
+
@oauth2_client.auth_code.authorize_url(:redirect_uri => @config.redirect_uri)
|
55
|
+
end
|
56
|
+
|
57
|
+
# Finish auth process and get access token
|
58
|
+
#
|
59
|
+
# Arguments:
|
60
|
+
# authz_code: (String)
|
61
|
+
def get_access_token(authz_code)
|
62
|
+
$LOG.i "getting access and refresh token pair"
|
63
|
+
@access_token = @oauth2_client.auth_code.get_token(authz_code, :redirect_uri => @config.redirect_uri)
|
64
|
+
$LOG.i "got access and refresh token pair", @access_token
|
65
|
+
|
66
|
+
refresh_config_from_access_token
|
67
|
+
|
68
|
+
@access_token
|
69
|
+
end
|
70
|
+
|
71
|
+
# Get actual client config
|
72
|
+
def get_actual_config
|
73
|
+
@config
|
74
|
+
end
|
75
|
+
|
76
|
+
# Run GET request
|
77
|
+
#
|
78
|
+
# Arguments:
|
79
|
+
# uri: (String)
|
80
|
+
# param: (Hash)
|
81
|
+
def get(uri, params = {})
|
82
|
+
send_request(uri, :get, params)
|
83
|
+
end
|
84
|
+
|
85
|
+
# Run POST request
|
86
|
+
#
|
87
|
+
# Arguments:
|
88
|
+
# uri: (String)
|
89
|
+
# param: (Hash)
|
90
|
+
def post(uri, params = {})
|
91
|
+
send_request(uri, :post, params)
|
92
|
+
end
|
93
|
+
|
94
|
+
# Run PUT request
|
95
|
+
#
|
96
|
+
# Arguments:
|
97
|
+
# uri: (String)
|
98
|
+
# param: (Hash)
|
99
|
+
def put(uri, params = {})
|
100
|
+
send_request(uri, :put, params)
|
101
|
+
end
|
102
|
+
|
103
|
+
# Run DELETE request
|
104
|
+
#
|
105
|
+
# Arguments:
|
106
|
+
# uri: (String)
|
107
|
+
# param: (Hash)
|
108
|
+
def delete(uri, params = {})
|
109
|
+
send_request(uri, :delete, params)
|
110
|
+
end
|
111
|
+
|
112
|
+
# Get full URL
|
113
|
+
def full_url(uri) # :nodoc:
|
114
|
+
Upwork::Api::BASE_HOST + '/' + get_uri_with_format(uri);
|
115
|
+
end
|
116
|
+
|
117
|
+
# Get URI with :format
|
118
|
+
def get_uri_with_format(uri) # :nodoc:
|
119
|
+
(@epoint) + uri + ((@epoint == 'api') ? '.' + DATA_FORMAT : '')
|
120
|
+
end
|
121
|
+
|
122
|
+
private
|
123
|
+
|
124
|
+
# Refresh config from the actual access token
|
125
|
+
def refresh_config_from_access_token
|
126
|
+
$LOG.i "saving access token data in config object"
|
127
|
+
|
128
|
+
@config.access_token = @access_token.token
|
129
|
+
@config.refresh_token = @access_token.refresh_token
|
130
|
+
@config.expires_in = @access_token.expires_in
|
131
|
+
@config.expires_at = @access_token.expires_at
|
132
|
+
|
133
|
+
$LOG.i "new config is", @config
|
134
|
+
|
135
|
+
@config
|
136
|
+
end
|
137
|
+
|
138
|
+
# get url with parameters for get requests
|
139
|
+
def get_url_with_params(path, params)
|
140
|
+
"#{path}?".concat(params.collect{|k,v| "#{k}=#{OAuth::Helper::escape(v.to_s)}"}.join("&"))
|
141
|
+
end
|
142
|
+
|
143
|
+
# Send request
|
144
|
+
def send_request(uri, method = :get, params = {}) # :nodoc:
|
145
|
+
$LOG.i "send request for url", uri
|
146
|
+
$LOG.i "and method", method
|
147
|
+
|
148
|
+
if method == :put or method == :delete
|
149
|
+
$LOG.i "add overload parameter"
|
150
|
+
params[OVERLOAD_VAR] = method.to_s
|
151
|
+
end
|
152
|
+
|
153
|
+
$LOG.i "and parameters", params
|
154
|
+
|
155
|
+
@access_token = OAuth2::AccessToken.new(
|
156
|
+
@oauth2_client,
|
157
|
+
@config.access_token,
|
158
|
+
:refresh_token => @config.refresh_token,
|
159
|
+
:expires_at => @config.expires_at
|
160
|
+
)
|
161
|
+
|
162
|
+
# expired? then refresh it
|
163
|
+
if @access_token.expired?
|
164
|
+
$LOG.i "access token has expired, refreshing..."
|
165
|
+
@access_token = @access_token.refresh!
|
166
|
+
refresh_config_from_access_token
|
167
|
+
end
|
168
|
+
|
169
|
+
case method
|
170
|
+
when :get
|
171
|
+
url = get_url_with_params get_uri_with_format(uri), params
|
172
|
+
response = @access_token.get(url).body
|
173
|
+
when :post, :put, :delete
|
174
|
+
response = @access_token.post(get_uri_with_format(uri), {body: params}).body
|
175
|
+
else
|
176
|
+
raise ArgumentError, "Don't know how to handle http method: :#{method.to_s}"
|
177
|
+
end
|
178
|
+
$LOG.i "got response from server", response
|
179
|
+
JSON.parse(response)
|
180
|
+
end
|
181
|
+
|
182
|
+
end
|
183
|
+
end
|
184
|
+
end
|