safe-t-rest 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e20d688d2f00aa0da8542721bcf48bea3569325
-  data.tar.gz: ce79343210ed7631483f3aa85ba9f52a1ba18ef8
+  metadata.gz: 6d3bab011ff613248b16904f750edc1e4c40b4ea
+  data.tar.gz: 8b85042ef3c65e91bc7e2a6542f7a4fdf9f9b981
 SHA512:
-  metadata.gz: cc68e6161be3c07ba250db4ab098fe1582adb1acaebd545ba60de34de70b9822f7cbb0f2805fe0d2747b9f2aeb4ad9bf0b60187ba3f432e717e5f91f18935aae
-  data.tar.gz: 99ff0681e20047f58e2ce797c9958176f3f60da4dfe678676fea5bfd5941b4b852725706236cefd69c0c0523b83eb765a79e472076cc204d3fe83c3ce3f51ea4
+  metadata.gz: dc02c1a829cbb66340ba529da4334e831e211baf9589e8bbeaf5cfddf9e18a270aa7801259de9a43676872ac7e91bdd7a327f148b0e8598e1d46be61b2c5372d
+  data.tar.gz: 0b76657b613bb3f86494acc7fcfb505a822bfb4b35017e475074dff04560acd7bb644935171f26ba451bc237c36e2da81c2e466cb048248872f3a5f97f9cd053

data/README.md

