ruby_desk 0.2.0 → 0.3.0

data/README.rdoc

@@ -6,7 +6,7 @@ A gem built by BadrIT (www.badrit.com) that works as an interface for oDesk APIs
 Initialize with your api key
   rd = RubyDesk::Connector.new(api_key, api_secret)
 
-Gets the URL that will ask the user to authenticate your application
+Get the URL that will ask the user to authenticate your application
   rd.auth_url
 
 You should then redirect the user to the returned URL to get the frob.
@@ -23,3 +23,4 @@ Now you are ready to use all the APIs you need
 == Copyright
 
 Copyright (c) 2010 Ahmed ElDawy. See LICENSE for details.
+

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ruby_desk/connector.rb

@@ -5,12 +5,15 @@ require 'net/https'
 
 module RubyDesk
   class Connector
-    ODESK_API_URL = "www.odesk.com/api/"
-    ODESK_AUTH_URL = "www.odesk.com/services/api/auth/"
-    DEFAULT_OPTIONS = {:secure=>true, :sign=>true, :format=>'xml'}
-    
+    ODESK_URL = "www.odesk.com/"
+    ODESK_API_URL = "#{ODESK_URL}api/"
+    ODESK_GDS_URL = "#{ODESK_URL}gds/"
+    ODESK_AUTH_URL = "#{ODESK_URL}services/api/auth/"
+    DEFAULT_OPTIONS = {:secure=>true, :sign=>true, :format=>'json',
+      :base_url=>ODESK_API_URL, :auth=>true, :params=>{} }
+
     attr_writer :frob
-    
+
     def initialize(api_key=nil, api_secret=nil, frob=nil, api_token=nil)
       @api_key = api_key
       @api_secret = api_secret
@@ -19,46 +22,52 @@ module RubyDesk
       @api_key = "991ac77f4c202873b0ab88f11762370c"
       @api_secret = "c3382d5902e5a7b0"
     end
-    
-    # Sign the given parameters and returns the signature 
+
+    # Sign the given parameters and returns the signature
     def sign(params)
       # sort parameters by its names (keys)
       sorted_params = params.sort { |a, b| a.to_s <=> b.to_s}
-      
+
       # concatenate secret with names, values
       concatenated = @api_secret + sorted_params.to_s
-      
-      # Calculate md5 of concatenated string
-      md5 = Digest::MD5.hexdigest(concatenated)
-      
-      # Return the calculated value as the signature
-      md5
+
+      # Calculate and return md5 of concatenated string
+      Digest::MD5.hexdigest(concatenated)
     end
-    
+
     # Returns the correct URL to go to to invoke the given api
     # path: the path of the API to call. e.g. 'auth'
-    # params: a hash of parameters that needs to be appended
     # options:
     # * :secure=>false: Whether a secure connection is required or not.
     # * :sign=>true: Whether you need to sign the parameters or not
-    def prepare_api_call(path, params = {}, options = {})
+    # * :params=>{}: a hash of parameters that needs to be appended
+    # * :auth=>true: when true indicates that this call need authentication.
+    #     This forces adding :api_token, :api_key and :api_sig to parameters.
+    def prepare_api_call(path, options = {})
       options = DEFAULT_OPTIONS.merge(options)
-      params[:api_sig] = sign(params) if options[:sign]
-      {:url=>"http#{options[:secure]? 's' : ''}://" + ODESK_API_URL + path + "." + options[:format],
-          :params=> params, :method=>options[:method]}
+      params = options[:params]
+      params[:api_sig] = sign(params) if options[:sign] || options[:auth]
+      if options[:auth]
+        params[:api_token] ||= @api_token
+        params[:api_key] ||= @api_key
+      end
+      url = (options[:secure] ? "https" : "http") + "://"
+      url << options[:base_url] << path
+      url << ".#{options[:format]}" if options[:format]
+      return {:url=>url, :params=> params, :method=>options[:method]}
     end
-    
+
     # invokes the given API call and returns body of the response as text
     def invoke_api_call(api_call)
       url = URI.parse(api_call[:url])
       http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
-  
+
       data = api_call[:params].to_a.map{|pair| pair.join '='}.join('&')
       headers = {
         'Content-Type' => 'application/x-www-form-urlencoded'
       }
-      
+
       case api_call[:method]
         when :get, 'get' then
           resp, data = http.request(Net::HTTP::Get.new(url.path+"?"+data, headers))
@@ -67,28 +76,30 @@ module RubyDesk
         when :delete, 'delete' then
           resp, data = http.request(Net::HTTP::Delete.new(url.path, headers), data)
       end
-      
+
       return data
     end
-    
+
     # Prepares an API call with the given arguments then invokes it and returns its body
-    def prepare_and_invoke_api_call(path, params = {}, options = {})
-      api_call = prepare_api_call(path, params, options)
+    def prepare_and_invoke_api_call(path, options = {})
+      api_call = prepare_api_call(path, options)
       invoke_api_call(api_call)
     end
-    
+
     # Returns the URL that authenticates the application for the current user
     def auth_url
-      params = {:api_key=>@api_key}
-      params[:api_sig] = sign(params)
-      "https://"+ODESK_AUTH_URL+"?"+params.to_a.map{|pair| pair.join '='}.join('&')
+      auth_call = prepare_api_call("", :params=>{:api_key=>@api_key},
+        :base_url=>ODESK_AUTH_URL)
+      return auth_call[:url]
     end
