Merge remote-tracking branch 'r-spacex/master'

# Conflicts:
#	data/launchpads.rb

Author: waterskier2007

.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+sudo: required
+dist: trusty
+
+before_install:
+  - gem update --system
+  - gem --version

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+## Contribution Steps (New Contributors)
+
+1. Fork the repo, make changes, commit, and submit a Pull Request
+
+2. New Pull Requests will automatically trigger a Travis CI Build
+
+3. If the build fails, look at the [Build Logs](https://travis-ci.org/r-spacex/SpaceX-API).
+Changes will not be merged unless the build passes.
+
+4. If the build succeeds, the pull request will be merged, and automatically
+pushed to the staging server at [http://api.spacexdev.com](http://api.spacexdev.com) for a
+final check before promoting changes to production at [https://api.spacexdata.com](https://api.spacexdata.com).
+
+## Contribution Steps (Org Members)
+
+1. Make changes, create a commit, and push to master
+
+2. New pushes will trigger a Travis CI build automatically
+
+3. If the build fails, look at the [Build Logs](https://travis-ci.org/r-spacex/SpaceX-API).
+Heroku will not accept a failing build onto the staging server.
+
+4. If the build succeeds, Heroku will automatically deploy to
+the staging server at [http://api.spacexdev.com](http://api.spacexdev.com)
+
+5. After a final check, the changes can be promoted to the Heroku production server at [https://api.spacexdata.com](https://api.spacexdata.com)

Gemfile

@@ -3,3 +3,6 @@ gem 'sinatra'
 gem 'sinatra-subdomain'
 gem 'json'
 gem 'mysql2'
+gem 'rack-test'
+gem 'test-unit'
+gem 'rake'

Gemfile.lock

@@ -4,16 +4,22 @@ GEM
     json (2.1.0)
     mustermann (1.0.0)
     mysql2 (0.4.6)
+    power_assert (1.0.2)
     rack (2.0.3)
     rack-protection (2.0.0)
       rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (12.0.0)
     sinatra (2.0.0)
       mustermann (~> 1.0)
       rack (~> 2.0)
       rack-protection (= 2.0.0)
       tilt (~> 2.0)
     sinatra-subdomain (0.3.0)
       sinatra
+    test-unit (3.2.5)
+      power_assert
     tilt (2.0.7)
 
 PLATFORMS
@@ -22,8 +28,11 @@ PLATFORMS
 DEPENDENCIES
   json
   mysql2
+  rack-test
+  rake
   sinatra
   sinatra-subdomain
+  test-unit
 
 BUNDLED WITH
    1.15.1

README.md

@@ -4,123 +4,24 @@
 
 ![Imgur](http://i.imgur.com/EdfIdgC.jpg)
 
-# SpaceX JSON Data API
+# SpaceX Data REST API
 
+[![Build Status](https://travis-ci.org/r-spacex/SpaceX-API.svg?branch=master)](https://travis-ci.org/r-spacex/SpaceX-API)
 [![GitHub release](https://img.shields.io/github/release/jakewmeyer/SpaceX-API.svg)]()
 [![Language](https://img.shields.io/badge/language-Ruby-red.svg)]()
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
 [![Platform](https://img.shields.io/badge/platform-REST--API-brightgreen.svg)]()
 
-### JSON API for data regarding company info, vehicles, launch sites, and launch data.
+### REST API for data regarding company info, vehicles, launch sites, and launch data.
 <br></br>
-# Usage / Endpoints
-</div>
-
-
-## Basic Info
-Get API info
-```http
-GET https://api.spacexdata.com
-```
-Get company info
-```http
-GET https://api.spacexdata.com/info
-```
-Get vehicle information
-```http
-GET https://api.spacexdata.com/vehicles
-```
-```http
-GET https://api.spacexdata.com/vehicles/falcon9
-GET https://api.spacexdata.com/vehicles/falconheavy
-GET https://api.spacexdata.com/vehicles/dragon
-```
-Get launchpad information
-```http
-GET https://api.spacexdata.com/launchpads
-```
-## Launch information by dates
-Get all launches
-```http
-GET https://api.spacexdata.com/launches
-```
-Get all future launches
-```http
-GET https://api.spacexdata.com/launches/upcoming
-```
-Get past launches by year
-```http
-GET https://api.spacexdata.com/launches?year=2017
-```
-Get past launches in a date range
-```http
-GET https://api.spacexdata.com/launches?from=2011-01-20&to=2017-05-25
-```
-
-## Launch info by serial #'s
-Get launches by core serial #
-```http
-GET https://api.spacexdata.com/launches/cores/B1021
-```
-Get launches by capsule serial #
-```http
-GET https://api.spacexdata.com/launches/caps/C106
-```
 
-## Detailed info about each capsule
-Get detailed info on all capsules
-```http
-GET https://api.spacexdata.com/parts/caps
-```
-Get detailed capsule information by serial #
-```http
-GET https://api.spacexdata.com/parts/caps/C106
-```
-
-## Detailed info about each core
-Get detailed info on all cores
-```http
-GET https://api.spacexdata.com/parts/cores
-```
-Get detailed core information by serial #
-```http
-GET https://api.spacexdata.com/parts/cores/B1021
-```
-
-## JSON launch response example
+</div>
 
-```json
-{
-  "flight_number": 42,
-  "launch_year": "2017",
-  "launch_date": "2017-06-23",
-  "time_utc": "19:10",
-  "time_local": "03:10 pm EDT",
-  "rocket": "Falcon 9",
-  "rocket_type": "FT",
-  "core_serial": "B1029",
-  "cap_serial": "",
-  "launch_site": "KSC LC39A",
-  "payload_1": "BulgariaSat-1",
-  "payload_2": "",
-  "payload_type": "Satelite",
-  "payload_mass_kg": 3669,
-  "payload_mass_lbs": 8089,
-  "orbit": "GTO",
-  "customer_1": "Bulgaria Sat",
-  "customer_2": "",
-  "launch_success": true,
-  "reused": true,
-  "land_success": true,
-  "landing_type": "ASDS",
-  "mission_patch": "http://i.imgur.com/VAvulaO.png",
-  "article_link": "https://en.wikipedia.org/wiki/BulgariaSat-1",
-  "video_link": "https://www.youtube.com/watch?v=Y8mLi-rRTh8",
-  "details": "Second time a booster will be reused: Second flight of B1029 after the Iridium mission of January 2017. The satellite will be the first commercial Bulgarian-owned communications satellite and it will provide television broadcasts and other communications services over southeast Europe."
-},
-```  
-<br></br>
+## Usage / Endpoints
+See the [Wiki](https://github.com/r-spacex/SpaceX-API/wiki) for API Documentation
 
+## Contributions
+See the [Contribution](https://github.com/r-spacex/SpaceX-API/blob/master/CONTRIBUTING.md) guide for detailed steps
 
 ## FAQ's
 * If you have any questions or corrections, please open an issue and we'll get it merged ASAP
@@ -129,9 +30,7 @@ GET https://api.spacexdata.com/parts/cores/B1021
 * For any other questions or concerns, just shoot me an email
 
 ## Technical Details
-* API is using [Sinatra](http://www.sinatrarb.com/) as a framework in Ruby
-* Launch, Capsule, and Core data implemented in [MariaDB](https://mariadb.org/)
-* Vehicle, Launchpad, and Company data is stored directly in JSON
+* API is using [Sinatra](http://www.sinatrarb.com/) framework
+* Launch, Capsule, and Core data stored in [MariaDB](https://mariadb.org/)
+* Vehicle, Launchpad, and Company data is stored in Ruby hashes.
 * API is deployed on [Heroku](https://www.heroku.com/)
-* This repo deploys to a staging server first, so the production server might
-be a few commits behind, this allows for testing, and preserves stability

Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require "test/unit"
+require "rack/test"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test.rb'
+  test.warning = true
+  test.verbose = true
+end
+
+task :default => [:test]

app.rb

@@ -1,7 +1,10 @@
+#
 # SpaceX API for searching company info,
 # vehicle info, launch sites, and
 # launch data.
+#
 
+require 'bundler/setup'
 require 'sinatra'
 require 'sinatra/subdomain'
 require 'json'
@@ -14,6 +17,10 @@
 require './data/launchpads.rb'
 require './data/dragon.rb'
 
+# Uses the modular version of Sinatra
+class SpacexAPI < Sinatra::Base
+  register Sinatra::Subdomain
+
 # DB connection to MariaDB
 DB = Mysql2::Client.new(
   :host => ENV['MARIA_HOST'],
@@ -41,6 +48,9 @@ def hash_merge(*hashes)
 # Uses subdomain api.example.com to route traffic
 subdomain :api do
 
+#
+# Basic Info Endpoints
+#
 get '/' do
   content_type :json
   JSON.pretty_generate($home_info)
@@ -85,10 +95,13 @@ def hash_merge(*hashes)
   JSON.pretty_generate(hash)
 end
 
-# Gets upcoming launches
+
+#
+# Upcoming launch endpoints
+#
 get '/launches/upcoming' do
   content_type :json
-  results = DB.query("SELECT * FROM launch WHERE launch_year = 'upcoming'", :cast_booleans => true)
+  results = DB.query("SELECT * FROM upcoming", :cast_booleans => true)
     hash = results.each do |row|
     end
     if hash.empty?
@@ -99,6 +112,44 @@ def hash_merge(*hashes)
     end
 end
 
+# Gets upcoming launches sorted by year
+get '/launches/upcoming/year=:year' do
+  content_type :json
+  year = params['year']
+  statement = DB.prepare('SELECT * FROM upcoming WHERE launch_year = ?')
+  results = statement.execute(year)
+    hash = results.each do |row|
+    end
+    if hash.empty?
+      error = { error: 'No Matches Found' }
+      JSON.pretty_generate(error)
+    else
+      JSON.pretty_generate(hash)
+    end
+end
+
+# Gets upcoming launches in a date range
+get '/launches/upcoming/from=:start&to=:final' do
+  content_type :json
+  start = params['start']
+  final = params['final']
+  statement = DB.prepare('SELECT * FROM upcoming WHERE launch_date BETWEEN ? AND ?;',)
+  results = statement.execute(start, final)
+    hash = results.each do |row|
+    end
+    if hash.empty?
+      error = { error: 'No Matches Found' }
+      JSON.pretty_generate(error)
+    else
+      JSON.pretty_generate(hash)
+    end
+end
+
+
+#
+# Launches by year endpoints
+#
+
 # Gets launches sorted by year
 get '/launches/year=:year' do
   content_type :json
@@ -115,7 +166,29 @@ def hash_merge(*hashes)
     end
 end
 
-# Get all launches with a serial number
+# Gets all launches in a date range
+get '/launches/from=:start&to=:final' do
+  content_type :json
+  start = params['start']
+  final = params['final']
+  statement = DB.prepare('SELECT * FROM launch WHERE launch_date BETWEEN ? AND ?;',)
+  results = statement.execute(start, final)
+    hash = results.each do |row|
+    end
+    if hash.empty?
+      error = { error: 'No Matches Found' }
+      JSON.pretty_generate(error)
+    else
+      JSON.pretty_generate(hash)
+    end
+end
+
+
+#
+# Launches by part serial #'s'
+#
+
+# Get all launches with a core serial number
 get '/launches/cores/:core' do
   content_type :json
   core = params['core']
@@ -206,21 +279,5 @@ def hash_merge(*hashes)
       JSON.pretty_generate(hash)
     end
 end
-
-# Gets all launches in a date range
-get '/launches/from=:start&to=:final' do
-  content_type :json
-  start = params['start']
-  final = params['final']
-  statement = DB.prepare('SELECT * FROM launch WHERE launch_date BETWEEN ? AND ?;',)
-  results = statement.execute(start, final)
-    hash = results.each do |row|
-    end
-    if hash.empty?
-      error = { error: 'No Matches Found' }
-      JSON.pretty_generate(error)
-    else
-      JSON.pretty_generate(hash)
-    end
 end
 end

config.ru

@@ -1,4 +1,8 @@
 # Rack uses this to start the application
 
+require 'bundler'
 require './app'
-run Sinatra::Application
+
+Bundler.require
+
+run SpacexAPI