@@ -82,4 +82,9 @@ args = {
 file = client.iFileDownload(args) # Get back the file as a base64 string
 file = Base64.decode64(file) # decode the string
 File.write('file.txt', file) # write decoded file
-```
+```
+
+# RubyDoc
+http://www.rubydoc.info/github/bararchy/safe-t-rest/SafeTRest
+
+* Added example client under /bin

data/bin/safe-t-bin

@@ -6,71 +6,69 @@ require 'nokogiri'
 require 'base64'
 require 'colorize'
 
-
 class ApiBin
-	
-	def self.main_loop
-	
-		puts "Safe-T API -- Using 'safe-t-rest' GEM".blue
-		client = SafeTRest.new
-		puts "Please enter servers url: ".bold
-		client.url = gets.chomp
-		puts "Please enter username: ".bold
-		client.username = gets.chomp
-		puts "Please enter password: ".bold
-		client.password = gets.chomp
-		puts "Please enter Role ID: ".bold
-		client.role_id = gets.chomp
-		puts "Please enter Extenstion ID: ".bold
-		client.extenstion_id = gets.chomp
+  
+  def self.main_loop
+  
+    puts "Safe-T API -- Using 'safe-t-rest' GEM".blue
+    client = SafeTRest.new
+    puts "Please enter servers url: ".bold
+    client.url = gets.chomp
+    puts "Please enter username: ".bold
+    client.username = gets.chomp
+    puts "Please enter password: ".bold
+    client.password = gets.chomp
+    puts "Please enter Role ID: ".bold
+    client.role_id = gets.chomp
+    puts "Please enter Extenstion ID: ".bold
+    client.extenstion_id = gets.chomp
+    puts "Configuration Loaded".green
+    
+    loop do
 
-		puts "Configuration Loaded".green
-		loop do 
-			
-			puts '1. List Files'.bold
-			puts '2. Upload Files'.bold
-			puts '3. Download Files'.bold
+      puts '1. List Files'.bold
+      puts '2. Upload Files'.bold
+      puts '3. Download Files'.bold
+      answer = gets.chomp
 
-			answer = gets.chomp
-			case answer
-			when '1'
-				puts "Please enter the path on the server to list (empty for root folder): "
-				path = gets.chomp
-				puts Nokogiri::XML(client.iGetFolderList(path))
-			when '2'
-				puts "Please enter the path to the file you want to upload: "
-				file = gets.chomp
-				filename = File.basename(file)
-				filepath = file.split('/')[-1]
-				upload_string = Base64.encode64(File.read(file))
-				args = {
-    				:file_base64 => upload_string, # the file as a base64 string Base64.encode64(File.read(file))
-    				:file_name => filename, # the name of the file
-    				:folder_path => '', # empty means root folder
-    				:root_folder_id => 417 # My Storage ID
-				}
-				answer = client.iFileUpload(args)
-				if answer == 'OK'
-					puts "File Uploaded".green
-				else
-					puts "Error Uploading File: #{answer}".red
-				end
-			when '3'
-				puts "Please enter the name of the file you want to download: "
-				filename = gets.chomp
-				puts "Please enter the path to the directory the file is in (empty for root directory): "
-				server_path = gets.chomp
-				puts "Please enter the path to save it to (example: /tmp): "
-				path = gets.chomp
-				args = {
-    				:file_name => filename, # The name of the file to download
-    				:folder_path => server_path, # The path of the file
-    				:root_folder_id => 417 # My Storage ID
-				}
-				download_string = Base64.decode64(client.iFileDownload(args))
-				File.write("#{path}/#{filename}", download_string)
-			end
-		end
-	end
+      case answer
+      when '1'
+        puts "Please enter the path on the server to list (empty for root folder): "
+        path = gets.chomp
+        puts Nokogiri::XML(client.get_folder_list(path))
+      when '2'
+        puts "Please enter the path to the file you want to upload: "
+        file = gets.chomp
+        filename = File.basename(file)
+        upload_string = Base64.encode64(File.read(file))
+        args = {
+          file_base64: upload_string, # the file as a base64 string Base64.encode64(File.read(file))
+          file_name: filename, # the name of the file
+          folder_path: '', # empty means root folder
+          root_folder_id: 417 # My Storage ID
+        }
+        answer = client.file_upload(args)
+        if answer == 'OK'
+          puts "File Uploaded".green
+        else
+          puts "Error Uploading File: #{answer}".red
+        end
+      when '3'
+        puts "Please enter the name of the file you want to download: "
+        filename = gets.chomp
+        puts "Please enter the path to the directory the file is in (empty for root directory): "
+        server_path = gets.chomp
+        puts "Please enter the path to save it to (example: /tmp): "
+        path = gets.chomp
+        args = {
+          file_name: filename, # The name of the file to download
+          folder_path: server_path, # The path of the file
+          root_folder_id: 417 # My Storage ID
+        }
+        download_string = Base64.decode64(client.file_download(args))
+        File.write("#{path}/#{filename}", download_string)
+      end
+    end
+  end
 end
 ApiBin.main_loop

data/lib/safe-t-rest.rb

@@ -1,105 +1,62 @@
 require 'rest-client'
-	
-class SafeTRest
-	attr_accessor(:extenstion_id, :username, :password, :url, :role_id, :guid)
-
-	def getAppsProcessState
-		RestClient::Request.execute(
-			:method => :post,
-			:url => @url,
-			:headers => {
-			   :servletRequestID => 'MethodRequest',
-			   :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', GetAppsProcessState: ['#{@guid}', false]}"
-			}
-		)
-	end
-
-	def getPackageFileList
-		RestClient::Request.execute(
-			:method => :post,
-			:url => @url,
-			:headers => {
-			   :servletRequestID => 'MethodRequest',
-			   :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', GetPackageFileList: ['#{@guid}']}"
-			}
-		)
-	end
-
-	def iVerifyUserAccount
-		RestClient::Request.execute(
-			:method => :post,
-			:url => @url,
-			:headers => {
-			   :servletRequestID => 'MethodRequest',
-			   :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iVerifyUserAccount: ['#{@username}', '#{@password}', true]}"
-			}
-		)
-	end
-
-   def iGetHistory(days)
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iGetHistory: ['#{@username}', '#{@password}', #{days}]}"
-         }
-      )
-   end
-
-   def iUserAccountAddressList
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iUserAccountAddressList: ['#{@username}', '#{@password}']}"
-         }
-      )
-   end
-
-   def iGetFolderList(path)
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iGetFolderList: ['#{@username}', '#{@password}', #{false}, #{true}, '#{path}', 417]}"
-         }
-      )
-   end
-
-   def iSafeShareFile(args)
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iSafeShareFile: ['#{@username}', '#{@password}', '#{args[:files]}', '#{args[:recipients]}', '#{args[:sender_name]}', '#{args[:sender_address]}', '#{args[:subject]}', '#{args[:message]}', #{args[:message_encryption_level]}, #{args[:delivery_method]}, '#{args[:mobile_recipient]}', #{args[:return_receipt]}, #{args[:safe_reply]}, #{args[:max_downloads]}, #{args[:package_expiry]}, '#{args[:folder_path]}', #{args[:root_folder_id]}]}"
-         }
-      )
-   end
-
-   def iFileUpload(args)
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iFileUpload: ['#{@username}', '#{@password}', '#{args[:file_base64]}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]}"
-         }
-      )
-   end
-
-   def iFileDownload(args)
-      RestClient::Request.execute(
-         :method => :post,
-         :url => @url,
-         :headers => {
-            :servletRequestID => 'MethodRequest',
-            :BusinessLogic => "{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iFileDownload: ['#{@username}', '#{@password}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]}"
-         }
-      )
-   end
 
