odesk-api 0.1.0

data/lib/odesk/api/routers/organization/users.rb

@@ -0,0 +1,40 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      module Organization
+        # Users inside Organization
+        class Users
+          ENTRY_POINT = 'api'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Get Auth User Info
+          def get_my_info
+            $LOG.i "running " + __method__.to_s
+            @client.get '/hr/v2/users/me'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/payments.rb

@@ -0,0 +1,52 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      # Custom Payments
+      class Payments
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get adjustments
+        #
+        # Arguments:
+        #  team_reference: (String)
+        #  params: (Hash)
+        def submit_bonus(team_reference, params)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/hr/v2/teams/' + team_reference + '/adjustments', params
+        end
+        
+        # Submit bonus
+        #
+        # Arguments:
+        #  team_reference: (String)
+        #  params: (Hash)
+        def get_adjustments(team_reference, params)
+          $LOG.i "running " + __method__.to_s
+          @client.post '/hr/v2/teams/' + team_reference + '/adjustments', params
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/reports/finance/accounts.rb

@@ -0,0 +1,56 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      module Reports
+        module Finance
+          # Generate Financial Reports for Accounts
+          class Accounts
+            ENTRY_POINT = 'gds'
+            
+            # Init
+            #
+            # Arguments:
+            #  client: (Client)
+            def initialize(client)
+              @client = client
+              @client.epoint = ENTRY_POINT 
+            end
+            
+            # Generate Financial Reports for an owned Account
+            #
+            # Arguments:
+            #  freelancer_reference: (String)
+            #  params: (Hash)
+            def get_owned(freelancer_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/financial_account_owner/' + freelancer_reference, params
+            end
+            
+            # Generate Financial Reports for a Specific Account
+            #
+            # Arguments:
+            #  entity_reference: (String)
+            #  params: (Hash)
+            def get_specific(entity_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/financial_accounts/' + entity_reference, params
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/reports/finance/billings.rb

@@ -0,0 +1,86 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      module Reports
+        module Finance
+          # Generate Billing Reports
+          class Billings
+            ENTRY_POINT = 'gds'
+            
+            # Init
+            #
+            # Arguments:
+            #  client: (Client)
+            def initialize(client)
+              @client = client
+              @client.epoint = ENTRY_POINT 
+            end
+            
+            # Generate Billing Reports for a Specific Freelancer
+            #
+            # Arguments:
+            #  freelancer_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancer(freelancer_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/providers/' + freelancer_reference + '/billings', params
+            end
+            
+            # Generate Billing Reports for a Specific Freelancer's Team
+            #
+            # Arguments:
+            #  freelancer_team_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancers_team(freelancer_team_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/provider_teams/' + freelancer_team_reference + '/billings', params
+            end
+            
+            # Generate Billing Reports for a Specific Freelancer's Company
+            #
+            # Arguments:
+            #  freelancer_company_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancers_company(freelancer_company_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/provider_companies/' + freelancer_company_reference + '/billings', params
+            end
+            
+            # Generate Billing Reports for a Specific Buyer's Team
+            #
+            # Arguments:
+            #  buyer_team_reference: (String)
+            #  params: (Hash)
+            def get_by_buyers_team(buyer_team_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/buyer_teams/' + buyer_team_reference + '/billings', params
+            end
+            
+            # Generate Billing Reports for a Specific Buyer's Company
+            #
+            # Arguments:
+            #  buyer_company_reference: (String)
+            #  params: (Hash)
+            def get_by_buyers_company(buyer_company_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/buyer_companies/' + buyer_company_reference + '/billings', params
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/reports/finance/earnings.rb

@@ -0,0 +1,86 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      module Reports
+        module Finance
+          # Generate Earning Reports
+          class Earnings
+            ENTRY_POINT = 'gds'
+            
+            # Init
+            #
+            # Arguments:
+            #  client: (Client)
+            def initialize(client)
+              @client = client
+              @client.epoint = ENTRY_POINT 
+            end
+            
+            # Generate Earning Reports for a Specific Freelancer
+            #
+            # Arguments:
+            #  freelancer_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancer(freelancer_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/providers/' + freelancer_reference + '/earnings', params
+            end
+            
+            # Generate Earning Reports for a Specific Freelancer's Team
+            #
+            # Arguments:
+            #  freelancer_team_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancers_team(freelancer_team_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/provider_teams/' + freelancer_team_reference + '/earnings', params
+            end
+            
+            # Generate Earning Reports for a Specific Freelancer's Company
+            #
+            # Arguments:
+            #  freelancer_company_reference: (String)
+            #  params: (Hash)
+            def get_by_freelancers_company(freelancer_company_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/provider_companies/' + freelancer_company_reference + '/earnings', params
+            end
+            
+            # Generate Earning Reports for a Specific Buyer's Team
+            #
+            # Arguments:
+            #  buyer_team_reference: (String)
+            #  params: (Hash)
+            def get_by_buyers_team(buyer_team_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/buyer_teams/' + buyer_team_reference + '/earnings', params
+            end
+            
+            # Generate Earning Reports for a Specific Buyer's Company
+            #
+            # Arguments:
+            #  buyer_company_reference: (String)
+            #  params: (Hash)
+            def get_by_buyers_company(buyer_company_reference, params)
+              $LOG.i "running " + __method__.to_s
+              @client.get '/finreports/v2/buyer_companies/' + buyer_company_reference + '/earnings', params
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/reports/time.rb

@@ -0,0 +1,114 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      module Reports
+        # Time reports
+        class Time
+          ENTRY_POINT = 'gds'
+          
+          # Init
+          #
+          # Arguments:
+          #  client: (Client)
+          def initialize(client)
+            @client = client
+            @client.epoint = ENTRY_POINT 
+          end
+          
+          # Generate Time Reports for a Specific Team (with financial info)
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  params: (Hash)
+          def get_by_team_full(company, team, params)
+            $LOG.i "running " + __method__.to_s
+            get_by_type(company, team, nil, params, false)
+          end
+          
+          # Generate Time Reports for a Specific Team (hide financial info)
+          #
+          # Arguments:
+          #  company: (String)
+          #  team: (String)
+          #  params: (Hash)
+          def get_by_team_limited(company, team, params)
+            $LOG.i "running " + __method__.to_s
+            get_by_type(company, team, nil, params, true)
+          end
+          
+          # Generating Agency Specific Reports
+          #
+          # Arguments:
+          #  company: (String)
+          #  agency: (String)
+          #  params: (Hash)
+          def get_by_agency(company, agency, params)
+            $LOG.i "running " + __method__.to_s
+            get_by_type(company, nil, agency, params, false)
+          end
+          
+          # Generating Company Wide Reports
+          #
+          # Arguments:
+          #  company: (String)
+          #  params: (Hash)
+          def get_by_company(company, params)
+            $LOG.i "running " + __method__.to_s
+            get_by_type(company, nil, nil, params, false)
+          end
+          
+          # Generating Freelancer's Specific Reports (hide financial info)
+          #
+          # Arguments:
+          #  freelancer_id: (String)
+          #  params: (Hash)
+          def get_by_freelancer_limited(freelancer_id, params)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/timereports/v1/providers/' + freelancer_id, params
+          end
+          
+          # Generating Freelancer's Specific Reports (with financial info)
+          #
+          # Arguments:
+          #  freelancer_id: (String)
+          #  params: (Hash)
+          def get_by_freelancer_full(freelancer_id, params)
+            $LOG.i "running " + __method__.to_s
+            @client.get '/timereports/v1/providers/' + freelancer_id, params
+          end
+          
+          private
+          
+          def get_by_type(company, team, agency, params, hide_fin_data)
+            $LOG.i "running " + __method__.to_s
+            url = '';
+            if (team != nil)
+                url = '/teams/' + team;
+                if (hide_fin_data)
+                    url = url + '/hours';
+                end
+            elsif (agency != nil)
+                url = '/agencies/' + agency
+            end
+    
+            @client.get '/timereports/v1/companies/' + company + url, params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/snapshot.rb

@@ -0,0 +1,65 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      # Snapshot
+      class Snapshot
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get snapshot info
+        #
+        # Arguments:
+        #  company: (String)
+        #  username: (String)
+        #  ts: (String)
+        def get(company, username, ts)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/team/v1/snapshots/' + company + '/' + username + '/' + ts
+        end
+        
+        # Update snapshot
+        #
+        # Arguments:
+        #  company: (String)
+        #  username: (String)
+        #  ts: (String)
+        #  params: (Hash)
+        def update(company, username, ts, params)
+          $LOG.i "running " + __method__.to_s
+          @client.put '/team/v1/snapshots/' + company + '/' + username + '/' + ts, params
+        end
+        
+        # Delete snapshot
+        # Arguments:
+        #  company: (String)
+        #  username: (String)
+        #  ts: (String)
+        def delete(company, username, ts)
+          $LOG.i "running " + __method__.to_s
+          @client.delete '/team/v1/snapshots/' + company + '/' + username + '/' + ts
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/teams.rb

@@ -0,0 +1,47 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      # Team API
+      class Teams
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get Team Rooms
+        def get_list
+          $LOG.i "running " + __method__.to_s
+          @client.get '/team/v2/teamrooms'
+        end
+        
+        # Get specific team or company
+        # Arguments:
+        #  team: (String)
+        #  params: (Hash)
+        def get_specific(team, params)
+          $LOG.i "running " + __method__.to_s
+          @client.get '/team/v2/teamrooms/' + team, params
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/routers/workdiary.rb

@@ -0,0 +1,43 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk
+  module Api
+    module Routers
+      # Work Diary
+      class Workdiary
+        ENTRY_POINT = 'api'
+        
+        # Init
+        #
+        # Arguments:
+        #  client: (Client)
+        def initialize(client)
+          @client = client
+          @client.epoint = ENTRY_POINT 
+        end
+        
+        # Get Workdiary
+        # Arguments:
+        #  company: (String)
+        #  username: (String)
+        #  date: (String)
+        #  params: (Hash)
+        def get(company, username, date, params = {})
+          $LOG.i "running " + __method__.to_s
+          @client.get '/team/v1/workdiaries/' + company + '/' + username + '/' + date, params
+        end
+      end
+    end
+  end
+end

data/lib/odesk/api/version.rb

@@ -0,0 +1,18 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+module Odesk # :nodoc:
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/lib/odesk/api.rb

@@ -0,0 +1,29 @@
+# Licensed under the oDesk'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@odesk.com)
+# Copyright:: Copyright 2014(c) oDesk.com
+# License::   See LICENSE.txt and TOS - http://developers.odesk.com/API-Terms-of-Use
+
+require 'oauth'
+
+require 'odesk/api/version'
+require 'odesk/api/logger'
+require 'odesk/api/config'
+require 'odesk/api/client'
+
+module Odesk # :nodoc:
+  module Api
+    # define some constants
+    BASE_HOST       = 'https://www.odesk.com'
+    DEFAULT_EPOINT  = 'api'
+    
+    $LOG = Logger.new
+  end
+end

data/odesk-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'odesk/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "odesk-api"
+  spec.version       = Odesk::Api::VERSION
+  spec.authors       = ["Maksym Novozhylov"]
+  spec.email         = ["mnovozhilov@odesk.com"]
+  spec.summary       = %q{Ruby bindings for oDesk API.}
+  spec.description   = %q{Ruby bindings for oDesk API makes your life easier due to working with your oDesk's data.}
+  spec.homepage      = "http://developers.odesk.com"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+$:.unshift 'lib'
+
+require 'odesk/api'
+
+$LOG = Odesk::Api::Logger.new
+
+module TestHelper
+  def get_client_mock    
+    config = Odesk::Api::Config.new({
+      'consumer_key'    => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+      'consumer_secret' => 'xxxxxxxxxxxxxxxx',
+      'access_token'    => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+      'access_secret'   => 'xxxxxxxxxxxxxxxx',
+      'debug'           => false
+    })
+    
+    client = Odesk::Api::Client.new(config)
+    client.expects(:send_request).returns(true)
+    client
+  end
+end