mars_photos 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aad43fc0e661685d7eef95f4094b935c449d4b3
-  data.tar.gz: 5c9fd83e491da06eaa5035ebacbe78c5ad8c331c
+  metadata.gz: a533a53524d6ab2e3f35b6682c8a19cb53449761
+  data.tar.gz: 557be1d304bf8f0c2902f3fa541232a8036281ef
 SHA512:
-  metadata.gz: afdbb5641ad0da567d20853d3e7b5359e31e22fb47e8a0c97c206c0dc0951c5fcb17d9e77215eb19692e712fa933ea5e63737fd0f3b72f9b9aebfcb0bf854f44
-  data.tar.gz: 757f8102538f900ad90c7ce663316a83cab96f8fc759ee810d2a8e152b68f1475ad7fc0c54733c11a4e75ecbd1939acb9e49ec4a15fe935cf7a2660a258d680f
+  metadata.gz: 82d7669f924d2a853bda847c3a42fa4f5b846143e643c9fa3c96a23d46b210522721f9af073a2d422318401ccb99520c3312005493d81c9723a73591bd9f9929
+  data.tar.gz: a57f096949946d4c9eeace474a4c4d9e397b4cb75da76df60d7dd3412522cc6efefbed5805ac42f898d4c86dda820d36fef5b0b9332d8cc7a5f8d8244eafdf18

data/README.md

@@ -16,22 +16,41 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mars-photos
+    $ gem install mars_photos
 
 ## Usage
 
-To retrieve photos by providing the rover, sol and camera, you can use the `get` method on the MarsPhotos module:
+For basic usage, instantiate an API object either with or without an API key (if you don't provide one it will be set to the demo key, which allows for 30 requests per IP address per hour, and a maximum of 50 requests per day). Get an API key from NASA [here](https://api.nasa.gov/index.html#apply-for-an-api-key).
 
 ```ruby
-MarsPhotos.get(rover: 'curiosity', sol: 1000, cam: 'fhaz')
+@api = MarsPhotos::API.new # Sets API key to 'DEMO_KEY'
+@api = MarsPhotos::API.new('YOUR_KEY_HERE')
+```
+
+Retrieve photos by rover and sol like this:
+
+```ruby
+@api.get(rover: 'curiosity', sol: 1000)
 ```
 
 This returns an array of the photos, each with an `img_src` attribute.
 
-You can also call this method with a block:
+You can provide an earth date in the format YYYY-MM-DD instead of a sol:
 
 ```ruby
-MarsPhotos.get(rover: 'curiosity', sol: 1000, cam: 'fhaz') do |photo|
+@api.get(rover: 'curiosity', earth_date: '2015-6-3')
+```
+
+For photos from a specific camera, just specify a `cam` in the method's parameters:
+
+```ruby
+@api.get(rover: 'curiosity', sol: 1000, cam: 'fhaz')
+```
+
+You can call this method with a block:
+
+```ruby
+@api.get(rover: 'curiosity', sol: 1000) do |photo|
   puts photo['img_src']
 end
 ```
@@ -39,11 +58,47 @@ end
 You can also instantiate the Rover class:
 
 ```ruby
-@curiosity = MarsPhotos::Rover.new
+@curiosity = MarsPhotos::Rover.new('curiosity')
 
 @curiosity.get(1000) # retrieves photos taken by curiosity on sol 1000
 ```
 
+### Rovers
+
+Images are available from three rovers:
+
+  Rover        | Landing Date
+  ------------ | ------------------------------
+   Spirit      |  January 4, 2004
+   Opportunity |  January 25, 2004
+   Curiosity   |  August 6, 2012
+
+### Sols
+
+Sol is a time measurement representing the number of Martian solar days since the rover landed. It starts from 0.
+
+### 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 and Spirit'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)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -52,7 +107,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cltweedie/mars-photos.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cltweedie/mars_photos.
 
 ## License
 

data/lib/mars_photos.rb

@@ -1,3 +1,4 @@
 require 'httparty'
 require 'mars_photos/rover'
-require 'mars_photos/mars_photos'
+require 'mars_photos/api'
+require 'mars_photos/mars_photos_calculations'

data/lib/mars_photos/api.rb

@@ -0,0 +1,28 @@
+module MarsPhotos
+  class API
+    attr_reader :key
+
+    def initialize(key='DEMO_KEY')
+      @key = key
+    end
+
+    def get(rover:, sol: nil, earth_date: nil, cam: nil)
+      if sol
+        date = "&sol=#{sol}"
+      elsif earth_date
+        date = "&earth_date=#{earth_date}"
+      else
+        raise "You must provide a sol or earth date"
+      end
+
+      camera = cam ? "&camera=#{cam}" : ""
+
+      response = HTTParty.get("https://api.nasa.gov/mars-photos/api/v1/rovers/#{rover}/photos?api_key=#{@key}#{date}#{camera}")
+
+      if block_given?
+        response['photos'].each { |photo| yield photo }
+      end
+      response['photos']
+    end
+  end
+end

data/lib/mars_photos/mars_photos_calculations.rb

@@ -0,0 +1,8 @@
+module MarsPhotos::Calculations
+  def self.build_url(rover_name, parameter)
+    url_rovers = "https://api.nasa.gov/mars-photos/api/v1/rovers/"
+    key = parameter.keys.first.to_s
+    value = parameter[parameter.keys.first]
+    "#{url_rovers}#{rover_name}/photos?#{key}=#{value}&api_key=DEMO_KEY"
+  end
+end

data/lib/mars_photos/rover.rb

@@ -1,14 +1,14 @@
 module MarsPhotos
-	class Rover
-		attr_accessor :name
+  class Rover
+    attr_accessor :name
+    def initialize(name)
+      @name = name
+    end
 
-		def initialize(name)
-			self.name = name
-		end
-
-		def get(sol)
-			response = HTTParty.get("https://api.nasa.gov/mars-photos/api/v1/rovers/#{self.name}/photos?sol=#{sol}&api_key=DEMO_KEY")
+    def get(parameter = {})
+      url = MarsPhotos::Calculations.build_url(name, parameter)
+      response = HTTParty.get(url)
       response['photos']
-		end
-	end
+    end
+  end
 end

data/lib/mars_photos/version.rb

@@ -1,3 +1,3 @@
 module MarsPhotos
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/mars_photos.gemspec

@@ -30,6 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
 
   spec.add_dependency "httparty"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mars_photos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Tweedie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: webmock
+  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: vcr
+  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: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +128,8 @@ files:
 - bin/console
 - bin/setup
 - lib/mars_photos.rb
-- lib/mars_photos/mars_photos.rb
+- lib/mars_photos/api.rb
+- lib/mars_photos/mars_photos_calculations.rb
 - lib/mars_photos/rover.rb
 - lib/mars_photos/version.rb
 - mars_photos.gemspec

data/lib/mars_photos/mars_photos.rb

@@ -1,9 +0,0 @@
-module MarsPhotos
-  def self.get(rover:, sol:, cam:)
-    response = HTTParty.get("https://api.nasa.gov/mars-photos/api/v1/rovers/#{rover}/photos?sol=#{sol}&camera=#{cam}&api_key=DEMO_KEY")
-    if block_given?
-      response['photos'].each { |photo| yield photo }
-    end
-    response['photos']
-  end
-end