sarskov 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b759afa44875ac51d7ade86700b311b0cda27e43befa0752bad17c9c940274
-  data.tar.gz: 1765644c983fb48dfd2e6af128c9333ea53c6aee55e4d0fed88d757f92aef486
+  metadata.gz: 26a2b62614552ad3d4af0cf328f2c0e6e703d5117a404ed8e909651c07db6b6c
+  data.tar.gz: c02352ceedee2c9022621d445dcfecb7fff132db5689a82be6da6b1741ba14c8
 SHA512:
-  metadata.gz: fe4aa1a5d6545ab6a74469e29e50bfefb97a9e460f0bfa6afe9ee482483065b3f596cac2c83dc6543ac0c98b0ddfd6c5952bb42dc468f95a88632afa0be25230
-  data.tar.gz: ce0581b737a0949913788fad7ec1af32878b72690adb3c06420c1048a29e88de6ef0d30dfcba407f179f605bb1761dc1b847da769a2d7c08df93b9b935227ea0
+  metadata.gz: d4d7c6db37b5106ed90b2a533dbdd8338f501c337338fc6c97df850f3ab5bdbc30a53c600015577d86e853153f4d4051b27757ef91bad04622d4d21790dbbaab
+  data.tar.gz: f2b4578e5908a3e3e20a022b6f6cdd7eb55c515130edf9fedd8f279c581eda9809c8c4a5797b6d1ab33671331530a22eadc9ad1acb29357cffdb52091acbb7a8

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sarskov.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    sarskov (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sarskov!
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -1,38 +1,300 @@
-# Sarskov
+# 😷 Sarskov
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sarskov`. To experiment with that code, run `bin/console` for an interactive prompt.
+Sarskov returns JSON formated statistics on COVID-19.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile: `gem 'sarskov'`. And then execute: `bundle install`. Or install it yourself as: `gem install sarskov`.
+
+## Usage
+### FETCHING
+🧫 Fetching country data
 
 ```ruby
-gem 'sarskov'
+Sarskov::Request.check("ghana")
 ```
+returns:
 
-And then execute:
+```json
+{
+  "country": "Ghana",
+  "countryInfo": {
+    "_id": 288,
+    "iso2": "GH",
+    "iso3": "GHA",
+    "lat": 8,
+    "long": -2,
+    "flag": "https://raw.githubusercontent.com/NovelCOVID/API/master/assets/flags/gh.png"
+  },
+  "cases": 195,
+  "todayCases": 0,
+  "deaths": 5,
+  "todayDeaths": 0,
+  "recovered": 31,
+  "active": 159,
+  "critical": 1,
+  "casesPerOneMillion": 6,
+  "deathsPerOneMillion": 0.2,
+  "updated": 1585805640451
+}
+```
 
-    $ bundle install
+🧫 Fetch world stats:
 
-Or install it yourself as:
+```ruby
+Sarskov::Request.world
+```
+returns:
 
-    $ gem install sarskov
+```json
+{
+  "cases": 955136,
+  "deaths": 48578,
+  "recovered": 203011,
+  "updated": 1585831890796,
+  "active": 703547,
+  "affectedCountries": 205
+}
+```
 
-## Usage
+🧫 Fetch Fetch aggregated data on Africa (all 57 states):
+
+```ruby
+Sarskov::Request.africa
+```
+returns:
+
+```json
+{
+  "cases": 6547,
+  "todayCases": 164,
+  "deaths": 244,
+  "todayDeaths": 8,
+  "recovered": 524,
+  "active": 5779,
+  "critical": 30,
+  "casesPerOneMillion": 520.4,
+  "deathsPerOneMillion": 15.7,
+  "updated": 77706080976400
+}
+```
+
+🧫 Fetch Fetch aggregated data on Europe (all 45 states):
 
-TODO: Write usage instructions here
+```ruby
+Sarskov::Request.europe
+```
+returns:
+
+```json
+{
+  "cases": 507309,
+  "todayCases": 20179,
+  "deaths": 35362,
+  "todayDeaths": 1716,
+  "recovered": 85480,
+  "active": 386467,
+  "critical": 24246,
+  "casesPerOneMillion": 49194,
+  "deathsPerOneMillion": 2054.3,
+  "updated": 68191050652346
+}
+```
+
+
+🧫 Fetch aggregated data on The EU (all 28 states):
+```ruby
+Sarskov::Request.eu
+```
+returns:
+
+```json
+{
+  "cases": 426951,
+  "todayCases": 0,
+  "deaths": 30612,
+  "todayDeaths": 0,
+  "recovered": 75010,
+  "active": 321329,
+  "critical": 23062,
+  "casesPerOneMillion": 18769,
+  "deathsPerOneMillion": 813.2,
+  "updated": 42816752292016
+}
+```
+
+🧫 Fetch Fetch aggregated data on Asia (all 53 states):
+```ruby
+Sarskov::Request.asia
+```
+returns:
+
+```json
+{
+  "cases": 191871,
+  "todayCases": 5005,
+  "deaths": 7602,
+  "todayDeaths": 188,
+  "recovered": 103818,
+  "active": 80451,
+  "critical": 5942,
+  "casesPerOneMillion": 4077.5000000000005,
+  "deathsPerOneMillion": 68.96000000000001,
+  "updated": 71362727427057
+}
+```
+
+🧫 Fetch Fetch aggregated data on South America (all 15 states):
+```ruby
+Sarskov::Request.sa
+```
+returns:
+
+```json
+{
+  "cases": 16212,
+  "todayCases": 512,
+  "deaths": 444,
+  "todayDeaths": 22,
+  "recovered": 1075,
+  "active": 14693,
+  "critical": 548,
+  "casesPerOneMillion": 757,
+  "deathsPerOneMillion": 15.700000000000001,
+  "updated": 17444222259947
+}
+```
+
+
+🧫 Fetching state data 🇺🇸
+```ruby
+Sarskov::Request.state("ohio")
+```
+returns:
+
+```json
+{
+  "state": "Ohio",
+  "cases": 2547,
+  "todayCases": 0,
+  "deaths": 65,
+  "todayDeaths": 0,
+  "active": 2482
+}
+```
+
+### COMPARING
+🧫 Country Comparison
+```ruby
+Sarskov::Request.compare_countries("poland", "ghana", "iran")
+```
+returns an array of hashes sorted in DESC of number of cases:
+
+```json
+[
+  {
+    "country": "Iran",
+    "countryInfo": {
+      "_id": 364,
+      "iso2": "IR",
+      "iso3": "IRN",
+      "lat": 32,
+      "long": 53,
+      "flag": "https://raw.githubusercontent.com/NovelCOVID/API/master/assets/flags/ir.png"
+    },
+    "cases": 47593,
+    "todayCases": 0,
+    "deaths": 3036,
+    "todayDeaths": 0,
+    "recovered": 15473,
+    "active": 29084,
+    "critical": 3871,
+    "casesPerOneMillion": 567,
+    "deathsPerOneMillion": 36,
+    "updated": 1585805640441
+  },
+  {
+    "country": "Poland",
+    "countryInfo": {
+      "_id": 616,
+      "iso2": "PL",
+      "iso3": "POL",
+      "lat": 52,
+      "long": 20,
+      "flag": "https://raw.githubusercontent.com/NovelCOVID/API/master/assets/flags/pl.png"
+    },
+    "cases": 2554,
+    "todayCases": 0,
+    "deaths": 43,
+    "todayDeaths": 0,
+    "recovered": 56,
+    "active": 2455,
+    "critical": 50,
+    "casesPerOneMillion": 67,
+    "deathsPerOneMillion": 1,
+    "updated": 1585805640443
+  },
+  {
+    "country": "Ghana",
+    "countryInfo": {
+      "_id": 288,
+      "iso2": "GH",
+      "iso3": "GHA",
+      "lat": 8,
+      "long": -2,
+      "flag": "https://raw.githubusercontent.com/NovelCOVID/API/master/assets/flags/gh.png"
+    },
+    "cases": 195,
+    "todayCases": 0,
+    "deaths": 5,
+    "todayDeaths": 0,
+    "recovered": 31,
+    "active": 159,
+    "critical": 1,
+    "casesPerOneMillion": 6,
+    "deathsPerOneMillion": 0.2,
+    "updated": 1585805640451
+  }
+]
+```
+
+🧫 State Comparison
+```ruby
+Sarskov::Request.compare_states("maryland", "ohio")
+```
+returns:
+
+```json
+[
+  {
+    "state": "Ohio",
+    "cases": 2547,
+    "todayCases": 0,
+    "deaths": 65,
+    "todayDeaths": 0,
+    "active": 2482
+  },
+  {
+    "state": "Maryland",
+    "cases": 1985,
+    "todayCases": 0,
+    "deaths": 31,
+    "todayDeaths": 0,
+    "active": 1885
+  }
+]
+```
 
 ## 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.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sarskov. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sarskov/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/siaw23/sarskov. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/siaw23/sarskov/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +303,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Sarskov project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sarskov/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Sarskov project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/siaw23/sarskov/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "sarskov"
+require 'bundler/setup'
+require 'sarskov'
 
 # 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.
@@ -10,5 +11,5 @@ require "sarskov"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/sarskov/request.rb

@@ -7,13 +7,115 @@ module Sarskov
 
     BASE_URL = 'https://corona.lmao.ninja/'
     COUNTRIES_PATH = BASE_URL + 'countries/'
+    STATES_PATH =  BASE_URL + 'states/'
+    JHUCSSE_URL = BASE_URL + '/v2/jhucsse'
+
+    SERVER_DOWN = 'Server overwhelmed. Please try again in a moment.'
+
+    EU_ISOS = %w[AT BE BG CY CZ DE DK EE ES FI FR GR HR HU IE IT LT \
+                 LU LV MT NL PL PT RO SE SI SK].freeze
+    EUROPE_ISOS = EU_ISOS + %w[GB IS NO CH MC AD SM VA BA RS ME MK AL\
+                               BY UA RU MD]
+    AFRICA_ISOS = %w[DZ AO BJ BW BF BI CM CV CF TD KM CD CG CI DJ EG \
+                     GQ ER SZ ET GA GM GH GN GW KE LS LR LY MG MW ML MR MU MA MZ NA NE \
+                     NG RW ST SN SC SL SO ZA SS SD TZ TG TN UG ZM ZW EH].freeze
+    SOUTH_AMERICA_ISOS = ['AR' 'BO', 'BV', 'BR', 'CL', 'CO', 'EC', \
+                          'FK', 'GF', 'GY', 'PY', 'PE', 'GS', 'SR', 'UY', 'VE'].freeze
+    ASIA_ISOS = %w[AE AF AM AZ BD BH BN BT CC CN CX GE HK ID IL IN \
+                   IQ IR JO JP KG KH KP KR KW KZ LA LB LK MM MN MO MY NP OM PH PK \
+                   PS QA SA SG SY TH TJ TL TM TR TW UZ VN YE].freeze
 
     class << self
+      ### FETCH METHODS ###
+
       def check(country_name)
         uri = URI("#{COUNTRIES_PATH}#{country_name}")
 
         JSON.parse(Net::HTTP.get(uri))
       end
+
+      def state(state_name)
+        uri = URI(STATES_PATH)
+        states_array = JSON.parse(Net::HTTP.get(uri))
+
+        states_array.select { |sn| sn['state'] == capitalize_words(state_name) }.first
+      end
+
+      def province; end
+
+      ## WORLD ##
+
+      def world
+        uri = URI(BASE_URL + 'all/')
+
+        JSON.parse(Net::HTTP.get(uri))
+      end
+
+      ## CONTINENTS ##
+
+      def africa
+        aggregator(AFRICA_ISOS)
+      end
+
+      def europe
+        aggregator(EUROPE_ISOS)
+      end
+
+      def eu
+        aggregator(EU_ISOS)
+      end
+
+      def sa
+        aggregator(SOUTH_AMERICA_ISOS)
+      end
+
+      def asia
+        aggregator(ASIA_ISOS)
+      end
+
+      ### COMPARE METHODS ###
+
+      # Returns data sorted by 'cases'
+      def compare_countries(*list)
+        list.map do |country|
+          uri = URI(COUNTRIES_PATH + country.to_s)
+
+          JSON.parse(Net::HTTP.get(uri))
+        end.sort_by { |country| -country['cases'] }
+      end
+
+      # Returns an array of hashes containing list of states passed as parameter
+      def compare_states(*states)
+        JSON.parse(Net::HTTP.get(URI(STATES_PATH))).map do |state|
+          state if states.include?(state['state'].downcase)
+        end.compact
+      end
+
+      ### HISTORY ###
+
+      private
+
+      def aggregator(isos)
+        uri = URI(COUNTRIES_PATH)
+        countries_array = JSON.parse(Net::HTTP.get(uri))
+
+        country_array = countries_array.select do |hash|
+          isos.include?(hash['countryInfo']['iso2'])
+        end
+
+        data = country_array.inject do |base, other|
+          base.merge(other) do |key, left, right|
+            left  ||= 0
+            right ||= 0
+
+            left + right unless %w[country countryInfo].include?(key)
+          end
+        end.compact
+      end
+
+      def capitalize_words(string)
+        string.split.map(&:capitalize).join(' ')
+      end
     end
   end
 end

data/lib/sarskov/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sarskov
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/sarskov.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'sarskov/version'
+require 'sarskov/request'
 
 module Sarskov
   class Error < StandardError; end

data/sarskov.gemspec

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 require_relative 'lib/sarskov/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sarskov"
+  spec.name          = 'sarskov'
   spec.version       = Sarskov::VERSION
-  spec.authors       = ["Emmanuel Hayford"]
-  spec.email         = ["siawmensah@gmail.com"]
+  spec.authors       = ['Emmanuel Hayford']
+  spec.email         = ['siawmensah@gmail.com']
 
-  spec.summary       = %q{Sarskov returns statistics on the COVID-19 pandemic in a JSON format.}
-  spec.description   = %q{Sarskov returns statistics on the COVID-19 pandemic in a JSON format.}
-  spec.homepage      = "https://github.com/siaw23/sarskov"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.summary       = 'Sarskov returns statistics on the COVID-19 pandemic in a JSON format.'
+  spec.description   = 'Sarskov returns statistics on the COVID-19 pandemic in a JSON format.'
+  spec.homepage      = 'https://github.com/siaw23/sarskov'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/siaw23/sarskov"
-  spec.metadata["changelog_uri"] = "https://github.com/siaw23/sarskov"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/siaw23/sarskov'
+  spec.metadata['changelog_uri'] = 'https://github.com/siaw23/sarskov'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sarskov
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Emmanuel Hayford
@@ -22,6 +22,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile