sys_lib_detector 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 021ed26b0412910307df6c158d9311de498ff518
+  data.tar.gz: 79c5851f9c6e2457f6b58813b4ee1279bf289d3b
+SHA512:
+  metadata.gz: 878ddd8ac643df79238ec2a46a9c8c234d36dda067982dd06a5c4a78a166c66d4623d08a5a7532cbf301c1f24c2af69f1fca25456185c9f49892a7cd828747a4
+  data.tar.gz: a37cbe9f2d39fcc59ab2505f643d86acc4b0409f703c5eaf3d4f7d82e49acaaaddfee141fdc65272385bf74279d3f1a1d22b1dfe6bdf494458f63a405f539733

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hussein.abumash@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sys_lib_detector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sys_lib_detector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sys_lib_detector
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HusseinReda/sys_lib_detector.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sys_lib_detector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/sys-lib-detector

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'sys_lib_detector/cli'
+
+SysLibDetector::Cli.start

data/lib/sys_lib_detector/cli.rb

@@ -0,0 +1,63 @@
+require "thor"
+require "sys_lib_detector"
+
+module SysLibDetector
+	# The command-line interface class, responsible for the commands of running 
+	# the gem's funcionalities, using Thor's gem
+	class Cli < Thor
+
+		desc "list_all_gems", "Listing all the local gems existing in the porject"
+		# Listing the local gems existing in the porject
+		def list_all_gems
+			gems = get_gems
+			if gems.empty?
+				puts "You don't have any gems installed"
+			else
+				puts gems
+			end
+		end
+
+		desc "list_sys_libs", "Retrieving gems' dependant system libraries "
+		# Retrieving the required system libraries for the project's local gems via 
+		# sending the retrieval request to the web-service, and then displaying 
+		# it in a friendly way using the Displayer class
+		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 = clean_response(response)
+
+				Displayer::diplay_list_sys_libs(response, gems)
+			rescue Exception::NoInternetConnection
+				abort "Please check your internet connectivity"
+			end
+		end
+
+		private
+			# private method for getting the project's local gems
+			def get_gems
+				return GemsCollector.get_all
+			end
+
+			# private method for getting the running operating system's name
+			def get_os_name
+				return SystemDetector.get_os_name
+			end
+
+			# private method for initializing a new handler for the web-service
+			def get_web_service_handler
+				return WebServiceCommunicator.new
+			end
+
+			# private method for cleaning up the web-service's response from empty 
+			# values, for gems that exist in the web-service but doesn't have 
+			# libraries attached yet
+			# @param json_object [Json] The json response of web-service 
+			def clean_response(json_object)
+				return json_object.delete_if {|key, value| value.nil? || value.empty?}
+			end
+	end
+end

data/lib/sys_lib_detector/displayer.rb

@@ -0,0 +1,53 @@
+module SysLibDetector
+	# Class responsible for displaying the results of the 
+	# command line interface class
+	class Displayer
+		# Displaying the system libraries retrieved
+		# @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.diplay_list_sys_libs(response, gems)
+			display_header(response, gems)
+
+			response.each do |gemm, libraries|
+				puts "#{gemm}:"
+				libraries.each do |library|
+					puts "  #{library}"
+				end
+			end
+
+			# display_footer if response.count > 0
+		end
+
+		private
+
+			def self.gems_with_libraries_count(response)
+				return response.keys.count
+			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
+
+				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
+
+			# def self.display_footer
+			# 	puts "\nTo install the required system libraries listed, run 'sys-lib-detector install-sys-libs'"
+			# end
+	end
+end

data/lib/sys_lib_detector/exceptions.rb

@@ -0,0 +1,12 @@
+module SysLibDetector
+	# Namespace for the exceptions classes 
+	module Exception
+		# Standard error exception
+		class Error < StandardError
+		end
+
+		# No internet connectivity exception
+		class NoInternetConnection < Error
+		end
+	end
+end

data/lib/sys_lib_detector/gems_collector.rb

