spacex 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c74162dea1d1f3e802796e8553db4d79ef981ae5
-  data.tar.gz: d2e2ed9cd5efddae48184918de2276a83ee93b07
+  metadata.gz: 507504ea67cb24744c580b4e934916cc37a782b8
+  data.tar.gz: 52fb07cf5aa01a14093c6b4d65a27c2df9797ba6
 SHA512:
-  metadata.gz: 7373aa70e494200d0ebc1600e30c32a02c86f5a53c3479cff303b96025b0b49d9e144038f261afa49a631840b512f27b5301c8e8113c65463cf072de7af051e4
-  data.tar.gz: b547de5a01d4e95368cd2e5c8f3b52b228d8cb28f2fcd7262ce8159921030f7a0c977a2e3d14bb467712a6a06082d734aa24809c9fa904b4c9815f43dcfe7645
+  metadata.gz: 01da7e4f1bc94516207eadbd47f653e185a36197a3c6b4c4903dfd52461ce7bad93f82f0ce610aa97db159710d2a7afeeb1f0164d9615484313891bc18a30fd2
+  data.tar.gz: a20c61675ae70e9d8066d55d21fdb41ff309b819fc1cf754df90014d7f13779537fddeeb3071f73aa68d62818627b457b627e6aca0721e8d5939243a49ea8a0d

data/.gitignore

@@ -50,3 +50,4 @@ Gemfile.lock
 .rvmrc
 
 *.gem
+.byebug_history

data/.rubocop.yml

@@ -5,4 +5,10 @@ AllCops:
 Naming/MethodName:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,39 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-22 09:37:39 -0400 using RuboCop version 0.51.0.
+# on 2018-10-05 18:26:44 -0400 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/AmbiguousOperator:
+# Offense count: 4
+Lint/ParenthesesAsGroupedExpression:
   Exclude:
-    - 'spec/spacex/launches_spec.rb'
+    - 'spec/spacex/dragon_capsules_spec.rb'
+    - 'spec/spacex/ships_spec.rb'
 
-# Offense count: 5
+# Offense count: 13
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 71
+  Max: 100
 
