altadata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba3bd8d384a691b9367ca59cd75fc5f8c373dc92ac7b12b731272a932f3ef66e
+  data.tar.gz: 366e45a3aeed84b93658f00090dc4d3cf128e1323d2c888a1d38cc226cf5ae12
+SHA512:
+  metadata.gz: 4b78fa04c30a8879b9e404389741266bb9527379b7b140a5e61a5f329bb3c0b070503ea7b57595c7ffe39e102b06410b4fd1814d251c39d7f02182833029d6ed
+  data.tar.gz: 515c57033050a32ce2954def0cd150b3be52e2a5c0a547dd8e7099fff5b587593b52a321d60b8390bc730ad4a53035fc73e2c7d10d93c97bca5aacfb48dedc4d

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 (30-Oct-20)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ALTADATA
+
+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,149 @@
+# ALTADATA Ruby Client
+
+ALTADATA Ruby gem provides convenient access to the ALTADATA API from applications written in the Ruby language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'altadata'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install altadata
+
+
+## Quickstart
+
+Obtain an API key in your dashboard and initialize the client:
+
+```ruby
+require 'altadata'
+
+client = Altadata::Client.new(api_key='YOUR_API_KEY')
+```
+
+## Retrieving Data
+
+You can get the entire data with the code below.
+
+```ruby
+data = client.get_data(product_code = PRODUCT_CODE).load
+```
+
+## Retrieving Subscription Info
+
+You can get your subscription info with the code below.
+
+```ruby
+product_list = client.list_subscription
+```
+
+## Retrieving Data Header Info
+
+You can get your data header with the code below.
+
+```ruby
+client.get_header(product_code = PRODUCT_CODE)
+```
+
+## Retrieving Data with Conditions
+
+You can get data with using various conditions.
+
+The columns you can apply these filter operations to are limited to the **filtered columns**.
+
+> You can find the **filtered columns** in the data section of the data product page.
+
+### equal condition
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE)
+        .equal(condition_column = 'province_state', condition_value = 'Alabama')
+        .load
+```
+
+### in condition
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE)
+        .condition_in(condition_column = 'province_state', condition_value = %w[Montana Utah])
+        .load
+```
+
+> condition_value parameter of condition_in method must be Array
+
+### sort operation
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE)
+        .sort(order_column = 'reported_date', order_method = 'desc')
+        .load
+```
+
+> Default value of order_method parameter is 'asc' and order_method parameter must be 'asc' or 'desc'
+
+
+### select specific columns
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE)
+        .select(selected_column = %w[reported_date province_state mortality_rate])
+        .load
+```
+
+> selected_column parameter of select method must be Array
+
+### get the specified amount of data
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE, size = 20)
+        .load
+```
+
+## Retrieving Data with Multiple Conditions
+
+You can use multiple condition at same time.
+
+```ruby
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+data =
+    client.get_data(product_code = PRODUCT_CODE, size = 100)
+        .condition_in(condition_column = "province_state", condition_value = %w[Montana Utah])
+        .sort(order_column = 'mortality_rate', order_method = 'desc')
+        .select(selected_column = %w[reported_date province_state mortality_rate])
+        .load
+```
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/altabering/altadata-ruby/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/altadata.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/altadata/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'altadata'
+  spec.version               = Altadata::VERSION
+  spec.authors               = ['ALTADATA']
+  spec.email                 = ['contact@altadata.io']
+  spec.summary               = 'Ruby gem for the ALTADATA API'
+  spec.description           = 'ALTADATA Ruby gem provides convenient access to the ALTADATA API from applications written in the Ruby language.'
+  spec.homepage              = 'https://github.com/altabering/altadata-ruby'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.files = Dir['README.md', 'LICENSE', 'CHANGELOG.md', 'lib/**/*.rb', 'lib/**/*.rake',
+                   'altadata.gemspec', '.github/*.md', 'Gemfile', 'Rakefile']
+  spec.test_files       = Dir['spec/**/*.rb']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_dependency 'faraday',                              '~> 1.0'
+  spec.add_dependency 'json',                                 '>= 1.8.0'
+
+  spec.add_development_dependency 'rake',                     '~> 13.0'
+  spec.add_development_dependency 'rspec',                    '~> 3.6'
+  spec.add_development_dependency 'rubocop',                  '~> 1.1'
+  spec.add_development_dependency 'rubocop-performance',      '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec',            '~> 1.37'
+end

data/lib/altadata.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'altadata/version'
+require_relative 'altadata/client'

data/lib/altadata/client.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module Altadata
+  class Client
+    attr_accessor :api_key
+
+    ##
+    # Sets the api key and api urls required to access the Altadata API.
+    def initialize(api_key)
+      @api_key = api_key
+      @data_api_url = 'https://www.altadata.io/data/api/'
+      @subscription_api_url = "https://www.altadata.io/subscription/api/subscriptions?api_key=#{@api_key}"
+    end
+
+    ##
+    # Retrieves customer's subscription info
+    def list_subscription
+      response = Faraday.get(@subscription_api_url)
+      JSON.parse(response.body)
+    end
+
+    ##
+    # Controls types of parameters
+    def check_parameter(parameter_name, parameter, data_type)
+      raise "#{parameter_name} parameter must be #{data_type}" unless parameter.is_a? data_type
+    end
+
+    ##
+    # Retrieves data header as an array
+    def get_header(product_code)
+      check_parameter('product_code', product_code, String)
+
+      request_url = "#{@data_api_url}#{product_code}/?format=json&page=1&api_key=#{@api_key}"
+      response = Faraday.get(request_url)
+      JSON.parse(response.body)[0].keys
+    end
+
+    ##
+    # Initializes retrieve data process
+    def get_data(product_code, size = nil)
+      check_parameter('product_code', product_code, String)
+
+      unless size.nil?
+        check_parameter('size', size, Integer)
+        raise 'size parameter must be greater than 0' unless size.positive?
+      end
+
+      @size = size
+      @request_url_base = "#{@data_api_url}#{product_code}/?format=json"
+
+      self
+    end
+
+    ##
+    # Select specific columns in the retrieve data process
+    def select(selected_column)
+      check_parameter('selected_column', selected_column, Array)
+
+      selected_column_text = selected_column.join(',')
+      @request_url_base += "&columns=#{selected_column_text}"
+
+      self
+    end
+
+    ##
+    # Sort data by given column and method in the retrieve data process
+    def sort(order_column, order_method = 'asc')
+      check_parameter('order_column', order_column, String)
+      check_parameter('order_method', order_method, String)
+      order_method_array = %w[asc desc]
+      raise "order_method parameter must be 'asc' or 'desc'" unless order_method_array.include? order_method
+
+      @request_url_base += "&order_by=#{order_column}_#{order_method}"
+
+      self
+    end
+
+    ##
+    # 'Equal' condition by given column and value in the retrieve data process
+    def equal(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_eq=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'Not Equal' condition by given column and value in the retrieve data process
+    def not_equal(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_neq=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'Greater than' condition by given column and value in the retrieve data process
+    def greater_than(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_gt=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'Greater than equal' condition by given column and value in the retrieve data process
+    def greater_than_equal(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_gte=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'Less than' condition by given column and value in the retrieve data process
+    def less_than(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_lt=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'Less than equal' condition by given column and value in the retrieve data process
+    def less_than_equal(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+
+      @request_url_base += "&#{condition_column}_lte=#{condition_value}"
+
+      self
+    end
+
+    ##
+    # 'In' condition by given column and value in the retrieve data process
+    def condition_in(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+      check_parameter('condition_value', condition_value, Array)
+
+      condition_value_text = condition_value.join(',')
+      @request_url_base += "&#{condition_column}_in=#{condition_value_text}"
+
+      self
+    end
+
+    ##
+    # 'Not in' condition by given column and value in the retrieve data process
+    def condition_not_in(condition_column, condition_value)
+      check_parameter('condition_column', condition_column, String)
+      check_parameter('condition_value', condition_value, Array)
+
+      condition_value_text = condition_value.join(',')
+      @request_url_base += "&#{condition_column}_notin=#{condition_value_text}"
+
+      self
+    end
+
+    ##
+    # Fetch data with configurations given before
+    def load
+      data = []
+      page = 1
+      total_size = 0
+
+      loop do
+        request_url = "#{@request_url_base}&page=#{page}&api_key=#{@api_key}"
+        response = Faraday.get(request_url)
+
+        response_json = JSON.parse(response.body)
+
+        break if response_json.empty?
+
+        response_json.each do |item|
+          data << item
+        end
+
+        unless @size.nil?
+          total_size += response_json.length
+
+          break if total_size > @size
+        end
+
+        page += 1
+      end
+
+      data = data.first(@size) unless @size.nil?
+
+      data
+    end
+  end
+end

data/lib/altadata/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Altadata
+  VERSION = '0.0.1'
+end

data/spec/altadata_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../lib/altadata'
+
+API_KEY = ENV['TEST_API_KEY']
+PRODUCT_CODE = 'co_10_jhucs_03'
+
+RSpec.describe Altadata do
+  client = Altadata::Client.new(api_key = API_KEY)
+
+  it 'has a version number' do
+    expect(Altadata::VERSION).not_to be nil
+  end
+
+  it 'has a valid return at list_subscription method ' do
+    subscription_info = client.list_subscription
+    product_code_arr = []
+
+    subscription_info.each do |info|
+      product_code_arr << info['offer']['code']
+    end
+
+    product_code_list = %w[CO_10_JHUCS_04 CO_08_UNXXX_04
+                           CO_10_JHUCS_03 CO_07_IDEAX_02]
+
+    expect(product_code_arr).to eq(product_code_list)
+  end
+
+  it 'has a valid return at get_header method ' do
+    header = %w[reported_date province_state population lat
+                lng confirmed prev_confirmed_1d new_confirmed
+                peak_confirmed_1d_flag active deaths prev_deaths_1d
+                new_deaths most_deaths_1d_flag recovered
+                hospitalization_rate incidence_rate mortality_rate
+                people_hospitalized people_tested testing_rate]
+
+    expect(client.get_header(product_code = PRODUCT_CODE)).to eq(header)
+  end
+
+  it 'has a valid return at get_data method with sort' do
+    data =
+      client.get_data(product_code = PRODUCT_CODE, size = 10)
+            .equal(condition_column = 'province_state', condition_value = 'Alabama')
+            .sort(order_column = 'reported_date', order_method = 'asc')
+            .load
+
+    expect(data[0]['reported_date']).to eq('2020-04-12')
+  end
+
+  it 'has a valid return at get_data method with select' do
+    selected_columns = %w[reported_date province_state mortality_rate]
+    data =
+      client.get_data(product_code = PRODUCT_CODE, size = 10)
+            .select(selected_column = selected_columns)
+            .load
+
+    expect(data[0].keys).to eq(selected_columns)
+  end
+
+  it 'has a valid return at get_data method with in' do
+    data =
+      client.get_data(product_code = PRODUCT_CODE, size = 250)
+            .condition_in(condition_column = 'province_state', condition_value = %w[Montana Utah])
+            .load
+
+    province_state_arr = []
+
+    data.each do |item|
+      province_state_arr << item['province_state']
+    end
+
+    province_state_arr.uniq!
+
+    expect(province_state_arr).to eq(%w[Montana Utah])
+  end
+
+  it 'has a valid return at get_data method with not in' do
+    check_list = %w[Montana Utah Alabama]
+
+    data =
+      client.get_data(product_code = PRODUCT_CODE, size = 250)
+            .condition_not_in(condition_column = 'province_state', condition_value = check_list)
+            .load
+
+    province_state_arr = []
+
+    data.each do |item|
+      province_state_arr << item['province_state']
+    end
+
+    province_state_arr.uniq!
+
+    check_list.each do |item|
+      expect(province_state_arr).not_to include(item)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'altadata'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: altadata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ALTADATA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+description: ALTADATA Ruby gem provides convenient access to the ALTADATA API from
+  applications written in the Ruby language.
+email:
+- contact@altadata.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- altadata.gemspec
+- lib/altadata.rb
+- lib/altadata/client.rb
+- lib/altadata/version.rb
+- spec/altadata_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/altabering/altadata-ruby
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby gem for the ALTADATA API
+test_files:
+- spec/altadata_spec.rb
+- spec/spec_helper.rb