spacex 1.0.2 → 2.0.0

data/docs/v4.md

@@ -0,0 +1,179 @@
+# V4 Usage
+- [Capsules](#capsules)
+  - `SPACEX::V4::Capsules.info`
+  - `SPACEX::V4::Capsules.info('id')`
+- [Cores](#cores)
+  - `SPACEX::V4::Cores.info`
+  - `SPACEX::V4::Cores.info('id')`
+- [Company](#company)
+  - `SPACEX::V4::Company.info`
+- [Crew](#crew)
+  - `SPACEX::V4::Crew.info`
+  - `SPACEX::V4::Crew.info('id')`
+- [Rockets](#rockets)
+  - `SPACEX::V4::Rockets.info`
+  - `SPACEX::V4::Rockets.info('id')`
+
+**Note:**
+Return values encapsulated in `SPACEX::Response` are accessible as attribute methods e.g.
+
+```ruby
+first_rocket.diameter # #<SPACEX::Response feet=5.5 meters=1.68>
+first_rocket.diameter.feet # 5.5
+first_rocket.diameter.meters # 1.68
+```
+
+Return values encapsulated in `Hashie::Array` are accessible as regular arrays e.g.
+
+```ruby
+first_rocket.flickr_images # #<Hashie::Array ["https://imgur.com/DaCfMsj.jpg", "https://imgur.com/azYafd8.jpg"]>
+first_rocket.flickr_images[0] # "https://imgur.com/DaCfMsj.jpg"
+```
+
+**Note:**
+Return values encapsulated in `SPACEX::Response` are accessible as attribute methods e.g.
+```ruby
+first_rocket.diameter # #<SPACEX::Response feet=5.5 meters=1.68>
+first_rocket.diameter.feet # 5.5
+first_rocket.diameter.meters # 1.68
+```
+Return values encapsulated in `Hashie::Array` are accessible as regular arrays e.g.
+```ruby
+first_rocket.flickr_images # #<Hashie::Array ["https://imgur.com/DaCfMsj.jpg", "https://imgur.com/azYafd8.jpg"]>
+first_rocket.flickr_images[0] # "https://imgur.com/DaCfMsj.jpg"
+```
+
+### Capsules
+
+- Get information for all capsules: `SPACEX::V4::Capsules.info`
+- Get information about a specific capsule: `SPACEX::V4::Capsules.info('id')`
+
+**NOTE:** As of v4, the capsules.info uses the capsule's `id` and not `serial` as it did in v3.
+
+
+This example shows how to get capsules information and what the data fields are for that object:
+
+```ruby
+capsules_info = SPACEX::V4::Capsules.info
+
+capsules_info.first.id # '5e9e2c5bf35918ed873b2664'
+capsules_info.first.land_landings # 0
+capsules_info.first.last_update # 'Reentered after three weeks in orbit'
+capsules_info.first.launches # #<Hashie::Array ["5eb87cdeffd86e000604b330"]>
+capsules_info.first.launches.first # '5eb87cdeffd86e000604b330'
+capsules_info.first.reuse_count # 1
+capsules_info.first.serial # 'C101'
+capsules_info.first.status # 'retired'
+capsules_info.first.type # 'Dragon 1.0'
+capsules_info.first.water_landings # 1
+```
+
+### Cores
+
+- Get information for all cores: `SPACEX::V4::Cores.info`
+- Get information about a specific core: `SPACEX::V4::Cores.info('id')`
+
+This example shows how to get cores information and what the data fields are for that object:
+
+```ruby
+cores_info = SPACEX::V4::Cores.info
+cores_info.last.block # 5
+cores_info.last.reuse_count # 0
+cores_info.last.rtls_attempts # 0
+cores_info.last.rtls_landings # 0
+cores_info.last.asds_attempts # 1
+cores_info.last.asds_landings # 1
+cores_info.last.last_update # 'Landed on OCISLY* as of June 3, 2021 '
+cores_info.last.launches # #<Hashie::Array ["5fe3af84b3467846b3242161"]>
+cores_info.last.launches.first # '5fe3af84b3467846b3242161'
+cores_info.last.serial # B1067
+cores_info.last.id # '60b800111f83cc1e59f16438'
+```
+
+### Company
+
+- Get SpaceX company information: `SPACEX::V4::Company.info`
+
+This example shows how to get company information and what the data fields are for that object:
+
+```ruby
+company_info = SPACEX::V4::Company.info
+company_info.name # 'SpaceX'
+company_info.founder # 'Elon Musk'
+company_info.founded # 2002
+company_info.employees # 9500
+company_info.vehicles # 4
+company_info.launch_sites # 3
+company_info.test_sites # 3
+company_info.ceo # 'Elon Musk'
+company_info.cto # 'Elon Musk'
+company_info.coo # 'Gwynne Shotwell'
+company_info.cto_propulsion # 'Tom Mueller'
+company_info.valuation # 74_000_000_000
+company_info.headquarters.address # 'Rocket Road'
+company_info.headquarters.city # 'Hawthorne'
+company_info.headquarters.state # 'California'
+company_info.summary # 'SpaceX designs, manufactures and launches advanced rockets and spacecraft. The company was founded in 2002 to revolutionize space technology, with the ultimate goal of enabling people to live on other planets.'
+company_info.links.website # 'https://www.spacex.com/'
+company_info.links.flickr # 'https://www.flickr.com/photos/spacex/'
+company_info.links.twitter # 'https://twitter.com/SpaceX'
+company_info.links.elon_twitter # 'https://twitter.com/elonmusk'
+company_info.id # '5eb75edc42fea42237d7f3ed'
+### Rockets
+
+- Get information for all rockets: `SPACEX::V4::Rockets.info`
+- Get information about a specific rocket: `SPACEX::V4::Rockets.info('id')`
+
+**NOTE:** As of v4, the rockets.info uses the rocket's `id` and not `rocket_id` as it did in v3.
+
+This example shows how to get rockets information and what the data fields are for that object:
+
+
+```ruby
+rockets = SPACEX::V4::Rockets.info
+first_rocket = rockets.first
+
+first_rocket.active # false
+first_rocket.boosters # 0
+first_rocket.company # "SpaceX"
+first_rocket.cost_per_launch # 6700000
+first_rocket.country # "Republic of the Marshall Islands"
+first_rocket.description # "The Falcon 1 was an expendable launch system privately developed and manufactured by SpaceX during 2006-2009. On 28 September 2008, Falcon 1 became the first privately-developed liquid-fuel launch vehicle to go into orbit around the Earth."
+first_rocket.diameter # #<SPACEX::Response feet=5.5 meters=1.68>
+first_rocket.diameter.feet # 5.5
+first_rocket.diameter.meters # 1.68
+first_rocket.engines # #<SPACEX::Response engine_loss_max=0 isp=#<SPACEX::Response sea_level=267 vacuum=304> layout="single" number=1 propellant_1="liquid oxygen" propellant_2="RP-1 kerosene" thrust_sea_level=#<SPACEX::Response kN=420 lbf=94000> thrust_to_weight=96 thrust_vacuum=#<SPACEX::Response kN=480 lbf=110000> type="merlin" version="1C">
+first_rocket.first_flight # "2006-03-24"
+first_rocket.first_stage # #<SPACEX::Response burn_time_sec=169 engines=1 fuel_amount_tons=44.3 reusable=false thrust_sea_level=#<SPACEX::Response kN=420 lbf=94000> thrust_vacuum=#<SPACEX::Response kN=480 lbf=110000>>
+first_rocket.flickr_images # #<Hashie::Array ["https://imgur.com/DaCfMsj.jpg", "https://imgur.com/azYafd8.jpg"]>
+first_rocket.height # #<SPACEX::Response feet=73 meters=22.25>
+first_rocket.id # "5e9d0d95eda69955f709d1eb"
+first_rocket.landing_legs # #<SPACEX::Response material=nil number=0>
+first_rocket.mass # #<SPACEX::Response kg=30146 lb=66460>
+first_rocket.name # "Falcon 1"
+first_rocket.payload_weights # #<Hashie::Array [#<SPACEX::Response id="leo" kg=450 lb=992 name="Low Earth Orbit">]>
+first_rocket.second_stage # #<SPACEX::Response burn_time_sec=378 engines=1 fuel_amount_tons=3.38 payloads=#<SPACEX::Response composite_fairing=#<SPACEX::Response diameter=#<SPACEX::Response feet=4.9 meters=1.5> height=#<SPACEX::Response feet=11.5 meters=3.5>> option_1="composite fairing"> reusable=false thrust=#<SPACEX::Response kN=31 lbf=7000>>
+first_rocket.stages # 2
+first_rocket.success_rate_pct # 40
+first_rocket.type # "rocket"
+first_rocket.wikipedia # "https://en.wikipedia.org/wiki/Falcon_1"
+```
+
+### Crew
+- Get information for all crew: `SPACEX::V4::Crew.info`
+- Get information about a specific crew member: `SPACEX::V4::Crew.info('id')`
+
+ This example shows how to get crew members information and what the data fields are for that object:
+
+ ```ruby
+crew_members = SPACEX::V4::Crew.info
+first_crew_member = crew_members.first
+
+first_crew_member.agency # "NASA"
+first_crew_member.id # "5ebf1a6e23a9a60006e03a7a"
+first_crew_member.image # "https://imgur.com/0smMgMH.png"
+first_crew_member.launches #  #<Hashie::Array ["5eb87d46ffd86e000604b388"]>
+first_crew_member.name # "Robert Behnken"
+first_crew_member.status # "active"
+first_crew_member.wikipedia # "https://en.wikipedia.org/wiki/Robert_L._Behnken"
+```

data/lib/spacex/base_request.rb

@@ -1,21 +1,21 @@
 module SPACEX
+  BASE_URI = 'https://api.spacexdata.com'.freeze
+
   class Response < Hashie::Mash
     disable_warnings
   end
 
   module BaseRequest
     class << self
-      def info(path, klass = nil, params = {})
-        response_body = get(path, params).body
+      def info(path, klass = nil)
+        response_body = get(path).body
         process(response_body, klass)
       end
 
       private
 
-      def get(path, params)
-        conn(path).get do |req|
-          req.params = params
-        end
+      def get(path)
+        conn(path).get
       end
 
       def process(response_body, klass)
@@ -42,12 +42,12 @@ module SPACEX
 
       def conn(path)
         Faraday.new(
-          url: "#{SPACEX::ENDPOINT_URI}/#{path}",
+          url: "#{SPACEX::BASE_URI}/v4/#{path}",
           request: {
             params_encoder: Faraday::FlatParamsEncoder
           }
         ) do |connection|
-          connection.use ::FaradayMiddleware::ParseJson
+          connection.response :json
           connection.use Faraday::Response::RaiseError
           connection.adapter ::Faraday.default_adapter
         end

data/lib/spacex/capsules.rb

@@ -1,19 +1,17 @@
 module SPACEX
-  class Capsules < Hashie::Trash
-    include Hashie::Extensions::IgnoreUndeclared
-
-    property 'capsule_serial'
-    property 'capsule_id'
+  class Capsules < SPACEX::Resource
+    property 'id'
+    property 'land_landings'
+    property 'last_update'
+    property 'launches'
+    property 'reuse_count'
+    property 'serial'
     property 'status'
-    property 'original_launch'
-    property 'original_launch_unix'
-    property 'missions'
-    property 'landings'
     property 'type'
-    property 'details'
+    property 'water_landings'
 
-    def self.info(capsule_serial = nil)
-      SPACEX::BaseRequest.info("capsules/#{capsule_serial}", SPACEX::Capsules)
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("capsules/#{id}", SPACEX::Capsules)
     end
   end
 end

data/lib/spacex/company.rb

@@ -0,0 +1,7 @@
+module SPACEX
+  module Company
+    def self.info
+      SPACEX::BaseRequest.info('company')
+    end
+  end
+end

data/lib/spacex/cores.rb

@@ -1,22 +1,19 @@
 module SPACEX
-  class Cores < Hashie::Trash
-    include Hashie::Extensions::IgnoreUndeclared
-
-    property 'core_serial'
+  class Cores < SPACEX::Resource
+    property 'asds_attempts'
+    property 'asds_landings'
     property 'block'
-    property 'status'
-    property 'original_launch'
-    property 'original_launch_unix'
-    property 'missions'
+    property 'id'
+    property 'last_update'
+    property 'launches'
+    property 'reuse_count'
     property 'rtls_attempts'
     property 'rtls_landings'
-    property 'asds_attempts'
-    property 'asds_landings'
-    property 'water_landing'
-    property 'details'
+    property 'serial'
+    property 'status'
 
-    def self.info(core_serial = nil)
-      SPACEX::BaseRequest.info("cores/#{core_serial}", SPACEX::Cores)
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("cores/#{id}", SPACEX::Cores)
     end
   end
 end

data/lib/spacex/crew.rb

@@ -0,0 +1,15 @@
+module SPACEX
+  class Crew < SPACEX::Resource
+    property 'agency'
+    property 'id'
+    property 'image'
+    property 'launches'
+    property 'name'
+    property 'status'
+    property 'wikipedia'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("crew/#{id}", SPACEX::Crew)
+    end
+  end
+end

data/lib/spacex/{dragon_capsules.rb → dragons.rb}

@@ -1,33 +1,31 @@
 module SPACEX
-  class DragonCapsules < Hashie::Trash
-    include Hashie::Extensions::IgnoreUndeclared
-
-    property 'capsule_id', from: 'id'
-    property 'name'
-    property 'type'
+  class Dragons < SPACEX::Resource
     property 'active'
     property 'crew_capacity'
-    property 'sidewall_angle_deg'
-    property 'orbit_duration_yr'
+    property 'description'
+    property 'diameter'
     property 'dry_mass_kg'
     property 'dry_mass_lb'
     property 'first_flight'
+    property 'flickr_images'
     property 'heat_shield'
-    property 'thrusters'
+    property 'height_w_trunk'
+    property 'id'
     property 'launch_payload_mass'
     property 'launch_payload_vol'
+    property 'name'
+    property 'orbit_duration_yr'
+    property 'pressurized_capsule'
     property 'return_payload_mass'
     property 'return_payload_vol'
-    property 'pressurized_capsule'
+    property 'sidewall_angle_deg'
+    property 'thrusters'
     property 'trunk'
-    property 'height_w_trunk'
-    property 'diameter'
-    property 'flickr_images'
+    property 'type'
     property 'wikipedia'
-    property 'description'
 
-    def self.info(dragon_id = nil)
-      SPACEX::BaseRequest.info("dragons/#{dragon_id}", SPACEX::DragonCapsules)
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("dragons/#{id}", SPACEX::Dragons)
     end
   end
 end

data/lib/spacex/history.rb

@@ -1,7 +1,14 @@
 module SPACEX
-  module History
+  class History < SPACEX::Resource
+    property 'details'
+    property 'event_date_unix'
+    property 'event_date_utc'
+    property 'id'
+    property 'links'
+    property 'title'
+
     def self.info(id = nil)
-      SPACEX::BaseRequest.info("history/#{id}")
+      SPACEX::BaseRequest.info("history/#{id}", SPACEX::History)
     end
   end
 end

data/lib/spacex/landpads.rb

@@ -0,0 +1,23 @@
+module SPACEX
+  class Landpads < SPACEX::Resource
+    property 'details'
+    property 'full_name'
+    property 'id'
+    property 'images'
+    property 'landing_attempts'
+    property 'landing_successes'
+    property 'latitude'
+    property 'launches'
+    property 'locality'
+    property 'longitude'
+    property 'name'
+    property 'region'
+    property 'status'
+    property 'type'
+    property 'wikipedia'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("landpads/#{id}", SPACEX::Landpads)
+    end
+  end
+end

data/lib/spacex/launches.rb

@@ -1,27 +1,51 @@
 module SPACEX
-  module Launches
-    def self.info(flight_number = nil)
-      SPACEX::BaseRequest.info("launches/#{flight_number}")
+  class Launches < SPACEX::Resource
+    property 'auto_update'
+    property 'capsules'
+    property 'cores'
+    property 'crew'
+    property 'date_local'
+    property 'date_precision'
+    property 'date_unix'
+    property 'date_utc'
+    property 'details'
+    property 'failures'
+    property 'fairings'
+    property 'flight_number'
+    property 'id'
+    property 'launch_library_id'
+    property 'launchpad'
+    property 'links'
+    property 'name'
+    property 'net'
+    property 'payloads'
+    property 'rocket'
+    property 'ships'
+    property 'static_fire_date_unix'
+    property 'static_fire_date_utc'
+    property 'success'
+    property 'tbd'
+    property 'upcoming'
+    property 'window'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("launches/#{id}", SPACEX::Launches)
     end
 
     def self.latest
-      SPACEX::BaseRequest.info('launches/latest')
+      SPACEX::BaseRequest.info('launches/latest', SPACEX::Launches)
     end
 
     def self.next
-      SPACEX::BaseRequest.info('launches/next')
+      SPACEX::BaseRequest.info('launches/next', SPACEX::Launches)
     end
 
     def self.past
-      SPACEX::BaseRequest.info('launches/past')
+      SPACEX::BaseRequest.info('launches/past', SPACEX::Launches)
     end
 
     def self.upcoming
-      SPACEX::BaseRequest.info('launches/upcoming')
-    end
-
-    def self.all
-      info
+      SPACEX::BaseRequest.info('launches/upcoming', SPACEX::Launches)
     end
   end
 end

data/lib/spacex/launchpads.rb

@@ -0,0 +1,23 @@
+module SPACEX
+  class Launchpads < SPACEX::Resource
+    property 'details'
+    property 'full_name'
+    property 'id'
+    property 'images'
+    property 'latitude'
+    property 'launch_attempts'
+    property 'launch_successes'
+    property 'launches'
+    property 'locality'
+    property 'longitude'
+    property 'name'
+    property 'region'
+    property 'rockets'
+    property 'status'
+    property 'timezone'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("launchpads/#{id}", SPACEX::Launchpads)
+    end
+  end
+end

data/lib/spacex/models.rb

@@ -0,0 +1,16 @@
+module SPACEX
+  autoload :Capsules,   'spacex/capsules'
+  autoload :Company,    'spacex/company'
+  autoload :Cores,      'spacex/cores'
+  autoload :Crew,       'spacex/crew'
+  autoload :Dragons,    'spacex/dragons'
+  autoload :History,    'spacex/history'
+  autoload :Landpads,   'spacex/landpads'
+  autoload :Launches,   'spacex/launches'
+  autoload :Launchpads, 'spacex/launchpads'
+  autoload :Payloads,   'spacex/payloads'
+  autoload :Roadster,   'spacex/roadster'
+  autoload :Rockets,    'spacex/rockets'
+  autoload :Ships,      'spacex/ships'
+  autoload :Starlink,   'spacex/starlink'
+end

data/lib/spacex/payloads.rb

@@ -1,7 +1,36 @@
 module SPACEX
-  module Payloads
+  class Payloads < SPACEX::Resource
+    property 'apoapsis_km'
+    property 'arg_of_pericenter'
+    property 'customers'
+    property 'dragon'
+    property 'eccentricity'
+    property 'epoch'
+    property 'id'
+    property 'inclination_deg'
+    property 'launch'
+    property 'lifespan_years'
+    property 'longitude'
+    property 'manufacturers'
+    property 'mass_kg'
+    property 'mass_lbs'
+    property 'mean_anomaly'
+    property 'mean_motion'
+    property 'name'
+    property 'nationalities'
+    property 'norad_ids'
+    property 'orbit'
+    property 'periapsis_km'
+    property 'period_min'
+    property 'raan'
+    property 'reference_system'
+    property 'regime'
+    property 'reused'
+    property 'semi_major_axis_km'
+    property 'type'
+
     def self.info(id = nil)
-      SPACEX::BaseRequest.info("payloads/#{id}")
+      SPACEX::BaseRequest.info("payloads/#{id}", SPACEX::Payloads)
     end
   end
 end

data/lib/spacex/rockets.rb

@@ -1,7 +1,30 @@
 module SPACEX
-  module Rockets
-    def self.info(rocket_id = nil)
-      SPACEX::BaseRequest.info("rockets/#{rocket_id}")
+  class Rockets < SPACEX::Resource
+    property 'active'
+    property 'boosters'
+    property 'company'
+    property 'cost_per_launch'
+    property 'country'
+    property 'description'
+    property 'diameter'
+    property 'engines'
+    property 'first_flight'
+    property 'first_stage'
+    property 'flickr_images'
+    property 'height'
+    property 'id'
+    property 'landing_legs'
+    property 'mass'
+    property 'name'
+    property 'payload_weights'
+    property 'second_stage'
+    property 'stages'
+    property 'success_rate_pct'
+    property 'type'
+    property 'wikipedia'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("rockets/#{id}", SPACEX::Rockets)
     end
   end
 end

data/lib/spacex/ships.rb

@@ -1,33 +1,31 @@
 module SPACEX
-  class Ships < Hashie::Trash
-    include Hashie::Extensions::IgnoreUndeclared
-
-    property 'ship_id', from: 'id'
-    property 'ship_name'
-    property 'ship_model'
-    property 'ship_type'
-    property 'roles'
+  class Ships < SPACEX::Resource
+    property 'abs'
     property 'active'
+    property 'course_deg'
+    property 'home_port'
+    property 'id'
+    property 'image'
     property 'imo'
+    property 'last_ais_update'
+    property 'latitude'
+    property 'launches'
+    property 'legacy_id'
+    property 'link'
+    property 'longitude'
+    property 'mass_kg'
+    property 'mass_lbs'
     property 'mmsi'
-    property 'abs'
-    property 'ship_class', from: 'class'
-    property 'weight_lbs'
-    property 'weight_kg'
-    property 'year_built'
-    property 'home_port'
-    property 'status'
+    property 'model'
+    property 'name'
+    property 'roles'
     property 'speed_kn'
-    property 'course_deg'
-    property 'position'
-    property 'successful_landings'
-    property 'attempted_landings'
-    property 'missions'
-    property 'url'
-    property 'image'
+    property 'status'
+    property 'type'
+    property 'year_built'
 
-    def self.info(ship_id = nil)
-      SPACEX::BaseRequest.info("ships/#{ship_id}", SPACEX::Ships)
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("ships/#{id}", SPACEX::Ships)
     end
   end
 end

data/lib/spacex/starlink.rb

@@ -0,0 +1,16 @@
+module SPACEX
+  class Starlink < SPACEX::Resource
+    property 'height_km'
+    property 'id'
+    property 'latitude'
+    property 'launch'
+    property 'longitude'
+    property 'spaceTrack'
+    property 'velocity_kms'
+    property 'version'
+
+    def self.info(id = nil)
+      SPACEX::BaseRequest.info("starlink/#{id}", SPACEX::Starlink)
+    end
+  end
+end

data/lib/spacex/version.rb

@@ -1,5 +1,5 @@
 module SPACEX
-  VERSION = '1.0.2'.freeze
+  VERSION = '2.0.0'.freeze
 
   def self.help
     puts 'https://github.com/rodolfobandeira/spacex'