The Bliss Collector is a Ruby command-line application to collect repository and commit data for Bliss.ai.
You will need the following information before using Bliss's Collector:
- Your Bliss API Key - You can find this by logging into bliss.ai, clicking on the Settings wheel, scrolling the the bottom and clicking "Show" on the API Key bar
- The path of the directory where all of your repositories are located
- Your git organization name
Make sure you have Git installed on your machine.
For Ubuntu/Debian machines, execute the following in terminal:
sudo apt-get install git
For RPM-based systems such as Yum, execute the following in terminal:
sudo yum install -y git
For Windows machines, you will need to download and run the installer at: https://git-scm.com/download/win
You can then clone the repository by executing the following in your terminal:
git clone https://github.com/founderbliss/collector.git
Bliss's Collector has specific requirements that need to be met before it will work on all project types. We attempt to install these for you with the installscripts as outlined below, however additional steps may be required depending on your specific environment and it's compatibility with our scripts.
The following is a list of dependencies that are required to support:
- JRuby 9.0.3.0
- Ruby DevKit
- Perl
- Python
- NodeJS and Node Package Manager
- php
- Git installation
In addition, a number of linting tools are required:
- JSHint (for JavaScript repositories)
- Prospector (for Python/Django repositories)
- ReSharper and InspectCode (for .NET repositories)
- pmd (for Java repositories)
- cpd - included with pmd (for all repositories)
- lizard (for Objective-C repositories)
- metric_fu (for ruby repositories)
- PHP Codesniffer (for php repositories)
- Wordpress Codesniffer (for Wordpress repositories)
- csslint (for css file linting)
For those with .NET repositories, you will need to manually install InspectCode, which is a code inspection tool for .NET projects. You download it here:
https://www.jetbrains.com/resharper/features/command-line.html
There is a shell script in the 'installscripts' that will handle the installation of dependencies. To run this script, open up a terminal window, navigate (cd) into the 'installscripts' directory, and type
sh linux.sh
You will need to reboot your system after running this script.
After running this script and rebooting, you will need to navigate (cd) into the Collector directory and type:
gem install bundler
bundle install
There is a script called setup.ps1 in the 'installscripts' folder that will manage the installation of Java, JRuby, Chocolatey Nuget, Perl, Python, NodeJS and NPM.
To run this script, open up a Powershell window (as an Administrator), navigate (cd) into the 'installscripts' directory, and type:
powershell.exe setup.ps1
This will begin the installation process.
Note: If running scripts is disabled on your machine, make sure to set the '-ExecutionPolicy ByPass' option when executing the above command.
Detailed instructions on how to install PHP in Windows can be found here:
http://www.sitepoint.com/how-to-install-php-on-windows/
You can also use Chocolatey to install PHP, however you will need to add 'C:\tools\php' to your path as this is not done automatically. Instructions on altering your path can be found here:
http://windowsitpro.com/systems-management/how-can-i-add-new-folder-my-system-path
After running this script and rebooting, you will need to navigate (cd) into the Collector directory and type:
gem install bundler
bundle install
To run our Bliss CLI, navigate (cd) to the Collector directory in a shell, and type:
ruby blisscollector.rb
To run the CLI, navigate (cd) to the Collector directory in a shell, and type:
jruby blisscollector.rb
The first time you do this, you will be prompted for the information set out in the 'Information Required' section above. This information will be stored in a YAML file, bliss-config.yml, in the home folder for future use. You can remove any of these entries to be prompted again, or you can updated the information stored in the config file.
The commands available through the CLI tool are:
- Collector (C) - this command will collect metadata about your repositories and post them to Bliss
- Stats (S) - this command will log all of your commits with Bliss, and calculate data such as Lines of Code, Test Lines of Code etc.
- Linter (L) - this command will run linters over all of your outstanding commits and send the linting data to Bliss for analysis
These should be run in the following order:
Collector -> Stats -> Linter
Bliss Collector uses the 'whenever' gem to manage cron scheduling. To set the task to run on a regular basis, open 'config/schedule.rb'. There is an existing task in the file that will run Collector, Stats and Linter in order. Just change the '1.minutes' to whatever interval you wish the job to run at, update your crontab by typing
bundle exec whenever --update-crontab
into your terminal from the collector directory.
To stop scheduled tasks, just type
bundle exec whenever -c
into your terminal from the collector directory.
Windows users can schedule the collector to run every three hours by running the collector with an optional argument:
jruby blisscollector.rb schedule
- You will need to make sure that the machine the Collector runs on has the appropriate SSH keys setup, so that the application can 'git pull' without being prompted for a username/password combination.
Issues are reported via github "Issues":
https://github.com/founderbliss/collector/issues
To start working on an issue, take one that you can handle from the issue list. Assign it to yourself and start to work on it. Please close issues before taking new ones.
Please include the issue number in the commit preceded by the hash (#) character (see https://github.com/blog/831-issues-2-0-the-next-generation). This does not need to follow a 'fixes' or 'closed' but just include it so that we can see what commits are for which issues.
You must keep your diffs down the the minimum. Do not add extra spaces or remove extra spaces on lines that you do not need to change. Also, keep the tab set as two spaces and not reformat the code unless you are changing it. If your IDE reformats code, please disable this feature so that only the minimum diff is committed to keep the issue clean and self contained. We code review almost every commit so if the diffs are bigger than they need to be, we will be spending time looking into lines that just contain space changes which takes extra time and therefore money.
If you are working on a long change, you can commit locally but do not push until you have the tests passing. If you push code with broken tests, this will break our continuous build and send alerts to our team.
Copyright (c) 2015 by Bliss.ai Inc
Bliss.ai Inc San Francisco, CA, USA
Copyright (c) 2015 Bliss.ai Inc - all rights reserved
By using this code and agreeing to work on this, you agree to treat is as private and confidential information.
“Confidential Information” shall mean any and all information and documents relating to the business of the Disclosing Party that are (or are reasonably understood to be) of a confidential or proprietary nature and are provided by the Disclosing Party to the Receiving Party, whether before, on or after the date of this Agreement, either directly or indirectly, in writing, electronically, orally, by inspection of tangible objects, or otherwise. "Confidential Information" includes, without limitation, products and services under development, source codes, software and software technology, computer programs, related documentation and manuals, formulas, inventions, techniques, processes, programs, prototypes, diagrams, schematics, technical information, customer and financial information, sales and marketing plans, any business strategies or arrangements, editorial plans, systems architecture, intellectual property, technical data, trade secrets or know-how, research initiatives, customer and subscriber lists, email directories and databases, user databases and other data about users, and engineering and hardware configuration information. Confidential Information of the Disclosing Party may also include such information disclosed to the Receiving Party by third parties. Confidential Information disclosed to the Receiving Party by any officer, director, employee, agent or affiliate of the Disclosing Party is covered by this Agreement.
Use of Confidential Information. The Receiving Party shall not use or disclose and shall keep confidential any and all Confidential Information other than to explore a potential business relationship between the parties and/or to perform its obligations under any such relationship entered into by the parties, and shall use the same care as the Receiving Party uses to maintain the confidentiality of its confidential information, but in no event less than reasonable care. The Receiving Party may disclose Confidential Information only to its officers, directors, employees, consultants, agents or advisors to whom such disclosure is necessary to evaluate, and engage in discussions concerning, the potential business relationship and/or for the Receiving Party to perform its obligations under any such relationship, and who are bound by the terms hereof or similar confidentiality obligations. The Receiving Party acknowledges that the remedy at law for any breach of the foregoing provisions of this paragraph shall be inadequate and that the Disclosing Party shall be entitled to obtain injunctive relief against any such breach or threatened breach, without posting any bond, in addition to any other remedy available to it. Notwithstanding any other provision of this Agreement, the Receiving Party may disclose Confidential Information pursuant to any governmental, judicial or administrative order, subpoena or discovery request, provided that the Receiving Party uses reasonable efforts to notify the Disclosing Party sufficiently in advance of such order, subpoena, or discovery request so that the Disclosing Party may seek to object to such order, subpoena or request, or to make such disclosure subject to a protective order or confidentiality agreement. The Receiving Party shall not reverse engineer, disassemble or decompile any prototypes, software or other tangible objects which embody the Disclosing Party's Confidential Information and which are provided to the Receiving Party hereunder. The Receiving Party agrees that it shall take reasonable measures to protect the secrecy of and avoid disclosure and unauthorized use of the Confidential Information of the Disclosing Party. The Receiving Party shall reproduce the Disclosing Party's proprietary rights notices on any copies of Confidential Information, in the same manner in which such notices were set forth in or on the original.
“Confidential Information” shall not include information that (a) at the time of use or disclosure by the Receiving Party, is in the public domain through no fault of, action or failure to act by the Receiving Party; (b) becomes known to the Receiving Party from a third-party source without violation of any obligation of confidentiality or other wrongful or tortious act; (c) was known by the Receiving Party prior to disclosure of such information by the Disclosing Party to the Receiving Party; or (d) was independently developed by the Receiving Party without any use of Confidential Information.
Warranty. ALL CONFIDENTIAL INFORMATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND. THE RECEIVING PARTY AGREES THAT THE DISCLOSING PARTY SHALL NOT BE LIABLE FOR ANY DAMAGES WHATSOEVER RELATING TO THE RECEIVING PARTY'S USE OF SUCH CONFIDENTIAL INFORMATION.
Return of Confidential Information. The Receiving Party shall immediately destroy or return all tangible and, to the extent practicable, intangible material in its possession or control embodying the Disclosing Party’s Confidential Information (in any form and including, without limitation, all summaries, copies and excerpts of Confidential Information) upon the earlier of (a) the completion or termination of the dealings between the parties or (b) such time as the Disclosing Party may so request. The Disclosing Party may require that the Receiving Party will provide a certificate stating that the Receiving Party has complied with the foregoing requirements.
Notice of Breach. The Receiving Party shall notify the Disclosing Party immediately upon discovery of any unauthorized use or disclosure of Confidential Information and shall cooperate with the Disclosing Party in every reasonable way to help the Disclosing Party regain possession of Confidential Information and prevent its further unauthorized use.
Publicity; Relationship. Neither party shall make any representations, give any warranties or enter into any negotiations or agreements with third parties on behalf of the other party. Each party agrees that all press releases, announcements or other forms of publicity made by such party concerning any joint activity or business relationship between the parties must be pre-approved in writing by the other party.
Non-waiver. Any failure by the Disclosing Party to enforce the Receiving Party’s strict performance, or any waiver by the Disclosing Party, of any provision of this Agreement shall not constitute a waiver of the Disclosing Party’s right to subsequently enforce such provision or any other provision of this Agreement.
No License. Nothing in this Agreement is intended to grant any ownership or other rights to either party under any patent, trademark or copyright of the other party, nor shall this Agreement grant any party any ownership or other rights in or to the Confidential Information of the other party except as expressly set forth herein.
No Obligation. Nothing in this Agreement shall impose any obligation upon either party to consummate a transaction with the other or upon either party to enter into discussions or negotiations with respect thereto.
Term. The obligations of each Receiving Party hereunder shall survive until the earlier of (a) two (2) years from the date of this Agreement, or (b) such time as all Confidential Information disclosed hereunder is in the public domain through no fault of, action or failure to act by the Receiving Party.
Miscellaneous.
This Agreement shall be governed by and construed in accordance with the laws of the State of California without regard to the conflicts of law principles of such State. All actions in connection with this Agreement shall be brought only in the state or federal courts sitting in the City, County and State of New York. Those courts shall have jurisdiction over the parties in connection with any such lawsuit and venue shall be appropriate in those courts. Process may be served in any manner permitted by the rules of the court having jurisdiction. Any notice required or permitted under this Agreement shall be in writing and delivered by personal delivery, a nationally-recognized express courier assuring overnight delivery, confirmed facsimile transmission or first-class certified or registered mail, return receipt requested, and will be deemed given (i) upon personal delivery; (ii) one (1) business day after deposit with the express courier or confirmation of receipt of facsimile; or (iii) five (5) days after deposit in the mail. Such notice shall be sent to the party for which intended at the address set forth below its signature hereto or at such other address as that party may specify in writing pursuant to this section, and, in the case of the worker via email or odes notification, and in the case of Bliss.ai Inc, with a copy to: 500 Westover Dr #1415, Sanford NC 27330, Attn: Ian Connor, CTO or via email to [email protected] In the event that any one or more of the provisions of this Agreement shall be held invalid, illegal or unenforceable in any respect, or the validity, legality and enforceability of any one or more of the provisions contained herein shall be held to be excessively broad as to duration, activity or subject, such provision shall be construed by limiting and reducing such provision so as to be enforceable to the maximum extent compatible with applicable law. In any action to enforce any of the terms or provisions of this Agreement or on account of the breach hereof, the prevailing party shall be entitled to recover all its expenses, including, without limitation, reasonable attorneys’ fees. This Agreement shall inure to the benefit of, and be binding upon, the parties and their respective successors and assigns; provided that neither party may assign this Agreement without the prior, written consent of the other party. Execution and acceptance of this agreement may be evidenced by pulling the git repository from github or downloading any portion except the README by web browser or any other means.