upwork-api 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 687d56981732d041ce5ca1de7db6b05472a13190
+  data.tar.gz: 7382d3f5cd651e69a39a715daa3b1c19a702cccc
+SHA512:
+  metadata.gz: 7fd8b6660036d2f6e5a02cfe244d4cfa9af85756f36ab3e294e4be5cab2bdae2c2742e36da16c605ce37e9ff0ea911d2a11915dfcedd89d21a6ebbb717023533
+  data.tar.gz: 8999e166988f08b94c87937034991bde252fd0ed7b3f389290c14285e438044ee0dc84eb4e71e71629e834dca6e37958c53a6b0a9e819767cf91a90c9b3a5d97

data/README.md

@@ -21,7 +21,7 @@ These are the supported API resources:
 * Job and Freelancer Profile
 * Search Jobs and Freelancers
 * Organization
-* MC
+* Messages
 * Time and Financial Reporting
 * Metadata
 * Snapshot

data/Rakefile

@@ -1,6 +1,6 @@
 %w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
 $LOAD_PATH << File.dirname(__FILE__) + '/lib'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'oauth'
 
 Rake::TestTask.new do |t|
@@ -9,4 +9,4 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task :default => :test

data/example/myapp.rb

@@ -6,7 +6,6 @@ $LOAD_PATH << File.dirname(__FILE__)
 
 require 'upwork/api'
 require 'upwork/api/routers/auth'
-require 'upwork/api/routers/mc'
 require 'upwork/api/routers/reports/time'
 require 'upwork/api/routers/freelancers/search'
 #require 'pry'
@@ -39,17 +38,10 @@ end
 auth = Upwork::Api::Routers::Auth.new(client)
 info = auth.get_user_info
 
-# work with mc
-mc = Upwork::Api::Routers::Mc.new(client)
-mc_response = mc.get_trays
- 
-# mark the thread
-#response = mc.mark_thread 'username', '88888', {'read' => 'false'}
-
 report = Upwork::Api::Routers::Reports::Time.new(client)
 report_response = report.get_by_freelancer_limited('mnovozhilov', {'tqx' => 'out:json', 'tq' => "select task where worked_on >= '2014-06-01' AND worked_on <= '2014-06-03' order by worked_on"})
 
-p info['info']['portrait_32_img'], mc_response['trays'], report_response
+p info['info']['portrait_32_img'], report_response
 
 params = {'q' => 'python'}
 freelancers = Upwork::Api::Routers::Freelancers::Search.new(client)

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

