explore_mars 0.4.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a796f889c91a18a40ee81414146362fdf7277a7
+  data.tar.gz: 9ace25496a95003b03db4aae4cd21aa2b01ae158
+SHA512:
+  metadata.gz: eca76e01d4e0d0542fca11248840c6c364cc9e52179e08542b0ad38c7e08fad1437788c8ec3bf7bc4a2768632f2288a9e8adbf4a000f9df12a58698ed0415a7f
+  data.tar.gz: e1a067c1386529c6b7a1c9f0af56643528f95cb3380334b098b481e05fc9074699d1130d8ffe9b414b872f7d8882cd999d63004835892f32934b10f03cc0fc0c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+before_install:
+  - gem update --system
+install: "bundle install"
+script: "bundle exec rake"
+
+branches:
+  only:
+    - master
+
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in explore_mars.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris C Cerami
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+[![Gem Version](https://badge.fury.io/rb/explore_mars.svg)](http://badge.fury.io/rb/explore_mars)[![Build Status](https://travis-ci.org/chrisccerami/explore_mars.svg)](https://travis-ci.org/chrisccerami/explore_mars)[![Code Climate](https://codeclimate.com/github/chrisccerami/explore_mars/badges/gpa.svg)](https://codeclimate.com/github/chrisccerami/explore_mars)
+
+# ExploreMars
+
+## Description
+
+While I was attending [Launch Academy](http://www.launchacademy.com/),
+I decided to build a simple API in Rails that would allow myself, other
+developers, researchers, students, or anyone else to more easily access
+photo data from NASA's Mars rover Curiosity. The idea was that by
+surfacing those photos through an API, building apps that took advantage
+of this public resource would become easier.
+
+Since then I decided that to make it even easier, I would build a gem
+that provides a few easy to use methods that access that API for you.
+I have also since added support for the Opportunity rover to the API and
+the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'explore_mars'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install explore_mars
+
+## Usage
+
+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)
+```
+
+you can make a call to the API, which will return a set of ```Photos```.
+The ```rover``` parameter is name of the rover from which you'd like to
+query. The rovers currently available are Curiosity and Opportunity.
+The ```sol``` parameter is the Martian date of the rover's expedition
+during which the photo was taken. The ```camera``` parameter is the
+particular camera on the rover that the photo was taken with. The camera
+argument can be entered as either a string or a symbol and is not case
+sensitive. The cameras are as follows:
+
+### Curiosity's Cameras
+
+  Abbreviation | Camera
+  ------------ | ------------------------------
+   FHAZ        |  Front Hazard Avoidance Camera
+   RHAZ        |  Rear Hazard Avoidance Camera
+   MAST        |  Mast Camera
+   CHEMCAM     |  Chemistry and Camera Complex
+   MAHLI       |  Mars Hand Lens Imager
+   MARDI       |  Mars Descent Imager
+   NAVCAM      |  Navigation Camera
+
+### Opportunity's Cameras
+
+  Abbreviation | Camera
+  ------------ | -----------------------------
+    FHAZ       |  Front Hazard Avoidance Camera
+    RHAZ       |  Rear Hazard Avoidance Camera
+    PANCAM     |  Panoramic Camera
+    NAVCAM     |  Navigation Camera
+    MINITES    |  Miniature Thermal Emission Spectrometer (Mini-TES)
+
+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)
+```
+
+If you would prefer to query by a particular Earth date instead, you can use:
+
+```ruby
+ExploreMars.get_by_date(rover, date, camera)
+```
+
+or
+
+```ruby
+ExploreMars.get_by_date(rover, date)
+```
+
+The date param should be entered as a String, formatted as "yyyy-mm-dd".
+
+
+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.each do |photo|
+  image_tag(photo.src)
+end
+```
+
+# Contributing
+
+If you would like to contribute to ExploreMars, feel free to create a
+pull request. If you'd like to contact me, you can reach me at
+[chrisccerami@gmail.com](mailto:chrisccerami@gmail.com) or on
+Twitter [@chrisccerami](https://twitter.com/chrisccerami).
+
+1. Fork it ( https://github.com/chrisccerami/explore_mars/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r explore_mars -I ./lib"
+end

data/explore_mars.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'explore_mars/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "explore_mars"
+  spec.version       = ExploreMars::VERSION
+  spec.authors       = ["Chris C Cerami"]
+  spec.email         = ["chrisccerami@gmail.com"]
+  spec.date          = '2015-03-25'
+  spec.summary       = "Browse photos from the Mars rover Curiosity"
+  spec.description   = "A gem to find photos from the Curiosity rover. It serves as a Ruby wrapper for the Mars Curiosity API. My intention is to eventually build a similar API for the Opportunity rover, which will also be accessible through this gem."
+  spec.homepage      = "http://rubygems.org/gems/explore_mars"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path  = "lib"
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "valid_attribute"
+end

data/lib/explore_mars.rb

@@ -0,0 +1,39 @@
+# external dependencies
+require "uri"
+require "net/http"
+require "json"
+require 'active_support/time'
+
+# internal dependencies
+require "explore_mars/version"
+require "explore_mars/call"
+require "explore_mars/photo"
+require "explore_mars/sol_query"
+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 "-- 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"
+    puts "-- camera represents the camera with which it was taken, options are:"
+    puts "--- 'FHAZ' (Front Hazard Avoidance Camera)"
+    puts "--- 'RHAZ' (Rear Hazard Avoidance Camera)"
+    puts "--- 'MAST' (Mast Camera)"
+    puts "--- 'CHEMCAM' (Chemistry and Camera Complex)"
+    puts "--- 'NAVCAM' (Navigation Camera)"
+    puts "--- 'MAHLI' (Mars Hand Lens Imager)"
+    puts "--- 'MARDI' (Mars Descent Imager)"
+    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
+  end
+
+  def self.get_by_date(rover, date, camera=nil)
+    DateQuery.new(rover, date, camera).get
+  end
+end

data/lib/explore_mars/call.rb

@@ -0,0 +1,26 @@
+module ExploreMars
+  class Call
+    CAMERAS = ["FHAZ", "RHAZ", "MAST", "CHEMCAM", "NAVCAM", "MAHLI", "MARDI", "PANCAM", "MINITES"]
+    BASE_URI = "https://mars-photos.herokuapp.com/api/v1/rovers/"
+
+    def get
+      check_cameras(@camera)
+      uri = build_uri
+      response = Net::HTTP.get(uri)
+      photos = JSON.parse(response)["photos"]
+      photos.map { |photo|
+        ExploreMars::Photo.new(photo["img_src"], photo["sol"],
+                               photo["camera"]["name"], photo["earth_date"],
+                               @rover)
+      }
+    end
+
+    private
+
+    def check_cameras(camera)
+      if !camera.empty? && !CAMERAS.include?(camera.upcase)
+        raise "Camera argument must be one of #{CAMERAS.join(', ')}"
+      end
+    end
+  end
+end

data/lib/explore_mars/date_query.rb

@@ -0,0 +1,19 @@
+module ExploreMars
+  class DateQuery < Call
+    attr_accessor :date, :camera, :rover
+
+    def initialize(rover, date, camera=nil)
+      @date = date
+      @camera = camera.to_s.upcase
+      @rover = rover
+    end
+
+    def build_uri
+      if !@camera.empty?
+        URI.parse(BASE_URI + "#{@rover}/" + "photos?earth_date=#{@date}&camera=#{@camera}")
+      else
+        URI.parse(BASE_URI + "#{@rover}/" + "photos?earth_date=#{@date}")
+      end
+    end
+  end
+end

data/lib/explore_mars/photo.rb

@@ -0,0 +1,18 @@
+module ExploreMars
+  class Photo
+    require "date"
+    attr_reader :src, :sol, :camera, :earth_date, :rover
+
+    def initialize(src, sol, camera, earth_date, rover)
+      @src = src
+      @sol = sol
+      @camera = camera
+      @earth_date = Date.strptime(earth_date)
+      @rover = rover
+    end
+
+    def to_s
+      @src
+    end
+  end
+end

data/lib/explore_mars/sol_query.rb

@@ -0,0 +1,18 @@
+module ExploreMars
+  class SolQuery < Call
+    attr_accessor :sol, :camera, :rover
+    def initialize(rover, sol, camera=nil)
+      @sol = sol
+      @camera = camera.to_s.upcase
+      @rover = rover
+    end
+
+    def build_uri
+      if !@camera.empty?
+        URI.parse(BASE_URI + "#{@rover}/" + "photos?sol=#{@sol}&camera=#{@camera}")
+      else
+        URI.parse(BASE_URI + "#{@rover}/" + "photos?sol=#{@sol}")
+      end
+    end
+  end
+end

data/lib/explore_mars/version.rb

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

data/spec/call_spec.rb

@@ -0,0 +1,8 @@
+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::CAMERAS).to eq ["FHAZ", "RHAZ", "MAST", "CHEMCAM", "NAVCAM", "MAHLI", "MARDI", "PANCAM", "MINITES"]
+  end
+end

data/spec/explore_mars_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ExploreMars do
+  it 'has a version number' do
+    expect(ExploreMars::VERSION).not_to be nil
+  end
+end

data/spec/photo_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe ExploreMars::Photo do
+  describe "attributes" do
+    let(:photo) { ExploreMars::Photo.new("http://www.image.com", 829, "FHAZ", "2015-6-3", "curiosity") }
+
+    it "should have a src" do
+      expect(photo.src).to eq("http://www.image.com")
+    end
+
+    it "should have a sol" do
+      expect(photo.sol).to eq 829
+    end
+
+    it "should have a camera" do
+      expect(photo.camera).to eq "FHAZ"
+    end
+
+    it "should have an earth_date" do
+      expect(photo.earth_date.class).to eq Date
+      expect(photo.earth_date).to eq Date.strptime("2015-6-3")
+    end
+
+    it "should have a rover" do
+      expect(photo.rover).to eq "curiosity"
+    end
+  end
+
+  describe "to_s" do
+    it "should return the source url" do
+      photo = ExploreMars::Photo.new("http://www.image.com", 829, "FHAZ", "2015-6-3", "curiosity")
+
+      expect(photo.to_s).to eq photo.src
+    end
+  end
+end

data/spec/sol_query_spec.rb

@@ -0,0 +1,27 @@
+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")
+
+      expect(query.rover).to eq "curiosity"
+      expect(query.sol).to eq 940
+      expect(query.camera).to eq "FHAZ"
+    end
+  end
+
+  describe "cameras" do
+    it "should be valid" do
+      expect{
+        ExploreMars::SolQuery.new("curiosity", 940, "FHAZ").get
+      }.not_to raise_error
+
+      expect{
+        ExploreMars::SolQuery.new("curiosity", 940, "Not a camera").get
+      }.to raise_error
+    end
+  end
+
+  describe "sol"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'explore_mars'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: explore_mars
+version: !ruby/object:Gem::Version
+  version: 0.4.4
+platform: ruby
+authors:
+- Chris C Cerami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+    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: valid_attribute
+  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'
+description: A gem to find photos from the Curiosity rover. It serves as a Ruby wrapper
+  for the Mars Curiosity API. My intention is to eventually build a similar API for
+  the Opportunity rover, which will also be accessible through this gem.
+email:
+- chrisccerami@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- explore_mars.gemspec
+- lib/explore_mars.rb
+- lib/explore_mars/call.rb
+- lib/explore_mars/date_query.rb
+- lib/explore_mars/photo.rb
+- lib/explore_mars/sol_query.rb
+- lib/explore_mars/version.rb
+- spec/call_spec.rb
+- spec/date_query_spec.rb
+- spec/explore_mars_spec.rb
+- spec/photo_spec.rb
+- spec/sol_query_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/explore_mars
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Browse photos from the Mars rover Curiosity
+test_files:
+- spec/call_spec.rb
+- spec/date_query_spec.rb
+- spec/explore_mars_spec.rb
+- spec/photo_spec.rb
+- spec/sol_query_spec.rb
+- spec/spec_helper.rb