ruby_desk 0.0.0 → 0.1.0

data/README.rdoc

@@ -1,17 +1,24 @@
-= ruby_desk
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+= RubyDesk
+
+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
+
+== Example
+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
+  rd.auth_url
+
+This will get you the frob you need to access all APIs.
+When you get the frob set it using
+  rd.frob = frob
+
+After that you should request an api_token
+  rd.get_token
+
+Now you are ready to use all the APIs you need
+  team_rooms = RubyDesk::TeamRoom.get_teamrooms(rd)
+  team_rooms.each { |team_room| puts team_room.id }
 
 == Copyright
 

data/Rakefile

@@ -10,7 +10,8 @@ begin
     gem.email = "ahmed.eldawy@badrit.com"
     gem.homepage = "http://github.com/aseldawy/ruby_desk"
     gem.authors = ["Ahmed ElDawy"]
-#    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.files = FileList['lib/**/*.rb', '[A-Z]*', 'test/**/*'].to_a
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/ruby_desk/connector.rb

@@ -0,0 +1,149 @@
+require 'digest/md5'
+require 'uri'
+require 'net/http'
+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'}
+    
+    attr_writer :frob
+    
+    def initialize(api_key=nil, api_secret=nil, frob=nil, api_token=nil)
+      @api_key = api_key
+      @api_secret = api_secret
+      @frob = frob
+      @api_token = api_token
+      @api_key = "991ac77f4c202873b0ab88f11762370c"
+      @api_secret = "c3382d5902e5a7b0"
+    end
+    
+    # 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
+    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 = {})
+      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]}
+    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))
+        when :post, 'post' then
+          resp, data = http.request(Net::HTTP::Post.new(url.path, headers), data)
+        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)
+      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('&')
+    end
+    
+    # return the URL that logs user out of odesk applications
+    def logout_url
+      "https://"+ODESK_AUTH_URL
+    end
+    
+    # Returns an authentication frob.
+    #  Parameters
+    #    * frob
+    #    * api_key
+    #    * api_sig
+    #
+    #  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'
+      json = JSON.parse(response)
+      @api_token = json['token']
+    end
+    
+    # Returns an authentication frob.
+    #Parameters
+    #    * api_key
+    #    * api_sig
+    #
+    #Return Data
+    #    * frob
+    
+    def get_frob
+      response = prepare_and_invoke_api_call 'auth/v1/keys/frobs', {:api_key=>@api_key}, :method=>:post, :format=>'json'
+      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     
+    def check_token
+      prepare_and_invoke_api_call 'auth/v1/keys/token', {:api_key=>@api_key, :api_token=>@api_token}, :method=>:get, :format=>'json'
+      json = JSON.parse(response)
+      # TODO what to make with results?
+      return json
+    end
+
+    # Revokes the given aut
+    # Parameters
+    #  * api_key
+    #  * api_sig
+    #  * 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'
+      @api_token = nil
+    end
+  
+  end
+end

data/lib/ruby_desk/snapshot.rb

@@ -0,0 +1,19 @@
+module RubyDesk
+  class Snapshot
+    attr_reader :status, :time, :billing_status, :report_url, :screenshot_img, :activity,
+      :online_presence, :user, :screenshot_url, :mouse_events_count, :company_id,
+      :timezone, :uid, :keyboard_events_count, :last_worked_status, :last_worked,
+      :memo, :active_window_title, :portrait_img, :report24_img, :computer_name,
+      :screenshot_img_thmb, :online_presence_img, :user_id, :role, :client_version,
+      :snapshot_api, :workdiary_api
+    def initialize(params={})
+      params.each do |k, v|
+        if k.to_s == 'user'
+          @user = RubyDesk::User.new(v)
+        else
+          self.instance_variable_set("@#{k}", v)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_desk/team_room.rb

@@ -0,0 +1,37 @@
+module RubyDesk
+  class TeamRoom
+    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'
+        # 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'].each do |teamroom|
+          # Append this TeamRoom to array
+          team_rooms << self.new(teamroom)
+        end
+        # 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={})
+      params.each do |k, v|
+        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'
+      json = JSON.parse(response)
+      RubyDesk::Snapshot.new(json['teamroom']['snapshot'])
+    end
+    
+  end
+end

data/lib/ruby_desk/user.rb

@@ -0,0 +1,12 @@
+module RubyDesk
+  class User
+    
+    attr_accessor :messenger_id, :timezone, :uid, :timezone_offset, :last_name,
+        :mail, :creation_time, :first_name
+    def initialize(params)
+      params.each do |k, v|
+        self.instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/ruby_desk.rb