@@ -0,0 +1,13 @@
+# Namespace for classes handling the whole process of the gem 
+# from collecting the projects' gem, going through system libraries retrieval, 
+# till displaying the results or installing the required system libraries
+
+module SysLibDetector
+	# Class responsible for collecting the projects' local gems
+	class GemsCollector
+		# Getting all the projects' local gems
+		def self.get_all
+			Bundler.load.specs.map(&:name)
+		end
+	end
+end

data/lib/sys_lib_detector/system_detector.rb

@@ -0,0 +1,11 @@
+require 'system'
+
+module SysLibDetector
+	# Class responsible for getting information about the current system
+	class SystemDetector
+		# Getting the running operating system's name
+		def self.get_os_name
+			return System::OS.name
+		end
+	end
+end

data/lib/sys_lib_detector/version.rb

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

data/lib/sys_lib_detector/web_service_communicator.rb

@@ -0,0 +1,48 @@
+require 'rest-client'
+require 'json'
+
+module SysLibDetector
+	# Handler for the communication with the web-service for retrieving 
+	# the required system libraries
+	class WebServiceCommunicator
+		# Url for the web-service libraries retrieval endpoint
+		SERVICE_URL = "https://sys-libraries.herokuapp.com/libraries"
+
+		# Initializing the handler object, with a check for internet connectivity
+		def initialize
+			# checking internet connectivity
+			raise Exception::NoInternetConnection if ping != :pong
+
+			@url = SERVICE_URL
+		end
+
+		# Retrieving the required system libraries by sending a get request 
+		# to the web-service with the gems' names and running operating system
+		# @param gems_names [Array] The current project's gems' names
+		# @param os_name [String] The operating system's name as a symbol (:linux, :osx, :windows)
+		# @return [Json] The web-services's response, 
+		# 	in format { gem_1: [a,b,c], gem_2: [x,y,z] }
+		def retrieve_sys_libraries(gems_names, os_name)
+			params = {
+				gems: gems_names,
+				os: os_name
+			}
+			response = JSON.parse(RestClient.get(@url, {params: params}))
+		end
+
+		private
+
+			# Pinging google.com for checking the internet connectivity, by
+			# making a simple get request to www.google.com
+			def ping
+				begin
+					RestClient.get("https://www.google.com")
+					return :pong
+				rescue SocketError => e
+					return e
+				rescue Errno::ECONNREFUSED => e
+					return e
+				end
+			end
+	end
+end

data/lib/sys_lib_detector.rb

@@ -0,0 +1,7 @@
+require "sys_lib_detector/version"
+require "sys_lib_detector/gems_collector"
+require "sys_lib_detector/system_detector"
+require "sys_lib_detector/web_service_communicator"
+require "sys_lib_detector/displayer"
+require "sys_lib_detector/installer"
+require "sys_lib_detector/exceptions"

data/sys-lib-detector.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sys_lib_detector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sys_lib_detector"
+  spec.version       = SysLibDetector::VERSION
+  spec.authors       = ["Hussein Abu Maash"]
+  spec.email         = ["hussein.abumaash@gmail.com"]
+
+  spec.summary       = "Listing and installing gems' system libraries"
+  spec.description   = "SysLibDetector lists and installs all the gems' system libraries and native dependencies"
+  spec.homepage      = "https://github.com/HusseinReda/SysLibDetectorGem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "system", "~> 0.1"
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "json", "~> 2.1"
+  spec.add_dependency "thor"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: sys_lib_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hussein Abu Maash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: system
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SysLibDetector lists and installs all the gems' system libraries and
+  native dependencies
+email:
+- hussein.abumaash@gmail.com
+executables:
+- console
+- setup
+- sys-lib-detector
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sys-lib-detector
+- lib/sys_lib_detector.rb
+- lib/sys_lib_detector/cli.rb
+- lib/sys_lib_detector/displayer.rb
+- lib/sys_lib_detector/exceptions.rb
+- lib/sys_lib_detector/gems_collector.rb
+- lib/sys_lib_detector/installer.rb
+- lib/sys_lib_detector/system_detector.rb
+- lib/sys_lib_detector/version.rb
+- lib/sys_lib_detector/web_service_communicator.rb
+- sys-lib-detector.gemspec
+homepage: https://github.com/HusseinReda/SysLibDetectorGem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Listing and installing gems' system libraries
+test_files: []