ikbis 0.2.0

data/lib/ikbis/advanced/photo.rb

@@ -0,0 +1,171 @@
+module Ikbis
+  module Advanced
+    class Photo < Ikbis::Advanced::Media
+         #######################################################
+         # Set the class extention string for this class.
+         ######################
+         # @Created : Jan/19/2009
+         # @LastRefactor : Jan/19/2009
+         # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+         #######################################################
+         def initialize
+           @class_extention = "ikbis.photos"
+           super ### call the media initialize function.
+         end
+         
+         
+         #######################################################
+         # getUploadedList
+         #   -> This gets a list of photos uploaded by the specified user.
+         #   -> If the calling user is logged in, this will return information that calling 
+         #   -> user has access to (including private photos). If the calling user is not authenticated, 
+         #   -> this will only return public information, or a permission denied error if none is available.
+         # 
+         # Parameters
+         #   * string username- ex.(moski_doski)
+         #   * options:
+         #   *   int page - Which page to show.
+         #   *   int per_page - How many results per page?  
+         #   *   string how - xml or json or php
+         # 
+         # ex:   getUploadedList('moski_doski' , {:how => 'json'}) 
+         #
+         # Returns:
+         #   -> <photos>
+         #        <photo>
+         #           <id>142139</id>   
+         #           <title>In the office</title>
+         #           <caption>In the office</caption>    
+         #           <views>61</views>\n    
+         #           <category></category>\n    
+         #           <owner>moski_doski</owner>\n    
+         #           <comments>0</comments>\n    
+         #           <rating>0</rating>\n    
+         #           <thumbnails>\n      
+         #             <small>http://shots.ikbis.com/image/142139/small/Photo_107.jpg</small>\n      
+         #             <thumb>http://shots.ikbis.com/image/142139/thumb/Photo_107.jpg</thumb>\n      
+         #             <medium_crop>http://shots.ikbis.com/image/142139/medium_crop/Photo_107.jpg</medium_crop>\n      
+         #             <medium>http://shots.ikbis.com/image/142139/medium/Photo_107.jpg</medium>\n         
+         #             <screen>http://shots.ikbis.com/image/142139/screen/Photo_107.jpg</screen>\n      
+         #             <big_screen>http://shots.ikbis.com/image/142139/big_screen/Photo_107.jpg</big_screen>\n      
+         #             <large>http://shots.ikbis.com/image/142139/large/Photo_107.jpg</large>\n    
+         #           </thumbnails>\n  
+         #       </photo>
+         #     </photos>
+         #
+         # Authentication
+         #   ->    Authentication is not required.
+         ######################
+         # @Created : DEC/31/2008
+         # @LastRefactor : DEC/31/2008
+         # @Author  : Moski
+         #######################################################
+         ### Auto-generated using method_missing ####
+         
+         
+         #######################################################
+         # getInfo
+         #   -> Get all kinds of information about a photo
+         #   -> If the calling user is logged in, this will return information 
+         #   -> that calling user has access to (including private photos).
+         #   -> If the calling user is not authenticated, this will only return 
+         #      public information, or a permission denied error if none is available.
+         # Parameters
+         #   * int media_id (required) - Get information from this id
+         #
+         # ex:   getInfo('103678' , {:how => 'json'}) 
+         #
+         # Returns:
+         #   -> <photo>\n  <id>103678</id>\n  <title>First Album</title>\n  <caption>Cool avatars</caption>\n  <views>171</views>\n          
+         #      <category></category>\n  <owner>moski_doski</owner>\n  <comments>0</comments>\n  <rating>0</rating>\n  <thumbnails>\n    
+         #      <small>http://shots.ikbis.com/image/103678/small/Another_ID_by_pyromaniac.png</small>\n    
+         #      <thumb>http://shots.ikbis.com/image/103678/thumb/Another_ID_by_pyromaniac.png</thumb>\n    
+         #      <medium_crop>http://shots.ikbis.com/image/103678/medium_crop/Another_ID_by_pyromaniac.png</medium_crop>\n    
+         #      <medium>http://shots.ikbis.com/image/103678/medium/Another_ID_by_pyromaniac.png</medium>\n    
+         #      <screen>http://shots.ikbis.com/image/103678/screen/Another_ID_by_pyromaniac.png</screen>\n    
+         #      <big_screen>http://shots.ikbis.com/image/103678/big_screen/Another_ID_by_pyromaniac.png</big_screen>\n    
+         #      <large>http://shots.ikbis.com/image/103678/large/Another_ID_by_pyromaniac.png</large>\n  </thumbnails>\n</photo>
+         #
+         # Authentication
+         #   ->    Authentication is not required.
+         ######################
+         # @Created : DEC/31/2008
+         # @LastRefactor : DEC/31/2008
+         # @Author  : Moski
+         #######################################################
+         ### Auto-generated using method_missing ####
+         
+         
+         #######################################################
+         # getThumbnailUrl
+         #   -> Get a thumbnail URL for a given photo/size
+         # 
+         # Parameters
+         #   * int media_id (required) - Get information from this video
+         #   * thumbnail_size: 
+         #           small        "70x70"   and  crop => "1:1"
+         #           thumb        "90x90"   and  crop => "1:1"
+         #           medium_crop  "144x144" and  crop => "1:1"
+         #           medium       "240x240" and  no crop
+         #           screen       "420x420" and  no crop
+         #           big_screen   "500x500" and no crop
+         #           large        "800x800" and no crop
+         #           all          return all sizes
+         # Returns:
+         #   ->   <thumbnails>
+         #           <small>http://shots.ikbis.com/video_thumbnail/110774/small/video.jpg</small>\n        
+         #           <thumb>http://shots.ikbis.com/video_thumbnail/110774/thumb/video.jpg</thumb>\n    
+         #           <medium_crop>http://shots.ikbis.com/video_thumbnail/110774/medium_crop/video.jpg</medium_crop>
+         #           ..........
+         #       </thumbnails>
+         # Authentication
+         #   ->    Authentication is not required.
+         ######################
+         # @Created : DEC/31/2008
+         # @LastRefactor : DEC/31/2008
+         # @Author  : Moski
+         ######################################################
+         ### Auto-generated using method_missing ####
+         
+         
+         #######################################################
+         # setTitle
+         #   -> Set the title of a photo (overwrites previous title) 
+         # Parameters
+         #   * int media_id (required) - Set the title of this photo.
+         #   * string title (required) - The new title. 128 is the max length for this field, any longer and it will be trimmed.
+         #
+         # ex:   setTitle(media_id , "My cool new title" ,{:how => 'json'})
+         #
+         # Returns:
+         #   ->  <rsp>ok</rsp>
+         # Authentication
+         #   ->    Authentication is required.
+         ######################
+         # @Created : DEC/31/2008
+         # @LastRefactor : DEC/31/2008
+         # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+         #######################################################
+         ### Auto-generated using method_missing ####
+         
+         #######################################################
+         # setCaption
+         #   -> Set a new caption for a photo (overwrites previous caption)
+         # Parameters
+         #   * int media_id (required) - Set the title of this photo.
+         #   * string caption (required) - The new caption.
+         # Returns:
+         #   ->  <rsp>ok</rsp>
+         # Authentication
+         #   ->    Authentication is required.
+         ######################
+         # @Created : DEC/31/2008
+         # @LastRefactor : DEC/31/2008
+         # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+         #######################################################
+         ### Auto-generated using method_missing ####
+         
+         
+    end ## end class
+  end ## end Advanced
+end ## end ikbis

