upwork-api 1.0.0

data/lib/upwork/api/config.rb

@@ -0,0 +1,42 @@
+# 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
+    # Config storage
+    class Config
+      @@debug = false;
+      
+      attr_accessor :access_token, :access_secret
+      attr_reader :consumer_key, :consumer_secret, :signature_method
+      
+      # Init config object
+      #
+      # Arguments:
+      #  config: (Hash)
+      def initialize(config = {})
+        @consumer_key, @consumer_secret = config['consumer_key'], config['consumer_secret']
+        @access_token, @access_secret = config['access_token'], config['access_secret']
+        @signature_method = config['signature_method']
+        @@debug = config['debug']
+
+        $DEBUG = self.debug
+      end
+
+      # Get debug status
+      def debug # :nodoc:
+        @@debug
+      end
+    end
+  end
+end

data/lib/upwork/api/logger.rb

@@ -0,0 +1,35 @@
+# 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
+    # Logger for debug process
+    class Logger
+      # Print information string and dump parameter if any
+      #
+      # Arguments:
+      #  str: (String)
+      #  param: (Mixed)
+      def i(str, param = nil)
+        if $DEBUG
+          puts "> #{str}"
+          if param
+            puts "<< dump-begin >>"
+            p param
+            puts "<< dump-end >>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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
+      module Activities
+        # Engagement Activities
+        class Engagement
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # List activities for specific engagement
+          #
+          # Arguments:
+          #  engagement_ref: (String)
+          def get_specific(engagement_ref)
+            @client.get '/tasks/v2/tasks/contracts/' + engagement_ref
+          end
+          
+          # Assign engagements to the list of activities
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  engagement: (String)
+          #  params: (Hash)
+          def assign(company, team, engagement, params)
+            @client.put '/otask/v1/tasks/companies/' + company + '/' + team + '/engagements/' + engagement, params
+          end
+        
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# 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
+      module Activities
+        # Team Activities
+        class Team
+          ENTRY_POINT = 'api'
+
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT
+          end
+
+          # List all oTask/Activity records within a team
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          def get_list(company, team)
+            get_by_type company, team, nil
+          end
+
+          # List all oTask/Activity records within a Company by specified code(s)
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  code: (String)
+          def get_specific_list(company, team, code)
+            get_by_type company, team, code
+          end
+
+          # Create an oTask/Activity record within a team
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  params: (Hash)
+          def add_activity(company, team, params)
+            @client.post '/otask/v1/tasks/companies/' + company + '/' + team + '/tasks', params
+          end
+
+          # Update specific oTask/Activity record within a team
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  code: (String)
+          #  params: (Hash)
+          def update_activities(company, team, code, params)
+            @client.put '/otask/v1/tasks/companies/' + company + '/' + team + '/tasks/' + code, params
+          end
+
+          # Archive specific oTask/Activity record within a team
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  code: (String)
+          def archive_activities(company, team, code)
+            @client.put '/otask/v1/tasks/companies/' + company + '/' + team + '/archive/' + code
+          end
+
+          # Unarchive specific oTask/Activity record within a team
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  code: (String)
+          def unarchive_activities(company, team, code)
+            @client.put '/otask/v1/tasks/companies/' + company + '/' + team + '/unarchive/' + code
+          end
+
+          # Update a group of oTask/Activity records within a company
+          #
+          # Arguments:
+          #  company: (String)
+          #  params: (Hash)
+          def update_batch(company, params)
+            @client.put '/otask/v1/tasks/companies/' + company + '/tasks/batch', params
+          end
+
+          private
+
+          # Get by type
+          def get_by_type(company, team, code = nil)
+            $LOG.i "running " + __method__.to_s
+            url = '';
+            if code != nil
+                url = '/' + code;
+            end
+
+            @client.get '/otask/v1/tasks/companies/' + company + '/' + team + '/tasks' + url
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/upwork/api/routers/auth.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 2014(c) Upwork.com
+# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html
+
+module Upwork
+  module Api
+    module Routers
+      # Get My Info
+      class Auth
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get info of authenticated user
+        def get_user_info
+          $LOG.i "running " + __method__.to_s
+          @client.get '/auth/v1/info'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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
+      module Freelancers
+        # Freelancer's profile info
+        class Profile
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Get specific profile
+          #
+          # Arguments:
+          #  key: (String)
+          def get_specific(key)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/profiles/v1/providers/' + key
+          end
+
+          # Get brief info on specific profile
+          #
+          # Arguments:
+          #  key: (String)
+          def get_specific_brief(key)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/profiles/v1/providers/' + key + '/brief'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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
+      module Freelancers
+        # Search Freelancer's profiles
+        class Search
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Search profiles
+          #
+          # Arguments:
+          #  params: (Hash)
+          def find(params)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/profiles/v2/search/providers', params
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+      module Hr
+        module Clients
+          # Client Job Applications API
+          class Applications
+            ENTRY_POINT = 'api'
+            
+            # Init
+            #
+            # Arguments:
+            #  client: (Client)
+            def initialize(client)
+              @client = client
+              @client.epoint = ENTRY_POINT 
+            end
+            
+            # Get list of applications
+            #
+            # Arguments:
+            #  params: (Hash)
+            def get_list(params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/hr/v3/clients/applications', params
+            end
+            
+            # Get specific application
+            #
+            # Arguments:
+            #  reference: (String)
+            #  params: (Hash)
+            def get_specific(reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/hr/v3/clients/applications/' + reference, params
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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
+      module Hr
+        module Clients
+          # Client Job Offers API
+          class Offers
+            ENTRY_POINT = 'api'
+            
+            # Init
+            #
+            # Arguments:
+            #  client: (Client)
+            def initialize(client)
+              @client = client
+              @client.epoint = ENTRY_POINT 
+            end
+            
+            # Get list of offers
+            #
+            # Arguments:
+            #  params: (Hash)
+            def get_list(params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/offers/v1/clients/offers', params
+            end
+            
+            # Get specific offer
+            #
+            # Arguments:
+            #  reference: (String)
+            #  params: (Hash)
+            def get_specific(reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/offers/v1/clients/offers/' + reference, params
+            end
+            
+            # Make an Offer
+            #
+            # Arguments:
+            #  params: (Hash)
+            def make_offer(params)
+              $LOG.i "running " + __method__.to_s
+              @client.post '/offers/v1/clients/offers', params
+            end
+          end
+        end
+      end
+    end
+  end
+end