json_or_ruby_to_csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8bafab148ce181a519c47c5de25d43585c17b213c2f8d80ec5150ffcbd1d03c2
+  data.tar.gz: a6742c8d856291fff8fb44141536d4b6b1f27151185205c5198c0622a03e4525
+SHA512:
+  metadata.gz: c544fb68d32881a29b1fee4f2e26cf003c4761d3bff810bae1d7ca73f717c32946192ccef3cceed486ba6eee12f7f783f6a9c11370949be5611600b7300b36f7
+  data.tar.gz: fba76649ea7911e085748013064cf8fa61db98aa474009ae9fd232c840ea555c018a129fd58408afdd1c7752489639e5449046d047814b6c2b14bdc9f41c51b3

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Melashu 
+
+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,153 @@
+
+<a name="readme-top"></a>
+
+
+# 📗 Table of Contents
+
+- [📗 Table of Contents](#-table-of-contents)
+- [📖 JSON\_to\_CSV ](#-json_to_csv-)
+  - [Why we need to use SQLite database](#why-we-need-to-use-sqlite-database)
+  - [Tech Stack ](#tech-stack-)
+  - [Key Features ](#key-features-)
+  - [💻 Getting Started ](#-getting-started-)
+    - [Prerequisites](#prerequisites)
+    - [Setup](#setup)
+    - [Usage](#usage)
+      - [Using `/convert` endpoint](#using-convert-endpoint)
+      - [Using `/convert/previous` endpoint](#using-convertprevious-endpoint)
+    - [Run tests](#run-tests)
+  - [👥 Authors ](#-authors-)
+  - [🔭 Future Features ](#-future-features-)
+
+# 📖 JSON_to_CSV <a name="about-project"></a>
+
+JSON_to_CSV is a Rails API that converts an array of objects to a CSV-formatted string. It has two endpoints: `/convert` and `/convert/previous`.
+
+To minimize the error rate when converting an array of objects to CSV-formatted data, the API uses an Employee model with the following attributes: `fname`, `lname`, `salary`, `company`, and `position`.
+
+To convert data, the user sends a POST request to the `/convert` endpoint with an array of objects as the payload. The objects must have the above attributes as keys. The `/convert` endpoint persists the data to a SQLite database and responds with a CSV-formatted string.
+
+To access previously converted data, the user need to sends GET request to `/convert/previous` endpoint.
+
+## Why we need to use SQLite database
+To allow users to view previous data, we use a SQLite database to persist the data when we convert it for the first time. So user can view persisted data using `/convert/previous` endpoint.
+ 
+## Tech Stack <a name="tech-stack"></a>
+
+To complete this task I used the following tools 
+  - Ruby on Rails
+  - RSpec
+  - SQLite Database
+    
+## Key Features <a name="key-features"></a>
+The key features of this API
+
+- Converts JSON-formatted arrays of objects to CSV-formatted data
+- Persists the data for future use
+- Allows users to view previously converted data
+## 💻 Getting Started <a name="getting-started"></a>
+
+To get a local copy up and running, follow these steps
+
+### Prerequisites
+
+- Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- Install [Ruby version 3.1.2(2022-04-12 revision)](https://rubyinstaller.org/)
+- Open your terminal and install rails using `gem install rails`
+- Install [Postman](https://www.postman.com/downloads/) or other API testing tool
+- Install [Visual Studio Code](https://code.visualstudio.com/download) or other code editor
+
+### Setup
+
+Clone this repository to your desired folder:
+
+`https://github.com/melashu/json_to_csv.git`
+
+cd `json_to_csv`
+
+Run `bundler install`
+
+Run `rails db:migrate`
+
+Run `rails server` or `rails s`
+
+### Usage
+
+#### Using `/convert` endpoint 
+
+To convert data to CSV formated-string, open Postman or other API testing tool, then put `server_address/convert` to the url section and make the request type `POST`
+
+> NB: server_address may be like http://127.0.0.1:3000 e.g. `http://127.0.0.1:3000/convert`
+
+Under body section select raw, then copy and put the following JSON formated data as a payload 
+
+````
+{
+  "data": [
+    { "id": 1,
+      "fname": "Marek",
+      "lname": "Vydareny",
+      "salary": 4500,
+      "company": "Radar Cyber Security",
+      "position": "DevOps IT Operations"
+    },
+    
+    { "id": 2,
+      "fname": "Norbert",
+      "lname": "Szivós",
+      "salary": 5000,
+      "company": "Radar Cyber Security",
+      "position": "Rails Developer"
+    },
+    {
+      "id": 3,
+      "fname": "Ákos",
+      "lname": "Balogh",
+      "salary": 5000,
+      "company": "Radar Cyber Security",
+      "position": "Senior Sofware Developer"
+    }
+  ]
+}
+
+````
+Then click `send` button 
+
+> NB: Dont forget the objects must have `fname`, `lname`, `salary`, `company`, and `position` attributes as keys. Otherwise, the server will responed `Either the id is duplicted or invalid format,try /convert/previous to see previous data` but you can leave `id` attribute. In addition to this, make sure the request format is JSON
+
+The response looks like 
+
+![image](https://user-images.githubusercontent.com/30173722/236670626-56fe50e3-9f8e-4987-a29b-4fa0f852d48c.png)
+
+#### Using `/convert/previous` endpoint
+
+To view previously converted data, open Postman or other API testing tool, then put `server_address/convert/previous` to the url section and make the request type `GET`
+
+> E.g. `http://127.0.0.1:3000/convert/previous`
+
+If there is previously converted data, the server will responed it as CSV-formated data, otherwise it will responed `No data avaliable` message.
+
+### Run tests
+
+Run 
+
+`rails db:migrate RAILS_ENV=test` 
+ to change the enviroment to testing mode, then run `rspec spec `
+
+## 👥 Authors <a name="authors"></a>
+
+ 👤 Melashu Amare
+
+- GitHub: [@melashu](https://github.com/melashu)
+- Twitter: [@meshu102](https://twitter.com/meshu102)
+- LinkedIn: [Melashu Amare](https://www.linkedin.com/in/melashu-amare/)
+
+## 🔭 Future Features <a name="future-features"></a>
+
+> I would recommend improvement on the following features.
+
+- [ ] Add more model validation like checking the length of character, salary must be number
+- [ ] Allow the API to convert any json formated object
+- [ ] Add API version 
+  
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

data/lib/json_or_ruby_to_csv/helper.rb

@@ -0,0 +1,35 @@
+module Helper
+  def name; end
+
+  def convert_array_to_csv(data)
+    csv_keys = data[0].keys.join(',')
+
+    csv_file = data.map do |ele|
+      ele.values.join(',')
+    end.join("\n")
+
+    "#{csv_keys}\n#{csv_file}"
+  end
+
+  def convert_hash_to_csv(data)
+    csv_keys = data.keys.join(',')
+
+    csv_values = data.values.join(',')
+
+    "#{csv_keys}\n#{csv_values}"
+  end
+
+  def relation_to_array(data)
+    array_value = data.map(&:attributes)
+
+    convert_array_to_csv(array_value)
+  rescue StandardError
+    'Invalid format!'
+  end
+
+  def object_to_hash(data)
+    convert_hash_to_csv(data.attributes)
+  rescue StandardError
+    'Invalid format!'
+  end
+end

data/lib/json_or_ruby_to_csv/version.rb

@@ -0,0 +1,3 @@
+module Version
+    VERSION = "0.0.1"
+end

data/lib/json_or_ruby_to_csv.rb

@@ -0,0 +1,22 @@
+require_relative './json_or_ruby_to_csv/helper'
+module JsonOrRubyToCsv
+  include Helper
+  def array_or_hash_to_csv(data)
+    case data
+    when Array
+      data.all? { |ele| ele.is_a? Hash } ? convert_array_to_csv(data) : 'Invalid format!'
+    when Hash
+      convert_hash_to_csv(data)
+    else
+      'Invalid format!'
+    end
+  end
+
+  def activerecord_to_csv(data)
+     if data.respond_to?(:each)
+      relation_to_array(data)
+     else
+      object_to_hash(data)
+     end
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'json_or_ruby_to_csv'
+require 'spec_helper'
+describe JsonOrRubyToCsv do
+  describe "" do
+    it "" do
+      
+      expect(Dummy.new.name).to eq('meshu')
+    end
+  end
+end
+
+class Dummy
+include JsonOrRubyToCsv
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: json_or_ruby_to_csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Melashu Amare
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-21 00:00:00.000000000 Z
+dependencies:
+- !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: rspec-rails
+  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: This gem convert array of json object, array of hash, simple hash or
+  ActiveRecord relation and objects to CSV formated string
+email: meshu.amare@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/json_or_ruby_to_csv.rb
+- lib/json_or_ruby_to_csv/helper.rb
+- lib/json_or_ruby_to_csv/version.rb
+- spec/helper_spec.rb
+- spec/json_or_ruby_to_csv_spec.rb
+- spec/spec_helper.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  documentation_uri: https://github.com/melashu/json_or_ruby_to_csv
+  bug_tracker_uri: https://github.com/melashu/json_or_ruby_to_csv/issues
+  homepage_uri: https://rubygems.org/gems/json_or_ruby_to_csv
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: This gem convert array of hash and ActiveRecord_Relation to CSV formated
+  string
+test_files: []