ruby-upwork-oauth2 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae0c55c23aa24352c0f7abbb6e8997c9ddd9a569f18e51073d677ee1db27de56
-  data.tar.gz: 1146d2241c4ef5309dcbfa9437cfe07531e72c5c61b5fbf1188a7279802e4ac1
+  metadata.gz: 9c2b73f43493b0b28b2e57c5a6f0f585e6fdb5dae551c7727a08aebee090472c
+  data.tar.gz: 7bc58ddae0c69c0623af09ab601da75ebc90998d2d28ef8a8e9007cf1c64729d
 SHA512:
-  metadata.gz: 7de51dee4754a23762d8641acb725641838942563bcef8389058db5dd915e624105242d5266c932d833c85ebdd3c085b7ccfd57369eace355d8640aac135e4b0
-  data.tar.gz: '064596e784a903ca8415a130a9df988ead4082dbe6ac2037dc6cbd55d9920f1dd6f97e979604070c8a761a55250579f203e7278456cea262c555dda69773e483'
+  metadata.gz: 79f1166d56aab80b453ba1903f76eac2bece055edee57e3d21e43f698f56dba973339d0256e08bf5639030a2ac5ee81f85b741ec152ed7cfc08be2cd38c9f6e5
+  data.tar.gz: 6892be3d8566e75fc102fb2a2269f90d90a6e8089897e513b8b464ccd31f68635ed886412ccafa96802dd58930f26819e68ad4c6c0d78dd4f9966a2712c97ab0

data/.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: build
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  test:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [ '2.7.3', '2.6.7', '3.0.1' ]
+
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      # step 1: setup
+      - name: Setup ruby
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      # step 2: install dependencies
+      - name: Install dependencies
+        run: gem install oauth2 test-unit mocha
+      # step 3: run test
+      - name: Run tests
+        run: rake test

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 2.2.0
+* Support Client Credentials Grant
+
+## 2.1.4
+* Add GraphQL support
+
 ## 2.1.3
 * Send Message to a Batch of Rooms API
 

data/README.md

