json_or_ruby_to_csv 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bafab148ce181a519c47c5de25d43585c17b213c2f8d80ec5150ffcbd1d03c2
-  data.tar.gz: a6742c8d856291fff8fb44141536d4b6b1f27151185205c5198c0622a03e4525
+  metadata.gz: 48510a6c840fb0b34b5414b50cd342f7d2481e9cbdf42f7408517d108ed6e2da
+  data.tar.gz: 50b7e0b189c61e5d1f944fad7eaa6cc6c713c2c1e8ad83c006079d3a2ee40831
 SHA512:
-  metadata.gz: c544fb68d32881a29b1fee4f2e26cf003c4761d3bff810bae1d7ca73f717c32946192ccef3cceed486ba6eee12f7f783f6a9c11370949be5611600b7300b36f7
-  data.tar.gz: fba76649ea7911e085748013064cf8fa61db98aa474009ae9fd232c840ea555c018a129fd58408afdd1c7752489639e5449046d047814b6c2b14bdc9f41c51b3
+  metadata.gz: 8d86fe5e254ef049cdeac58dc14a83f11bd900064ecf94d715bc05a7858dfac13da72e9cdeae08fb0b207839ba703738c869ed77ff51eca5183390dbd0e9291e
+  data.tar.gz: 92537631b911438d4ad142ae3857e5f9fcdb34490498afba41ff1b839bc2531246102d24f48d2693adb4a4b08bbf5c94f4e3a89fffb0ce144e3484c948eb70c6

data/Gemfile

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

data/README.md

@@ -1,138 +1,183 @@
 
 <a name="readme-top"></a>
 
-
 # 📗 Table of Contents