-    
+
     # return the URL that logs user out of odesk applications
     def logout_url
-      "https://"+ODESK_AUTH_URL
+      logout_call = prepare_api_call("", :base_url=>ODESK_AUTH_URL,
+        :secure=>false)
+      return logout_call[:url]
     end
-    
+
     # Returns an authentication frob.
     #  Parameters
     #    * frob
@@ -98,11 +109,13 @@ module RubyDesk
     #  Return Data
     #    * token
     def get_token
-      response = prepare_and_invoke_api_call 'auth/v1/keys/tokens', {:frob=>@frob, :api_key=>@api_key}, :method=>:post, :format=>'json'
+      response = prepare_and_invoke_api_call 'auth/v1/keys/tokens',
+          :params=>{:frob=>@frob, :api_key=>@api_key}, :method=>:post,
+          :auth=>false
       json = JSON.parse(response)
       @api_token = json['token']
     end
-    
+
     # Returns an authentication frob.
     #Parameters
     #    * api_key
@@ -110,25 +123,26 @@ module RubyDesk
     #
     #Return Data
     #    * frob
-    
+
     def get_frob
-      response = prepare_and_invoke_api_call 'auth/v1/keys/frobs', {:api_key=>@api_key}, :method=>:post, :format=>'json'
+      response = prepare_and_invoke_api_call 'auth/v1/keys/frobs',
+        :params=>{:api_key=>@api_key}, :method=>:post, :auth=>false
       json = JSON.parse(response)
       @frob = json['frob']
     end
-    
+
     # Returns the authenticated user associated with the given authorization token.
     #  Parameters
-    #  
+    #
     #      * api_key
     #      * api_sig
     #      * api_token
-    #  
+    #
     #  Return Data
-    #  
-    #      * token     
+    #
+    #      * token
     def check_token
-      prepare_and_invoke_api_call 'auth/v1/keys/token', {:api_key=>@api_key, :api_token=>@api_token}, :method=>:get, :format=>'json'
+      prepare_and_invoke_api_call 'auth/v1/keys/token', :method=>:get
       json = JSON.parse(response)
       # TODO what to make with results?
       return json
@@ -141,9 +155,10 @@ module RubyDesk
     #  * api_token
 
     def revoke_token
-      prepare_and_invoke_api_call 'auth/v1/keys/token', {:api_key=>@api_key, :api_token=>@api_token}, :method=>:delete, :format=>'json'
+      prepare_and_invoke_api_call 'auth/v1/keys/token', :method=>:delete
       @api_token = nil
     end
-  
+
   end
 end
+

data/lib/ruby_desk/provider.rb

@@ -1,91 +1,7 @@
 class RubyDesk::Provider < RubyDesk::OdeskEntity
   class << self
     def all_categories
-      text = <<-CATEGORIES
-            Web Development
-              * Web Design
-              * Web Programming
-              * Ecommerce
-              * UI Design
-              * Website QA
-              * Website Project Management
-              * Other - Web Development
-          Software Development
-              * Desktop Applications
-              * Game Development
-              * Scripts & Utilities
-              * Software Plug-ins
-              * Mobile Apps
-              * Application Interface Design
-              * Software Project Management
-              * Software QA
-              * VOIP
-              * Other - Software Development
-          Networking & Information Systems
-              * Network Administration
-              * DBA - Database Administration
-              * Server Administration
-              * ERP / CRM Implementation
-              * Other - Networking & Information Systems
-          Writing & Translation
-              * Technical Writing
-              * Website Content
-              * Blog & Article Writing
-              * Copywriting
-              * Translation
-              * Creative Writing
-              * Other - Writing & Translation
-          Administrative Support
-              * Data Entry
-              * Personal Assistant
-              * Web Research
-              * Email Response Handling
-              * Transcription
-              * Other - Administrative Support
-          Design & Multimedia
-              * Graphic Design
-              * Logo Design
-              * Illustration
-              * Print Design
-              * 3D Modeling & CAD
-              * Audio Production
-              * Video Production
-              * Voice Talent
-              * Animation
-              * Presentations
-              * Engineering & Technical Design
-              * Other - Design & Multimedia
-          Customer Service
-              * Customer Service & Support
-              * Technical support
-              * Phone Support
-              * Order Processing
-              * Other - Customer Service
-          Sales & Marketing
-              * Advertising
-              * Email Marketing
-              * SEO - Search Engine Optimization
-              * SEM - Search Engine Marketing
-              * SMM - Social Media Marketing
-              * PR - Public Relations
-              * Telemarketing & Telesales
-              * Business Plans & Marketing Strategy
-              * Market Research & Surveys
-              * Sales & Lead Generation
-              * Other - Sales & Marketing
-          Business Services
-              * Accounting
-              * Bookkeeping
-              * HR / Payroll
-              * Financial Services & Planning
-              * Payment Processing
-              * Legal
-              * Project Management
-              * Business Consulting
-              * Recruiting
-              * Statistical Analysis
-              * Other - Business Services
-            CATEGORIES
+      text = File.read(File.join(File.dirname(__FILE__), "..", "categories"))
       lines = text.split(/[\r\n]+/).map{|line| line.strip}
       categories = {}
       subcategories = nil