data/lib/ikbis/advanced/test.rb

@@ -0,0 +1,50 @@
+module Ikbis
+  module Advanced
+    
+    class Test < Ikbis::Advanced::Base
+      def echo(options={})
+         options.merge!(:what => "ikbis.test.echo")
+         options.merge!(:how => 'xml') unless options.has_key?(:how)
+         response = @access_token.post('/api/rest' , options)
+         return response.body
+      end ## end test_echo
+      
+      #######################################################
+      # ikbis.test.login
+      #   -> Is the user logged in?
+      # Returns:
+      #   -> <profile>
+      #   ->      <id>25874</id> 
+      #   ->      <username>moski_doski</username>
+      #   -> </profile>
+      # Error Codes:
+      #   ->  205: Not Logged in
+      ######################
+      # @Created : DEC/31/2007
+      # @LastRefactor : DEC/31/2007
+      # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+      #######################################################
+      def login(options = {})
+        options.merge!(:what => "ikbis.test.login")
+        options.merge!(:how => "xml") unless options.has_key?(:how)
+        return send_request(options)
+      end ## end test_login
+    
+      #######################################################
+      # ikbis.test.ping
+      #   -> This is just a simple ping test...
+      # Returns:
+      #   -> <rsp>ok</rsp>
+      ######################
+      # @Created : DEC/31/2007
+      # @LastRefactor : DEC/31/2007
+      # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+      #######################################################
+      def ping(options = {})
+        options.merge!(:what => "ikbis.test.ping")
+        options.merge!(:how => 'xml') unless options.has_key?(:how)
+        return send_request(options)
+      end ## end test_ping
+    end
+  end ## end Advanced
+end ## end ikbis