+[![json_or_ruby_to_ - csv](https://img.shields.io/badge/json__or__ruby__to__-csv-2ea44f)](https://rubygems.org/gems/json_or_ruby_to_csv)
 
 - [📗 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)
+- [📖 json\_or\_ruby\_to\_csv ](#-json_or_ruby_to_csv-)
+  - [Installation ](#installation-)
     - [Usage](#usage)
-      - [Using `/convert` endpoint](#using-convert-endpoint)
-      - [Using `/convert/previous` endpoint](#using-convertprevious-endpoint)
-    - [Run tests](#run-tests)
+      - [Using array\_or\_hash\_to\_csv](#using-array_or_hash_to_csv)
+      - [Using activerecord\_to\_csv](#using-activerecord_to_csv)
+      - [json\_or\_ruby\_to\_csv usage with rails controller](#json_or_ruby_to_csv-usage-with-rails-controller)
   - [👥 Authors ](#-authors-)
-  - [🔭 Future Features ](#-future-features-)
+  - [🤝 Contributing ](#-contributing-)
+  - [⭐️ Show your support ](#️-show-your-support-)
 
-# 📖 JSON_to_CSV <a name="about-project"></a>
+# 📖 json_or_ruby_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`.
+This gem converts data from a variety of sources into a comma-separated value (CSV) format. The gem can convert arrays of JSON objects, arrays of hashes, arrays of ActionController params, simple hashes, or ActiveRecord relations and objects. The CSV format is a common way to store data in a tabular format. It is often used for data exchange between different applications.
 
-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`.
+## Installation <a name="tech-stack"></a>
 
-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.
+Add the following code to you Gemfile 
 
-To access previously converted data, the user need to sends GET request to `/convert/previous` endpoint.
+```
+gem 'json_or_ruby_to_csv'
+```
+or 
 
-## 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>
+install the gem on your terminal 
 
-To complete this task I used the following tools 
-  - Ruby on Rails
-  - RSpec
-  - SQLite Database
+```
+gem install json_or_ruby_to_csv
+```
     
-## 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`
+### Usage
 
-Run `bundler install`
+`require` this gem on the top of your ruby code.
 
-Run `rails db:migrate`
+#### Using array_or_hash_to_csv
 
-Run `rails server` or `rails s`
 
-### Usage
+If you want to convert `arrays of JSON objects`, `arrays of hashes`, `arrays of ActionController params`, and `simple hashes` to csv you can use `array_or_hash_to_csv` method from `JsonOrRubyToCsv`. Let's see how:-
 
-#### Using `/convert` endpoint 
+> Don't forget to include `JsonOrRubyToCsv` module in your ruby class.
 
-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`
+<i>For example </i>
 
-> 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 
+require 'json_or_ruby_to_csv'
+class Employee
+  include JsonOrRubyToCsv
 
-````
-{
-  "data": [
-    { "id": 1,
-      "fname": "Marek",
-      "lname": "Vydareny",
+  def get_csv_data(data_list)
+   array_or_hash_to_csv(data_list)
+  end
+end
+```
+Let's create `Employee` object and send array of object to `get_csv_data` method.
+  
+```
+employee = Employee.new
+data_list =  [
+    { "id": 200,
+      "fname": "Meshu",
+      "lname": "Amare",
       "salary": 4500,
-      "company": "Radar Cyber Security",
+      "company": "XYZ.com",
       "position": "DevOps IT Operations"
     },
     
-    { "id": 2,
-      "fname": "Norbert",
-      "lname": "Szivós",
+    { "id": 201,
+      "fname": "Solomon",
+      "lname": "Alebachew",
       "salary": 5000,
-      "company": "Radar Cyber Security",
+      "company": "XYZ.com",
       "position": "Rails Developer"
     },
     {
-      "id": 3,
-      "fname": "Ákos",
-      "lname": "Balogh",
+      "id": 202,
+      "fname": "Bini",
+      "lname": "Ew",
       "salary": 5000,
-      "company": "Radar Cyber Security",
+      "company": "XYZ.com",
       "position": "Senior Sofware Developer"
     }
   ]
-}
 
-````
-Then click `send` button 
+print employee.get_csv_data(data_list)
+
+```
+
+**The output looks like below**
+
+``` 
+id,fname,lname,company,position,salary
+200,Meshu,Amare,XYZ.com,DevOps IT Operations,4500
+201,Solomon,Alebachew,XYZ.com,Rails Developer,5000
+203,Bini,Ew,XYZ.com,Senior Sofware Developer,5000 
+```
+
+#### Using activerecord_to_csv
 
-> 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
+If you want to conver `ActiveRecord::Relation` **(collection of objects fetched by `.all` or `.where()`)** or simple ActiveRecord object to csv formated-string you can use `activerecord_to_csv` method from `JsonOrRubyToCsv` module.
 
-The response looks like 
+*For example*
 
-![image](https://user-images.githubusercontent.com/30173722/236670626-56fe50e3-9f8e-4987-a29b-4fa0f852d48c.png)
+```
 
-#### Using `/convert/previous` endpoint
+require 'json_or_ruby_to_csv'
+class Employee
+  include JsonOrRubyToCsv
 
-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`
+  def get_data_as_csv
+    all_employee = Employee.select(:id, :fname, :lname, :salary, :company, :position)
+     activerecord_to_csv(all_employee)
+  end
+ 
+end
+
+```
+Here `get_data_as_csv` method first retrive data from the database, then pass to `activerecord_to_csv` method and return the data as comma-separated csv formated string. 
+
+Let's create `Employee` object and call `get_data_as_csv` method.
+
+```
+employee = Employee.new
+employee.get_data_as_csv
+
+```
+
+**The output looks like below**
+
+``` 
+id,fname,lname,company,position,salary
+200,Meshu,Amare,XYZ.com,DevOps IT Operations,4500
+201,Solomon,Alebachew,XYZ.com,Rails Developer,5000
+203,Bini,Ew,XYZ.com,Senior Sofware Developer,5000 
+```
+
+#### json_or_ruby_to_csv usage with rails controller  
 
-> E.g. `http://127.0.0.1:3000/convert/previous`
+You can include the functionality of this gem in your controller class.
 
-If there is previously converted data, the server will responed it as CSV-formated data, otherwise it will responed `No data avaliable` message.
+*for example*
 
-### Run tests
+If you want your controller action to return a CSV formated data after fetching data from the database, you can do it as follow.
 
-Run 
+```
+require 'json_or_ruby_to_csv'
+class ConvertsController < ApplicationController
+  include JsonOrRubyToCsv
+  def index
+    input = params_value[:data]
+    result = array_or_hash_to_csv(input)
+    render plain: result, status: :ok
+  end
 
-`rails db:migrate RAILS_ENV=test` 
- to change the enviroment to testing mode, then run `rspec spec `
+
+  def previous
+    all_employee = Employee.select(:id, :fname, :lname, :salary, :company, :position)
+    result = activerecord_to_csv(all_employee)
+    render plain: result, status: :ok
+  end
+
+  private
+
+  def params_value
+    params.require(:data) # there must be data
+    params.permit(data: %i[id fname lname company position salary]) # list of optional attributes
+  end
+end
+
+
+```
+
+`index` action controller method will convert array of params data to csv formated string where as `previous` will return csv formated string after fetching data from database.
 
 ## 👥 Authors <a name="authors"></a>
 
@@ -142,12 +187,14 @@ Run
 - Twitter: [@meshu102](https://twitter.com/meshu102)
 - LinkedIn: [Melashu Amare](https://www.linkedin.com/in/melashu-amare/)
 
-## 🔭 Future Features <a name="future-features"></a>
+## 🤝 Contributing <a name="contributing"></a>
+
+This repo is open for contributions. Issues, and feature requests are welcome!
+
+Feel free to check the [issues page.](https://github.com/melashu/json_or_ruby_to_csv/issues)
 
-> I would recommend improvement on the following features.
+## ⭐️ Show your support <a name="support"></a>
 
-- [ ] 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 
+Give a star if you like this project!
   
 <p align="right">(<a href="#readme-top">back to top</a>)</p>

data/lib/json_or_ruby_to_csv/helper.rb

@@ -1,6 +1,4 @@
 module Helper
-  def name; end
-
   def convert_array_to_csv(data)
     csv_keys = data[0].keys.join(',')
 

data/lib/json_or_ruby_to_csv/version.rb

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

data/lib/json_or_ruby_to_csv.rb

@@ -1,10 +1,17 @@
 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!'
+      begin
+        new_data = data.map(&:to_h)
+        convert_array_to_csv(new_data)
+      rescue StandardError
+        'Invalid format!'
+      end
     when Hash
       convert_hash_to_csv(data)
     else
@@ -12,11 +19,23 @@ module JsonOrRubyToCsv
     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

@@ -1,16 +1,23 @@
 # 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')
+describe Helper do
+  let(:dummy){Dummy.new}
+  context 'When we pass array of hash' do
+    let(:data){[{name: 'Meshu', age: 29}]}
+    it 'convert_array_to_csv should return csv formated string ' do
+      expect(dummy.convert_array_to_csv(data)).to eq("name,age\nMeshu,29")
+    end
+  end
+  context 'When we pass simple hash' do
+    let(:data){{name: 'Meshu', age: 29}}
+    it 'convert_hash_to_csv should return csv formated string ' do
+      expect(dummy.convert_hash_to_csv(data)).to eq("name,age\nMeshu,29")
     end
   end
 end
 
 class Dummy
-include JsonOrRubyToCsv
+include Helper
 
 end

data/spec/json_or_ruby_to_csv_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+describe JsonOrRubyToCsv do
+    let(:dummy){ Dummy.new } 
+   context 'When we pass array of string ' do
+    let(:data){["Meshu", "Amare",29]}
+    it 'array_or_hash_to_csv should return invalid format! ' do
+      expect(dummy.array_or_hash_to_csv(data)).to eq('Invalid format!')
+    end
+  end
+   context 'When we pass array of hash' do
+    let(:data){[{name: 'Meshu', age: 29}]}
+    it 'array_or_hash_to_csv should return csv formated string ' do
+      expect(dummy.array_or_hash_to_csv(data)).to eq("name,age\nMeshu,29")
+    end
+  end
+
+   context 'When we pass simple hash' do
+    let(:data){{name: 'Meshu', age: 29}}
+    it 'array_or_hash_to_csv should return csv formated string ' do
+      expect(dummy.array_or_hash_to_csv(data)).to eq("name,age\nMeshu,29")
+    end
+  end
+end
+
+class Dummy
+    include JsonOrRubyToCsv
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_or_ruby_to_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Melashu Amare
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,8 +38,9 @@ dependencies:
     - - ">="
       - !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
+description: This gem converts arrays of JSON objects, arrays of hashes, arrays of
+  ActionController params, simple hashes, or ActiveRecord relations and objects to
+  a CSV-formatted string.
 email: meshu.amare@gmail.com
 executables: []
 extensions: []