@@ -98,7 +14,7 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
       end
       return categories
     end
-    
+
     # Implements search with the given criteria
     #* q - ProfileData (ProfileData)
     #      * Profile data is any text that appears in a provider's profile. For example if q = 'odesk' the search would return any user's with the word odesk in their profile.
@@ -158,7 +74,8 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
       if options.respond_to? :to_str
         return search(connector, :q=>options.to_str)
       end
-      response = connector.prepare_and_invoke_api_call 'profiles/v1/search/providers', {:api_token=>@api_token, :api_key=>@api_key}, :method=>:get, :format=>'json'
+      response = connector.prepare_and_invoke_api_call(
+        'profiles/v1/search/providers', :method=>:get)
       # parses a JSON result returned from oDesk and extracts an array of Providers out of it
       json = JSON.parse(response)
       providers = []
@@ -167,11 +84,11 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
       end
       return providers
     end
-    
+
     def get_profile(connector, id, options={})
       brief = options.delete :brief || false
-      response = connector.prepare_and_invoke_api_call("profiles/v1/providers/#{id}" + (brief ? "/brief" : ""),
-          {:api_token=>@api_token, :api_key=>@api_key}, :method=>:get, :format=>'json')
+      response = connector.prepare_and_invoke_api_call(
+        "profiles/v1/providers/#{id}" + (brief ? "/brief" : ""), :method=>:get)
       json = JSON.parse(response)
       return self.new(json['profile'])
     end
@@ -203,7 +120,7 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
       :ag_adj_score, :dev_recent_hours, :dev_timezone, :ag_country_tz, :ag_city,
       :dev_test_passed_count, :dev_tot_feedback, :ag_summary, :ag_manager_name,
       :ag_active_assignments, :portfolio_items
-  
+
   attribute :skills, :class=>RubyDesk::Skill, :sub_element=>'skill'
   attribute :dev_scores, :class=>RubyDesk::DeveloperSkill, :sub_element=>'dev_score'
   attribute :dev_ac_agencies, :class=>RubyDesk::Agency, :sub_element=>'dev_ac_agency'
@@ -228,4 +145,5 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
       end
     end
   end
-end
+end
+

data/lib/ruby_desk/snapshot.rb

@@ -8,4 +8,38 @@ class RubyDesk::Snapshot < RubyDesk::OdeskEntity
 
   attribute :user, :class=>RubyDesk::User
 
-end
+  def self.work_diary(connector, company_id, user_id, date = nil, timezone = "mine")
+    response = connector.prepare_and_invoke_api_call(
+      "team/v1/workdiaries/#{company_id}/#{user_id}" + (date ? "/"+date : ""),
+        :params=>{:timezone=>timezone}, :method=>:get)
+    json = JSON.parse(response)
+
+    return nil unless json['snapshots']['snapshot']
+    [json['snapshots']['snapshot']].flatten.map do |snapshot|
+      self.new(snapshot)
+    end
+  end
+
+  def self.snapshot_details(connector, company_id, user_id, timestamp = nil)
+    timestamp_param = case timestamp
+      when String then timestamp
+      when Date, Time then timestamp.strftime("%Y%m%d")
+      when Range then [timestamp.first, timestamp.last].map{|t|t.strftime("%Y%m%d")}.join(",")
+      when Array then timestamp.map{|t| t.strftime("%Y%m%d")}.join(";")
+    end
+    # Invoke API call
+    response = connector.prepare_and_invoke_api_call(
+      "team/v1/workdiaries/#{company_id}/#{user_id}" +
+      (timestamp_param ? "/#{timestamp_param}" : ""), :method=>:get)
+
+    # Parse result in json format
+    json = JSON.parse(response)
+
+    # Generate ruby objects for each snapshot
+    [json['snapshot']].flatten.map do |snapshot|
+      self.new(snapshot)
+    end
+  end
+
+end
+

data/lib/ruby_desk/team_room.rb

@@ -1,7 +1,11 @@
 class RubyDesk::TeamRoom
+  # Attribute readers for all attributes
+  attr_reader :company_recno, :company_name, :name, :id, :recno, :teamroom_api
+
   class << self
     def get_teamrooms(connector)
-      response = connector.prepare_and_invoke_api_call 'team/v1/teamrooms', {:api_token=>@api_token, :api_key=>@api_key}, :method=>:get, :format=>'json'
+      response = connector.prepare_and_invoke_api_call 'team/v1/teamrooms',
+          :method=>:get
       # parses a JSON result returned from oDesk and extracts an array of TeamRooms out of it
       json = JSON.parse(response)
       team_rooms = []
@@ -12,12 +16,9 @@ class RubyDesk::TeamRoom
       # return the resulting array
       team_rooms
     end
-    
+
   end
-    
-  # Attribute readers for all attributes
-  attr_reader :company_recno, :company_name, :name, :id, :recno, :teamroom_api
-  
+
   # Create a new TeamRoom from a hash similar to the one in ActiveRecord::Base.
   # The given hash maps each attribute name to its value
   def initialize(params={})
@@ -25,10 +26,16 @@ class RubyDesk::TeamRoom
       self.instance_variable_set("@#{k}", v)
     end
   end
-  
+
   def snapshot(connector, online='now')