-# Offense count: 26
+# Offense count: 42
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 494
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 11
-
-# Offense count: 5
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/spacex/base_request.rb'
-    - 'lib/spacex/company_info.rb'
-    - 'lib/spacex/launches.rb'
-    - 'lib/spacex/roadster.rb'
-    - 'lib/spacex/version.rb'

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+### 0.0.7 (2018/10/07)
+
+* Your contribution here.
+* Refactor responses getting multiple objects like Ships, Capsules to wrap a specific object. This helps translating specific properties like `id` and `class` to `ship_id`, `ship_class` - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* Add ability to retrieve specific Ship via `.info('ship_id')` - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* Add ability to retrieve specific Dragon Capsule via `.info('dragon_id')` - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* [#10](https://github.com/rodolfobandeira/spacex/pull/10): Added Ships information - [@zainalmustofa](https://github.com/zainalmustofa).
+* [#9](https://github.com/rodolfobandeira/spacex/pull/9): Added Dragon Capsules information - [@JackieCalapristi](https://github.com/JackieCalapristi).
+* [#16](https://github.com/rodolfobandeira/spacex/pull/16): Added missions information - [@maiafernando](https://github.com/maiafernando).
+
+### 0.0.6 (2018/08/22)
+
+* Added Roadster information - [@rodolfobandeira](https://github.com/rodolfobandeira).
+
+### 0.0.5 (2018/08/21)
+
+* Added Company information and General Refactors - [@rodolfobandeira](https://github.com/rodolfobandeira).
+
+### 0.0.4 (2018/08/21)
+
+* Initial public release - [@rodolfobandeira](https://github.com/rodolfobandeira).
+

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## How to Contribute with the SPACEX gem?
+
+### Fork the repository
+
+```
+git clone https://github.com/rodolfobandeira/spacex.git
+cd spacex
+git remote add upstream https://github.com/rodolfobandeira/spacex.git
+bundle install
+```
+
+### Write test
+
+We use `rspec`. After writing your test, you can run using: 
+
+`bundle exec rspec`
+
+
+### Write your code
+
+Write your code to make your tests pass. After that, make sure you run `Rubocop`.
+
+`bundle exec rubocop`
+
+Sometimes errors could be fixed by running:
+
+`bundle exec rubocop -a`
+
+### Update the Changelog with the description of your code and your name
+
+Update the Changelog with the description of your code and your name on the line after `"* Your contribution here"`
+
+### Push your change and open a pull request.
+
+Thank you!

data/Gemfile

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
 source 'http://rubygems.org'
-
+group :test do
+  gem 'byebug'
+end
 gemspec

data/README.md

@@ -11,10 +11,20 @@ Ruby library that consumes SpaceX API
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Latest Launch](#latest-launch)
-  - [Company Info](#company-info)
-  - [Roadster](#roadster)
-- [Contributing](#contributing)
+  - [Latest Launch](#latest-launch) - `SPACEX::Launches.latest`
+  - [Company Info](#company-info) - `SPACEX::CompanyInfo.info`
+  - [Roadster](#roadster) - `SPACEX::Roadster.info`
+  - [Dragon Capsules](#dragon-capsules)
+    - `SPACEX::DragonCapsules.info`
+    - `SPACEX::DragonCapsules.info('dragon_id')`
+  - [Ships](#ships)
+    - `SPACEX::Ships.info`
+    - `SPACEX::Ships.info('ship_id')`
+  - [Missions](#missions)
+    - `SPACEX::Missions.info`
+    - `SPACEX::Missions.info('mission_id')`
+- [Contributing](#contributing) 
+  - [Contributors / Changelog](#contributors)
 - [Copyright](#copyright)
 
 
@@ -157,14 +167,120 @@ roadster.wikipedia # 'https://en.wikipedia.org/wiki/Elon_Musk%27s_Tesla_Roadster
 roadster.details # "Elon Musk's Tesla Roadster is an electric sports car that served as the dummy payload for the February 2018 Falcon Heavy test flight and is now an artificial satellite of the Sun. Starman, a mannequin dressed in a spacesuit, occupies the driver's seat. The car and rocket are products of Tesla and SpaceX, both companies founded by Elon Musk. This 2008-model Roadster was previously used by Musk for commuting, and is the only consumer car sent into space."
 ```
 
+### Dragon Capsules
+
+- `SPACEX::DragonCapsules.info` Retrieve all Dragon Capsules;
+- `SPACEX::DragonCapsules.info('dragon_id')` Retrieve a specific dragon capsule. Ex: `dragon1`
+
+
+```ruby
+dragon_capsules = SPACEX::DragonCapsules.info
+
+dragon_capsules.first.capsule_id # "dragon1"
+dragon_capsules.first.name # "Dragon 1"
+dragon_capsules.first.type # "capsule"
+dragon_capsules.first.active # true
+dragon_capsules.first.crew_capacity # 0
+dragon_capsules.first.sidewall_angle_deg # 15
+dragon_capsules.first.orbit_duration_yr # 2
+dragon_capsules.first.dry_mass_kg # 4200
+dragon_capsules.first.dry_mass_lb # 9300
+dragon_capsules.first.first_flight # "2010-12-08"
+dragon_capsules.first.heat_shield['material'] # "PICA-X"
+dragon_capsules.first.heat_shield['size_meters'] # 3.6
+dragon_capsules.first.heat_shield['temp_degrees'] # 3000
+dragon_capsules.first.heat_shield['dev_partner'] # "NASA"
+dragon_capsules.first.thrusters[0]['type'] # "Draco"
+dragon_capsules.first.thrusters[0]['amount'] # 18
+dragon_capsules.first.thrusters[0]['pods'] # 4
+dragon_capsules.first.thrusters[0]['fuel_1'] # "nitrogen tetroxide"
+dragon_capsules.first.thrusters[0]['fuel_2'] # "monomethylhydrazine"
+dragon_capsules.first.thrusters[0]['thrust']['kN'] # 0.4
+dragon_capsules.first.thrusters[0]['thrust']['lbf'] # 90
+dragon_capsules.first.launch_payload_mass['kg'] # 6000
+dragon_capsules.first.launch_payload_mass['lb'] # 13228
+dragon_capsules.first.launch_payload_vol['cubic_meters'] # 25
+dragon_capsules.first.launch_payload_vol['cubic_feet'] # 883
+dragon_capsules.first.return_payload_mass['kg'] # 3000
+dragon_capsules.first.return_payload_mass['lb'] # 6614
+dragon_capsules.first.return_payload_vol['cubic_meters'] # 11
+dragon_capsules.first.return_payload_vol['cubic_feet'] # 388
+dragon_capsules.first.pressurized_capsule['payload_volume']['cubic_meters']) # 11
+dragon_capsules.first.pressurized_capsule['payload_volume']['cubic_feet'] # 388
+dragon_capsules.first.trunk['trunk_volume['cubic_meters'] # 14
+dragon_capsules.first.trunk['trunk_volume['cubic_feet'] # 494
+dragon_capsules.first.trunk['cargo']['solar_array'] # 2
+dragon_capsules.first.trunk['cargo']['unpressurized_cargo'] # true
+dragon_capsules.first.height_w_trunk['meters'] # 7.2
+dragon_capsules.first.height_w_trunk['feet'] # 23.6
+dragon_capsules.first.diameter['meters'] # 3.7
+dragon_capsules.first.diameter['feet'] # 12
+dragon_capsules.first.wikipedia # "https://en.wikipedia.org/wiki/SpaceX_Dragon"
+dragon_capsules.first.description # "Dragon is a reusable spacecraft developed by SpaceX, an American private space transportation company based in Hawthorne, California. Dragon is launched into space by the SpaceX Falcon 9 two-stage-to-orbit launch vehicle. The Dragon spacecraft was originally designed for human travel, but so far has only been used to deliver cargo to the International Space Station (ISS)."
+```
+
+### Ships
+
+- `SPACEX::Ships.info` Retrieve all Ships;
+- `SPACEX::Ships.info('ship_id')` Retrieve a specific ship. Ex: `AMERICANCHAMPION`
+
+```ruby
+ship = SPACEX::Ships.info('AMERICANCHAMPION')
+
+ship.ship_id # 'AMERICANCHAMPION'
+ship.ship_name # 'American Champion'
+ship.ship_model # nil
+ship.ship_type # 'Tug'
+ship.roles # ['Support Ship', 'Barge Tug']
+ship.active # false
+ship.imo # 7_434_016
+ship.mmsi # 367_020_820
+ship.abs # 571_252
+ship.ship_class # 7_604_342 # Call as array since "class" is a method in Ruby
+ship.weight_lbs # 588_000
+ship.weight_kg # 266_712
+ship.year_built # 1976
+ship.home_port # 'Port of Los Angeles'
+ship.status # 'Stopped'
+ship.speed_kn # 0
+ship.course_deg # nil
+ship.position # ({ 'latitude' => 30.52852, 'longitude' => -88.09869 })
+ship.successful_landings # nil
+ship.attempted_landings # nil
+ship.missions # [{ 'flight' => 7, 'name' => 'COTS 1' }, { 'flight' => 8, 'name' => 'COTS 2' }]
+ship.url # 'https://www.marinetraffic.com/en/ais/details/ships/shipid:434663/vessel:AMERICAN%20CHAMPION'
+ship.image # 'https://i.imgur.com/woCxpkj.jpg'
+```
+
+### Missions
+
+- `SPACEX::Missions.info` Retrieve all Missions;
+- `SPACEX::Missions.info('mission_id')` Retrieve a specific mission. Ex: `F3364BF`
+
+```ruby
+missions = SPACEX::Missions.info
+
+missions.first.mission_id # "F3364BF"
+missions.first.mission_name # "Iridium NEXT"
+missions.first.manufacturers # ["Orbital ATK"]
+missions.first.payload_ids # ["Iridium NEXT 1", "Iridium NEXT 2", "Iridium NEXT 3", "Iridium NEXT 4", "Iridium NEXT 5", "Iridium NEXT 6", "Iridium NEXT 7"]
+missions.first.wikipedia # "https://en.wikipedia.org/wiki/Iridium_satellite_constellation"
+missions.first.website # "https://www.iridiumnext.com/"
+missions.first.twitter # "https://twitter.com/IridiumBoss?lang=en"
+missions.first.description # "In 2017, Iridium began launching Iridium NEXT, a second-generation worldwide network of telecommunications satellites, consisting of 66 active satellites, with another nine in-orbit spares and six on-ground spares. These satellites will incorporate features such as data transmission that were not emphasized in the original design. The constellation will provide L-band data speeds of up to 128 kbit/s to mobile terminals, up to 1.5 Mbit/s to Iridium Pilot marine terminals, and high-speed Ka-band service of up to 8 Mbit/s to fixed/transportable terminals. The next-generation terminals and service are expected to be commercially available by the end of 2018. However, Iridium's proposed use of its next-generation satellites has raised concerns the service will harmfully interfere with GPS devices. The satellites will incorporate a secondary payload for Aireon, a space-qualified ADS-B data receiver. This is for use by air traffic control and, via FlightAware, for use by airlines. A tertiary payload on 58 satellites is a marine AIS ship-tracker receiver, for Canadian company exactEarth Ltd. Iridium can also be used to provide a data link to other satellites in space, enabling command and control of other space assets regardless of the position of ground stations and gateways."
+```
 
 ## Contributing
 
-Want to help? Create an issue, open a pull request. Any help is welcome.
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Contributors
+
+[Awesome people that already helped this project](CHANGELOG.md).
 
 
 ## Copyright
 
-Copyright (c) Rodolfo Bandeira, 2018
+Copyright (c) 2018, [Rodolfo Bandeira](https://twitter.com/rodolfobandeira) and [Contributors](CHANGELOG.md).
 
 MIT License, see [LICENSE](https://github.com/rodolfobandeira/spacex/blob/master/LICENSE) for details.

data/lib/spacex.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday_middleware/response_middleware'
@@ -10,3 +8,6 @@ require_relative 'spacex/version'
 require_relative 'spacex/launches'
 require_relative 'spacex/company_info'
 require_relative 'spacex/roadster'
+require_relative 'spacex/dragon_capsules'
+require_relative 'spacex/ships'
+require_relative 'spacex/missions'

data/lib/spacex/base_request.rb

@@ -1,9 +1,23 @@
-# frozen_string_literal: true
+require 'byebug'
 
 module SPACEX
+  class Response < Hashie::Mash
+    disable_warnings
+  end
+
   module BaseRequest
     def self.get(path)
-      data = Faraday.new(
+      data = call_api(path)
+      SPACEX::Response.new(data.get.body)
+    end
+
+    def self.retrieve_all(path)
+      data = call_api(path)
+      data.get.body.map { |k| [k] }
+    end
+
+    def self.call_api(path)
+      Faraday.new(
         url: "#{SPACEX::ROOT_URI}/#{path}",
         request: {
           params_encoder: Faraday::FlatParamsEncoder
@@ -13,7 +27,6 @@ module SPACEX
         c.use Faraday::Response::RaiseError
         c.use Faraday::Adapter::NetHttp
       end
-      Hashie::Mash.new(data.get.body)
     end
   end
 end

data/lib/spacex/company_info.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SPACEX
   module CompanyInfo
     def self.info

data/lib/spacex/dragon_capsules.rb

@@ -0,0 +1,47 @@
+module SPACEX
+  class DragonCapsules < Hashie::Trash
+    include Hashie::Extensions::IgnoreUndeclared
+
+    property 'capsule_id', from: 'id'
+    property 'name'
+    property 'type'
+    property 'active'
+    property 'crew_capacity'
+    property 'sidewall_angle_deg'
+    property 'orbit_duration_yr'
+    property 'dry_mass_kg'
+    property 'dry_mass_lb'
+    property 'first_flight'
+    property 'heat_shield'
+    property 'thrusters'
+    property 'launch_payload_mass'
+    property 'launch_payload_vol'
+    property 'return_payload_mass'
+    property 'return_payload_vol'
+    property 'pressurized_capsule'
+    property 'trunk'
+    property 'height_w_trunk'
+    property 'diameter'
+    property 'flickr_images'
+    property 'wikipedia'
+    property 'description'
+
+    class << self
+      def retrieve_all
+        data = SPACEX::BaseRequest.call_api('dragons')
+        data.get.body.map { |k| SPACEX::DragonCapsules.new(k) }
+      end
+
+      def get(dragon_id = nil)
+        return retrieve_all if dragon_id.nil?
+
+        data = SPACEX::BaseRequest.get("dragons/#{dragon_id}")
+        SPACEX::DragonCapsules.new(data)
+      end
+
+      def info(dragon_id = nil)
+        get(dragon_id)
+      end
+    end
+  end
+end

data/lib/spacex/endpoint.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SPACEX
-  ENDPOINT = 'https://api.spacexdata.com/v2/'
+  ENDPOINT = 'https://api.spacexdata.com/v3/'.freeze
 end

data/lib/spacex/launches.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module SPACEX
   module Launches
     def self.latest

data/lib/spacex/missions.rb

@@ -0,0 +1,32 @@
+module SPACEX
+  class Missions < Hashie::Trash
+    include Hashie::Extensions::IgnoreUndeclared
+
+    property 'mission_id'
+    property 'mission_name'
+    property 'manufacturers'
+    property 'payload_ids'
+    property 'wikipedia'
+    property 'website'
+    property 'twitter'
+    property 'description'
+
+    class << self
+      def retrieve_all
+        data = SPACEX::BaseRequest.call_api('missions')
+        data.get.body.map { |k| SPACEX::Missions.new(k) }
+      end
+
+      def get(mission_id = nil)
+        return retrieve_all if mission_id.nil?
+
+        data = SPACEX::BaseRequest.get("missions/#{mission_id}")
+        SPACEX::Missions.new(data)
+      end
+
+      def info(mission_id = nil)
+        get(mission_id)
+      end
+    end
+  end
+end