rsyslibs 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3392c2f37b64465d61bbf31af3ccb46da5e3059d
+  data.tar.gz: caee22f8f535eb259cccd991c62df38c0a0b18b3
+SHA512:
+  metadata.gz: 0920aaa7c0864a7e1a13af3f8fa69f680e896a8966422508da87f2b51beaa858cd5f7ba086fb4c68706d39492a9ed24d131844f2e7463c8592a5060099906f69
+  data.tar.gz: 33a68a2efc1cd1370f45cf6495ae374495101675aab8c052d3515e0540c4f19a0d60310d0d550682e4fa34c06ac11778b2664c181deccca31035345aa0d518b0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug history
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Max: 35
+Documentation:
+  Enabled: false

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 amrrbakry17@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rsyslibs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    rsyslibs (0.2.0)
+      os (~> 1.0)
+      rest-client (~> 2.0, >= 2.0.2)
+      thor (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    byebug (9.1.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    os (1.0.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    thor (0.20.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  byebug (~> 9.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rsyslibs!
+  rubocop (~> 0.52.0)
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Amr El-Bakry
+
+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,87 @@
+# Rsyslibs
+
+A simple ruby library to determine the required system-level packages for your project dependencies.
+
+## Overview
+
+The Ruby Gem package manager ‘bundler’ and NodeJS ‘npm’ are excellent tools to install
+project-specific dependencies.
+However, they both share a major flaw, the ability to determine system-level packages required
+to build native extensions.
+
+For example, when you want to install a Ruby gem such as ‘nokogiri’, and if you don’t know
+upfront, you will be hit with an exception about a missing system library. Only when you check
+Nokogiri’s website, you will find out that you need to install ‘zlib1g-dev’ and ‘liblzma-dev’.
+
+**Rsyslibs** collects all gems in your project along with operating system info and sends them to a database-driven RESTful API which looks up and returns the system-level libraries required to install your local gems.
+
+*contribute to the API [here](https://github.com/Amrrbakry/rsyslibs_api).*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rsyslibs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rsyslibs
+
+## Usage
+
+To look up the system-level libraries you need for your project dependencies, simpley run:
+
+```ruby
+$ rsyslibs system_dependencies
+```
+
+
+or use:
+
+```ruby
+Rsyslibs::Dependencies.system_dependencies
+```
+
+
+To get a formatted human-readable output from the API, run:
+
+```ruby
+$ rsyslibs print_friendly_syslibs
+```
+
+or
+
+```ruby
+Rsyslibs::Dependencies.print_friendly_syslibs
+```
+
+To fetch all required system-level libraries and **install them**:
+
+```ruby
+$ rsyslibs install_syslibs # MacOS and Linux only
+```
+
+
+## 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/amrrbakry/rsyslibs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rsyslibs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amrrbakry/rsyslibs/blob/master/CODE_OF_CONDUCT.md).

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 'rsyslibs'
+
+# 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/exe/rsyslibs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rsyslibs/cli'
+Rsyslibs::CLI.start

data/lib/rsyslibs.rb

@@ -0,0 +1,69 @@
+require 'rsyslibs/version'
+require 'rsyslibs/operating_system_info'
+require 'rsyslibs/request'
+require 'bundler'
+require 'json'
+
+module Rsyslibs
+  class Dependencies
+    class << self
+      def system_dependencies
+        payload = {
+          project_dependencies: project_dependencies,
+          os_info: os_info
+        }.to_json
+        parse_response(api(:post, '/lookup_syslibs', payload))
+      end
+
+      def project_dependencies
+        Bundler.definition.dependencies.map(&:name)
+      end
+
+      def print_friendly_syslibs
+        syslibs = JSON.parse(system_dependencies)
+        return 'No libraries found.' if syslibs.empty?
+
+        puts "#{syslibs.size} system libraries found..."
+        puts ''
+        syslibs.each_with_index do |lib, index|
+          project_dependencies = lib['project_dependencies'].collect { |v| v['name'] }.join(', ')
+          puts "#{index + 1}- #{lib['name']} for gems (#{project_dependencies}) on operating system #{lib['os']}."
+        end
+        puts ''
+        puts "Run 'sudo apt-get install LIBRARY NAME' to install on Ubuntu and Debian-based distros."
+        puts "Run 'brew install LIBRARY NAME' to install on macOS."
+        syslibs
+      end
+
+      def install_syslibs
+        syslibs = JSON.parse(system_dependencies)
+        return 'No libraries found.' if syslibs.empty?
+
+        os_name = Rsyslibs::OperatingSystemInfo.os_name
+        case os_name
+        when 'MacOS' then syslibs.each { |lib| `brew install #{lib['name']}` }
+        when 'Linux' then syslibs.each { |lib| `apt-get install #{lib['name']}` }
+        else "I don't know how to install these libraries on this operating system :("
+        end
+      end
+
+      private
+
+      def parse_response(response)
+        if response.code == 200
+          response.body
+        else
+          'Request failed. Please try again.'
+        end
+      end
+
+      def os_info
+        Rsyslibs::OperatingSystemInfo.os_info
+      end
+
+      def api(method, path, payload, headers = { content_type: :json, accpet: :json })
+        Rsyslibs::Request.api(method, path, payload, headers)
+      end
+    end
+  end
+end

data/lib/rsyslibs/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'rsyslibs'
+
+module Rsyslibs
+  class CLI < Thor
+    desc 'system_dependencies', 'Fetches all required system-level libraries for your project dependencies'
+    def system_dependencies
+      puts Rsyslibs::Dependencies.system_dependencies
+    end
+
+    desc 'print_friendly_syslibs', 'Fetches all required system-level libraries for your project dependencies
+    and prints them in a formatted friendly way'
+    def print_friendly_syslibs
+      puts Rsyslibs::Dependencies.print_friendly_syslibs
+    end
+
+    desc 'install_syslibs', 'Fetches all required system-level libraries for your project dependencies
+    and installs them.'
+    def install_syslibs
+      puts Rsyslibs::Dependencies.install_syslibs
+    end
+  end
+end

data/lib/rsyslibs/operating_system_info.rb

@@ -0,0 +1,24 @@
+require 'os'
+require 'yaml'
+
+module Rsyslibs
+  class OperatingSystemInfo
+    def self.os_info
+      os_report = YAML.safe_load(OS.report)
+      {
+        os: os_report['target_os'],
+        os_vendor: os_report['target_vendor'],
+        os_bits: OS.bits,
+        ruby_platform: os_report['RUBY_PLATFORM']
+      }
+    end
+
+    def self.os_name
+      return 'MacOS' if OS.mac?
+
+      return 'Linux' if OS.linux?
+
+      'Unknown OS'
+    end
+  end
+end

data/lib/rsyslibs/request.rb

@@ -0,0 +1,12 @@
+require 'rest-client'
+
+module Rsyslibs
+  class Request
+    API_BASE_URL = 'https://rsyslibsapi.herokuapp.com'.freeze
+
+    def self.api(method, path, payload, headers)
+      url = "#{API_BASE_URL}#{path}"
+      RestClient::Request.execute(method: method, url: url, payload: payload, headers: headers)
+    end
+  end
+end

data/lib/rsyslibs/version.rb

@@ -0,0 +1,3 @@
+module Rsyslibs
+  VERSION = '0.2.0'.freeze
+end

data/rsyslibs.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rsyslibs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rsyslibs'
+  spec.version       = Rsyslibs::VERSION
+  spec.authors       = ['Amr El-Bakry']
+  spec.email         = ['amrrbakry17@gmail.com']
+
+  spec.summary       = 'A simple ruby library to determine the required system-level packages for your
+                        project dependencies.'
+  spec.description   = 'Rsyslibs collects all local gems in your project and sends them to a web server to determine
+                        the system libraries you need to install.'
+  spec.homepage      = 'https://github.com/amrrbakry/rsyslibs'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = ['rsyslibs']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'byebug', '~> 9.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.0'
+
+  spec.add_dependency 'os', '~> 1.0'
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency 'thor', '~> 0.20.0'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: rsyslibs
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Amr El-Bakry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: |-
+  Rsyslibs collects all local gems in your project and sends them to a web server to determine
+                          the system libraries you need to install.
+email:
+- amrrbakry17@gmail.com
+executables:
+- rsyslibs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rsyslibs
+- lib/rsyslibs.rb
+- lib/rsyslibs/cli.rb
+- lib/rsyslibs/operating_system_info.rb
+- lib/rsyslibs/request.rb
+- lib/rsyslibs/version.rb
+- rsyslibs.gemspec
+homepage: https://github.com/amrrbakry/rsyslibs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.12
+signing_key: 
+specification_version: 4
+summary: A simple ruby library to determine the required system-level packages for
+  your project dependencies.
+test_files: []