ruby-upwork-oauth2 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30396e38e7003832bc1afee54cb092275109658e4054ff0aa477f1d587075dc9
-  data.tar.gz: dfc128c0a3fe618af664075bce4f87f3adcb9255ad653620e8ddf8dd1684f320
+  metadata.gz: 9c2b73f43493b0b28b2e57c5a6f0f585e6fdb5dae551c7727a08aebee090472c
+  data.tar.gz: 7bc58ddae0c69c0623af09ab601da75ebc90998d2d28ef8a8e9007cf1c64729d
 SHA512:
-  metadata.gz: 71b9945740d5412cc7c80e720ba4f73ed06b70a409fd7e36f09153c33adb49d4f9fb9d5abaab818a4d3f721cd49c142688f9e630d1f50093a461470750317a64
-  data.tar.gz: 7ad335171b968d0b6e53cb22807e781ba0f4f0f8d334df7c866075ae408c37d498222f9486260705a1d4583f75aac19444d9c2613a5fc4dfba7ffbd3e4d4dd2e
+  metadata.gz: 79f1166d56aab80b453ba1903f76eac2bece055edee57e3d21e43f698f56dba973339d0256e08bf5639030a2ac5ee81f85b741ec152ed7cfc08be2cd38c9f6e5
+  data.tar.gz: 6892be3d8566e75fc102fb2a2269f90d90a6e8089897e513b8b464ccd31f68635ed886412ccafa96802dd58930f26819e68ad4c6c0d78dd4f9966a2712c97ab0

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: [ '2.7.3', '2.6.7', '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/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/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.4"
+    VERSION = "2.2.0"
   end
 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.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Maksym Novozhylov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -119,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
@@ -155,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
@@ -201,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Upwork API (OAuth2).
@@ -214,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