native_ext_fetcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e631820654fb2882e0bcc0b2304e1364e1c615e
+  data.tar.gz: 35277f285157e5bb2164e43c640f9c53c2ed7f35
+SHA512:
+  metadata.gz: 096fac5a0deb44edf0b7ab988ee52a4b7973ef46856f4ab0f83d434e8a32c6a8cf37f2eefa230f30701c2d6eb0515f6b3c29263a25842c84d7345b278367a6a7
+  data.tar.gz: c0fabcfa8da1b706c6f23669d82d92ec20b68ead9501e018260d40d17b2ca559f8f7480673a8f62aa18d33828727320620b23109c3cfe1e954ce6a591ede3f2b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in native_ext_fetcher.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-minitest'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Coyne
+
+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,62 @@
+# NativeExtFetcher
+
+This is a simple gem designed to be used in an extconf.rb file for
+Ruby gems with native extensions. It will detect and normalize host
+details and will attempt to download the proper native library from a
+remote host. This is especially useful with gems that use Rust native
+libraries.
+
+This code was abstracted from the
+[Skylight](https://github.com/skylightio/skylight-ruby) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'native_ext_fetcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install native_ext_fetcher
+
+## Usage
+
+To use this gem, you'd add something like following to your gem's
+extconf.rb
+
+```ruby
+include NativeExtFetcher
+
+# Configure the NativeExtFetcher
+native_ext_config 's3.amazonaws.com/bucket_name/some/path', __dir__, {
+  linux_x86_64: '[sha2 checksum]'
+}
+
+# Fetch the library from S3
+native_ext_fetch! 'libmynativelib'
+
+# Setup our Makefile as normal
+LIB_DIRS = [RbConfig::CONFIG['libdir'], native_ext_download_path]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/native_ext_fetcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "native_ext_fetcher"
+
+# 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

data/bin/setup

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

data/lib/native_ext_fetcher/fetcher.rb

@@ -0,0 +1,57 @@
+module NativeExtFetcher
+  class Fetcher
+    InvalidDigest = Class.new(StandardError)
+
+    attr_reader :download_path
+
+    def config(host, path, checksums, options = {})
+      @lib_path = File.expand_path(File.join(path, '..', '..', 'lib'))
+
+      raise ArgumentError, 'Checksums must be a hash' unless Hash === checksums
+      raise ArgumentError, 'Library path not found ' unless Dir.exists?(@lib_path)
+
+      @host = host
+      @checksums = checksums
+      @options = options
+
+      @download_path = expand_download_path
+    end
+
+    def fetch!(library)
+      File.open(library_local_path(library), 'w+') do |file|
+        file.truncate 0 # empty file
+
+        uri = library_request_uri(library)
+        digest = http_client.get_file(file, uri)
+
+        unless digest == expected_digest
+          raise InvalidDigest, "invalid checksums for #{library} from #{uri}"
+        end
+      end
+    end
+
+    protected
+
+    def http_client
+      @http_client ||= Http.new(@options)
+    end
+
+    def expected_digest
+      @checksums[Platform.native_extension_key]
+    end
+
+    def library_local_path(library)
+      File.join @download_path, "#{library}#{Platform.native_extension_file_ext}"
+    end
+
+    def library_request_uri(library)
+      "https://#{@host}/#{library}#{Platform.native_extension_file_postfix}"
+    end
+
+    def expand_download_path
+      File.join(@lib_path, 'native', *Platform.native_extension_tuple).tap do |native_path|
+        FileUtils.mkdir_p native_path
+      end
+    end
+  end
+end

data/lib/native_ext_fetcher/http.rb

@@ -0,0 +1,91 @@
+require 'fileutils'
+require 'digest/sha2'
+require 'net/http'
+require 'uri'
+
+module NativeExtFetcher
+  class Http
+    MAX_REDIRECTS = 5
+    MAX_RETRIES   = 3
+
+    MaxRedirect = Class.new(StandardError)
+    MaxRetries  = Class.new(StandardError)
+
+    def initialize(options = {})
+      @max_redirects = options[:max_redirects] || MAX_REDIRECTS
+      @max_retries   = options[:max_retries] || MAX_RETRIES
+
+      if http_proxy = ENV['HTTP_PROXY'] || ENV['http_proxy']
+        uri = URI.parse(http_proxy)
+
+        @proxy_host, @proxy_port = uri.host, uri.port
+        @proxy_user, @proxy_pass = uri.userinfo.split(/:/) if uri.userinfo
+      end
+    end
+
+    def get_file(out, uri)
+      remaining_attempts = @max_retries
+
+      @max_redirects.times do |i|
+        begin
+          host, port, path = deconstruct_uri(uri)
+          status, result = http_get(out, host, port, path)
+
+          case status
+          when :success
+            return result
+
+          else uri = result
+          end
+
+        rescue => e
+          remaining_attempts -= 1
+
+          unless remaining_attempts.zero?
+            sleep 2
+            retry
+          end
+
+          raise MaxRetries, "max retries; #{e.message}"
+        end
+      end
+
+      raise MaxRedirect, 'max redirects hit'
+    end
+
+    protected
+
+    def deconstruct_uri(uri)
+      uri = URI.parse(uri)
+
+      [ uri.host, uri.port, uri.path ]
+    end
+
+    def http_get(out, host, port, path)
+      Net::HTTP.start(host, port, @proxy_host, @proxy_pass, @proxy_user, @proxy_pass, use_ssl: true) do |http|
+        http.request_get path do |resp|
+          case resp
+          when Net::HTTPSuccess
+            digest = Digest::SHA2.new
+
+            resp.read_body do |chunk|
+              digest << chunk
+              out.write chunk
+            end
+
+            return :success, digest.hexdigest
+
+          when Net::HTTPRedirection
+            unless location = resp['location']
+              raise "received redirect but no location"
+            end
+
+            return :redirect, location
+          else
+            raise "received HTTP status code #{resp.code}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/native_ext_fetcher/platform.rb

@@ -0,0 +1,68 @@
+require 'rbconfig'
+
+module NativeExtFetcher
+  module Platform
+    class << self
+      protected
+
+      def determine_host_os
+        case os = RbConfig::CONFIG['host_os'].downcase
+        when /linux/
+          'linux'
+        when /darwin/
+          'darwin'
+        when /freebsd/
+          'freebsd'
+        when /netbsd/
+          'netbsd'
+        when /openbsd/
+          'openbsd'
+        when /sunos|solaris/
+          'solaris'
+        when /mingw|mswin/
+          'windows'
+        else os
+        end
+      end
+
+      def determine_host_arch
+        case cpu = RbConfig::CONFIG['host_cpu'].downcase
+        when /amd64|x86_64/
+          'x86_64'
+        when /i?86|x86|i86pc/
+          'x86'
+        when /ppc|powerpc/
+          'powerpc'
+        when /^arm/
+          'arm'
+        else
+          cpu
+        end
+      end
+
+      def determine_host_dlext
+        RbConfig::CONFIG['DLEXT'].downcase
+      end
+    end
+
+    HOST_OS    = determine_host_os.freeze
+    HOST_ARCH  = determine_host_arch.freeze
+    HOST_DLEXT = determine_host_dlext.freeze
+
+    def self.native_extension_key
+      :"#{HOST_OS}_#{HOST_ARCH}"
+    end
+
+    def self.native_extension_file_postfix
+      "-#{HOST_OS}-#{HOST_ARCH}.#{HOST_DLEXT}"
+    end
+
+    def self.native_extension_file_ext
+      ".#{HOST_DLEXT}"
+    end
+
+    def self.native_extension_tuple
+      [HOST_OS, HOST_ARCH]
+    end
+  end
+end

data/lib/native_ext_fetcher/version.rb

@@ -0,0 +1,3 @@
+module NativeExtFetcher
+  VERSION = "0.1.0"
+end

data/lib/native_ext_fetcher.rb

@@ -0,0 +1,20 @@
+require 'fileutils'
+
+require 'native_ext_fetcher/version'
+require 'native_ext_fetcher/platform'
+require 'native_ext_fetcher/fetcher'
+require 'native_ext_fetcher/http'
+
+module NativeExtFetcher
+  def self.instance
+    @instance ||= Fetcher.new
+  end
+
+  instance.public_methods(false).each do |method|
+    class_eval <<-RUBY_EVAL
+      def native_ext_#{method}(*args)
+        NativeExtFetcher.instance.#{method}(*args)
+      end
+    RUBY_EVAL
+  end
+end

data/native_ext_fetcher.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'native_ext_fetcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "native_ext_fetcher"
+  spec.version       = NativeExtFetcher::VERSION
+  spec.authors       = ["DefWare LLC"]
+  spec.email         = ["michael@defware.io"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Native extenstion fetch library}
+  spec.description   = %q{Fetch native libraries based upon platform details}
+  spec.homepage      = "https://github.com/DefWare/native_ext_fetcher"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "fakefs", "~> 0.8"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: native_ext_fetcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DefWare LLC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Fetch native libraries based upon platform details
+email:
+- michael@defware.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/native_ext_fetcher.rb
+- lib/native_ext_fetcher/fetcher.rb
+- lib/native_ext_fetcher/http.rb
+- lib/native_ext_fetcher/platform.rb
+- lib/native_ext_fetcher/version.rb
+- native_ext_fetcher.gemspec
+homepage: https://github.com/DefWare/native_ext_fetcher
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Native extenstion fetch library
+test_files: []