-    response = connector.prepare_and_invoke_api_call "team/v1/teamrooms/#{self.id}", {:api_token=>@api_token, :api_key=>@api_key, :online=>online}, :method=>:get, :format=>'json'
+    response = connector.prepare_and_invoke_api_call "team/v1/teamrooms/#{self.id}",
+      :params=>{:online=>online}, :method=>:get
     json = JSON.parse(response)
     RubyDesk::Snapshot.new(json['teamroom']['snapshot'])
   end
-end
+
+  def work_diary(connector, user_id, date = nil, timezone = "mine")
+    RubyDesk::Snapshot.workdiary(connector, self.id, user_id, date, timezone)
+  end
+end
+

data/lib/ruby_desk/time_report.rb

@@ -0,0 +1,119 @@
+require 'uri'
+require 'date'
+
+class RubyDesk::TimeReport
+  DEFAULT_OPTIONS = {:select => "worked_on, provider_id, sum(hours)",
+    :conditions=>{} }
+
+  # The time reports API uses the Google Visualization API's query language to
+  # run detailed reports on a user's team, company, as well as provider
+  # specific detail.
+  # In order to use the reports API you need to understand the data model
+  # accessible as well as the supported Google query language elements.
+  # Please see the
+  # <a href="http://developers.odesk.com/oDesk-Google-Data-Source-Language">
+  # oDesk Google Data Source Language</a> page for a detailed description of
+  # what's available.
+  # For more details around how to construct data parameters see the
+  # <a href="http://code.google.com/apis/visualization/documentation/querylanguage.html">
+  # google documentation</a>.
+  #
+  # Allowed values for options are
+  # :select
+  # :condition
+  #   Here is the limited support for the where clause.
+  #     Fields
+  #      * Name
+  #      * company_id
+  #      * agency_id
+  #      * provider_id
+  #      * worked_on
+  #      * assignment_team_id
+  #      * provider_id
+  #      * task
+  # :order
+  def self.find(connector, options={})
+    options = DEFAULT_OPTIONS.merge(options)
+    call_url = "timereports/v1"
+    # Adjust a URL that has as much information as we can
+    if String === options[:conditions][:company_id]
+      # Limit to one company in url (better looking)
+      call_url << "/companies/#{options[:conditions].delete :company_id}"
+
+      if String === options[:conditions][:agency_id]
+        # Limit to one agency in url (better looking)
+        call_url << "/agencies/#{options[:conditions].delete :agency_id}"
+      elsif String === options[:conditions][:team_id]
+        # Limit to one team in url (better looking)
+        call_url << "/teams/#{options[:conditions].delete :team_id}"
+      end
+    elsif String === options[:conditions][:provider_id]
+      call_url << "/providers/#{options[:conditions].delete :provider_id}"
+    end
+
+    call_url << "/hours" if options[:hours]
+
+    gds_query = build_query(options)
+    response = connector.prepare_and_invoke_api_call(call_url, :method=>:get,
+      :base_url=>RubyDesk::Connector::ODESK_GDS_URL, :format=>nil,
+      :params=>{:tq=>URI.escape(gds_query," ,%&=./"), :tqx=>"out:json"})
+
+    json = JSON.parse(response)
+    columns = [json['table']['cols']].flatten
+    rows = [json['table']['rows']].flatten.map do |row_data|
+      row = {}
+      [row_data['c']].flatten.each_with_index do |row_element, element_index|
+        column = columns[element_index]
+        row[column['label']] = str_to_value(row_element['v'], column['type'])
+      end
+      row
+    end
+    return rows
+  end
+
+  def self.build_query(options)
+    gds_query = ""
+    gds_query << "SELECT " << options[:select]
+    if options[:conditions]
+      gds_query << " WHERE "
+      combined = options[:conditions].map do |field, condition|
+        "(" +
+        case condition
+          when String, Numeric, Date, Time then
+            "#{field}=#{value_to_str(condition)}"
+          when Array then
+            condition.map{|v| "#{field}=#{value_to_str(v)}"}.join(" OR ")
+          when Range
+            "#{field}>=#{value_to_str(condition.first)} AND #{field}" +
+              (condition.exclude_end? ? "<" : "<=") +
+              value_to_str(condition.last)
+        end +
+        ")"
+      end
+      gds_query << combined.join(" AND ")
+    end
+    if options[:order]
+      gds_query << " ORDER BY " << options[:order]
+    end
+    gds_query
+  end
+
+  def self.value_to_str(value)
+    case value
+      when String then value
+      when Date, Time then "'"+value.strftime("%Y-%m-%d")+"'"
+      when Numeric then value.to_s
+    end
+  end
+
+  def self.str_to_value(string, type)
+    case type
+      when 'number' then string.to_f
+      when 'date' then Date.strptime(string, "%Y%m%d")
+      when 'string' then string
+    end
+  end
+
+
+end
+

data/lib/ruby_desk.rb

@@ -14,43 +14,49 @@ module RubyDesk
       attributes *attribute_names
     end
   end
