explore_mars 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a796f889c91a18a40ee81414146362fdf7277a7
-  data.tar.gz: 9ace25496a95003b03db4aae4cd21aa2b01ae158
+  metadata.gz: 22c75a285412e6dcd7a67e134b96783a9a8b5a59
+  data.tar.gz: 7204f8cfeb12f2ef82f66f47129508ec7422e2c2
 SHA512:
-  metadata.gz: eca76e01d4e0d0542fca11248840c6c364cc9e52179e08542b0ad38c7e08fad1437788c8ec3bf7bc4a2768632f2288a9e8adbf4a000f9df12a58698ed0415a7f
-  data.tar.gz: e1a067c1386529c6b7a1c9f0af56643528f95cb3380334b098b481e05fc9074699d1130d8ffe9b414b872f7d8882cd999d63004835892f32934b10f03cc0fc0c
+  metadata.gz: 68e9e99fd2d56407a6f2c87752bb0d7405819fea32b13ced6cae83743802daa02d5c82f985e01e834f1d465bcddfa899e609e6208bb231236f1092e9ea7cc30b
+  data.tar.gz: f7c5df361ff475f3a71283f9147d265a2ac61d4b6b3ecdd1b8578eccbeb8a02b030b950d9cd9098887d62a21cb8cb8da103873b47e958c4957ef4b4b0a24d28f

data/README.md

@@ -38,7 +38,13 @@ There are only a few parts to this gem so far, so it's relatively simple
 to use. By calling:
 
 ```ruby
-ExploreMars.get_by_sol(rover, sol, camera)
+ExploreMars.get_by_sol(rover: <ROVER>, sol: <SOL>, camera: <CAMERA>)
+```
+
+For example:
+
+```ruby
+ExploreMars.get_by_sol(rover: "curiosity", sol: 1000, camera: "FHAZ")
 ```
 
 you can make a call to the API, which will return a set of ```Photos```.
@@ -62,7 +68,7 @@ sensitive. The cameras are as follows:
    MARDI       |  Mars Descent Imager
    NAVCAM      |  Navigation Camera
 
-### Opportunity's Cameras
+### Opportunity's and Spirit's Cameras
 
   Abbreviation | Camera
   ------------ | -----------------------------
@@ -75,31 +81,36 @@ sensitive. The cameras are as follows:
 You can also make the API call without providing the camera argument to receive all photos that were taken on a particular sol from all cameras:
 
 ```ruby
-ExploreMars.get(rover, sol)
+ExploreMars.get_by_sol(rover: <ROVER>, sol: <SOL>)
 ```
 
 If you would prefer to query by a particular Earth date instead, you can use:
 
 ```ruby
-ExploreMars.get_by_date(rover, date, camera)
+ExploreMars.get_by_date(rover: <ROVER>, date: <DATE>, camera: <CAMERA>)
 ```
 
 or
 
 ```ruby
-ExploreMars.get_by_date(rover, date)
+ExploreMars.get_by_date(rover: <ROVER>, date: <DATE>)
 ```
 
 The date param should be entered as a String, formatted as "yyyy-mm-dd".
 
+For example:
+
+```ruby
+ExploreMars.get_by_date(rover: "curiosity", date: "2015-12-4")
+```
 
