ruby-upwork-oauth2 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f950287c9a08d380f4911c57feb1ed858341264e52f34037f2d9f83223f02af
+  data.tar.gz: 39ea135cbab5433dcbee0febcd68a90dc49fa4b5cf9ad7c0e314b990e77f61b6
+SHA512:
+  metadata.gz: 02a09a90a058d02cb7aaf06e111355dcf469aab4884f9c98f6f243d50aad5dfb74ac480da327677cbbcb8b68726a4829f3e7eec13eb3f3bf07238b1c3da5e56a
+  data.tar.gz: da5e2095a70f08564f10126b901fb98a3336bf8135806e0ba5bd08e8ab2a112a38d996b182404b12a018976e942e465d5934fe66fd254ea2108fab573da55a46

data/.docgen

@@ -0,0 +1 @@
+rdoc

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+script: rake
+rvm:
+  - 2.2.2
+  - 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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in upwork-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,80 @@
+Ruby bindings for Upwork API (OAuth2)
+============
+
+[![License](http://img.shields.io/packagist/l/upwork/php-upwork.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+[![Gem Version](https://badge.fury.io/rb/upwork-api.svg)](http://badge.fury.io/rb/upwork-api)
+[![GitHub release](https://img.shields.io/github/release/upwork/ruby-upwork.svg)](https://github.com/upwork/ruby-upwork/releases)
+[![Build Status](https://travis-ci.org/upwork/ruby-upwork.svg)](https://travis-ci.org/upwork/ruby-upwork)
+[![Stories in Ready](http://badge.waffle.io/upwork/ruby-upwork.png)](http://waffle.io/upwork/ruby-upwork)
+
+# Upwork::Api
+
+This project provides a set of resources of Upwork API from http://developers.upwork.com
+ 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
+
+# License
+
+Copyright 2018 Upwork Corporation. All Rights Reserved.
+
+ruby-upwork is licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+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.
+
+## SLA
+The usage of this API is ruled by the Terms of Use at:
+
+    https://developers.upwork.com/api-tos.html
+
+# Application Integration
+To integrate this library you need to have:
+
+* Ruby >= 1.9.3
+* OAuth2 Extension installed (use `gem install oauth2`)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'upwork-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install upwork-api
+
+## Usage
+
+1.
+Follow instructions from the `Installation` section.
+
+2.
+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.
+***That's all. Run your app as `ruby example.rb` and have fun.***'

data/Rakefile

@@ -0,0 +1,12 @@
+%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+require 'bundler/gem_tasks'
+require 'oauth2'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/example/example.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby
+
+$:.unshift '../lib'
+
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'upwork/api'
+require 'upwork/api/routers/auth'
+require 'upwork/api/routers/messages'
+require 'upwork/api/routers/reports/time'
+require 'upwork/api/routers/freelancers/search'
+
+# initiate config
+config = Upwork::Api::Config.new({
+  'client_id'     => 'xxxxxxxx',
+  'client_secret' => 'xxxxxxxx',
+  'redirect_uri'  => 'https://a.callback.url',
+#  'access_token'  => 'xxxxxxxx',
+#  'refresh_token' => 'xxxxxxxx',
+#  'expires_in'    => '86399'
+#  'expires_at'    => '1518017490',
+#  'debug'         => true
+})
+
+# setup client
+client = Upwork::Api::Client.new(config)
+
+# 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
+  authz_url = client.get_authorization_url
+
+  puts "Visit the authorization url and provide [authorization code] for further authorization"
+  puts authz_url
+  authz_code = gets.strip
+  @token = client.get_access_token(authz_code)
+  # store access token data in safe place!
+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
+
+# get my auth data
+#auth = Upwork::Api::Routers::Auth.new(client)
+#info = auth.get_user_info
+#p info['server_time']
+
+# work with timereports
+#report = Upwork::Api::Routers::Reports::Time.new(client)
+#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"})
+
+# work with search
+#params = {'q' => 'python AND java AND (perl OR php)'}
+#freelancers = Upwork::Api::Routers::Freelancers::Search.new(client)
+#p freelancers.find(params)
+
+# work with messages
+#messages = Upwork::Api::Routers::Messages.new(client)
+#params = {
+#  'story' => '{"message": "test message from api", "userId": "~xxxxxxxx", "orgId": "xxxxxxxx"}'
+#}
+#messages.send_message_to_room 'company-xxxxxxxx', 'room-xxxxxxxx', params

data/lib/upwork/api.rb

@@ -0,0 +1,29 @@
+# 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 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+require 'oauth2'
+
+require 'upwork/api/version'
+require 'upwork/api/logger'
+require 'upwork/api/config'
+require 'upwork/api/client'
+
+module Upwork # :nodoc:
+  module Api
+    # define some constants
+    BASE_HOST       = 'https://www.upwork.com'
+    DEFAULT_EPOINT  = 'api'
+    
+    $LOG = Logger.new
+  end
+end

data/lib/upwork/api/client.rb

@@ -0,0 +1,184 @@
+# 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 2018(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+require 'json'
+require 'uri'
+
+module Upwork
+  module Api
+    # Client for accessing API
+    class Client
+      DATA_FORMAT   = 'json'
+      OVERLOAD_VAR  = "http_method"
+      
+      URI_AUTH    = "/ab/account-security/oauth2/authorize"
+      URI_RTOKEN  = "/api/v3/oauth2/token" # refresh
+      URI_ATOKEN  = "/api/v3/oauth2/token" # access
+      
+      attr_accessor :epoint
+      attr_reader :url_auth, :url_rtoken, :url_atoken
+      
+      # Init client
+      #
+      # Arguments:
+      #  config: (Config)
+      def initialize(config)
+        $LOG.i('initializing client')
+        @config = config
+        @epoint = Upwork::Api::DEFAULT_EPOINT
+	@url_auth, @url_rtoken, @url_atoken = URI_AUTH, URI_RTOKEN, URI_ATOKEN
+
+	@oauth2_client = OAuth2::Client.new(
+          @config.client_id,
+          @config.client_secret,
+	  :site => Upwork::Api::BASE_HOST,
+	  :authorize_url => @url_auth,
+	  :token_url => @url_atoken
+	)
+      end
+      
+      # Start auth process and get authorization URL
+      def get_authorization_url
+        $LOG.i "requesting authorization URL"
+ 
+        @oauth2_client.auth_code.authorize_url(:redirect_uri => @config.redirect_uri)
+      end
+      
+      # Finish auth process and get access token
+      #
+      # 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
+
+	refresh_config_from_access_token
+
+	@access_token
+      end
+
+      # Get actual client config
+      def get_actual_config
+        @config
+      end
+      
+      # Run GET request
+      #
+      # Arguments:
+      #  uri: (String)
+      #  param: (Hash)
+      def get(uri, params = {})
+        send_request(uri, :get, params)
+      end
+      
+      # Run POST request
+      #
+      # Arguments:
+      #  uri: (String)
+      #  param: (Hash)
+      def post(uri, params = {})
+        send_request(uri, :post, params)
+      end
+      
+      # Run PUT request
+      #
+      # Arguments:
+      #  uri: (String)
+      #  param: (Hash)
+      def put(uri, params = {})
+        send_request(uri, :put, params)
+      end
+      
+      # Run DELETE request
+      #
+      # Arguments:
+      #  uri: (String)
+      #  param: (Hash)
+      def delete(uri, params = {})
+        send_request(uri, :delete, params)
+      end
+      
+      # Get full URL
+      def full_url(uri) # :nodoc:
+        Upwork::Api::BASE_HOST + '/' + get_uri_with_format(uri);
+      end
+      
+      # Get URI with :format
+      def get_uri_with_format(uri) # :nodoc:
+        (@epoint) + uri + ((@epoint == 'api') ? '.' + DATA_FORMAT : '')
+      end
+      
+      private
+
+      # Refresh config from the actual access token
+      def refresh_config_from_access_token
+        $LOG.i "saving access token data in config object"
+        
+        @config.access_token  = @access_token.token
+        @config.refresh_token = @access_token.refresh_token
+        @config.expires_in = @access_token.expires_in
+        @config.expires_at = @access_token.expires_at
+
+	$LOG.i "new config is", @config
+        
+        @config
+      end
+      
+      # get url with parameters for get requests
+      def get_url_with_params(path, params)
+        "#{path}?".concat(params.collect{|k,v| "#{k}=#{OAuth::Helper::escape(v.to_s)}"}.join("&"))
+      end
+      
+      # Send request
+      def send_request(uri, method = :get, params = {}) # :nodoc:
+        $LOG.i "send request for url", uri
+        $LOG.i "and method", method
+        
+        if method == :put or method == :delete
+          $LOG.i "add overload parameter"
+          params[OVERLOAD_VAR] = method.to_s
+        end
+        
+        $LOG.i "and parameters", params
+        
+        @access_token = OAuth2::AccessToken.new(
+	  @oauth2_client,
+	  @config.access_token,
+	  :refresh_token => @config.refresh_token,
+	  :expires_at => @config.expires_at
+	)
+
+	# expired? then refresh it
+	if @access_token.expired?
+	  $LOG.i "access token has expired, refreshing..."
+	  @access_token = @access_token.refresh!
+	  refresh_config_from_access_token
+	end
+
+        case method
+        when :get
+          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
+        else
+          raise ArgumentError, "Don't know how to handle http method: :#{method.to_s}"
+        end
+        $LOG.i "got response from server", response
+        JSON.parse(response)
+      end
+      
+    end
+  end
+end