-  
+
   Competency = define_simple_class(:cmp_url, :cmp_when, :cmp_provider, :cmp_ref,
-      :cmp_percentile, :cmp_name, :cmp_recno, :cmp_score, :cmp_id)
-  Skill = define_simple_class(:skl_level_num, :skl_ref, :skl_name, :skl_last_used,
-      :skl_recno, :skl_level, :skl_comment, :skl_year_exp)
-  Agency = define_simple_class(:ag_adj_score, :ag_logo, :ag_name, :ag_recent_hours, :ag_tot_feedback,
-      :ag_recno, :ciphertext, :ag_adj_score_recent, :ag_total_hours)
+    :cmp_percentile, :cmp_name, :cmp_recno, :cmp_score, :cmp_id)
+  Skill = define_simple_class(:skl_level_num, :skl_ref, :skl_name,
+    :skl_last_used, :skl_recno, :skl_level, :skl_comment, :skl_year_exp)
+  Agency = define_simple_class(:ag_adj_score, :ag_logo, :ag_name,
+    :ag_recent_hours, :ag_tot_feedback, :ag_recno, :ciphertext,
+    :ag_adj_score_recent, :ag_total_hours)
   Exam = define_simple_class(:ts_name, :ts_rank, :ts_duration, :ts_when,
-      :ts_provider, :ts_score, :ts_percentile, :ts_curl_name, :ts_ref,
-      :ts_is_certification, :ts_id, :ts_pass, :ts_seo_link)
+    :ts_provider, :ts_score, :ts_percentile, :ts_curl_name, :ts_ref,
+    :ts_is_certification, :ts_id, :ts_pass, :ts_seo_link)
   JobCategory = define_simple_class(:seo_link, :second_level, :first_level)
   Experience = define_simple_class(:exp_comment, :exp_from, :exp_recno,
-      :exp_title, :exp_company, :exp_to)
+    :exp_title, :exp_company, :exp_to)
   Candidacy = define_simple_class(:permalink, :dev_recno, :opening_ciphertext,
-      :rel_requested_assignment, :created_type, :developer_ciphertext,
-      :ciphertext, :create_date, :profile_seo_link, :Agencyref, :agency_ciphertext,
-      :op_title, :record_id, :job_profile_access)
-  Assignment = define_simple_class(:as_type, :as_blended_cost_rate, :as_total_hours,
-      :as_to, :as_from, :as_client, :as_opening_access, :as_agency_name, :as_rate,
-      :as_blended_charge_rate, :as_amount, :as_total_charge, :as_opening_recno,
-      :as_description, :as_opening_title, :as_status, :as_job_type,
-      :as_ciphertext_opening_recno, :as_total_cost)
-  Certificate = define_simple_class(:cmp_url, :cmp_when, :cmp_provider, :cmp_ref,
-      :cmp_percentile, :cmp_name, :cmp_recno, :cmp_score, :cmp_id)
+    :rel_requested_assignment, :created_type, :developer_ciphertext,
+    :ciphertext, :create_date, :profile_seo_link, :Agencyref,
+    :agency_ciphertext, :op_title, :record_id, :job_profile_access)
+  Assignment = define_simple_class(:as_type, :as_blended_cost_rate,
+    :as_total_hours, :as_to, :as_from, :as_client, :as_opening_access,
+    :as_agency_name, :as_rate, :as_blended_charge_rate, :as_amount,
+    :as_total_charge, :as_opening_recno, :as_description, :as_opening_title,
+    :as_status, :as_job_type, :as_ciphertext_opening_recno, :as_total_cost)
+  Certificate = define_simple_class(:cmp_url, :cmp_when, :cmp_provider,
+    :cmp_ref, :cmp_percentile, :cmp_name, :cmp_recno, :cmp_score, :cmp_id)
   Institution = define_simple_class(:ed_area, :ed_school, :ed_degree, :ed_to,
-      :ed_recno, :ed_comment, :ed_from)
-  OtherExperience = define_simple_class(:exp_recno, :exp_description, :exp_subject)
-  Trend = define_simple_class(:trend_word, :trend_url, :trend_recno, :trend_skill)
-  PortfolioItem = define_simple_class(:pi_recno, :pi_description, :pi_attachment,
-      :pi_completed, :pi_thumbnail, :pi_title, :pi_category, :pi_url, :pi_image)
-  User = define_simple_class(:messenger_id, :timezone, :uid, :timezone_offset, :last_name,
-      :mail, :creation_time, :first_name)
-#   = define_simple_class()
+    :ed_recno, :ed_comment, :ed_from)
+  OtherExperience = define_simple_class(:exp_recno, :exp_description,
+    :exp_subject)
+  Trend = define_simple_class(:trend_word, :trend_url, :trend_recno,
+    :trend_skill)
+  PortfolioItem = define_simple_class(:pi_recno, :pi_description,
+    :pi_attachment, :pi_completed, :pi_thumbnail, :pi_title, :pi_category,
+    :pi_url, :pi_image)
+  User = define_simple_class(:messenger_id, :timezone, :uid, :timezone_offset,
+    :last_name, :mail, :creation_time, :first_name)
+  DeveloperSkill = define_simple_class(:order, :description,
+    :avg_category_score_recent, :avg_category_score, :label)
 #   = define_simple_class()
 #   = define_simple_class()
 end
 
 Dir.glob(File.join(File.dirname(__FILE__), 'ruby_desk', '*.rb')).each do |file|
   require file
-end
+end
+

data/test/snapshot.json