+class SafeTRest
+  attr_accessor :extenstion_id, :user_name, :password, :url, :role_id
+
+  def initialize(config_hash={})
+    @extenstion_id = config_hash[:extenstion_id]
+    @user_name = config_hash[:user_name]
+    @password = config_hash[:password]
+    @url = config_hash[:url]
+    @role_id = config_hash[:role_id]
+  end
+
+  def get_apps_process_state(guid)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', GetAppsProcessState: ['#{guid}', false]}")
+  end
+
+  def get_package_file_list(guid)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', GetPackageFileList: ['#{guid}']}")
+  end
+
+  def verify_user_account
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iVerifyUserAccount: ['#{@user_name}', '#{@password}', true]}")
+  end
+
+  def get_user_history(days)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iGetHistory: ['#{@user_name}', '#{@password}', #{days}]}")
+  end
+
+  def user_account_address_list
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iUserAccountAddressList: ['#{@user_name}', '#{@password}']}")
+  end
+
+  def get_folder_list(path)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iGetFolderList: ['#{@user_name}', '#{@password}', false, true, '#{path}', 417]}")
+  end
+
+  def safe_share_file(args)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iSafeShareFile: ['#{@user_name}', '#{@password}', '#{args[:files]}', '#{args[:recipients]}', '#{args[:sender_name]}', '#{args[:sender_address]}', '#{args[:subject]}', '#{args[:message]}', #{args[:message_encryption_level]}, #{args[:delivery_method]}, '#{args[:mobile_recipient]}', #{args[:return_receipt]}, #{args[:safe_reply]}, #{args[:max_downloads]}, #{args[:package_expiry]}, '#{args[:folder_path]}', #{args[:root_folder_id]}]}")
+  end
+
+  def file_upload(args)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iFileUpload: ['#{@user_name}', '#{@password}', '#{args[:file_base64]}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]}")
+  end
+
+  def file_download(args)
+    send_request("{Username:'', Password:'', RoleID: '#{@role_id}', ExtensionID: '#{@extenstion_id}', iFileDownload: ['#{@user_name}', '#{@password}', '#{args[:file_name]}', '#{args[:folder_path]}', #{args[:root_folder_id]}]}")
+  end
+
+  private
+
+  def send_request(request_string)
+    RestClient::Request.execute(
+      method: :post,
+      url: @url,
+      headers: {
+        servletRequestID: 'MethodRequest',
+        BusinessLogic: request_string
+      }
+    )
+  end
 end

data/safe-t-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'safe-t-rest'
-  s.version     = '0.0.8'
+  s.version     = '0.1.0'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'A ruby gem to interact with Safe-T Box.'
   s.description = 'Ruby gem to interact with Safe-T Box rest API. '

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe-t-rest
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Bar Hofesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A ruby gem to interact with Safe-T Box.