sys_lib_detector 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 021ed26b0412910307df6c158d9311de498ff518
-  data.tar.gz: 79c5851f9c6e2457f6b58813b4ee1279bf289d3b
+  metadata.gz: 9b16819c07104381fe0fcf416ed83a3921debe96
+  data.tar.gz: f2918a512c5715223c5b16e162501f1c18189dc4
 SHA512:
-  metadata.gz: 878ddd8ac643df79238ec2a46a9c8c234d36dda067982dd06a5c4a78a166c66d4623d08a5a7532cbf301c1f24c2af69f1fca25456185c9f49892a7cd828747a4
-  data.tar.gz: a37cbe9f2d39fcc59ab2505f643d86acc4b0409f703c5eaf3d4f7d82e49acaaaddfee141fdc65272385bf74279d3f1a1d22b1dfe6bdf494458f63a405f539733
+  metadata.gz: 3393ecec1ff8f6f9f2eba899e15d8663c169638f25781853f15ab4d7a9cab4b13d73b6c6d15cc68e5b37ef80362cb0968835cb796e1d66687e192e9a5a9869c2
+  data.tar.gz: 24ce55003c607d2c10da9ff7b6c7ec66e9a81c7b4dbaa2f534159444bb54dae581bbf124f68ea5b1d5d5dd3a61aed7d42b707e916bfcc11ba3860fd333ccbe37

data/README.md