@@ -0,0 +1,2 @@
+{"server_time":1263130514,"auth_user":{"first_name":"Ahmed El-Dawy","last_name":".","uid":"aseldawy","mail":"aseldawy@odesk.com","messenger_id":"aseldawy","messenger_type":"yahoo","timezone":"Africa\/Cairo","timezone_offset":"7200"},"snapshot":{"status":"PRIVATE","time":"1249344000","billing_status":"non-billed.disconnected","activity":"0","online_presence":"0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0","user":{"messenger_id":"aseldawy","timezone":"Africa\/Cairo","uid":"aseldawy","timezone_offset":"7200","last_name":".","messenger_type":"yahoo","mail":"aseldawy@odesk.com","creation_time":"1207503924","archiving_time":"1262563200","first_name":"Ahmed El-Dawy"},"mouse_events_count":"","company_id":"techunlimited","timezone":"Africa\/Cairo","uid":"","keyboard_events_count":"","last_worked":"1258037998","memo":"","active_window_title":"","report24_img":"http:\/\/chart.apis.google.com\/chart?chs=96x17&cht=ls&chco=cccccc&chf=bg,s,f8f8f8&chm=B,cccccc,0,0,0&chd=t:0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0","computer_name":"","online_presence_img":"http:\/\/chart.apis.google.com\/chart?chs=96x17&cht=ls&chco=cccccc&chf=bg,s,f8f8f8&chm=B,cccccc,0,0,0&chd=t:0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0","user_id":"aseldawy","client_version":"","teamroom_api":"\/api\/team\/v1\/teamrooms\/techunlimited.json","workdiary_api":"\/api\/team\/v1\/workdiaries\/techunlimited\/aseldawy\/20090804.json"}}
+

data/test/teamrooms.json

@@ -0,0 +1,2 @@
+{"server_time":"1263125223","auth_user":{"first_name":"Ahmed El-Dawy","last_name":".","uid":"aseldawy","mail":"aseldawy@odesk.com","messenger_id":"aseldawy","messenger_type":"yahoo","timezone":"Africa\/Cairo","timezone_offset":"7200"},"teamrooms":{"teamroom":[{"company_recno":"28705","company_name":"Tech Unlimited, Inc.","name":"Tech Unlimited, Inc.","id":"techunlimited","recno":"28705","teamroom_api":"\/api\/team\/v1\/teamrooms\/techunlimited.json"},{"company_recno":"81112","company_name":"Arabic Development Int.","name":"Phase One","id":"tejahcom","recno":"81112","teamroom_api":"\/api\/team\/v1\/teamrooms\/tejahcom.json"},{"company_recno":"16273","company_name":"Techniprise Inc.","name":"Techniprise Inc.","id":"techniprise","recno":"16273","teamroom_api":"\/api\/team\/v1\/teamrooms\/techniprise.json"},{"company_recno":"33618","company_name":"BadrIT","name":"BadrIT","id":"badrit","recno":"33618","teamroom_api":"\/api\/team\/v1\/teamrooms\/badrit.json"},{"company_recno":"51737","company_name":"Lian AlKhaleej","name":"Lian AlKhaleej","id":"lianalkhaleej:lianalkhaleej","recno":"51737","teamroom_api":"\/api\/team\/v1\/teamrooms\/lianalkhaleej:lianalkhaleej.json"}]},"teamroom":""}
+

data/test/test_ruby_desk.rb

@@ -1,14 +1,44 @@
 require 'helper'
+require 'date'
 
 class TestRubyDesk < Test::Unit::TestCase
+  def test_sign
+    connector  = RubyDesk::Connector.new('824d225a889aca186c55ac49a6b23957',
+      '984aa36db13fff5c')
+    assert_equal 'dc30357f7c6b62aadf99e5313ac93365',
+      connector.sign(:online=>'all', :tz=>'mine',
+        :api_key=>'824d225a889aca186c55ac49a6b23957',
+        :api_token=>'ffffffffffffffffffffffffffffffff')
+  end
+
+  def test_api_call
+    connector  = RubyDesk::Connector.new('824d225a889aca186c55ac49a6b23957',
+      '984aa36db13fff5c')
+    api_call = connector.prepare_api_call('auth/v1/keys/tokens',
+      :params=>{:frob=>@frob, :api_key=>@api_key},
+      :method=>:post, :format=>'json')
+    assert api_call[:url].index('.json')
+    assert api_call[:url].index('/api/auth/v1/keys/tokens')
+    assert api_call[:params][:api_sig]
+  end
+
+  def test_gds_api_call
+    connector  = RubyDesk::Connector.new('824d225a889aca186c55ac49a6b23957',
+      '984aa36db13fff5c')
+    api_call = connector.prepare_api_call('timereports/v1/companies/1',
+      :method=>:post, :base_url=>RubyDesk::Connector::ODESK_GDS_URL)
+    assert api_call[:url].index('/gds/timereports/v1/companies/1')
+    assert api_call[:params][:api_sig]
+  end
+
   def test_provider_search
     connector = Object.new
     def connector.prepare_and_invoke_api_call(*args)
       File.read(File.join(File.dirname(__FILE__), 'providers.json'))
     end
-    
+
     providers = RubyDesk::Provider.search(connector, 'rails')
-    
+
     assert providers.is_a?(Array)
     assert_equal 20, providers.size
     assert_equal RubyDesk::Provider, providers.first.class
