ruby-upwork-oauth2 2.1.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30396e38e7003832bc1afee54cb092275109658e4054ff0aa477f1d587075dc9
-  data.tar.gz: dfc128c0a3fe618af664075bce4f87f3adcb9255ad653620e8ddf8dd1684f320
+  metadata.gz: 714d57824d8e7e99ce8abfb0292feb999658487dc796645583ef0f37fbb79e4b
+  data.tar.gz: f6d723f4d3b7f46b5c389cc1db185f5064e648e1c2bc44ec62895942c7b62fa2
 SHA512:
-  metadata.gz: 71b9945740d5412cc7c80e720ba4f73ed06b70a409fd7e36f09153c33adb49d4f9fb9d5abaab818a4d3f721cd49c142688f9e630d1f50093a461470750317a64
-  data.tar.gz: 7ad335171b968d0b6e53cb22807e781ba0f4f0f8d334df7c866075ae408c37d498222f9486260705a1d4583f75aac19444d9c2613a5fc4dfba7ffbd3e4d4dd2e
+  metadata.gz: 8edcd97947d2ccdcf59043db46f2e41a640a60bc4b091a801052841c978b6e17eb7896ff19045286e5518abed259c184570c0d14b72d67c50a5a9112da8b4a32
+  data.tar.gz: 7518ea1a6642682ded9da4fe7cc27cceb2e163b74f0d6a70bac74333e7a88b712d9bb0c3a0504875f524b88a35ab91ab8b52710a6339493986a8523ee50e23d9

data/.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [ '2.7.3', '2.6.7', '2.5.9' ]
+        ruby: [ '3.0.1' ]
 
     name: Ruby ${{ matrix.ruby }}
     steps:

data/CHANGES.md

@@ -1,5 +1,8 @@
 # Release History
 
+## 2.2.0
+* Support Client Credentials Grant
+
 ## 2.1.4
 * Add GraphQL support
 

data/README.md

@@ -12,21 +12,7 @@ This project provides a set of resources of Upwork API from http://developers.up
  based on OAuth 2.0.
 
 # Features
-These are the supported API resources:
-
-* My Info
-* Custom Payments
-* Hiring
-* Job and Freelancer Profile
-* Search Jobs and Freelancers
-* Organization
-* Messages
-* Time and Financial Reporting
-* Metadata
-* Snapshot
-* Team
-* Workd Diary
-* Activities
+The library supports all GraphQL calls, which are publicly shared at Upwork
 
 # License
 

data/example/example.rb