data/lib/ikbis/advanced/upload.rb

@@ -0,0 +1,164 @@
+require 'open-uri'
+require 'net/http'
+require 'yaml'
+require 'cgi'
+require 'net/http/post/multipart'
+module Ikbis
+  module Advanced
+    class Upload < Ikbis::Advanced::Base
+    
+      class CouldNotUpload < Exception; end
+      class CouldNotAuthenticate < CouldNotUpload; end
+      class InvalidUploadFile < CouldNotUpload; end
+      class InvalidMediaType < Exception; end
+      
+      #######################################################
+      # Set the class extention string for this class.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+      #######################################################
+      def initialize
+       @class_extention = "ikbis.upload"
+       super ### call the media initialize function.
+      end
+
+      #######################################################
+      # Sends a multipart/form POST request to the server
+      # containing all the required fields for uploading media.
+      #
+      # It made no sense for this method to follow its siblings behaviour
+      # by delegating a send request to Ikbis::Advanced::Base module
+      # with the req params, like the other modules are doing since this
+      # request is handled by Net::HTTP and NOT HTTParty.
+      #
+      # The uploaded file is being parsed into a multi-part/form compatible
+      # request object by the gem `multipart-post' by Nick Sieger, cheers
+      # to him for making this an easy task.
+      #
+      # Params:
+      #   * string file_path => 
+      #       must either be a full path or a relative one to the upload file
+      #   * hash options
+      #    {
+      #       * string :title => media title
+      #       * string :caption => media caption, defaults to title if not specified
+      #       * string enum :type => !"media"|"image"|"video"
+      #       * string :tags => space delimited media tag(s)
+      #       * string enum :permission => !"public"|"private"|"shared"
+      #     }
+      #   `!' implies default value
+      #   note: ALL parameters are REQUIRED
+      #
+      # Usage ex:
+      #   uploader = Ikbis::Advanced::Uploader.new # must create an object since OAuth is required
+      #   uploader.oauth_authentication("ikbis.yml")
+      #   uploader.upload(
+      #     "http://www.mydomain.com/foo.png", 
+      #     { 
+      #       :title => "FooBAR", 
+      #       :caption => "FooBAR Cap'n", 
+      #       :tags => "hello world", 
+      #       :permission => "public"
+      #      })
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/13/2010
+      # @Author  : Monther Abushaikh <abushaikh@gmail.com>
+      #######################################################
+      IMAGE = "image"
+      VIDEO = "video"
+      MEDIA = "media"
+      @@image_types = [ "jpg", "jpeg", "png", "svg", "gif", "bmp" ]
+      @@video_types = [ "flv", "wmv", "avi", "mpeg", "3gp", "3g2", "asf", "swf", "mpg", "rm", "3gpp", "mp4", "asp", "mov" ]
+
+      def uploadFile(file_path, options)
+        puts "|------------------------ Uploading ------------------------|"
+        begin                  
+          # open file for uploading
+          begin
+            file = File.new(file_path)
+          rescue
+            raise InvalidUploadFile
+          end
+           
+          url = URI.parse('http://localhost:3000/api/medias')
+
+          puts "| Initiating POST request to `#{url.request_uri}'"
+          req = Net::HTTP::Post.new(url.request_uri)
+
+          puts "| Constructing File object"
+          req = Net::HTTP::Post::Multipart.new url.path, 
+            { "file" => UploadIO.new(file, mime_type(file), file.path),
+              "title" => options[:title], 
+              "caption" => options[:caption], 
+              "type" => type(file), 
+              "tags" => options[:tags], 
+              "permission" => options[:permission]
+            }
+
+          puts "| Authenticating..."
+          begin
+            @consumer.sign!(req, @access_token)
+          rescue
+            raise CouldNotAuthenticate
+          end
+
+          puts "| Initiating connection with `#{url.host}:#{url.port}'"
+          res = ""
+          
+          Net::HTTP.new(url.host, url.port).start do |http| 
+            print "| Processing request..."
+            res = http.request(req)
+            print " done!\n"
+          end
+        
+          puts "| Upload request sent successfully:"
+          puts "|   Request URI -> #{url.request_uri}"
+          puts "|   Response -> #{res}"
+
+        rescue InvalidMediaType
+          print "|   File format not supported. Supported types: "
+          print "\n|   Images => "
+          print @@image_types.join(", ")
+          print "\n|   Videos => "
+          print @@video_types.join(", ")
+          print "\n"     
+        rescue CouldNotAuthenticate
+            puts "|  Error while authenticating, have you run oauth_authenticate() ?"
+        rescue InvalidUploadFile
+            puts "| An error occured processing the file you input, please make sure the file is valid."
+        rescue
+          puts "| Upload failed with `#{$!}'\n"
+          raise CouldNotUpload
+        end
+        
+        puts "|------------------------ --------- ------------------------|"
+                
+      end
+
+      private
+       
+      # quick and dirty method for determining mime type of uploaded file
+      def mime_type(file)
+        case 
+          when file =~ /\.jpg/ then 'image/jpg'
+          when file =~ /\.gif$/ then 'image/gif'
+          when file =~ /\.png$/ then 'image/png'
+          else 'application/octet-stream'
+        end
+      end
+      
+      def type(file)
+        ext = File.extname(file.path).gsub(".", "")
+
+        return IMAGE if @@image_types.include?(ext)
+        return VIDEO if @@video_types.include?(ext) 
+
+        raise InvalidMediaType
+      end
+  
+    end ## end class
+  end ## end Advanced
+end ## end ikbis