@@ -0,0 +1,129 @@
+# 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 2016(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      class Messages
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Retrieve rooms information
+        #
+        # Arguments:
+        #  company: (String)
+        #  params: (Hash)
+        def get_rooms(company, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/messages/v3/' + company + '/rooms', params
+        end
+        
+        # Get a specific room information
+        #
+        # Arguments:
+        #  company: (String)
+	#  room_id: (String)
+        #  params: (Hash)
+        def get_room_details(company, room_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/messages/v3/' + company + '/rooms/' + room_id, params
+        end
+        
+        # Get a specific room by offer ID
+        #
+        # Arguments:
+        #  company: (String)
+	#  offer_id: (String)
+        #  params: (Hash)
+        def get_room_by_offer(company, offer_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/messages/v3/' + company + '/rooms/offers/' + offer_id, params
+        end
+        
+        # Get a specific room by application ID
+        #
+        # Arguments:
+        #  company: (String)
+	#  application_id: (String)
+        #  params: (Hash)
+        def get_room_by_application(company, application_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/messages/v3/' + company + '/rooms/applications/' + application_id, params
+        end
+        
+        # Get a specific room by contract ID
+        #
+        # Arguments:
+        #  company: (String)
+	#  contract_id: (String)
+        #  params: (Hash)
+        def get_room_by_contract(company, contract_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/messages/v3/' + company + '/rooms/contracts/' + contract_id, params
+        end
+        
+        # Create a new room
+        #
+        # Arguments:
+        #  company: (String)
+        #  params: (Hash)
+        def create_room(company, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.post '/messages/v3/' + company + '/rooms', params
+        end
+        
+        # Send a message to a room
+        #
+        # Arguments:
+        #  company: (String)
+	#  room_id: (String)
+        #  params: (Hash)
+        def send_message_to_room(company, room_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.post '/messages/v3/' + company + '/rooms/' + room_id + '/stories', params
+        end
+        
+        # Update a room settings
+        #
+        # Arguments:
+        #  company: (String)
+	#  room_id: (String)
+	#  username: (String)
+        #  params: (Hash)
+        def update_room_settings(company, room_id, username, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.put '/messages/v3/' + company + '/rooms/' + room_id + '/users/' + username, params
+        end
+        
+        # Update the metadata of a room
+        #
+        # Arguments:
+        #  company: (String)
+	#  room_id: (String)
+        #  params: (Hash)
+        def update_room_metadata(company, room_id, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.put '/messages/v3/' + company + '/rooms/' + room_id, params
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/version.rb

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

data/test/test_config.rb

@@ -5,7 +5,7 @@ require 'test/unit'
 require 'mocha/test_unit'
 
 class ConfigTest < Test::Unit::TestCase
-  def test_config_initialization
+  def test_my_config_initialization
     config = Upwork::Api::Config.new({
       'consumer_key'    => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
       'consumer_secret' => 'xxxxxxxxxxxxxxxx',
@@ -22,4 +22,4 @@ class ConfigTest < Test::Unit::TestCase
     assert_equal 'sig',config.signature_method
     assert_equal false,config.debug
   end
-end
+end

data/test/test_messages.rb

@@ -0,0 +1,56 @@
+$:.unshift 'lib'
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'helper'
+require 'upwork/api/routers/messages'
+require 'test/unit'
+require 'mocha/test_unit'
+
+class MessagesTest < Test::Unit::TestCase
+  include TestHelper
+  
+  def test_get_rooms
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.get_rooms('company')
+  end
+  
+  def test_get_room_details
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.get_room_details('company', 'room-id', {})
+  end
+  
+  def test_get_room_by_offer
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.get_room_by_offer('company', '1234', {})
+  end
+  
+  def test_get_room_by_application
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.get_room_by_application('company', '1234', {})
+  end
+  
+  def test_get_room_by_contract
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.get_room_by_contract('company', '1234', {})
+  end
+  
+  def test_create_room
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.create_room('company', {})
+  end
+  
+  def test_send_message_to_room
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.send_message_to_room('company', 'room-id', {})
+  end
+  
+  def test_update_room_settings
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.update_room_settings('company', 'room-id', 'username', {})
+  end
+  
+  def test_update_room_metadata
+    api = Upwork::Api::Routers::Messages.new(get_client_mock)
+    assert api.update_room_metadata('company', 'room-id', {})
+  end
+end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: upwork-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Maksym Novozhylov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby bindings for Upwork API makes your life easier due to working with
@@ -99,9 +88,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .docgen
-- .gitignore
-- .travis.yml
+- ".docgen"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -129,7 +118,7 @@ files:
 - lib/upwork/api/routers/hr/submissions.rb
 - lib/upwork/api/routers/jobs/profile.rb
 - lib/upwork/api/routers/jobs/search.rb
-- lib/upwork/api/routers/mc.rb
+- lib/upwork/api/routers/messages.rb
 - lib/upwork/api/routers/metadata.rb
 - lib/upwork/api/routers/organization/companies.rb
 - lib/upwork/api/routers/organization/teams.rb
@@ -166,7 +155,7 @@ files:
 - test/test_jobs_profile.rb
 - test/test_jobs_search.rb
 - test/test_logger.rb
-- test/test_mc.rb
+- test/test_messages.rb
 - test/test_metadata.rb
 - test/test_organization_companies.rb
 - test/test_organization_teams.rb
@@ -184,27 +173,26 @@ files:
 homepage: http://developers.upwork.com
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for Upwork API.
 test_files:
 - test/helper.rb
@@ -229,7 +217,7 @@ test_files:
 - test/test_jobs_profile.rb
 - test/test_jobs_search.rb
 - test/test_logger.rb
-- test/test_mc.rb
+- test/test_messages.rb
 - test/test_metadata.rb
 - test/test_organization_companies.rb
 - test/test_organization_teams.rb

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

@@ -1,113 +0,0 @@
-# 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
-
-module Upwork
-  module Api
-    module Routers
-      class Mc
-        ENTRY_POINT = 'api'
-        
-        # Init
-        #
-        # Arguments:
-        #  client: (Client)
-        def initialize(client)
-          @client = client
-          @client.epoint = ENTRY_POINT 
-        end
-        
-        # Get trays
-        def get_trays
-          $LOG.i "running " + __method__.to_s
-          @client.get '/mc/v1/trays'
-        end
-        
-        # Get tray by type
-        #
-        # Arguments:
-        #  username: (String)
-        #  type: (String)
-        def get_tray_by_type(username, type)
-          $LOG.i "running " + __method__.to_s
-          @client.get '/mc/v1/trays/' + username + '/' + type
-        end
-        
-        # List thread details based on thread id
-        #
-        # Arguments:
-        #  username: (String)
-        #  thread_id: (String)
-        def get_thread_details(username, thread_id)
-          $LOG.i "running " + __method__.to_s
-          @client.get '/mc/v1/threads/' + username + '/' + thread_id
-        end
-        
-        # Get a specific thread by context
-        #
-        # Arguments:
-        #  username: (String)
-        #  job_key: (String)
-        #  application_id: (String)
-        #  context: (String)
-        def get_thread_by_context(username, job_key, application_id, context = 'Interviews')
-          $LOG.i "running " + __method__.to_s
-          @client.get '/mc/v1/contexts/' + username + '/' + context + ':' + job_key + ':' + application_id
-        end
-        
-        # Get a specific thread by context (last message content)
-        #
-        # Arguments:
-        #  username: (String)
-        #  job_key: (String)
-        #  application_id: (String)
-        #  context: (String)
-        def get_thread_by_context_last_posts(username, job_key, application_id, context = 'Interviews')
-          $LOG.i "running " + __method__.to_s
-          @client.get '/mc/v1/contexts/' + username + '/' + context + ':' + job_key + ':' + application_id + '/last_posts'
-        end
-        
-        # Send new message
-        #
-        # Arguments:
-        #  username: (String)
-        #  params: (Hash)
-        def start_new_thread(username, params = {})
-          $LOG.i "running " + __method__.to_s
-          @client.post '/mc/v1/threads/' + username, params
-        end
-        
-        # Reply to existent thread
-        #
-        # Arguments:
-        #  username: (String)
-        #  thread_id: (String)
-        #  params: (Hash)
-        def reply_to_thread(username, thread_id, params = {})
-          $LOG.i "running " + __method__.to_s
-          @client.post '/mc/v1/threads/' + username + '/' + thread_id, params
-        end
-        
-        # Update threads based on user actions
-        #
-        # Arguments:
-        #  username: (String)
-        #  thread_id: (String)
-        #  params: (Hash)
-        def mark_thread(username, thread_id, params = {})
-          $LOG.i "running " + __method__.to_s
-          @client.put '/mc/v1/threads/' + username + '/' + thread_id, params
-        end
-      end
-    end
-  end
-end

data/test/test_mc.rb

@@ -1,51 +0,0 @@
-$:.unshift 'lib'
-$LOAD_PATH << File.dirname(__FILE__)
-
-require 'helper'
-require 'upwork/api/routers/mc'
-require 'test/unit'
-require 'mocha/test_unit'
-
-class McTest < Test::Unit::TestCase
-  include TestHelper
-  
-  def test_get_trays
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.get_trays
-  end
-  
-  def test_get_tray_by_type
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.get_tray_by_type('username', 'type')
-  end
-  
-  def test_get_thread_details
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.get_thread_details('username', '12')
-  end
-  
-  def test_get_thread_by_context
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.get_thread_by_context('username', '~key', '12')
-  end
-  
-  def test_get_thread_by_context_last_posts
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.get_thread_by_context_last_posts('username', '~key', '12')
-  end
-  
-  def test_start_new_thread
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.start_new_thread('username', {})
-  end
-  
-  def test_reply_to_thread
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.reply_to_thread('username', '12', {})
-  end
-  
-  def test_mark_thread
-    api = Upwork::Api::Routers::Mc.new(get_client_mock)
-    assert api.mark_thread('username', '12', {})
-  end
-end