@@ -20,11 +50,82 @@ class TestRubyDesk < Test::Unit::TestCase
     def connector.prepare_and_invoke_api_call(*args)
       File.read(File.join(File.dirname(__FILE__), 'profile.json'))
     end
-    
+
     profile = RubyDesk::Provider.get_profile(connector, 'aseldawy')
-    
+
     assert_equal RubyDesk::Provider, profile.class
     assert_equal RubyDesk::Skill, profile.skills.first.class
     assert_equal RubyDesk::Competency, profile.competencies.first.class
   end
+
+  def test_team_rooms
+    connector = Object.new
+    def connector.prepare_and_invoke_api_call(*args)
+      File.read(File.join(File.dirname(__FILE__), 'teamrooms.json'))
+    end
+
+    teamrooms = RubyDesk::TeamRoom.get_teamrooms(connector)
+
+    assert_equal 5, teamrooms.size
+    assert_equal RubyDesk::TeamRoom, teamrooms.first.class
+  end
+
+  def test_workdiary
+    connector = Object.new
+    def connector.prepare_and_invoke_api_call(*args)
+      File.read(File.join(File.dirname(__FILE__), 'workdiary.json'))
+    end
+
+    snapshots = RubyDesk::Snapshot.work_diary(connector, 'techunlimited',
+      'aseldawy')
+    assert_equal 14, snapshots.size
+    assert_equal RubyDesk::Snapshot, snapshots.first.class
+  end
+
+  def test_snapshot
+    connector = Object.new
+    def connector.prepare_and_invoke_api_call(*args)
+      File.read(File.join(File.dirname(__FILE__), 'snapshot.json'))
+    end
+
+    snapshots = RubyDesk::Snapshot.snapshot_details(connector, 'techunlimited',
+      'aseldawy', Time.now)
+    assert_equal 1, snapshots.size
+    assert_equal RubyDesk::Snapshot, snapshots.first.class
+  end
+
+  def test_query_builder
+    test_data = [
+      [{:select=>"worked_on", :conditions=>{:worked_on=>Time.mktime(2009, 10, 10)}},
+        "SELECT worked_on WHERE (worked_on='2009-10-10')"],
+      [{:select=>"worked_on, provider_id", :conditions=>{:provider_id=>[1,2,3]}},
+        "SELECT worked_on, provider_id WHERE (provider_id=1 OR provider_id=2 OR provider_id=3)"],
+      [{:select=>"worked_on", :conditions=>{:provider_id=>1, :agency_id=>3}},
+        ["SELECT worked_on WHERE (agency_id=3) AND (provider_id=1)",
+        "SELECT worked_on WHERE (provider_id=1) AND (agency_id=3)"]],
+      [{:select=>"worked_on", :conditions=>{:provider_id=>1..3}},
+        "SELECT worked_on WHERE (provider_id>=1 AND provider_id<=3)"],
+      [{:select=>"worked_on", :conditions=>{:provider_id=>1...3}},
+        "SELECT worked_on WHERE (provider_id>=1 AND provider_id<3)"],
+    ]
+    test_data.each do |options, query|
+      assert query.include?(RubyDesk::TimeReport.build_query(options))
+    end
+  end
+
+  def test_timreport
+    connector = Object.new
+    def connector.prepare_and_invoke_api_call(*args)
+      File.read(File.join(File.dirname(__FILE__), 'timereport.json'))
+    end
+
+    timereport = RubyDesk::TimeReport.find(connector,
+      :select=>"worked_on, sum(hours), provider_id")
+    assert_equal 15, timereport.size
+    assert_equal Hash, timereport.first.class
+    assert_equal Date, timereport.first['worked_on'].class
+    assert timereport.first['hours'].is_a?(Numeric)
+  end
+
 end
+

data/test/timereport.json

@@ -0,0 +1 @@
+{"server_time":"1263311702","auth_user":{"first_name":"Ahmed El-Dawy","last_name":".","uid":"aseldawy","mail":"aseldawy@odesk.com","messenger_id":"aseldawy","messenger_type":"yahoo","timezone":"Africa\/Cairo","timezone_offset":"7200"},"table":{"cols":[{"type":"date","label":"worked_on"},{"type":"number","label":"hours"},{"type":"string","label":"provider_id"}],"rows":[{"c":[{"v":"20080528"},{"v":"0.83"},{"v":"aseldawy"}]},{"c":[{"v":"20080526"},{"v":"4.50"},{"v":"mostafaali"}]},{"c":[{"v":"20080526"},{"v":"3.5"},{"v":"melkharashy"}]},{"c":[{"v":"20080529"},{"v":"2.83"},{"v":"adewandaru"}]},{"c":[{"v":"20080531"},{"v":"1.5"},{"v":"adewandaru"}]},{"c":[{"v":"20080525"},{"v":"5.00"},{"v":"melkharashy"}]},{"c":[{"v":"20080528"},{"v":"3.00"},{"v":"adewandaru"}]},{"c":[{"v":"20080527"},{"v":"2.0"},{"v":"adewandaru"}]},{"c":[{"v":"20080525"},{"v":"2.67"},{"v":"adewandaru"}]},{"c":[{"v":"20080528"},{"v":"3.67"},{"v":"melkharashy"}]},{"c":[{"v":"20080530"},{"v":"5.5"},{"v":"adewandaru"}]},{"c":[{"v":"20080531"},{"v":"3.67"},{"v":"melkharashy"}]},{"c":[{"v":"20080527"},{"v":"2.17"},{"v":"melkharashy"}]},{"c":[{"v":"20080526"},{"v":"8.01"},{"v":"adewandaru"}]},{"c":[{"v":"20080529"},{"v":"0.67"},{"v":"melkharashy"}]}]}}

