current_astronauts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea9a0aea97e05539d58cb73ff828f28014117dcd
+  data.tar.gz: 2a54100d6bcc0f91a2e6b8f7a8e4bfebcc9d3c41
+SHA512:
+  metadata.gz: 9e99e0d34009c3a34edb00cb1ed97906ef49c29e966687ad0eca7854bbfec009ac76e4c08d713eda0465589a1e49182785502e8b00ead772767c7904bde1696c
+  data.tar.gz: bc03d5169aad9f363d0d359c8db81198a7a93534d1508cc76f6f16860d79ab17c330a71ed3c55e6b85103c1b3f3ce554a2b5e1ae2ca3a50f805d8f65d330e7fd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.vendor/
+/vendor/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Horton
+
+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,97 @@
+[![CircleCI](https://circleci.com/gh/hortoncd/current_astronauts.svg?style=svg)](https://circleci.com/gh/hortoncd/current_astronauts)
+
+# CurrentAstronauts
+
+Small gem to work with the list of current astronauts in space from http://api.open-notify.org/astros.json.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'current_astronauts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install current_astronauts
+
+## Usage
+
+require the gem, and optionally include the module for simplicity
+```ruby
+require 'current_astronauts'
+
+include CurrentAstronauts
+```
+
+Instantiate an object and fetch data.  If success?, use the data as desired.
+```ruby
+a = Astronauts.new
+a.fetch
+if a.success?
+  # do something here
+end
+```
+
+The URL source defaults to http://api.open-notify.org/astros.json, but if you set ENV['OPEN_NOTIFY_URL'] before instantiating the object, it will use the set URL instead.
+
+```ruby
+ENV['OPEN_NOTIFY_URL']
+a = Astronauts.new
+```
+
+a.data contains the full data as returned in a hash.  There are methods to work with smaller portions of the data.
+
+How many astronauts are currently in space?
+```ruby
+puts "there are currently #{a.num} astronauts currently in space."
+```
+
+Use the 'people' method to work with the list of astronauts and their associated craft.  It is an array of hashes.
+```ruby
+people = a.people
+first = a.people.first
+
+puts "a.people returns a list of people and their associated craft as an #{people.class} of type #{first.class}."
+puts
+puts "#{first['name']} is currently on: #{first['craft']}."
+```
+
+Print a formatted list of astronauts and their associated craft.
+```ruby
+a.print
+```
+
+Formatted list appears as follows.
+
+```
+Name              | Craft
+------------------|-------------
+Anatoly Ivanishin | ISS
+Takuya Onishi     | ISS
+Kate Rubins       | ISS
+Jing Haipeng      | Shenzhou 11
+Chen Dong         | Shenzhou 11
+Sergey Rizhikov   | ISS
+Andrey Borisenko  | ISS
+Shane Kimbrough   | ISS
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hortoncd/current_astronauts.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "current_astronauts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/current_astronauts.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'current_astronauts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "current_astronauts"
+  spec.version       = CurrentAstronauts::VERSION
+  spec.authors       = ["Chris Horton"]
+  spec.email         = ["hortoncd@gmail.com"]
+
+  spec.summary       = %q{Work worth list of astronauts currently in space}
+  spec.description   = %q{Work worth list of astronauts currently in space.  Raw JSON data is available, along with a few methods for accessing specific portions of the data and print out a formatted list.}
+  spec.homepage      = "https://github.com/hortoncd/current_astronauts"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_dependency "httparty", "~> 0.14.0"
+end

data/examples/usage.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'current_astronauts'
+include CurrentAstronauts
+
+a = Astronauts.new
+a.fetch
+if a.success?
+  puts "a is an instance of an #{a.class} class."
+  puts
+  puts "a.data is a #{a.data.class}."
+  puts
+
+  puts "a.num tells you how many astronauts are currently in space (#{a.num})."
+  puts
+
+  # use the list of people and craft as hash
+  people = a.people
+  first = a.people.first
+
+  puts "a.people returns a list of people and their associated craft as an #{people.class} of type #{first.class}."
+  puts
+  puts "#{first['name']} is currently on: #{first['craft']}."
+  puts
+
+  # print out a list of people and craft
+  puts "a.print prints out a formatted list of astronautes and their associated craft."
+  a.print
+else
+  puts "Failed to fetch list of astronauts"
+end

data/fixtures/astros-fail.json

@@ -0,0 +1,6 @@
+{
+  "message": "fail", 
+  "number": 0, 
+  "people": [
+  ]
+}

data/fixtures/astros.json

@@ -0,0 +1,38 @@
+{
+  "message": "success", 
+  "number": 8, 
+  "people": [
+    {
+      "craft": "ISS", 
+      "name": "Anatoly Ivanishin"
+    }, 
+    {
+      "craft": "ISS", 
+      "name": "Takuya Onishi"
+    }, 
+    {
+      "craft": "ISS", 
+      "name": "Kate Rubins"
+    }, 
+    {
+      "craft": "Shenzhou 11", 
+      "name": "Jing Haipeng"
+    }, 
+    {
+      "craft": "Shenzhou 11", 
+      "name": "Chen Dong"
+    }, 
+    {
+      "craft": "ISS", 
+      "name": "Sergey Rizhikov"
+    }, 
+    {
+      "craft": "ISS", 
+      "name": "Andrey Borisenko"
+    }, 
+    {
+      "craft": "ISS", 
+      "name": "Shane Kimbrough"
+    }
+  ]
+}

data/fixtures/astros2.json

@@ -0,0 +1,14 @@
+{
+  "message": "success", 
+  "number": 2, 
+  "people": [
+    {
+      "craft": "ISS", 
+      "name": "Anatoly Ivanishin"
+    }, 
+    {
+      "craft": "Shenzhou 11", 
+      "name": "Jing Haipeng"
+    }
+  ]
+}

data/fixtures/print_output.txt

@@ -0,0 +1,10 @@
+Name              | Craft       
+------------------|-------------
+Anatoly Ivanishin | ISS         
+Takuya Onishi     | ISS         
+Kate Rubins       | ISS         
+Jing Haipeng      | Shenzhou 11 
+Chen Dong         | Shenzhou 11 
+Sergey Rizhikov   | ISS         
+Andrey Borisenko  | ISS         
+Shane Kimbrough   | ISS         

data/lib/current_astronauts.rb

@@ -0,0 +1,77 @@
+require 'current_astronauts/version'
+
+require 'httparty'
+
+module CurrentAstronauts
+  class Astronauts
+    attr_reader :data
+
+    def initialize
+      if ENV['OPEN_NOTIFY_URL']
+        @url = ENV['OPEN_NOTIFY_URL']
+      else
+        @url = 'http://api.open-notify.org/astros.json'
+      end
+      @data = nil
+    end
+
+    # Let's go get some data
+    def fetch
+      response = HTTParty.get(@url)
+      if response.success?
+        @data = response.parsed_response
+      end
+      response.code
+    end
+
+    # Fetch succeeded and data message is 'success'
+    def success?
+      stat = false
+      if @data and @data['message'] == 'success'
+        stat = true
+      end
+      return stat
+    end
+
+    # How many astronauts in space?
+    def num
+      success? ? @data['number'] : nil
+    end
+
+    # List of astronauts and their craft, as an array of hashes
+    def people
+      success? ? @data['people'] : nil
+    end
+
+    # Print a formatted list of astronauts and their craft
+    def print
+      unless success?
+        return nil
+      end
+      nlen = "Name".length
+      clen = "Craft".length
+      @data['people'].each do |p|
+        nlen = p['name'].length > nlen ? p['name'].length : nlen
+        clen = p['craft'].length > clen ? p['craft'].length : clen
+      end
+
+      print_header(nlen, clen)
+      @data['people'].each do |p|
+        print_line(nlen, p['name'], clen, p['craft'])
+      end
+    end
+
+    private
+
+    # print header with appropriate spacing
+    def print_header(nlen, clen)
+      print_line(nlen, "Name", clen, "Craft")
+      puts "%-#{nlen}s-|-%-#{clen}s-" % ["-" * nlen, "-" * clen]
+    end
+
+    # print individual lines with appropriate spacing
+    def print_line(nlen, n, clen, c)
+      puts "%-#{nlen}s | %-#{clen}s " % [n, c]
+    end
+  end
+end

data/lib/current_astronauts/version.rb

@@ -0,0 +1,3 @@
+module CurrentAstronauts
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: current_astronauts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Horton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Work worth list of astronauts currently in space.  Raw JSON data is available,
+  along with a few methods for accessing specific portions of the data and print out
+  a formatted list.
+email:
+- hortoncd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- current_astronauts.gemspec
+- examples/usage.rb
+- fixtures/astros-fail.json
+- fixtures/astros.json
+- fixtures/astros2.json
+- fixtures/print_output.txt
+- lib/current_astronauts.rb
+- lib/current_astronauts/version.rb
+homepage: https://github.com/hortoncd/current_astronauts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Work worth list of astronauts currently in space
+test_files: []