@@ -1,8 +1,17 @@
 # SysLibDetector
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sys_lib_detector`. To experiment with that code, run `bin/console` for an interactive prompt.
+SysLibDetector helps in solving an irritating issue, which is ruby gems requiring native system dependencies, such as 'nokogiri' gem, as if you don't know upfront that you need to install ‘zlib1g-dev’ and ‘liblzma-dev’ you will be hit with an exception about a missing system library, and you won't be able to know this till checking Nokogiri's website.
 
-TODO: Delete this and the text above, and describe your gem
+## How SysLibDetector works
+
+SysLibDetector collects your project's local gems and your system's operating system information and make an API request with this information to a web-service https://sys-libraries.herokuapp.com, which retrieves the **possibly found** system native libraries required for correct installation and usage of your project's gems.
+
+## Dependencies
+
+* [Json](https://rubygems.org/gems/json): for parsing json responses from the web-service.
+* [System](https://rubygems.org/gems/system): for system's operating system detection
+* [Thor](https://rubygems.org/gems/thor): for building a command-line interface.
+* [RestClient](https://rubygems.org/gems/rest-client): a rest client for the web-service communication
 
 ## Installation
 
@@ -22,17 +31,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+* Show the available methods
+
+      $ sys-lib-detector help 
+
+* List your project's gems
+
+      $ sys-lib-detector list_all_gems
+
+* List the **available** required system libraries for your project's gems
+
+      $ sys-lib-detector list_sys_libs
+
+	*Note: The web-service is continuously updated with gem's system libraries dependencies upon the contribution of different contributors, and you among those! Check the contribution part below.
+
+* Install the **available** required system libraries for your project's gems
+
+      $ sys-lib-detector install_sys_libs
+
+	*Note: Supported operating systems are Linux and OS X, with package managers `APT` and `Homebrew` respectively.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
+### Adding new gem's system libraries
+
+You can contribute yourself in order for making the whole process more reliable and more useful by adding gems' system dependencies.
+
+This can be done by making a simple POST API request to the web-service (contributing endpoint) https://sys-libraries.herokuapp.com/contribute_requests including your email, gem's information (name and version) and the system libraries dependencies, as in this example
+```
+{
+	"email": "you@example.com",
+	"ruby_gem": {
+		"name": "nokogiri",
+		"version": "1.8.2"
+	},
+	"libraries": [
+		{
+			"platform": "linux",
+			"name": "zlib1g-dev"
+		},
+        	{
+			"platform": "linux",
+			"name": "liblzma-dev"
+		},
+		{
+			"platform": "osx",
+			"name": "libxml2"
+		}
+	]
+}
+```
+***NOTE:** You can leave `version` field in `ruby_gems` attributes empty
+
+***NOTE:** `platform` field in `libraries` attributes can be any of those: 'linux', 'osx' or 'windows'
+
+### SysLibDetector gem
 Bug reports and pull requests are welcome on GitHub at https://github.com/HusseinReda/sys_lib_detector.
+The project is always welcoming for contributions.
+
+## Future Plans
+
+* Adding Windows to supported operating systems.
+* Automating the manual review of the contribution requests of adding gems' dependencies.
 
 ## License
 

data/lib/sys_lib_detector/cli.rb

@@ -24,15 +24,50 @@ module SysLibDetector
 		def list_sys_libs
 			gems = get_gems
 			os = get_os_name
+
 			begin
 				web_service_handler = get_web_service_handler
-				response = web_service_handler.retrieve_sys_libraries(gems, os)
 
+				response = web_service_handler.retrieve_sys_libraries(gems, os)
 				response = clean_response(response)
 
 				Displayer::diplay_list_sys_libs(response, gems)
+
+			rescue Exception::NoInternetConnection
+				abort "Please check your internet connectivity"
+			rescue => e
+				abort e.message
+			end
+		end
+
+		desc "install_sys_libs", "Installing the required gems' dependant system libraries "
+		# Installing the required system libraries for the project's local gems via 
+		# sending the retrieval request to the web-service, and then installing the 
+		# system libraries included in the response
+		def install_sys_libs
+			gems = get_gems
+			os = get_os_name
+
+			begin
+				web_service_handler = get_web_service_handler
+
+				response = web_service_handler.retrieve_sys_libraries(gems, os)
+				response = clean_response(response)
+
+				libraries = get_libraries(response)
+
+				Displayer::display_header(response, gems)
+
+				# if count == 0 message is already handled in the diplay header
+				if(libraries.count > 0)
+					installer = SysLibDetector::Installer.new
+					installer.install(libraries)
+				end
+
 			rescue Exception::NoInternetConnection
 				abort "Please check your internet connectivity"
+			rescue => e
+				abort e.message
 			end
 		end
 
@@ -59,5 +94,12 @@ module SysLibDetector
 			def clean_response(json_object)
 				return json_object.delete_if {|key, value| value.nil? || value.empty?}
 			end
+
+			# private method for extracting the system libraries from the reponse
+			# @param response [Json] The json response of web-service 
+			def get_libraries(response)
+				return response.values.flatten
+			end
+
 	end
 end

data/lib/sys_lib_detector/displayer.rb

@@ -16,38 +16,38 @@ module SysLibDetector
 				end
 			end
 
-			# display_footer if response.count > 0
+			display_footer if response.count > 0
 		end
 
-		private
+		# Displaying the header message after recieving the web-service response
+		# @param response [Json] The json response of web-service 
+		#	in format { gem_1: [a,b,c], gem_2: [x,y,z] }
+		# @param gems [Array] The current project's gems' names
+		def self.display_header(response, gems)
+			gems_found_count = gems_with_libraries_count(response)
+			all_found = gems_found_count == gems.count
+
+			if(gems_found_count == 0)
+				puts "No system libraries found for your gems, you can contribute by adding libraries!"
+				puts "For more details check https://github.com/HusseinReda/SysLibDetectorGem#contributing"
+				return
+			end
 
-			def self.gems_with_libraries_count(response)
-				return response.keys.count
+			if(all_found)
+				puts "Required system libraries found for all your gems!"
+			else
+				puts "Required system libraries found for gems: #{response.keys.join(", ")}"
 			end
+		end
 
-			# Displaying the header message after recieving the web-service response
-			# @param response [Json] The json response of web-service 
-			#	in format { gem_1: [a,b,c], gem_2: [x,y,z] }
-			# @param gems [Array] The current project's gems' names
-			def self.display_header(response, gems)
-				gems_found_count = gems_with_libraries_count(response)
-				all_found = gems_found_count == gems.count
-
-				if(gems_found_count == 0)
-					puts "No system libraries found for your gems, you can contribute by adding libraries!"
-					puts "For more details check https://github.com/HusseinReda/SysLibDetectorGem#contributing"
-					return
-				end
+		def self.display_footer
+			puts "\nTo install the required system libraries listed, run 'sys-lib-detector install-sys-libs'"
+		end
 
-				if(all_found)
-					puts "Required system libraries found for all your gems!"
-				else
-					puts "Required system libraries found for gems: #{response.keys.join(", ")}"
-				end
-			end
+		private
 
-			# def self.display_footer
-			# 	puts "\nTo install the required system libraries listed, run 'sys-lib-detector install-sys-libs'"
-			# end
+			def self.gems_with_libraries_count(response)
+				return response.keys.count
+			end
 	end
 end

data/lib/sys_lib_detector/installer.rb

@@ -0,0 +1,66 @@
+require "sys_lib_detector"
+
+module SysLibDetector
+	# Class responsible for installing the retrieved system libraries
+	class Installer
+		# Available operating systems for installing the libraries are
+		# linux and macos only.
+		AVAILABLE_OS = [:linux, :osx]
+
+		# Initializing the installer object with the current os
+		def initialize
+			@os_name = get_os_name
+		end
+
+		# Installing the required system libraries, packager specified 
+		# according to the current operating system, showing info about the 
+		# status of the libraries, whether installed or not
+		# @param libraries [Array] Retrieved required system libraries
+		def install(libraries)
+			# Abort with a friendly message if the running OS is not supported yet
+			abort "We're sorry but currently we don't support #{@os_name} package installation" if(!is_os_available?(@os_name))
+
+			# Message shown handled by the displayer already
+			abort if libraries.count == 0
+			installed_libraries = []
+			failed_libraries = []
+
+			libraries.each do |library|
+				installed = self.send("#{@os_name}_installer", library)
+				if(installed == true)
+					installed_libraries << library
+				else
+					failed_libraries << library
+				end
+			end
+
+			if(failed_libraries.count > 0)
+				abort "#{failed_libraries.count} libraries failed to be installed: #{failed_libraries}"
+			else
+				abort "#{installed_libraries.count} libraries installed successfully!"
+			end
+		end
+
+		private
+			# private method for getting the running operating system's name
+			def get_os_name
+				return SystemDetector.get_os_name
+			end
+
+			# private method for checking the availability of the operating system
+			def is_os_available?(os_name)
+				return AVAILABLE_OS.include?(os_name)
+			end
+
+			# private method for running linux (apt) installing command
+			def linux_installer(package)
+				system("sudo apt-get -y install #{package}")
+			end
+
+			# private method for running MacOS (homebrew) installing command
+			def osx_installer(package)
+				system("brew install #{package}")
+			end
+
+	end
+end

data/lib/sys_lib_detector/version.rb

@@ -1,4 +1,4 @@
 module SysLibDetector
 	# current version of the gem
-	VERSION = "0.1.1"
+	VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys_lib_detector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Hussein Abu Maash