@@ -1,96 +1,5 @@
-require 'digest/md5'
+module RubyDesk
+end
 
-class RubyDesk
-  ODESK_API_URL = "www.odesk.com/api/"
-  ODESK_AUTH_URL = "www.odesk.com/services/api/auth/"
-  DEFAULT_OPTIONS = {:secure=>true, :sign=>true, :format=>'xml'}
-  
-  def initialize(api_key=nil, api_secret=nil)
-    @api_key = api_key
-    @api_secret = api_secret
-    @api_key = "991ac77f4c202873b0ab88f11762370c"
-    @api_secret = "c3382d5902e5a7b0"
-  end
-  
-  # Sign the given parameters and updates the given 
-  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
-  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 get_api_url(path, params = {}, 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]}
-  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('&')
-  end
-  
-  # return the URL that logs user out of odesk applications
-  def logout_url
-    "https://"+ODESK_AUTH_URL
-  end
-  
-  # Returns an authentication frob.
-  #  Parameters
-  #    * frob
-  #    * api_key
-  #    * api_sig
-  #
-  #  Return Data
-  #    * token
-  def get_token_url(frob, options={})
-    get_api_url 'auth/v1/keys/tokens', {:frob=>frob, :api_key=>@api_key}, options.merge(:method=>:post)
-  end
-  
-  # Returns an authentication frob.
-  #Parameters
-  #    * api_key
-  #    * api_sig
-  #
-  #Return Data
-  #    * frob
-  
-  def get_frob_url(options={})
-    get_api_url 'auth/v1/keys/frobs', {:api_key=>@api_key}, options.merge(:method=>:post)
-  end
-  
-  #Returns the authenticated user associated with the given authorization token.
-  #  Parameters
-  #  
-  #      * api_key
-  #      * api_sig
-  #      * api_token
-  #  
-  #  Return Data
-  #  
-  #      * token     
-  def check_token_url(api_token, options={})
-    get_api_url 'auth/v1/keys/token', {:api_key=>@api_key, :api_token=>@api_token}, options.merge(:method=>:get)
-  end
-  
-  def revoke_token_url(api_token, options={})
-    get_api_url 'auth/v1/keys/token', {:api_key=>@api_key, :api_token=>@api_token}, options.merge(:method=>:delete)
-  end
-end
+require 'ruby_desk/connector'
+require 'ruby_desk/team_room'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_desk
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ahmed ElDawy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-05 00:00:00 +02:00
+date: 2010-01-13 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -23,13 +23,15 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/ruby_desk.rb
+- lib/ruby_desk/connector.rb
+- lib/ruby_desk/snapshot.rb
+- lib/ruby_desk/team_room.rb
+- lib/ruby_desk/user.rb
 - test/helper.rb
 - test/test_ruby_desk.rb
 has_rdoc: true
@@ -63,4 +65,3 @@ summary: Wrapper for oDesk APIs in Ruby
 test_files: 
 - test/test_ruby_desk.rb
 - test/helper.rb
-- test/test.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/test/test.rb

@@ -1,46 +0,0 @@
-require 'net/http'
-require 'net/https'
-require 'uri'
-require 'open-uri'
-require 'ruby_desk'
-require 'rubygems'
-require 'json'
-
-rd = RubyDesk.new
-
-get_frob = rd.get_frob_url(:format=>'json')
-
-url = URI.parse(get_frob[:url])
-
-http = Net::HTTP.new(url.host, url.port)
-http.use_ssl = true
-path = url.path
-
-data = get_frob[:params].to_a.map{|pair| pair.join '='}.join('&')
-headers = {
-  'Content-Type' => 'application/x-www-form-urlencoded'
-}
-
-resp, data = http.post(path, data, headers)
-
-json = JSON.parse(data)
-frob = json['frob']
-
-get_token = rd.get_token_url(frob, :format=>'json')
-
-url = URI.parse(get_token[:url])
-
-path = url.path
-
-data = get_frob[:params].to_a.map{|pair| pair.join '='}.join('&')
-headers = {
-  'Content-Type' => 'application/x-www-form-urlencoded'
-}
-
-resp, data = http.post(path, data, headers)
-
-json = JSON.parse(data)
-
-puts json.inspect
-
-puts open('https://www.odesk.com/api/team/v1/teamrooms')