sourceninja 0.0.7 → 0.0.8

data/COPYRIGHT

@@ -0,0 +1 @@
+Copyright (c) 2012 SourceNinja

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2012 SourceNinja
+
+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

@@ -1,20 +1,18 @@
-Note
-----
-* This gem is currently alpha. __You need to be invited to [SourceNinja Alpha](http://www.sourceninja.com/sign-up.html) in order to use this gem__.
-
-What is SourceNinja
+What is SourceNinja?
 -------------------
 SourceNinja is an awesome service that allows you to stay informed of updates to the open source packages that your application uses. When a newer version of a package is released, SourceNinja alerts you and gives you actionable information to help you determine whether you should upgrade to the newer package.
 
 Visit [SourceNinja](http://sourceninja.com) to learn more.
 
-What is the sourceninja gem
+What is the sourceninja gem?
 ---------------------------
-The sourceninja gem is a gem that can be included in your rails application to allow seamless integration with SourceNinja. The sourceninja gem will send all of your gem files and versions to SourceNinja to begin managing your open source libraries.
+The sourceninja gem is a gem that can be included in your Rails application to allow seamless integration with SourceNinja. The sourceninja gem will send SourceNinja the list of the gem names and gem versions that you are using to begin managing your open source libraries.
+
+In a non-Rails environment, a script is included for processing a Gemfile.lock and uploading it to SourceNinja.
 
 Getting Started
 ---------------
-1. Create a [SourceNinja](http://sourceninja.com) account. Currently, you need to be part of our [alpha](http://www.sourceninja.com/sign-up.html).
+1. Create a [SourceNinja](https://app.sourceninja.com/plans) account.
 
 2. Log into SourceNinja and create a product. The product you create will be paired with your application.
 
@@ -33,26 +31,44 @@ Getting Started
 
 6. Run `bundle install`.
 
-7. Set the environment variables ```SOURCENINJA_TOKEN``` and ```SOURCENINJA_PRODUCT_ID``` using the values from step 4.
-
-Updated Magically in Production
------------------
-Now each time you push to production the sourceninja gem will be run and data will be populated back to SourceNinja. If you visit your SourceNinja page you will be given a list of outdated gems.
+Rails environment - Testing
+----------------------------
+1. In order to automate the process of uploading module information from your Rails environment, you can create
+an initializer script to configure how your Rails application will send information to SourceNinja.
 
-The sourceninja data is populated whenever the app is initialized.
+### Contents of `config/initializers/sourceninja.rb`
+   	ENV["SOURCENINJA_TOKEN"]      ||= "50a336d92da8ddea1ae0a6c0d06a172"
+   	ENV["SOURCENINJA_PRODUCT_ID"] ||= "477fcfa7-765a-4b91-b6a5-2ebe4c4f9d58"
 
-Testing Locally
----------------
-If you would like to test sourceninja gem locally, you will want to create an initializer script to set the variables.
+The values that you set in this initializer script should be the ones presented to you in step 4, above.
 
-### Contents of `config/initializers/sourceninja.rb`
-	ENV["SOURCENINJA_TOKEN"]      ||= "1cea0be98caf02e830ac2aadbe44e4ee"
-	ENV["SOURCENINJA_PRODUCT_ID"] ||= "fb89e064-b48c-d0c3-81x4-a34a5b60a654"
+Now each time your Rails application is started, the sourceninja gem will be run and data will be populated back to SourceNinja. If you visit your SourceNinja page you will be given a list of outdated gems.
 
-Upon doing this, each time you start the rails server locally the data will be pushed. You could also use these steps if you want to manage a production instance and a development instance.
+You could also use these steps if you want to manage a production instance and a development instance.
 
 __Note: DO NOT DO THIS FOR PRODUCTION: No configuration files with sensitive information should ever be required within the application source and required config values should be read in from the ENV by supported libraries.__
 
+Rails environment - Production
+-------------------------------
+1. Configure environment variables for ```SOURCENINJA_TOKEN``` and ```SOURCENINJA_PRODUCT_ID``` using the values from step 4, above.
+
+Non-Rails environment
+----------------------
+1. Included in the gem is a script, ```sourceninja```, that you may run to have it upload information to SourceNinja directly from your Gemfile.lock.
+2. You will need the ```SOURCENINJA_TOKEN``` and ```SOURCENINJA_PRODUCT_ID``` values from step 4, above.
+3. Run the script with ```-h``` to see this output:
+    ```
+    Usage: sourceninja -t <sourceninja_account_token> -p <sourceninja_product_id> [-f Gemfile.lock]
+        -f, --filename FILE              Gemfile.lock file to process
+        -h, --help                       Display this screen
+        -p, --product_id PRODUCT_ID      SourceNinja Product ID
+        -t, --token TOKEN                SourceNinja API Key Token
+        -v, --verbose                    Output more information
+    ```
+4. Run the script using ```-p```, ```-f```, and ```-t``` to pass along the correct configuration information to SourceNinja.
+
+5. Now you can login to your SourceNinja account and review your project's information.
+
 Support
 -------
 Feel free to email us at support at sourceninja dot com if you have any questions or issues.

data/bin/sourceninja

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+require 'sourceninja'
+require 'bundler'
+require 'optparse'
+
+DEFAULT_FILE_TO_PROCESS = './Gemfile.lock'
+
+# This hash will hold all of the options
+# parsed from the command-line by
+# OptionParser.
+options = { 'file_to_process' => DEFAULT_FILE_TO_PROCESS }
+
+optparse = OptionParser.new do|opts|
+  # Set a banner, displayed at the top
+  # of the help screen.
+  opts.banner = "Usage: sourceninja -t <sourceninja_account_token> -p <sourceninja_product_id> [-f Gemfile.lock]"
+
+  # Define the options, and what they do
+  opts.on( '-f', '--filename FILE', 'Gemfile.lock file to process') do |filename|
+    options['file_to_process'] = filename
+  end
+
+  # This displays the help screen
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+
+  opts.on( '-p', '--product_id PRODUCT_ID', 'SourceNinja Product ID' ) do |product_id|
+    ENV["SOURCENINJA_PRODUCT_ID"] = product_id
+  end
+
+  opts.on( '-t', '--token TOKEN', 'SourceNinja API Key Token' ) do |token|
+    ENV["SOURCENINJA_TOKEN"] = token
+  end
+
+  options[:verbose] = false
+  opts.on( '-v', '--verbose', 'Output more information' ) do
+    options[:verbose] = true
+  end
+end
+
+# Actually parse the command line
+optparse.parse!
+
+unless ENV["SOURCENINJA_PRODUCT_ID"] and ENV["SOURCENINJA_TOKEN"]
+  $stderr.puts "You must supply a token and product ID! Exiting."
+  puts optparse.help
+  exit
+end
+
+unless File::exists? options['file_to_process']
+  $stderr.puts "Filename #{options['file_to_process']} not found! Exiting."
+  puts optparse.help
+  exit
+end
+
+lockfile = Bundler::LockfileParser.new(Bundler.read_file(options['file_to_process']))
+
+# all we need in the dep list is the name of the module. the version number here won't be important because
+# Bundler will resolve that into the spec list below
+dep_list = {}
+lockfile.dependencies.to_a.map{|b| b.to_s}.each do |dep|
+  puts "Sourceninja: processing dependency #{dep}" if options[:verbose]
+  unless dep =~ %r{^\s*(\S+)}
+    $stderr.puts "Sourceninja: Could not find the package name for #{dep.to_s}"
+    next
+  end
+
+  dep_list[$1] = true
+end
+
+package_data = []
+lockfile.specs.each do |spec|
+  #  Data looks like 'sourceninja (0.0.8)'
+  unless spec.to_s =~ %r{^(\S+)\s*\((\S+)\)$}
+    $stderr.puts "Sourceninja: Could not parse information for gem '#{spec}' (class #{spec.class.to_s})"
+    next
+  end
+
+  puts "Sourceninja: found gem #{$1} with a version of #{$2}" if options[:verbose]
+
+  package_data << { :package_name => $1, :package_version => $2, :direct_requirement => (dep_list[$1] || false) }
+end
+
+if package_data.empty?
+  $stderr.puts "Sourceninja: Did not successfully parse any packages, will not attempt to upload information"
+elsif options[:verbose]
+  puts "Package data: #{package_data.to_s}"
+end
+
+puts "Sending package information to SourceNinja..." if options[:verbose]
+Sourceninja.send_package_info package_data
+puts "Done." if options[:verbose]

data/lib/sourceninja.rb

@@ -1,4 +1,4 @@
 require "sourceninja/version"
 
-# only allow this to be run under rails for the time being.
-require "sourceninja/sourceninja.rb" if defined? Rails
+require "sourceninja/sourceninja"
+require "sourceninja/railtie" if defined? Rails

data/lib/sourceninja/railtie.rb

@@ -0,0 +1,8 @@
+module SourceNinja
+  class RailTie < Rails::Railtie
+    ActiveSupport.on_load(:after_initialize) do
+      package_data = Sourceninja.process_bundle_info
+      Sourceninja.send_package_info(package_data)
+    end
+  end
+end

data/lib/sourceninja/sourceninja.rb

@@ -2,68 +2,92 @@ require 'httparty'
 require 'json'
 
 module Sourceninja
-  class Sourceninja
-    include HTTParty
+  include HTTParty
 
-    @@base_uri = "https://app.sourceninja.com"
+  @@base_uri = "https://app.sourceninja.com"
 
-    def self.send_package_info
+  def self.process_bundle_info
+    # all we need in the dep list is the name of the module. the version number here won't be important because
+    # Bundler will resolve that into the spec list below
+    dep_list = {}
+    Bundler.environment.dependencies.to_a.map{|b| b.to_s}.each do |dep|
+      unless dep =~ %r{^\s*(\S+)}
+        if defined? Rails
+          Rails.logger.info "Sourceninja: Could not find the package name for #{dep.to_s}"
+        end
+
+        next
+      end
+
+      dep_list[$1] = true
+    end
+
+    package_data = []
+    spec_hash = Bundler.environment.specs.to_hash
+    spec_hash.keys.each do |key|
+      unless %r{Gem::Specification name=#{key} version=([\d.]+)} =~ spec_hash[key][0].to_s
+        if defined? Rails
+          Rails.logger.info "Sourceninja: Could not parse information for gem #{key}: #{spec_hash[key]}"
+        else
+          $stderr.puts "Sourceninja: Could not parse information for gem #{key}: #{spec_hash[key]}"
+        end
+        next
+      end
+      package_data << { :package_name => key, :package_version => $1, :direct_requirement => (dep_list[key] || false) }
+    end
+
+    if package_data.empty?
+      if defined? Rails
+        Rails.logger.info "Sourceninja: Did not successfully parse any packages, will not attempt to upload information"
+      end
+
+      return
+    end
+
+    package_data
+  end
+
+  def self.send_package_info(package_data_hash)
+    if defined? Rails
       Rails.logger.debug "Sourceninja: Attempting to send package information to SourceNinja"
+    end
 
-      base_uri = @@base_uri
+    base_uri = @@base_uri
 
-      if not ENV['SOURCENINJA_UPLOAD_URL'].nil? and ENV['SOURCENINJA_UPLOAD_URL'] != ""
+    if not ENV['SOURCENINJA_UPLOAD_URL'].nil? and ENV['SOURCENINJA_UPLOAD_URL'] != ""
+      if defined? Rails
         Rails.logger.debug "Sourceninja: using #{ENV['SOURCENINJA_UPLOAD_URL']} for the upload URI"
-        base_uri = ENV['SOURCENINJA_UPLOAD_URL']
       end
 
-      if ENV['SOURCENINJA_TOKEN'].nil? or ENV['SOURCENINJA_TOKEN'] == ""
+      base_uri = ENV['SOURCENINJA_UPLOAD_URL']
+    end
+
+    if ENV['SOURCENINJA_TOKEN'].nil? or ENV['SOURCENINJA_TOKEN'] == ""
+      if defined? Rails
         Rails.logger.debug "Sourceninja: No SOURCENINJA_TOKEN set, not uploading information to SourceNinja"
-        return
       end
 
-      if ENV['SOURCENINJA_PRODUCT_ID'].nil? or ENV['SOURCENINJA_PRODUCT_ID'] == ""
+      return
+    end
+
+    if ENV['SOURCENINJA_PRODUCT_ID'].nil? or ENV['SOURCENINJA_PRODUCT_ID'] == ""
+      if defined? Rails
         Rails.logger.debug "Sourceninja: No SOURCENINJA_PRODUCT_ID set, not uploading information to SourceNinja"
-        return
       end
 
-      # all we need in the dep list is the name of the module. the version number here won't be important because
-      # Bundler will resolve that into the spec list below
-      dep_list = {}
-      Bundler.environment.dependencies.to_a.map{|b| b.to_s}.each do |dep|
-        unless %r{^\s*(\S+)} =~ dep
-          Rails.logger.info "Sourceninja: Could not find the package name for #{dep.to_s}"
-          next
-        end
+      return
+    end
 
-        dep_list[$1] = true
-      end
+    params = { :id => ENV['SOURCENINJA_PRODUCT_ID'], :token => ENV['SOURCENINJA_TOKEN'], :package_info => { :package_details => package_data_hash }.to_json }
 
-      package_data = []
-      spec_hash = Bundler.environment.specs.to_hash
-      spec_hash.keys.each do |key|
-        unless %r{Gem::Specification name=#{key} version=([\d.]+)} =~ spec_hash[key][0].to_s
-          Rails.logger.info "Sourceninja: Could not parse information for gem #{key}: #{spec_hash[key]}"
-          next
-        end
-        package_data << { :package_name => key, :package_version => $1, :direct_requirement => (dep_list[key] || false) }
-      end
+    if defined? Rails
+      Rails.logger.debug "Sourceninja: Attempting to send package_info of #{params.to_s} to #{[base_uri,'rubygems/1_0'].join('/')}"
+    end
 
-      if package_data.empty?
-        Rails.logger.info "Sourceninja: Did not successfully parse any packages, will not attempt to upload information"
-        return
-      end
+    response = HTTParty.post([base_uri,'rubygems/1_0'].join('/'), :body => params )
 
-      params = { :id => ENV['SOURCENINJA_PRODUCT_ID'], :token => ENV['SOURCENINJA_TOKEN'], :package_info => { :package_details => package_data}.to_json }
-      Rails.logger.debug "Sourceninja: Attempting to send package_info of #{params.to_s} to #{[base_uri,'rubygems/1_0'].join('/')}"
-      response = HTTParty.post([base_uri,'rubygems/1_0'].join('/'), :body => params )
+    if defined? Rails
       Rails.logger.debug "Sourceninja: Got back status #{response.code}"
-     end
-  end
-
-  class RailTie < Rails::Railtie
-    ActiveSupport.on_load(:after_initialize) do
-      Sourceninja.send_package_info
     end
   end
 end

data/lib/sourceninja/version.rb

@@ -1,3 +1,3 @@
 module Sourceninja
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/sourceninja.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "json"
-  s.add_runtime_dependency "httparty"
+  s.add_dependency "json"
+  s.add_dependency "httparty"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sourceninja
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-19 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -48,15 +48,20 @@ description: Integration with SourceNinja software tracking. Will allow a user t
   SourceNinja system.
 email:
 - support@sourceninja.com
-executables: []
+executables:
+- sourceninja
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- COPYRIGHT
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
+- bin/sourceninja
 - lib/sourceninja.rb
+- lib/sourceninja/railtie.rb
 - lib/sourceninja/sourceninja.rb
 - lib/sourceninja/version.rb
 - sourceninja.gemspec