@@ -4,8 +4,7 @@ Ruby bindings for Upwork API (OAuth2)
 [![License](https://img.shields.io/github/license/upwork/ruby-upwork-oauth2)](http://www.apache.org/licenses/LICENSE-2.0.html)
 [![Gem Version](https://badge.fury.io/rb/ruby-upwork-oauth2.svg)](http://badge.fury.io/rb/ruby-upwork-oauth2)
 [![GitHub release](https://img.shields.io/github/release/upwork/ruby-upwork-oauth2.svg)](https://github.com/upwork/ruby-upwork-oauth2/releases)
-[![Build Status](https://travis-ci.org/upwork/ruby-upwork-oauth2.svg)](https://travis-ci.org/upwork/ruby-upwork-oauth2)
-[![Stories in Ready](http://badge.waffle.io/upwork/ruby-upwork-oauth2.png)](http://waffle.io/upwork/ruby-upwork-oauth2)
+[![Build Status](https://github.com/upwork/ruby-upwork-oauth2/workflows/build/badge.svg)](https://github.com/upwork/ruby-upwork-oauth2/actions)
 
 # Upwork::Api
 

data/example/example.rb

@@ -5,6 +5,7 @@ $:.unshift '../lib'
 $LOAD_PATH << File.dirname(__FILE__)
 
 require 'upwork/api'
+require 'upwork/api/routers/graphql'
 require 'upwork/api/routers/auth'
 require 'upwork/api/routers/messages'
 require 'upwork/api/routers/reports/time'
@@ -15,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'
@@ -25,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
@@ -37,12 +40,35 @@ 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
 # periodically to sync-up the data
 @actual_access_token_data = client.get_actual_config
 
+# execute graphql request
+#client.set_org_uid_header('1234567890') # Organization UID (optional)
+#graphql = Upwork::Api::Routers::Graphql.new(client)
+#params = {
+#  'query' => "query {
+#      user {
+#        id
+#        nid
+#        rid
+#      }
+#      organization {
+#        id
+#      }
+#    }"
+#}
+#data = graphql.execute params
+#p data['data']['user']['id']
+
 # get my auth data
 #auth = Upwork::Api::Routers::Auth.new(client)
 #info = auth.get_user_info

data/lib/upwork/api/client.rb

@@ -37,6 +37,7 @@ module Upwork
         @config = config
         @epoint = Upwork::Api::DEFAULT_EPOINT
 	@url_auth, @url_rtoken, @url_atoken = URI_AUTH, URI_RTOKEN, URI_ATOKEN
+        @tenant_id = nil
 
 	@oauth2_client = OAuth2::Client.new(
           @config.client_id,
@@ -59,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
 
@@ -73,6 +80,11 @@ module Upwork
       def get_actual_config
         @config
       end
+
+      # Configure X-Upwork-API-TenantId header
+      def set_org_uid_header(tenant_id)
+        @tenant_id = tenant_id
+      end
       
       # Run GET request
       #
@@ -117,7 +129,7 @@ module Upwork
       
       # Get URI with :format
       def get_uri_with_format(uri) # :nodoc:
-        (@epoint) + uri + ((@epoint == 'api') ? '.' + DATA_FORMAT : '')
+        (@epoint == 'graphql') ? Upwork::Api::GQL_EPOINT : ((@epoint) + uri + ((@epoint == 'api') ? '.' + DATA_FORMAT : ''))
       end
       
       private
@@ -172,7 +184,15 @@ module Upwork
           url = get_url_with_params get_uri_with_format(uri), params
           response = @access_token.get(url).body
         when :post, :put, :delete
-          response = @access_token.post(get_uri_with_format(uri), {body: params}).body
+          if @epoint == 'graphql'
+            data = {:body => params.to_json, :headers => {'Content-Type' => 'application/json'}}
+            if @tenant_id
+              data[:headers]['X-Upwork-API-TenantId'] = @tenant_id
+            end
+          else
+            data = {body: params}
+          end
+          response = @access_token.post(get_uri_with_format(uri), data).body
         else
           raise ArgumentError, "Don't know how to handle http method: :#{method.to_s}"
         end

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/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/version.rb

@@ -13,6 +13,6 @@
 
 module Upwork # :nodoc:
   module Api
-    VERSION = "2.1.3"
+    VERSION = "2.2.0"
   end
 end

data/lib/upwork/api.rb

@@ -23,6 +23,7 @@ module Upwork # :nodoc:
     # define some constants
     BASE_HOST       = 'https://www.upwork.com'
     DEFAULT_EPOINT  = 'api'
+    GQL_EPOINT      = 'https://api.upwork.com/graphql'
     
     $LOG = Logger.new
   end

data/ruby-upwork-oauth2.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "bundler", "~> 2.2", ">= 2.2.10"
+  spec.add_development_dependency "rake", "~>12.3", ">= 12.3.3"
   spec.add_development_dependency "mocha", "~> 0"
   spec.add_development_dependency "test-unit", "~> 0"
 end

data/test/test_graphql.rb

@@ -0,0 +1,16 @@
+$:.unshift 'lib'
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'helper'
+require 'upwork/api/routers/graphql'
+require 'test/unit'
+require 'mocha/test_unit'
+
+class GraphqlTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def test_execute
+    api = Upwork::Api::Routers::Graphql.new(get_client_mock)
+    assert api.execute({'query': 'query{}'})
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-upwork-oauth2
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Maksym Novozhylov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -30,18 +30,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
@@ -49,6 +58,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
@@ -89,9 +101,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".docgen"
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".tests"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -107,6 +119,7 @@ files:
 - lib/upwork/api/routers/auth.rb
 - lib/upwork/api/routers/freelancers/profile.rb
 - lib/upwork/api/routers/freelancers/search.rb
+- lib/upwork/api/routers/graphql.rb
 - lib/upwork/api/routers/hr/clients/applications.rb
 - lib/upwork/api/routers/hr/clients/offers.rb
 - lib/upwork/api/routers/hr/contracts.rb
@@ -143,6 +156,7 @@ files:
 - test/test_config.rb
 - test/test_freelancers_profile.rb
 - test/test_freelancers_search.rb
+- test/test_graphql.rb
 - test/test_hr_clients_applications.rb
 - test/test_hr_clients_offers.rb
 - test/test_hr_contracts.rb
@@ -189,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Upwork API (OAuth2).
@@ -202,6 +216,7 @@ test_files:
 - test/test_config.rb
 - test/test_freelancers_profile.rb
 - test/test_freelancers_search.rb
+- test/test_graphql.rb
 - test/test_hr_clients_applications.rb
 - test/test_hr_clients_offers.rb
 - test/test_hr_contracts.rb

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-script: rake
-rvm:
-  - 2.3.0
-  - 2.4.3
-  - 2.5.0
-  - jruby-head
-  - ruby-head
-install: gem install oauth2 test-unit mocha
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-notifications:
-  email:
-    recipients:
-      - apisupport@upwork.com
-    on_failure: change