supso 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd3d0c661894c025b644939402b512d0a856a749
+  data.tar.gz: 296bd55c43d99e08ce1a4e84de3099f58ec6febb
+SHA512:
+  metadata.gz: 9c207f50f11ff0b211b6aba820f06f035f2dfc0b79b649b012add56314ba55b70a21583042813ab669d2a85929a24db21b58ac899d13d1e72ca9557e14b3c979
+  data.tar.gz: 14d464d0dc69b0cd7baee6b43224bcfc03b46c5842dd6ed48532af79507cef82dc793e5202b55516c1b6aa5f707a4675269a357fcaefda9ce252a72899c6a530

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+log
+.DS_Store
+*.lock
+.idea
+*.gem

data/.rspec

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

data/DEV_README.md

@@ -0,0 +1,28 @@
+# Helpful things to remember when developing
+
+## Publishing to Rubygems
+
+Ensure the version number is updated (lib/supso/version.rb.
+
+rspec
+
+gem build supso.gemspec
+
+Make sure your ~/.gem credentials are the correct one
+
+gem push supso-VERSION.gem
+
+## Requiring the local version of the Gem
+
+Use something like this:
+
+gem 'supso', '0.9.0', path: 'local/path/to/gem'
+
+## Philosophy
+
+Super Source is split into two types of packages: the supso command line interface,
+and packages included with the projects that use Super Source.
+
+This gem, the Super Source Ruby gem, is an example of the former: the command line interface.
+
+The supso command line interface should never be directly added as a requirement from the projects.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Jeff Pickhardt
+
+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,25 @@
+# Super Source
+
+## Installation
+
+##### Instructions for using Super Source
+
+Create a new, empty directory. Inside this directory, create a file named Gemfile, and add the following to it:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'super_source'
+```
+
+Then execute:
+
+    $ bundle install
+
+## Documentation
+
+Visit the [docs page](http://supso.org/docs/overview/welcome) to read the documentation. The docs page is autogenerated from the files in this project's docs directory.
+
+## Contributing
+
+To contribute, get in touch at http://supso.org/ so that we can share the [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) with you, then create a pull request.

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 "supso"
+
+# 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/bin/supso

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/supso"
+require_relative "../lib/supso/commands"
+
+Supso::Commands.route_command(ARGV)

data/docs/README.md

@@ -0,0 +1,7 @@
+# Documentation
+
+The documentation directory is viewable at http://supso.org/docs.
+ 
+# Autogenerated
+
+The documentation directory is autogenerated from the main Super Source git repo. If you would like to add or correct something in the documentation, let us know or make a pull request to (https://github.com/TODO/docs)[https://github.com/TODO/docs].

data/docs/commands/README.md

@@ -0,0 +1,14 @@
+# Commands
+
+Commands can be run by running `supso commandname` from the project directory, assuming that you've already
+run `bundle install` to install the Super Source gem.
+
+The list of commands is:
+
+- [help](/docs/commands/[help])
+- [login](/docs/commands/login)
+- [logout](/docs/commands/logout)
+- [show](/docs/commands/show)
+- [update](/docs/commands/update)
+- [version](/docs/commands/[version])
+- [whoami](/docs/commands/whoami)

data/docs/commands/help.md

@@ -0,0 +1,10 @@
+# The `help` command
+
+The `help` command outputs a list of all available commands.
+
+Usage:
+
+`$ supso help
+Usage: supso command
+Commands: help login logout etc...
+`

data/docs/commands/login.md

@@ -0,0 +1,10 @@
+# The `login` command
+
+The `login` command will log in to your Super Source account. You will be prompted for your email address.
+
+If you have never added a password to your account, you will then be prompted for a confirmation token sent to your 
+email address, to complete log in. If your account does have a password, you'll be prompted for your password instead.
+
+Usage:
+
+`$ supso login`

data/docs/commands/logout.md

@@ -0,0 +1,7 @@
+# The `logout` command
+
+The `logout` command will log you out of Super Source, also deleting the user information stored locally on your computer.
+
+Usage:
+
+`$ supso logout`

data/docs/commands/show.md

@@ -0,0 +1,21 @@
+# The `show` command
+
+The `show` command shows a list of projects used by your project, and whether you have tokens for those projects.
+
+Usage:
+
+```
+$ supso show
+3 projects using Super Source.
+dataduck-etl
+  Source: add (ruby)
+  Valid: Yes
+js_supso_test
+  Source: npm
+  Valid: No
+  Reason: Missing client token. Run `supso update` to update the token.
+yet-another-ruby-project
+  Source: add (ruby)
+  Valid: No
+  Reason: Missing client token. Run `supso update` to update the token.
+```

data/docs/commands/update.md

@@ -0,0 +1,7 @@
+# The `update` command
+
+The `update` command updates the client tokens for all Super Source projects found in your project's Gemfile.
+
+Usage:
+
+`$ supso update`

data/docs/commands/version.md

@@ -0,0 +1,12 @@
+# The `version` command
+
+The `version` command outputs the current version of the Supso command line interface.
+ 
+Note: this version is for the Suspo command line interface, not any Super Source packages you may be using,
+such as the Ruby gem super_source, or the Javascript package super-source.
+
+Usage:
+
+`$ supso version
+0.9.1
+`

data/docs/commands/whoami.md

@@ -0,0 +1,5 @@
+# The `whoami` command
+
+The `whoami` command shows you who you're logged in as, if you are logged in.
+
+`$ supso whoami`

data/docs/contents.yml

@@ -0,0 +1,17 @@
+"Overview":
+  "Welcome": README
+  "Getting Started": getting_started
+
+"Commands":
+  "help": help
+  "login": login
+  "logout": logout
+  "show": show
+  "update": update
+  "version": version
+  "whoami": whoami
+
+"Errors":
+  "Invalid Project Token": invalid_project_token
+  "Missing Project Token": missing_project_token
+  

data/docs/errors/README.md

@@ -0,0 +1,6 @@
+# Errors
+
+If you have included a Super Source project and haven't updated, you may get one of these exceptions:
+
+- [Invalid Project Token](/docs/errors/invalid_project_token)
+- [Missing Project Token](/docs/errors/missing_project_token)

data/docs/errors/invalid_project_token.md

@@ -0,0 +1,4 @@
+# Invalid Project Token
+
+The `InvalidProjectToken` error is thrown when the client token exists, but is invalid. It may have been accidentally 
+modified, for instance. To fix and update the client token, run `supso update`.

data/docs/errors/missing_project_token.md

@@ -0,0 +1,4 @@
+# Missing Project Token
+
+The `MissingProjectToken` error is thrown when the client token is missing. To receive the
+client token, run `supso update`.

data/docs/overview/README.md

@@ -0,0 +1,16 @@
+# Overview
+
+Super Source let's you know who's using your software projects. If you have an open source project,
+and would like to understand who your users are, you should use Super Source.
+
+## Getting Started
+
+Getting started with Super Source takes just a few minutes. For instructions, read the
+[getting started](/docs/overview/getting_started) page.
+
+## Why Use Super Source
+
+- Learn who's using your project.
+- Develop relationships with your users.
+- Send announcements over email.
+

data/docs/overview/getting_started.md

@@ -0,0 +1,15 @@
+# Getting Started
+
+The following explains how to get started with Super Source as the downstream user of a project that uses it.
+If instead you are a developer looking to implement Super Source in your project, sign in to the website and visit the
+Install page.
+
+## Installation
+
+Run `gem install supso`
+
+This installs supso, the command line interface for Super Source.
+
+## Getting Client Tokens
+
+Run `supso update` from your project's directory

data/lib/helpers/module_vars.rb

@@ -0,0 +1,19 @@
+module ModuleVars
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method(name, &block)
+    end
+  end
+
+  def create_module_var(name, val = nil)
+    class_variable_set("@@#{ name }", val)
+
+    define_class_method(name) do
+      class_variable_get("@@#{ name }")
+    end
+
+    define_class_method("#{name}=") do |set_to|
+      class_variable_set("@@#{ name }", set_to)
+    end
+  end
+end

data/lib/other/supso2.pub

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxa97nwFuinf275M/uCFL
+MXDhR46lm3oCvEFMAPdqLJ4570DeJZK5MrsSeVaOtiMeW8eNAaLxNocL88QXojGm
+Bm5jMWJeMwcs1iZTz+w+UwL4njhfE6fF81LeKJf0iq6gFsJE328RuFqj2fayn8sv
+H5YTsPQhsm/dF2XkjWfQ2dSIHhjwBi0JUNgvZQDLmH6MbdQDenzMD2Z/MG+CMxyc
+VqKOy+qaqx+eHdfgFk9zoU22cb2XifOSZzph/mGJim7g5N4LQb0zoeykGVvlZuKj
+YiVCyjvHErM+iWqi7k2ZhlKacprI5Zm9tbZs+lFfmn8c1Ks11zUxeDPhkdUL/v38
+YwIDAQAB
+-----END PUBLIC KEY-----

data/lib/super_source/project.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../supso/project'
+
+module SuperSource
+  class Project
+    def self.add(*args)
+      Supso::Project.add(*args)
+    end
+  end
+end

data/lib/supso/commands.rb

@@ -0,0 +1,155 @@
+require 'erb'
+require 'json'
+require 'fileutils'
+require 'io/console'
+require 'super_source'
+
+module Supso
+  class Commands
+    def self.prepare_command_mode!
+      require File.dirname(__FILE__) + '/../super_source/project'
+    end
+
+    def self.prompt_choices(choices = [])
+      while true
+        print "Enter a number 0 - #{ choices.length - 1}\n"
+        choices.each_with_index do |choice, idx|
+          choice_name = choice.is_a?(String) ? choice : choice[1]
+          print "#{ idx }: #{ choice_name }\n"
+        end
+        choice = STDIN.gets.strip.to_i
+        if 0 <= choice && choice < choices.length
+          selected = choices[choice]
+          return selected.is_a?(String) ? selected : selected[0]
+        end
+      end
+    end
+
+    def self.prompt_confirmation_token(to_email)
+      token = ''
+      while token.length < 4
+        puts "Enter the confirmation token that was sent to #{ to_email }: (or enter 'resend')"
+        token = STDIN.gets.strip
+        if token.length < 4
+          puts "Sorry, #{ token } is not a valid confirmation token."
+        end
+      end
+      token
+    end
+
+    def self.prompt_email
+      email = ''
+      while !Util.is_email?(email)
+        puts "Enter your email address:"
+        email = STDIN.gets.strip
+        if !Util.is_email?(email)
+          puts "Sorry, #{ email } is not a valid email address."
+        end
+      end
+      email
+    end
+
+    def self.advanced_commands
+      ['logout', 'login', 'show', 'update', 'whoami']
+    end
+
+    def self.simple_commands
+      ['help', 'version']
+    end
+
+    def self.all_commands
+      self.advanced_commands + self.simple_commands
+    end
+
+    def self.update
+      Updater.update
+    end
+
+    def self.whoami
+      user = User.current_user
+      puts user ? user.email : nil
+    end
+
+    def self.logout
+      User.log_out!
+    end
+
+    def self.login
+      email = Commands.prompt_email
+
+      without_password_response = Util.http_post("#{ Supso.supso_api_root }sign_in_request_token_api", email: email)
+      if !without_password_response['success']
+        puts without_password_response['reason']
+        return
+      end
+
+      if without_password_response['confirmation_token_sent']
+        succeeded = false
+        while !succeeded
+          token = Commands.prompt_confirmation_token(email)
+          succeeded, reason = User.log_in_with_confirmation_token!(email, token)
+          if !succeeded && reason
+            puts reason
+          end
+        end
+      else
+        succeeded = false
+        while !succeeded
+          puts "Enter your password:"
+          password = STDIN.noecho(&:gets).chomp
+          succeeded, reason = User.log_in_with_password!(email, password)
+          if !succeeded && reason
+            puts reason
+          end
+        end
+      end
+
+      puts "Successfully signed in as #{ email }."
+    end
+
+    def self.show
+      Project.detect_all_projects!
+      if Project.projects.length == 0
+        puts "0 projects using Super Source."
+      else
+        puts "#{ Project.projects.length } #{ Util.pluralize(Project.projects.length, 'project') } using Super Source.\n"
+        Project.projects.each do |project|
+          project.puts_info
+        end
+      end
+    end
+
+    def self.route_command(args)
+      if args.length == 0
+        return Commands.help
+      end
+
+      command = args[0]
+      if !Commands.all_commands.include?(command)
+        puts "No such command: #{ command }"
+        return Commands.help
+      end
+
+      if Commands.simple_commands.include?(command)
+        return Commands.public_send(command)
+      end
+
+      Commands.prepare_command_mode!
+
+      begin
+        Commands.public_send(command, *args[1..-1])
+      rescue StandardError => err
+        Logs.error(err)
+      end
+    end
+
+    def self.help
+      puts "Usage: supso command"
+      puts "Commands: #{ all_commands.sort.join(' ') }"
+    end
+
+    def self.version
+      puts Supso::VERSION
+    end
+  end
+end

data/lib/supso/config.rb

@@ -0,0 +1,16 @@
+module Supso
+  class Config
+    def self.load_config!
+      if !Supso.project_supso_config_root
+        return
+      end
+
+      configs_to_load = ["/config.json"]
+      configs_to_load.each do |relative_path|
+        config_path = Supso.project_supso_config_root + relative_path
+        loaded_config = File.exist?(config_path) ? JSON.parse(File.read(config_path)) : {}
+        Supso.config = Util.deep_merge(Supso.config, loaded_config)
+      end
+    end
+  end
+end

data/lib/supso/javascript.rb

@@ -0,0 +1,57 @@
+module Supso
+  class Javascript
+    def self.detect_all_projects!
+      Javascript.detect_all_npm_projects!
+    end
+
+    def self.npm_list_command_response
+      if Util.has_command?('npm')
+        `npm list --json`
+      end
+    end
+
+    def self.npm_list_json
+      if !Util.has_command?('npm')
+        return
+      end
+
+      npm_list = Javascript.npm_list_command_response
+      npm_project_data = {}
+      begin
+        npm_project_data = JSON.parse(npm_list)
+      rescue
+        npm_project_data = {} # TODO maybe log this?
+      end
+
+      npm_project_data
+
+    end
+
+    def self.detect_all_npm_projects!
+      if !Util.has_command?('npm')
+        return
+      end
+
+      root_project = Javascript.npm_list_json
+      Javascript.detect_npm_project!(root_project['name'], root_project)
+    end
+
+    def self.detect_npm_project!(name, project)
+      if !project || !project['dependencies']
+        return
+      end
+
+      dependencies = project['dependencies']
+      dependencies.each_key do |dependency_name|
+        if dependency_name == 'super-source'
+          Project.add(name, nil, {
+                  aliases: [{'name' => name, 'platform' => 'npm'}],
+                  source: 'npm'
+              })
+        else
+          Javascript.detect_npm_project!(dependency_name, dependencies[dependency_name])
+        end
+      end
+    end
+  end
+end

data/lib/supso/logs.rb

@@ -0,0 +1,49 @@
+require 'logger'
+
+module Supso
+  module Logs
+    @@ONE_MB_IN_BYTES = 1048576
+
+    @@logger = nil
+
+    def Logs.log_target
+      (Supso.project_root || Supso.user_supso_config_root) + '/log/supso.log'
+    end
+
+    def Logs.ensure_logger_exists!
+      log_file_path =  Logs.log_target
+      Supso::Util.ensure_path_exists!(log_file_path)
+      @@logger ||= Logger.new(log_file_path, shift_age = 100, shift_size = 100 * @@ONE_MB_IN_BYTES)
+    end
+
+    def Logs.debug(message)
+      self.ensure_logger_exists!
+
+      puts "[DEBUG] #{ message }"
+      @@logger.debug(message)
+    end
+
+    def Logs.info(message)
+      self.ensure_logger_exists!
+
+      puts "[INFO] #{ message }"
+      @@logger.info(message)
+    end
+
+    def Logs.warn(message)
+      self.ensure_logger_exists!
+
+      puts "[WARN] #{ message }"
+      @@logger.warn(message)
+    end
+
+    def Logs.error(err, message = nil)
+      self.ensure_logger_exists!
+      message = err.to_s unless message
+
+      puts "[ERROR] #{ message }"
+      puts err.backtrace.join("\n")
+      @@logger.error(message)
+    end
+  end
+end