gemnasium 3.2.1

data/lib/gemnasium/connection.rb

@@ -0,0 +1,42 @@
+require 'net/https'
+
+module Gemnasium
+  class Connection
+    def initialize
+      @connection = Net::HTTP.new(Gemnasium.config.site, Gemnasium.config.use_ssl ? 443 : 80)
+      @connection.use_ssl = Gemnasium.config.use_ssl
+    end
+
+    def post(path, body, headers = {})
+      request = Net::HTTP::Post.new(path, headers.merge('Accept' => 'application/json', 'Content-Type' => 'application/json'))
+      request.basic_auth('X', Gemnasium.config.api_key)
+      request.body = body
+      @connection.request(request)
+    end
+
+    def get(path, headers = {})
+      request = Net::HTTP::Get.new(path, headers.merge('Accept' => 'application/json', 'Content-Type' => 'application/json'))
+      request.basic_auth('X', Gemnasium.config.api_key)
+      @connection.request(request)
+    end
+
+    # Set the API path for a specific item
+    #
+    # @param item [String] item the route should point to
+    # @return [String] API path
+    def api_path_for item
+      base = "/api/#{Gemnasium.config.api_version}"
+
+      case item
+      when 'base'
+        base
+      when 'projects'
+        "#{base}/projects"
+      when 'dependency_files'
+        "#{base}/projects/#{Gemnasium.config.project_slug}/dependency_files"
+      else
+        raise "No API path found for #{item}"
+      end
+    end
+  end
+end

data/lib/gemnasium/dependency_files.rb

@@ -0,0 +1,55 @@
+require 'digest/sha1'
+
+module Gemnasium
+  class DependencyFiles
+
+    SUPPORTED_DEPENDENCY_FILES = /(Gemfile|Gemfile\.lock|.*\.gemspec|package\.json|npm-shrinkwrap\.json|setup\.py|requirements\.txt|requires\.txt|composer\.json|composer\.lock)$/
+
+    # Get a Hash of sha1s for each file corresponding to the regex
+    #
+    # @param regexp [Regexp] the regular expression of requested files
+    # @return [Hash] the hash associating each file path with its SHA1 hash
+    def self.get_sha1s_hash(project_path)
+      Dir.chdir(project_path)
+      Dir.glob("**/**").grep(SUPPORTED_DEPENDENCY_FILES).inject({}) do |h, file_path|
+        h[file_path] = calculate_sha1("#{project_path}/#{file_path}") unless is_ignored?(file_path)
+        h
+      end
+    end
+
+    # Get the content to upload to Gemnasium.
+    #
+    # @param files_path [Array] an array containing the path of the files
+    # @return [Array] array of hashes containing file name, file sha and file content
+    def self.get_content_to_upload(project_path, files_path)
+      files_path.inject([]) do |arr, file_path|
+        arr << { filename: file_path, sha: calculate_sha1(file_path), content: File.open("#{project_path}/#{file_path}") {|io| io.read} }
+      end
+    end
+
+    private
+
+    # Calculate hash of a file in the same way git does
+    #
+    # @param file_path [String] path of the file
+    # @return [String] SHA1 of the file
+    def self.calculate_sha1(file_path)
+      mem_buf = File.open(file_path) {|io| io.read}
+      size = mem_buf.size
+      header = "blob #{size}\0" # type[space]size[null byte]
+
+      Digest::SHA1.hexdigest(header + mem_buf)
+    end
+
+    # Test if the file is ignored by the configuration file
+    #
+    # @param file_path [String] path of the file to test
+    # @return [Boolean] true if the file is ignored
+    def self.is_ignored?(file_path)
+      Gemnasium.config.ignored_paths.each do |ignored_path|
+        return true if file_path =~ ignored_path
+      end
+      false
+    end
+  end
+end

data/lib/gemnasium/errors.rb

@@ -0,0 +1,16 @@
+module Gemnasium
+  class InvalidApiKeyError < StandardError
+    def message
+      'Your API key is invalid. Please double check it on https://gemnasium.com/settings/api_access'
+    end
+  end
+  class DeprecatedApiVersionError < StandardError; end
+  class MalformedRequestError < StandardError; end
+  class MissingParamsError < StandardError; end
+  class NonBillableUserError < StandardError; end
+  class NoSlotsAvailableError < StandardError; end
+  class ProjectNotFoundError < StandardError; end
+  class ProjectNotOfflineError < StandardError; end
+  class ProjectParamMissingError < StandardError; end
+  class UnsupportedDependencyFilesError < StandardError; end
+end

