ruby_desk 0.4.1 → 0.5.0

data/README.rdoc

@@ -2,6 +2,10 @@
 
 A gem built by BadrIT (www.badrit.com) that works as an interface for oDesk APIs. It can be used for both desktop and web applications
 
+== Using RubyDesk with Rails
+If you want to use oDesk APIs with Rails applications you may better use ror_desk.
+ror_desk is a plugin built on Ruby Desk and makes it much easier to use with Rails.
+
 == Example
 Initialize with your api key
   rd = RubyDesk::Connector.new(api_key, api_secret)

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/lib/ruby_desk/connector.rb

@@ -2,6 +2,8 @@ require 'digest/md5'
 require 'uri'
 require 'net/http'
 require 'net/https'
+require 'rexml/document'
+require 'json'
 
 module RubyDesk
   class Connector
@@ -22,6 +24,7 @@ module RubyDesk
 
     # Sign the given parameters and returns the signature
     def sign(params)
+      RubyDesk.logger.info "Params to sign: #{params.inspect}"
       # sort parameters by its names (keys)
       sorted_params = params.sort { |a, b| a.to_s <=> b.to_s}
 
@@ -65,6 +68,10 @@ module RubyDesk
         'Content-Type' => 'application/x-www-form-urlencoded'
       }
 
+      RubyDesk.logger.info "URL: #{api_call[:url]}"
+      RubyDesk.logger.info "method: #{api_call[:method]}"
+      RubyDesk.logger.info "Params: #{data}"
+
       case api_call[:method]
         when :get, 'get' then
           resp, data = http.request(Net::HTTP::Get.new(url.path+"?"+data, headers))
@@ -74,13 +81,29 @@ module RubyDesk
           resp, data = http.request(Net::HTTP::Delete.new(url.path, headers), data)
       end
 
-      return data
+      RubyDesk.logger.info "Response code: #{resp.code}"
+      RubyDesk.logger.info "Returned data: #{data}"
+
+      case resp.code
+        when "200" then return data
+        when "401" then raise RubyDesk::UnauthorizedError, data
+        when "500" then raise RubyDesk::ServerError, data
+      end
+
     end
 
     # Prepares an API call with the given arguments then invokes it and returns its body
     def prepare_and_invoke_api_call(path, options = {})
       api_call = prepare_api_call(path, options)
-      invoke_api_call(api_call)
+      data = invoke_api_call(api_call)
+
+      parsed_data = case options[:format]
+        when 'json' then JSON.parse(data)
+        when 'xml' then REXML::Document.new(data)
+        else JSON.parse(data) rescue REXML::Document.new(data) rescue data
+      end
+      RubyDesk.logger.info "Parsed data: #{parsed_data.inspect}"
+      return parsed_data
     end
 
     # Returns the URL that authenticates the application for the current user
@@ -107,10 +130,9 @@ module RubyDesk
     #  Return Data
     #    * token
     def get_token
-      response = prepare_and_invoke_api_call 'auth/v1/keys/tokens',
+      json = 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
 
@@ -123,9 +145,8 @@ module RubyDesk
     #    * frob
 
     def get_frob
-      response = prepare_and_invoke_api_call 'auth/v1/keys/frobs',
+      json = 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
 
@@ -140,9 +161,8 @@ module RubyDesk
     #
     #      * token
     def check_token
-      prepare_and_invoke_api_call 'auth/v1/keys/token', :method=>:get
-      json = JSON.parse(response)
-      # TODO what to make with results?
+      json = prepare_and_invoke_api_call 'auth/v1/keys/token', :method=>:get
+      # TODO what to do with results?
       return json
     end
 

data/lib/ruby_desk/provider.rb