-The ```Photo``` objects that get returned have five main attributes:
-```rover```, ```sol```, ```camera```, ```earth_date```, and ```src```.
-The ```src``` attribute contains the source url of the actual image.
+The `Photo` objects that get returned have five main attributes:
+`rover`, `sol`, `camera`, `earth_date`, and `src`.
+The `src` attribute contains the source url of the actual image.
 In order to display an image in a Rails view for example, I could use:
 
 ```ruby
-photos = ExploreMars::Call.get("curiosity", 869, "FHAZ")
+photos = ExploreMars.get_by_sol("curiosity", 869, "FHAZ")
 
 photos.each do |photo|
   image_tag(photo.src)

data/explore_mars.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "shoulda-matchers"
   spec.add_development_dependency "valid_attribute"
 end

data/lib/explore_mars.rb

@@ -13,8 +13,8 @@ require "explore_mars/date_query"
 
 module ExploreMars
   def self.help
-    puts "- use ExploreMars#get_by_sol(rover, sol, camera) to receive a collection of photos by sol"
-    puts "- use ExploreMars#get_by_date(rover, date, camera) to receive a collection of photos by Earth date"
+    puts "- use ExploreMars#get_by_sol(rover: <ROVER>, sol: <SOL>, camera: <CAMERA>) to receive a collection of photos by sol"
+    puts "- use ExploreMars#get_by_date(rover: <ROVER>, date: <DATE>, camera: <CAMERA>) to receive a collection of photos by Earth date"
     puts "-- rover argument should be the name of one of NASA's Mars rovers"
     puts "-- sol argument should be a number representing the Martian day on which the photo was taken"
     puts "-- date argument should be a string formmated as yyyy-mm-dd"
@@ -29,11 +29,13 @@ module ExploreMars
     puts "- ExploreMars::Photo#src will return the source url for the photo"
   end
 
-  def self.get_by_sol(rover, sol, camera=nil)
-    SolQuery.new(rover, sol, camera).get
+  def self.get_by_sol(params)
+    fail "Rover and Sol are required" if (params[:rover].blank? || params[:sol].blank?)
+    SolQuery.new(params[:rover], params[:sol], params[:camera]).get
   end
 
-  def self.get_by_date(rover, date, camera=nil)
-    DateQuery.new(rover, date, camera).get
+  def self.get_by_date(params)
+    fail "Rover and Date are required" if (params[:rover].blank? || params[:date].blank?)
+    DateQuery.new(params[:rover], params[:date], params[:camera]).get
   end
 end

data/lib/explore_mars/call.rb

@@ -19,7 +19,7 @@ module ExploreMars
 
     def check_cameras(camera)
       if !camera.empty? && !CAMERAS.include?(camera.upcase)
-        raise "Camera argument must be one of #{CAMERAS.join(', ')}"
+        fail "Camera argument must be one of #{CAMERAS.join(', ')}"
       end
     end
   end

data/lib/explore_mars/version.rb

@@ -1,3 +1,3 @@
 module ExploreMars
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/spec/call_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe ExploreMars::Call do
   it "should have proper constants" do
-    expect(ExploreMars::Call::BASE_URI).to eq "https://mars-curiosity-api.herokuapp.com/api/v1/rovers/"
+    expect(ExploreMars::Call::BASE_URI).to eq "https://mars-photos.herokuapp.com/api/v1/rovers/"
     expect(ExploreMars::Call::CAMERAS).to eq ["FHAZ", "RHAZ", "MAST", "CHEMCAM", "NAVCAM", "MAHLI", "MARDI", "PANCAM", "MINITES"]
   end
 end

data/spec/sol_query_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe ExploreMars::SolQuery do
+
   describe "attributes" do
     it "should have a sol and a camera" do
       query = ExploreMars::SolQuery.new("curiosity", 940, "FHAZ")
@@ -12,14 +13,17 @@ describe ExploreMars::SolQuery do
   end
 
   describe "cameras" do
-    it "should be valid" do
+    it "handles a correct Camera" do
       expect{
         ExploreMars::SolQuery.new("curiosity", 940, "FHAZ").get
       }.not_to raise_error
+    end
 
+    it "raises an error when Camera is invalid" do
+      stub_const("CAMERAS", ["FHAZ", "RHAZ", "MAST", "CHEMCAM", "NAVCAM", "MAHLI", "MARDI", "PANCAM", "MINITES"])
       expect{
         ExploreMars::SolQuery.new("curiosity", 940, "Not a camera").get
-      }.to raise_error
+      }.to raise_error("Camera argument must be one of #{CAMERAS.join(', ')}")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: explore_mars
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris C Cerami
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Browse photos from the Mars rover Curiosity