data/lib/gemnasium/options.rb

@@ -0,0 +1,107 @@
+require 'optparse'
+
+module Gemnasium
+  class Options
+
+    # Parse arguments from command line
+    #
+    # @param args [Array] arguments from command line
+    # @return [Hash, OptionParser] hash of the parsed options & Option parser to get --help message
+    def self.parse args
+      options = {}
+
+      global = OptionParser.new do |opts|
+        opts.banner = 'Usage: gemnasium [options]'
+
+        opts.on '-v', '--version', 'Show Gemnasium version' do
+          options[:show_version] = true
+        end
+
+        opts.on '-h', '--help', 'Display this message' do
+          options[:show_help] = true
+        end
+
+        opts.separator ''
+        opts.separator <<-HELP_MESSAGE
+Available commands are:
+  create   :   Create or update project on Gemnasium
+  install  :   Install the necessary config file
+  push     :   Push your dependency files to Gemnasium
+  migrate  :   Migrate the configuration file
+  resolve  :   Resolve project name to an existing project on Gemnasium
+
+See `gemnasium COMMAND --help` for more information on a specific command.
+
+WARNING! The gemnasium Rubygem has been deprecated.
+Please use Gemnasium Toolbelt (https://github.com/gemnasium/toolbelt) instead.
+        HELP_MESSAGE
+      end
+
+      subcommands = {
+        'create'  => OptionParser.new do |opts|
+          opts.banner = 'Usage: gemnasium create [options]'
+
+          opts.on '-h', '--help', 'Display this message' do
+            options[:show_help] = true
+          end
+        end,
+        'install' => OptionParser.new do |opts|
+          opts.banner = 'Usage: gemnasium install [options]'
+
+          opts.on '--git', 'Create a post-commit hook to run gemnasium push command if a dependency file has been commited' do
+            options[:install_git_hook] = true
+          end
+
+          opts.on '--rake', 'Create rake task to run Gemnasium' do
+            options[:install_rake_task] = true
+          end
+
+          opts.on '-h', '--help', 'Display this message' do
+            options[:show_help] = true
+          end
+        end,
+        'push'    => OptionParser.new do |opts|
+          opts.banner = 'Usage: gemnasium push'
+
+          opts.on '-i', '--ignore-branch', 'Push to gemnasium regardless of branch' do
+            options[:ignore_branch] = true
+          end
+
+          opts.on '-s', '--silence-branch', 'Silently ignore untracked branches' do
+            options[:silence_branch] = true
+          end
+
+          opts.on '-h', '--help', 'Display this message' do
+            options[:show_help] = true
+          end
+        end,
+        'migrate'  => OptionParser.new do |opts|
+          opts.banner = 'Usage: gemnasium migrate [options]'
+
+          opts.on '-h', '--help', 'Display this message' do
+            options[:show_help] = true
+          end
+        end,
+        'resolve'  => OptionParser.new do |opts|
+          opts.banner = 'Usage: gemnasium resolve [options]'
+
+          opts.on '-h', '--help', 'Display this message' do
+            options[:show_help] = true
+          end
+        end
+      }
+
+      global.order! args
+      parser = global
+
+      unless (command = args.shift).nil?
+        raise OptionParser::ParseError unless subcommands.has_key?(command)
+        subcommands[command].order! args
+        options[:command] = command
+        parser = subcommands[command]
+      end
+
+      return options, parser
+    end
+  end
+end

data/lib/gemnasium/version.rb

@@ -0,0 +1,3 @@
+module Gemnasium
+  VERSION = "3.2.1"
+end

data/lib/templates/gemnasium.rake

@@ -0,0 +1,24 @@
+namespace :gemnasium do
+  require 'gemnasium'
+
+  desc "Push dependency files to gemnasium"
+  task :push do
+    Gemnasium.push project_path: File.expand_path(".")
+  end
+
+  desc "Create project on gemnasium"
+  task :create do
+    Gemnasium.create_project project_path: File.expand_path(".")
+  end
+
+  desc "Migrate the configuration file"
+  task :migrate do
+    Gemnasium.migrate project_path: File.expand_path(".")
+  end
+
+  desc "Resolve project name on gemnasium"
+  task :resolve do
+    Gemnasium.resolve_project project_path: File.expand_path(".")
+  end
+
+end

data/lib/templates/gemnasium.yml

@@ -0,0 +1,10 @@
+api_key: api_key_goes_here    # You personal (secret) API key. Get it at https://staging-gemnasium.tech-angels.net/settings#api_key
+project_name: project_name    # A name to remember your project.
+project_slug:                 # Unique slug for this project. Get it on the "settings" page of your project or run "gemnasium resolve".
+project_branch: master        # /!\ If you don't use git, remove this line
+ignored_paths:                # Paths you want to ignore when searching for dependency files (from app root)
+  - features/
+  - spec/
+  - test/
+  - tmp/
+  - vendor/

data/lib/templates/post-commit

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+SUPPORTED_COMMITED_FILES=$((git diff --name-only HEAD~ HEAD 2>/dev/null || git diff-tree -r --no-commit-id --name-only --root HEAD) | grep '^\(Gemfile\|Gemfile\.lock\|.*\.gemspec\|package\.json\|npm-shrinkwrap\.json\|setup\.py\|requirements\.txt\|requires\.txt\|composer\.json\|composer\.lock\)$')
+
+if [[ $SUPPORTED_COMMITED_FILES > 0 ]]; then
+  gemnasium push
+fi

data/spec/gemnasium/configuration_spec.rb

@@ -0,0 +1,195 @@
+require 'fileutils'
+require 'spec_helper'
+
+describe Gemnasium::Configuration do
+  describe 'default config' do
+    it { expect(Gemnasium::Configuration::DEFAULT_CONFIG['site']).to eql 'gemnasium.com' }
+    it { expect(Gemnasium::Configuration::DEFAULT_CONFIG['use_ssl']).to eql true }
+    it { expect(Gemnasium::Configuration::DEFAULT_CONFIG['api_version']).to eql 'v3' }
+    it { expect(Gemnasium::Configuration::DEFAULT_CONFIG['ignored_paths']).to eql [] }
+  end
+
+  let(:config_file_path) { 'tmp/config.yml' }
+  let(:config) { described_class.new File.expand_path(config_file_path) }
+
+  let(:config_options) do
+    {
+      api_key: 'api_key',
+      project_name: 'gemnasium-gem',
+      project_branch: 'master',
+      ignored_paths: ['spec/','tmp/*.lock', '*.gemspec']
+    }
+  end
+
+  def write_config_file
+    config_hash = config_options.reduce({}) do |memo, (key,value)|
+      memo ||= {}
+      memo[key.to_s] = value
+      memo
+    end
+    File.open(config_file_path, 'w+') { |f| f.write(config_hash.to_yaml) }
+  end
+
+  after do
+    File.delete(config_file_path) if File.exist?(config_file_path)
+  end
+
+  describe 'initialize' do
+    context 'for an inexistant config file' do
+      it { expect { Gemnasium::Configuration.new File.expand_path(config_file_path) }.to raise_error Errno::ENOENT }
+    end
+
+    context 'for a config file that does exist' do
+      before { FileUtils.touch(config_file_path) }
+
+      context 'with missing mandatory values' do
+        let(:config_options) {{ project_name: 'gemnasium-gem' }}
+        before { write_config_file }
+
+          it { expect { Gemnasium::Configuration.new File.expand_path(config_file_path) }.to raise_error('Your configuration file does not contain all mandatory parameters or contain invalid values. Please check the documentation.') }
+      end
+
+      context 'with all mandatory values' do
+        let(:config_options) {{ api_key: 'api_key', project_name: 'gemnasium-gem', project_branch: 'master', ignored_paths: ['spec/','tmp/*.lock', '*.gemspec'] }}
+        before { write_config_file }
+
+        it { expect(config.api_key).to eql config_options[:api_key] }
+
+        # Keep profile name for backward compatibility with version =< 2.0
+        it { expect(config.profile_name).to eql config_options[:profile_name] }
+
+        it { expect(config.project_name).to eql config_options[:project_name] }
+        it { expect(config.project_slug).to eql config_options[:project_slug] }
+        it { expect(config.project_branch).to eql config_options[:project_branch] }
+        it { expect(config.site).to eql Gemnasium::Configuration::DEFAULT_CONFIG['site'] }
+        it { expect(config.use_ssl).to eql Gemnasium::Configuration::DEFAULT_CONFIG['use_ssl'] }
+        it { expect(config.api_version).to eql Gemnasium::Configuration::DEFAULT_CONFIG['api_version'] }
+        it { expect(config.ignored_paths).to include Regexp.new("^spec/") }
+        it { expect(config.ignored_paths).to include Regexp.new("^tmp/[^/]+\\.lock") }
+        it { expect(config.ignored_paths).to include Regexp.new("^[^\/]+\\.gemspec") }
+      end
+    end
+
+    context 'for a config file with parsable ERB code' do
+      before { write_config_file }
+      before { ENV['GEMNASIUM_API_KEY'] = 'api_key_from_env' }
+
+      let(:config_options) do
+        {
+          api_key: "<%= ENV['GEMNASIUM_API_KEY'] %>",
+          project_name: 'gemnasium-gem',
+          project_branch: 'master',
+          ignored_paths: ['spec/','tmp/*.lock', '*.gemspec']
+        }
+      end
+
+      it 'parses ERB code' do
+        expect(config.api_key).to eql 'api_key_from_env'
+      end
+
+      it 'keeps values unchanged if not ERB code' do
+        expect(config.project_name).to eql config_options[:project_name]
+        expect(config.project_branch).to eql config_options[:project_branch]
+        expect(config.ignored_paths).to include Regexp.new("^spec/")
+        expect(config.ignored_paths).to include Regexp.new("^tmp/[^/]+\\.lock")
+        expect(config.ignored_paths).to include Regexp.new("^[^\/]+\\.gemspec")
+      end
+    end
+  end
+
+  pending "writable?"
+
+  describe "#store_value!" do
+    context "with a new value for an existing key" do
+      let(:key) { :project_name }
+      let(:value) { 'new-name' }
+
+      # HACK: fake config reload
+      let(:new_config) { Gemnasium::Configuration.new File.expand_path(config_file_path) }
+
+      before do
+        write_config_file
+        config.store_value! key, value, "my project name"
+      end
+
+      it "updates the given key-value pair" do
+        expect(new_config.project_name).to eql 'new-name'
+      end
+
+      it "keeps other key-value pairs unchanged" do
+        expect(new_config.api_key).to eql config_options[:api_key]
+        expect(new_config.project_branch).to eql config_options[:project_branch]
+      end
+
+      it "stores the given comment" do
+        content = File.read File.expand_path(config_file_path)
+        expect(content).to match /project_name:.*# my project name/
+      end
+    end
+  end
+
+  describe "#migrate!" do
+    before { write_config_file }
+    subject { config.needs_to_migrate? }
+
+    context "with NO profile_name key" do
+      let(:config_options) do
+        {
+          api_key: 'api_key',
+          project_name: 'gemnasium-gem',
+          project_branch: 'master'
+          # no profile_name
+        }
+      end
+
+      it { should be false }
+    end
+
+    context "with profile_name key" do
+      let(:config_options) do
+        {
+          project_name: 'gemnasium-gem',
+          profile_name: 'tech-angels',
+          api_key: '1337'
+        }
+      end
+
+      it { should be true }
+    end
+  end
+
+  describe "#migrate!" do
+    before { write_config_file }
+
+    let(:config_options) do
+      {
+        project_name: 'gemnasium-gem',
+        profile_name: 'tech-angels',
+        api_key: '1337'
+      }
+    end
+
+    # HACK: fake config reload
+    let(:new_config) { Gemnasium::Configuration.new File.expand_path(config_file_path) }
+
+    it "removes the profile_name" do
+      expect(config.profile_name).to eql 'tech-angels'
+      config.migrate!
+      expect(new_config.profile_name).to eql nil
+    end
+
+    it "adds an empty project_slug" do
+      config.migrate!
+      expect(new_config.project_slug).to eql nil
+
+      content = File.read File.expand_path(config_file_path)
+      expect(content).to match /^project_slug:$/
+    end
+
+    it "preserves the other keys" do
+      config.migrate!
+      expect(new_config.project_name).to eql 'gemnasium-gem'
+      expect(new_config.api_key).to eql '1337'
+    end
+  end
+end