data/lib/ikbis/advanced/video.rb

@@ -0,0 +1,172 @@
+module Ikbis
+  module Advanced
+    class Video < Ikbis::Advanced::Media
+      
+      #######################################################
+      # Set the class extention string for this class.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Moski
+      #######################################################
+      def initialize
+         @class_extention = "ikbis.videos"
+         super ### call the media initialize function.
+      end
+      
+      
+      #######################################################
+      # getUploadedList
+      #   -> This gets a list of videos uploaded by the specified user.
+      #   -> If the calling user is logged in, this will return information that calling 
+      #   -> user has access to (including private videos). If the calling user is not authenticated, 
+      #   -> this will only return public information, or a permission denied error if none is available.
+      # 
+      # Parameters
+      #   * string username- ex.(moski_doski)
+      #   * options:
+      #   *   int page - Which page to show.
+      #   *   int per_page - How many results per page?  
+      #   *   string how - xml or json or php
+      # 
+      # ex:   getUploadedList('moski_doski' , {:how => 'json'}) 
+      #
+      # Returns:
+      #   -> <videos>
+      #       <video>  
+      #         <id>106502</id>  <title>كيف توكل منسف اردني</title> <caption>كيف توكل منسف اردني </caption> <views>319</views>
+      #         <thumbnails>
+      #             <small>http://shots.ikbis.com/video_thumbnail/106502/small/video.jpg</small>
+      #             <thumb> http://shots.ikbis.com/video_thumbnail/106502/thumb/video.jpg </thumb>     
+      #             <medium_crop>http://shots.ikbis.com/video_thumbnail/106502/medium_crop/video.jpg</medium_crop>
+      #             <medium>http://shots.ikbis.com/video_thumbnail/106502/medium/video.jpg</medium>
+      #             <screen>http://shots.ikbis.com/video_thumbnail/106502/screen/video.jpg</screen>  
+      #         </thumbnails>     
+      #       </video>    
+      #     </videos>  
+      #
+      # Authentication
+      #   ->    Authentication is not required.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Moski
+      #######################################################
+      ### Auto-generated using method_missing ####
+      
+      
+      #######################################################
+      # getInfo
+      #   -> Get all kinds of information about a video
+      #   -> If the calling user is logged in, this will return information 
+      #   -> that calling user has access to (including private videos).
+      #   -> If the calling user is not authenticated, this will only return 
+      #      public information, or a permission denied error if none is available.
+      # Parameters
+      #   * int media_id (required) - Get information from this video
+      #
+      # ex:   getInfo('moski_doski' , {:how => 'json'}) 
+      #
+      # Returns:
+      #   -> <video>
+      #         <id>110774</id>
+      #         <title> the reason</title>
+      #         <caption>\r\nthe reason\r\n</caption>
+      #         <views>136</views>  
+      #         <category></category>  
+      #         <owner>moski_doski</owner> 
+      #         <comments>0</comments> 
+      #         <rating>0</rating>
+      #         <thumbnails>
+      #           <small>http://shots.ikbis.com/video_thumbnail/110774/small/video.jpg</small>\n        
+      #           <thumb>http://shots.ikbis.com/video_thumbnail/110774/thumb/video.jpg</thumb>\n    
+      #           <medium_crop>http://shots.ikbis.com/video_thumbnail/110774/medium_crop/video.jpg</medium_crop>
+      #           ..........
+      #         </thumbnails>          
+      #      </video>
+      #
+      # Authentication
+      #   ->    Authentication is not required.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Moski
+      #######################################################
+      ### Auto-generated using method_missing ####
+      
+      
+      #######################################################
+      # getThumbnailUrl(media_id)
+      #   -> Get a thumbnail URL for a given video/size
+      #   -> 
+      # Parameters
+      #   * int media_id (required) - Get information from this video
+      #   * thumbnail_size: 
+      #           small        "70x70"   and  crop => "1:1"
+      #           thumb        "90x90"   and  crop => "1:1"
+      #           medium_crop  "144x144" and  crop => "1:1"
+      #           medium       "240x240" and  no crop
+      #           screen       "420x420" and  no crop
+      #           all          return all sizes
+      #
+      # ex:   getThumbnailUrl(media_id , {:how => 'json'})
+      #
+      # Returns:
+      #   ->   <thumbnails>
+      #           <small>http://shots.ikbis.com/video_thumbnail/110774/small/video.jpg</small>\n        
+      #           <thumb>http://shots.ikbis.com/video_thumbnail/110774/thumb/video.jpg</thumb>\n    
+      #           <medium_crop>http://shots.ikbis.com/video_thumbnail/110774/medium_crop/video.jpg</medium_crop>
+      #           ..........
+      #       </thumbnails>
+      # Authentication
+      #   ->    Authentication is not required.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Moski
+      #######################################################
+      ### Auto-generated using method_missing ####
+      
+      
+      #######################################################
+      # setTitle
+      #   -> Set the title of a video (overwrites previous title) 
+      # Parameters
+      #   * int media_id (required) - Set the title of this video.
+      #   * string title (required) - The new title. 128 is the max length for this field, any longer and it will be trimmed.
+      #
+      # ex:   getThumbnailUrl(media_id , {:how => 'json'})
+      #
+      # Returns:
+      #   ->  <rsp>ok</rsp>
+      # Authentication
+      #   ->    Authentication is required.
+      ######################
+      # @Created : DEC/31/2007
+      # @LastRefactor : DEC/31/2007
+      # @Author  : Moski
+      #######################################################
+      ### Auto-generated using method_missing ####
+      
+      #######################################################
+      # setCaption
+      #   -> Set a new caption for a video (overwrites previous caption)
+      # Parameters
+      #   * int media_id (required) - Set the title of this video.
+      #   * string caption (required) - The new caption.
+      # Returns:
+      #   ->  <rsp>ok</rsp>
+      # Authentication
+      #   ->    Authentication is required.
+      ######################
+      # @Created : Jan/19/2009
+      # @LastRefactor : Jan/19/2009
+      # @Author  : Moski
+      #######################################################
+      ### Auto-generated using method_missing ####
+      
+      
+      
+    end ## end video
+  end ## end Advanced
+end ## end ikbis