@@ -16,6 +16,7 @@ config = Upwork::Api::Config.new({
   'client_id'     => 'xxxxxxxx',
   'client_secret' => 'xxxxxxxx',
   'redirect_uri'  => 'https://a.callback.url',
+#  'grant_type'    => 'client_credentials' # Client Credentials Grant
 #  'access_token'  => 'xxxxxxxx',
 #  'refresh_token' => 'xxxxxxxx',
 #  'expires_in'    => '86399'
@@ -26,6 +27,7 @@ config = Upwork::Api::Config.new({
 # setup client
 client = Upwork::Api::Client.new(config)
 
+# Code Authorization Grant
 # run authorization in case we haven't done it yet
 # and do not have an access and refresh token pair
 if !config.access_token and !config.refresh_token
@@ -38,6 +40,11 @@ if !config.access_token and !config.refresh_token
   # store access token data in safe place!
 end
 
+# Client Credentials Grant
+if !config.access_token
+  @token = client.get_access_token
+end
+
 # WARNING: the access token will be refreshed automatically for you
 # in case it's expired, i.e. expires_at < time(). Make sure you replace the
 # old token accordingly in your security storage. Call client.get_actual_config

data/lib/upwork/api/client.rb

@@ -60,10 +60,16 @@ module Upwork
       #
       # Arguments:
       #  authz_code: (String)
-      def get_access_token(authz_code)
-        $LOG.i "getting access and refresh token pair"
-	@access_token = @oauth2_client.auth_code.get_token(authz_code, :redirect_uri => @config.redirect_uri)
-        $LOG.i "got access and refresh token pair", @access_token
+      def get_access_token(authz_code = nil)
+        if @config.grant_type == 'client_credentials'
+          $LOG.i "getting access token"
+	  @access_token = @oauth2_client.client_credentials.get_token
+          $LOG.i "got access token", @access_token
+        else
+          $LOG.i "getting access and refresh token pair"
+	  @access_token = @oauth2_client.auth_code.get_token(authz_code, :redirect_uri => @config.redirect_uri)
+          $LOG.i "got access and refresh token pair", @access_token
+        end
 
 	refresh_config_from_access_token
 

data/lib/upwork/api/config.rb

@@ -18,14 +18,14 @@ module Upwork
       @@debug = false;
       
       attr_accessor :access_token, :refresh_token, :expires_in, :expires_at
-      attr_reader :client_id, :client_secret, :redirect_uri
+      attr_reader :client_id, :client_secret, :redirect_uri, :grant_type
       
       # Init config object
       #
       # Arguments:
       #  config: (Hash)
       def initialize(config = {})
-        @client_id, @client_secret, @redirect_uri = config['client_id'], config['client_secret'], config['redirect_uri']
+        @client_id, @client_secret, @redirect_uri, @grant_type = config['client_id'], config['client_secret'], config['redirect_uri'], config['grant_type']
         @access_token, @refresh_token, @expires_in, @expires_at = config['access_token'], config['refresh_token'], config['expires_in'], config['expires_at']
         @@debug = config['debug']
 

data/lib/upwork/api/routers/activities/engagement.rb

@@ -33,7 +33,7 @@ module Upwork
           # Arguments:
           #  engagement_ref: (String)
           def get_specific(engagement_ref)
-            @client.get '/tasks/v2/tasks/contracts/' + engagement_ref
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Assign engagements to the list of activities
@@ -44,7 +44,7 @@ module Upwork
           #  engagement: (String)
           #  params: (Hash)
           def assign(company, team, engagement, params)
-            @client.put '/otask/v1/tasks/companies/' + company + '/teams/' + team + '/engagements/' + engagement + '/tasks', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Assign to specific engagement the list of activities
@@ -53,7 +53,7 @@ module Upwork
           #  engagement_ref: (String)
           #  params: (Hash)
           def assign_to_engagement(engagement_ref, params)
-            @client.put '/tasks/v2/tasks/contracts/' + engagement_ref, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         
         end

data/lib/upwork/api/routers/activities/team.rb

@@ -54,7 +54,7 @@ module Upwork
           #  team: (String)
           #  params: (Hash)
           def add_activity(company, team, params)
-            @client.post '/otask/v1/tasks/companies/' + company + '/teams/' + team + '/tasks', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Update specific oTask/Activity record within a team
@@ -65,7 +65,7 @@ module Upwork
           #  code: (String)
           #  params: (Hash)
           def update_activities(company, team, code, params)
-            @client.put '/otask/v1/tasks/companies/' + company + '/teams/' + team + '/tasks/' + code, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Archive specific oTask/Activity record within a team
@@ -75,7 +75,7 @@ module Upwork
           #  team: (String)
           #  code: (String)
           def archive_activities(company, team, code)
-            @client.put '/otask/v1/tasks/companies/' + company + '/teams/' + team + '/archive/' + code
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Unarchive specific oTask/Activity record within a team
@@ -85,7 +85,7 @@ module Upwork
           #  team: (String)
           #  code: (String)
           def unarchive_activities(company, team, code)
-            @client.put '/otask/v1/tasks/companies/' + company + '/teams/' + team + '/unarchive/' + code
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Update a group of oTask/Activity records within a company
@@ -94,7 +94,7 @@ module Upwork
           #  company: (String)
           #  params: (Hash)
           def update_batch(company, params)
-            @client.put '/otask/v1/tasks/companies/' + company + '/tasks/batch', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           private

data/lib/upwork/api/routers/auth.rb

@@ -30,9 +30,9 @@ module Upwork
         # Get info of authenticated user
         def get_user_info
           $LOG.i "running " + __method__.to_s
-          @client.get '/auth/v1/info'
+          raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/freelancers/profile.rb

@@ -34,7 +34,7 @@ module Upwork
           #  key: (String)
           def get_specific(key)
             $LOG.i "running " + __method__.to_s
-            @client.get '/profiles/v1/providers/' + key
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
 
           # Get brief info on specific profile
@@ -42,7 +42,7 @@ module Upwork
           # Arguments:
           #  key: (String)
           def get_specific_brief(key)
-            $LOG.i "running " + __method__.to_s
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             @client.get '/profiles/v1/providers/' + key + '/brief'
           end
         end

data/lib/upwork/api/routers/freelancers/search.rb

@@ -34,10 +34,10 @@ module Upwork
           #  params: (Hash)
           def find(params)
             $LOG.i "running " + __method__.to_s
-            @client.get '/profiles/v2/search/providers', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/graphql.rb

@@ -0,0 +1,38 @@
+# Licensed under the Upwork's API Terms of Use;
+# you may not use this file except in compliance with the Terms.
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Author::    Maksym Novozhylov (mnovozhilov@upwork.com)
+# Copyright:: Copyright 2021(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      # Execute GraphQL requests
+      class Graphql
+        ENTRY_POINT = 'graphql'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Execute GraphQL request
+        def execute(params)
+          $LOG.i "running " + __method__.to_s
+          @client.post '', params
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/hr/clients/applications.rb

@@ -35,7 +35,7 @@ module Upwork
             #  params: (Hash)
             def get_list(params)
               $LOG.i "running " + __method__.to_s
-              @client.get '/hr/v4/clients/applications', params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Get specific application
@@ -45,7 +45,7 @@ module Upwork
             #  params: (Hash)
             def get_specific(reference, params)
               $LOG.i "running " + __method__.to_s
-              @client.get '/hr/v4/clients/applications/' + reference, params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
           end
         end

data/lib/upwork/api/routers/hr/clients/offers.rb

@@ -35,7 +35,7 @@ module Upwork
             #  params: (Hash)
             def get_list(params)
               $LOG.i "running " + __method__.to_s
-              @client.get '/offers/v1/clients/offers', params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Get specific offer
@@ -45,7 +45,7 @@ module Upwork
             #  params: (Hash)
             def get_specific(reference, params)
               $LOG.i "running " + __method__.to_s
-              @client.get '/offers/v1/clients/offers/' + reference, params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Make an Offer
@@ -54,7 +54,7 @@ module Upwork
             #  params: (Hash)
             def make_offer(params)
               $LOG.i "running " + __method__.to_s
-              @client.post '/offers/v1/clients/offers', params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
           end
         end

data/lib/upwork/api/routers/hr/contracts.rb

@@ -35,7 +35,7 @@ module Upwork
           #  params: (Hash)
           def suspend_contract(reference, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v2/contracts/' + reference + '/suspend', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Restart Contract
@@ -45,7 +45,7 @@ module Upwork
           #  params: (Hash)
           def restart_contract(reference, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v2/contracts/' + reference + '/restart', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # End Contract
@@ -55,7 +55,7 @@ module Upwork
           #  params: (Hash)
           def end_contract(reference, params)
             $LOG.i "running " + __method__.to_s
-            @client.delete '/hr/v2/contracts/' + reference, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end

data/lib/upwork/api/routers/hr/engagements.rb

@@ -34,7 +34,7 @@ module Upwork
           #  params: (Hash)
           def get_list(params)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/engagements', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Get specific engagement
@@ -43,10 +43,10 @@ module Upwork
           #  reference: (String)
           def get_specific(reference)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/engagements/' + reference
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/hr/freelancers/applications.rb

@@ -35,7 +35,7 @@ module Upwork
             #  params: (Hash)
             def get_list(params = {})
               $LOG.i "running " + __method__.to_s
-              @client.get '/hr/v4/contractors/applications', params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Get specific application
@@ -44,7 +44,7 @@ module Upwork
             #  reference: (String)
             def get_specific(reference)
               $LOG.i "running " + __method__.to_s
-              @client.get '/hr/v4/contractors/applications' + reference
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
           end
         end

data/lib/upwork/api/routers/hr/freelancers/offers.rb

@@ -35,7 +35,7 @@ module Upwork
             #  params: (Hash)
             def get_list(params = {})
               $LOG.i "running " + __method__.to_s
-              @client.get '/offers/v1/contractors/offers', params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Get specific offer
@@ -44,7 +44,7 @@ module Upwork
             #  reference: (String)
             def get_specific(reference)
               $LOG.i "running " + __method__.to_s
-              @client.get '/offers/v1/clients/offers/' + reference
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
             
             # Apply specific action
@@ -54,7 +54,7 @@ module Upwork
             #  params: (Hash)
             def actions(reference, params)
               $LOG.i "running " + __method__.to_s
-              @client.post '/offers/v1/clients/actions/' + reference, params
+              raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
             end
           end
         end

data/lib/upwork/api/routers/hr/interviews.rb

@@ -35,10 +35,10 @@ module Upwork
           #  params: (Hash)
           def invite(job_key, params)
             $LOG.i "running " + __method__.to_s
-            @client.post '/hr/v1/jobs/' + job_key + '/candidates', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/hr/jobs.rb

@@ -34,7 +34,7 @@ module Upwork
           #  params: (Hash)
           def get_list(params)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/jobs', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Get specific job by key
@@ -43,7 +43,7 @@ module Upwork
           #  key: (String)
           def get_specific(key)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/jobs/' + key
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Post a new job
@@ -52,7 +52,7 @@ module Upwork
           #  params: (Hash)
           def post_job(params)
             $LOG.i "running " + __method__.to_s
-            @client.post '/hr/v2/jobs', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Edit existent job
@@ -61,7 +61,7 @@ module Upwork
           #  params: (Hash)
           def edit_job(key, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v2/jobs/' + key, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Delete existent job
@@ -70,10 +70,10 @@ module Upwork
           #  params: (Hash)
           def delete_job(key, params)
             $LOG.i "running " + __method__.to_s
-            @client.delete '/hr/v2/jobs/' + key, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/hr/milestones.rb

@@ -34,7 +34,7 @@ module Upwork
           #  contract_id: (String)
           def get_active_milestone(contract_id)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v3/fp/milestones/statuses/active/contracts/' + contract_id
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Get active Milestone for specific Contract
@@ -43,7 +43,7 @@ module Upwork
           #  milestone_id: (String)
           def get_submissions(milestone_id)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v3/fp/milestones/' + milestone_id + '/submissions'
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Create a new Milestone
@@ -52,7 +52,7 @@ module Upwork
           #  params: (Hash)
           def create(params)
             $LOG.i "running " + __method__.to_s
-            @client.post '/hr/v3/fp/milestones', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Edit an existing Milestone
@@ -62,7 +62,7 @@ module Upwork
           #  params: (Hash)
           def edit(milestone_id, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v3/fp/milestones/' + milestone_id, params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Activate an existing Milestone
@@ -72,7 +72,7 @@ module Upwork
           #  params: (Hash)
           def activate(milestone_id, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v3/fp/milestones/' + milestone_id + '/activate', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Approve an existing Milestone
@@ -82,7 +82,7 @@ module Upwork
           #  params: (Hash)
           def approve(milestone_id, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v3/fp/milestones/' + milestone_id + '/approve', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Delete an existing Milestone
@@ -91,7 +91,7 @@ module Upwork
           #  milestone_id: (String)
           def delete(milestone_id)
             $LOG.i "running " + __method__.to_s
-            @client.delete '/hr/v3/fp/milestones/' + milestone_id
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end

data/lib/upwork/api/routers/hr/roles.rb

@@ -31,7 +31,7 @@ module Upwork
           # Get user roles
           def get_all
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/userroles'
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Get by specific user
@@ -40,10 +40,10 @@ module Upwork
           #  reference: (String)
           def get_by_specific_user(user_reference)
             $LOG.i "running " + __method__.to_s
-            @client.get '/hr/v2/userroles/' + user_reference
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/hr/submissions.rb

@@ -34,7 +34,7 @@ module Upwork
           #  params: (Hash)
           def request_approval(params)
             $LOG.i "running " + __method__.to_s
-            @client.post '/hr/v3/fp/submissions', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Approve an existing Submission
@@ -44,7 +44,7 @@ module Upwork
           #  params: (Hash)
           def approve(submission_id, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v3/fp/submissions/' + submission_id + '/approve', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
           
           # Reject an existing Submission
@@ -54,7 +54,7 @@ module Upwork
           #  params: (Hash)
           def reject(submission_id, params)
             $LOG.i "running " + __method__.to_s
-            @client.put '/hr/v3/fp/submissions/' + submission_id + '/reject', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end

data/lib/upwork/api/routers/jobs/profile.rb

@@ -34,10 +34,10 @@ module Upwork
           #  key: (String)
           def get_specific(key)
             $LOG.i "running " + __method__.to_s
-            @client.get '/profiles/v1/jobs/' + key
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end

data/lib/upwork/api/routers/jobs/search.rb

@@ -34,10 +34,10 @@ module Upwork
           #  params: (Hash)
           def find(params)
             $LOG.i "running " + __method__.to_s
-            @client.get '/profiles/v2/search/jobs', params
+            raise StandardError.new "The legacy API was deprecated. Please, use GraphQL call - see example in this library."
           end
         end
       end
     end
   end
-end
+end