@@ -116,11 +116,10 @@ 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(
+      json = connector.prepare_and_invoke_api_call(
         'profiles/v1/search/providers', :method=>:get,
         :auth=>false, :sign=>false)
-      # parses a JSON result returned from oDesk and extracts an array of Providers out of it
-      json = JSON.parse(response)
+
       providers = []
       [json['providers']['provider']].flatten.each do |provider|
         providers << self.new(provider)
@@ -130,9 +129,8 @@ class RubyDesk::Provider < RubyDesk::OdeskEntity
 
     def get_profile(connector, id, options={})
       brief = options.delete :brief || false
-      response = connector.prepare_and_invoke_api_call(
+      json = connector.prepare_and_invoke_api_call(
         "profiles/v1/providers/#{id}" + (brief ? "/brief" : ""), :method=>:get)
-      json = JSON.parse(response)
       return self.new(json['profile'])
     end
   end

data/lib/ruby_desk/snapshot.rb

@@ -9,10 +9,9 @@ class RubyDesk::Snapshot < RubyDesk::OdeskEntity
   attribute :user, :class=>RubyDesk::User
 
   def self.work_diary(connector, company_id, user_id, date = nil, timezone = "mine")
-    response = connector.prepare_and_invoke_api_call(
+    json = 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|
@@ -28,13 +27,10 @@ class RubyDesk::Snapshot < RubyDesk::OdeskEntity
       when Array then timestamp.map{|t| t.strftime("%Y%m%d")}.join(";")
     end
     # Invoke API call
-    response = connector.prepare_and_invoke_api_call(
+    json = 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)

data/lib/ruby_desk/team_room.rb

@@ -4,10 +4,9 @@ class RubyDesk::TeamRoom
 
   class << self
     def get_teamrooms(connector)
-      response = connector.prepare_and_invoke_api_call 'team/v1/teamrooms',
+      json = 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 = []
       [json['teamrooms']['teamroom']].flatten.each do |teamroom|
         # Append this TeamRoom to array
@@ -28,9 +27,9 @@ class RubyDesk::TeamRoom
   end
 
   def snapshot(connector, online='now')
-    response = connector.prepare_and_invoke_api_call "team/v1/teamrooms/#{self.id}",
+    json = 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
 

data/lib/ruby_desk/time_report.rb

@@ -54,11 +54,12 @@ class RubyDesk::TimeReport
     call_url << "/hours" if options[:hours]
 
     gds_query = build_query(options)
-    response = connector.prepare_and_invoke_api_call(call_url, :method=>:get,
+    json = 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)
+    raise RubyDesk::Error, json['errors'].inspect if json['status'] == "error"
+
     columns = [json['table']['cols']].flatten
     rows = [json['table']['rows']].flatten.map do |row_data|
       row = {}
@@ -73,7 +74,8 @@ class RubyDesk::TimeReport
 
   def self.build_query(options)
     gds_query = ""
-    gds_query << "SELECT " << options[:select]
+    gds_query << "SELECT " << (options[:select].respond_to?(:join)?
+      options[:select].join(",") : options[:select])
     if options[:conditions]
       gds_query << " WHERE "
       combined = options[:conditions].map do |field, condition|
@@ -83,10 +85,11 @@ class RubyDesk::TimeReport
             "#{field}=#{value_to_str(condition)}"
           when Array then
             condition.map{|v| "#{field}=#{value_to_str(v)}"}.join(" OR ")
-          when Range
+          when Range then
             "#{field}>=#{value_to_str(condition.first)} AND #{field}" +
               (condition.exclude_end? ? "<" : "<=") +
               value_to_str(condition.last)
+          else raise "Invalid condition for field: #{field}"
         end +
         ")"
       end

data/lib/ruby_desk.rb

@@ -1,8 +1,18 @@
 require 'rubygems'
 require 'json'
+require 'logger'
 
 module RubyDesk
   class Error < RuntimeError; end;
+  class UnauthorizedError < Error; end;
+  class ServerError < Error; end;
+
+  class << self
+    attr_accessor :logger
+  end
+
+  self.logger = Logger.new(STDERR)
+  self.logger.sev_threshold = Logger::FATAL
 end
 
 # This first file is required by other files

data/test/test_ruby_desk.rb

@@ -2,6 +2,17 @@ require 'helper'
 require 'date'
 
 class TestRubyDesk < Test::Unit::TestCase
+
+  def dummy_connector(result_filename)
+    connector = RubyDesk::Connector.new('824d225a889aca186c55ac49a6b23957',
+      '984aa36db13fff5c')
+    connector.instance_variable_set '@result_filename', result_filename
+    def connector.invoke_api_call(*args)
+      File.read(File.join(File.dirname(__FILE__), @result_filename))
+    end if result_filename
+    return connector
+  end
+
   def test_sign
     connector  = RubyDesk::Connector.new('824d225a889aca186c55ac49a6b23957',
       '984aa36db13fff5c')
@@ -32,10 +43,7 @@ class TestRubyDesk < Test::Unit::TestCase
   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
+    connector = dummy_connector('providers.json')
 
     providers = RubyDesk::Provider.search(connector, 'rails')
 
@@ -46,10 +54,7 @@ class TestRubyDesk < Test::Unit::TestCase
   end
 
   def test_get_profile
-    connector = Object.new
-    def connector.prepare_and_invoke_api_call(*args)
-      File.read(File.join(File.dirname(__FILE__), 'profile.json'))
-    end
+    connector = dummy_connector('profile.json')
 
     profile = RubyDesk::Provider.get_profile(connector, 'aseldawy')
 
@@ -59,10 +64,7 @@ class TestRubyDesk < Test::Unit::TestCase
   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
+    connector = dummy_connector('teamrooms.json')
 
     teamrooms = RubyDesk::TeamRoom.get_teamrooms(connector)
 
@@ -71,10 +73,7 @@ class TestRubyDesk < Test::Unit::TestCase
   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
+    connector = dummy_connector('workdiary.json')
 
     snapshots = RubyDesk::Snapshot.work_diary(connector, 'techunlimited',
       'aseldawy')
@@ -83,10 +82,7 @@ class TestRubyDesk < Test::Unit::TestCase
   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
+    connector = dummy_connector('snapshot.json')
 
     snapshots = RubyDesk::Snapshot.snapshot_details(connector, 'techunlimited',
       'aseldawy', Time.now)
@@ -107,6 +103,8 @@ class TestRubyDesk < Test::Unit::TestCase
         "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)"],
+      [{:select=>["worked_on", "hours"]},
+        "SELECT worked_on,hours"],
     ]
     test_data.each do |options, query|
       assert query.include?(RubyDesk::TimeReport.build_query(options))
@@ -114,10 +112,7 @@ class TestRubyDesk < Test::Unit::TestCase
   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
+    connector = dummy_connector('timereport.json')
 
     timereport = RubyDesk::TimeReport.find(connector,
       :select=>"worked_on, sum(hours), provider_id")
@@ -127,5 +122,13 @@ class TestRubyDesk < Test::Unit::TestCase
     assert timereport.first['hours'].is_a?(Numeric)
   end
 
+  def test_timreport_error
+    assert_raises RubyDesk::Error do
+      connector = dummy_connector('timereport_error.json')
+      timereport = RubyDesk::TimeReport.find(connector,
+        :select=>"worked_on, sum(hours), provider_id")
+    end
+  end
+
 end
 

data/test/timereport_error.json

@@ -0,0 +1,2 @@
+{"version":"0.6","status":"error","errors":[{"reason":"access_denied","message":"You have no access to this timereport"}]}
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_desk
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ahmed ElDawy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 +02:00
+date: 2010-01-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - test/teamrooms.json
 - test/test_ruby_desk.rb
 - test/timereport.json
+- test/timereport_error.json
 - test/workdiary.json
 has_rdoc: true
 homepage: http://github.com/aseldawy/ruby_desk