data/test/workdiary.json

@@ -0,0 +1,2 @@
+{"server_time":"1263126093","auth_user":{"first_name":"Ahmed El-Dawy","last_name":".","uid":"aseldawy","mail":"aseldawy@odesk.com","messenger_id":"aseldawy","messenger_type":"yahoo","timezone":"Africa\/Cairo","timezone_offset":"7200"},"snapshots":{"user":{"timezone":"Africa\/Cairo","uid":"aseldawy","timezone_offset":"7200","last_name":".","mail":"aseldawy@odesk.com","creation_time":"1207503924","archiving_time":"1262563200","first_name":"Ahmed El-Dawy"},"snapshot":[{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249372200","keyboard_events_count":"418","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249372678","billing_status":"billed.active","active_window_title":"sadfas","memo":"do nothing","activity":"5","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249372678.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249378200","keyboard_events_count":"431","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249378442","billing_status":"billed.active","active_window_title":"RadRails - Aptana Studio Community Edition ","memo":"do nothing","activity":"2","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249378442.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249378800","keyboard_events_count":"1018","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249379235","billing_status":"billed.active","active_window_title":"Google - Mozilla Firefox","memo":"do nothing","activity":"3","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249379235.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249379400","keyboard_events_count":"1015","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249379749","billing_status":"billed.active","active_window_title":"RadRails - 20090804093424_add_license_quota.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"7","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249379749.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249380000","keyboard_events_count":"665","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249380394","billing_status":"billed.active","active_window_title":"RadRails - page.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"7","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249380394.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249382400","keyboard_events_count":"691","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249382513","billing_status":"billed.active","active_window_title":"RadRails - page_test.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"1","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249382513.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249384200","keyboard_events_count":"536","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249384799","billing_status":"billed.active","active_window_title":"RadRails - page.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"5","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249384799.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249384800","keyboard_events_count":"1021","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249385243","billing_status":"billed.active","active_window_title":"aseldawy@aseldawy-laptop: ~\/Aptana_Studio\/planswift_backend","memo":"do nothing","activity":"10","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249385243.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249385400","keyboard_events_count":"380","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249385999","billing_status":"billed.active","active_window_title":"RadRails - fixtures.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"9","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249385999.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249386000","keyboard_events_count":"544","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249386477","billing_status":"billed.active","active_window_title":"Mohamed Amir","memo":"do nothing","activity":"8","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249386477.json"},{"mouse_events_count":"1","company_id":"bebebobo","cell_time":"1249386600","keyboard_events_count":"348","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249387084","billing_status":"billed.active","active_window_title":"RadRails - fixtures.rb - Aptana Studio Community Edition ","memo":"do nothing","activity":"7","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249387084.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249387200","keyboard_events_count":"598","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249387654","billing_status":"billed.active","active_window_title":"aseldawy@aseldawy-laptop: ~\/Aptana_Studio\/planswift_backend","memo":"do nothing","activity":"7","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249387654.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249387800","keyboard_events_count":"950","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249388254","billing_status":"billed.active","active_window_title":"Commit ","memo":"do nothing","activity":"10","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249388254.json"},{"mouse_events_count":"0","company_id":"bebebobo","cell_time":"1249388400","keyboard_events_count":"873","uid":"428268b0-45b1-4a54-83e0-4ec381b39cc0","timezone":"","status":"NORMAL","time":"1249388796","billing_status":"billed.active","active_window_title":"root@domU-12-31-38-00-3C-E3: \/var\/www\/planswift","memo":"do nothing","activity":"7","computer_name":"some computer","user_id":"aseldawy","client_version":"Linux\/1.3.4","snapshot_api":"\/api\/team\/v1\/snapshots\/bebebobo\/aseldawy\/1249388796.json"}],"teamroom_api":"\/api\/team\/v1\/teamrooms\/bebebobo.json"}}
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_desk
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ahmed ElDawy
@@ -38,15 +38,19 @@ files:
 - VERSION
 - lib/ruby_desk.rb
 - lib/ruby_desk/connector.rb
-- lib/ruby_desk/developer_skill.rb
 - lib/ruby_desk/odesk_entity.rb
 - lib/ruby_desk/provider.rb
 - lib/ruby_desk/snapshot.rb
 - lib/ruby_desk/team_room.rb
+- lib/ruby_desk/time_report.rb
 - test/helper.rb
 - test/profile.json
 - test/providers.json
+- test/snapshot.json
+- test/teamrooms.json
 - test/test_ruby_desk.rb
+- test/timereport.json
+- test/workdiary.json
 has_rdoc: true
 homepage: http://github.com/aseldawy/ruby_desk
 licenses: []

data/lib/ruby_desk/developer_skill.rb

@@ -1,3 +0,0 @@
-class RubyDesk::DeveloperSkill < RubyDesk::OdeskEntity
-  attributes :order, :description, :avg_category_score_recent, :avg_category_score, :label
-end