ol_dump_parser 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b669a8a1373635cb95df90dcc0f1839fee37cee811a4f9fdd4cfbcc806cac6
-  data.tar.gz: 664a046c478097ec475297eefe3fac6ffb24cc35afcdd07c5f5dc51c380bd86b
+  metadata.gz: 143bc6f339f1330854b00bec96a64fee9be7841ac8014f492980eb0e3c48acf7
+  data.tar.gz: e4c14464e5fa2de0ed9916265a0e4b4ecfca29b3730ac8bc761e12a3d1999987
 SHA512:
-  metadata.gz: 87e9d3e172c985fa6715141ffb71584fe6ba14a1d95a45b65d560a4d91b5283c1fb8ab7525ae8a1c413408d15ca0c4f54430b9bb86441adfde454e092296211e
-  data.tar.gz: 333b96344c009710ee077614724842ebca6c0b1c39127df25d6461510649fde86cdc8612cfee5aa5caaf1d77bea2522c2702b99bfe32700e4be4f27852aed117
+  metadata.gz: '0108a1fb35fcd2474dbd39435389e3cca4d8ef91121c83f105807d8d27369a885b86f34cdd4f1495b3445a9812f760b5e59f3dba858d5dd6eadec7b4c6dc7936'
+  data.tar.gz: 47947e3af61890ae90d91db956f5c18fd7e0390c4196ea2ace8d12cc4be4abb8ccc3d08dc85f3e3e33a357819df95f41f182997b5f11ee77e53890acd4d9021f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 arjundas
+
+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,19 @@
+# Open Library Dump Parser
+
+openlibrary-dump-parser is a simple ruby parser that parses the csv dump from open library into a json file
+
+## Getting started
+### Installation
+```sh
+gem install ol_dump_parser
+```
+
+### Ruby sample code:
+```ruby
+require 'ol_dump_parser'
+# Create a ol_dump_parser object
+ol_dump_parser = OlDumpParser.new({ inp_file: './inp_file_path', out_file: './output/out.json' })
+
+# parse the data, this will create the output file
+ol_dump_parser.parse
+```

data/lib/ol_dump_parser.rb

@@ -1,5 +1,14 @@
-class OlDumpParser
-  def self.hi
-    puts 'hello world'
+require_relative 'ol_dump_parser/parser'
+
+# Serves as the namespace for the whole gem
+module OlDumpParser
+  class << self
+
+    # Creates a new parser
+    # @param params [Hash{Symbol => String}] Input parameters to parser
+    def new(params)
+      Parser.new params
+    end
   end
 end
+

data/lib/ol_dump_parser/parser.rb

@@ -0,0 +1,50 @@
+require 'csv'
+require 'json'
+
+module OlDumpParser
+  # Parser class that will parses ol dump
+  class Parser
+    # @return [String] Path to the input file
+    attr_accessor :inp_file
+
+    # @return [String] Path to the output file
+    attr_accessor :out_file
+
+    # Constructor for Parser
+    # @param [Hash] params Inputs to parser
+    # @option params [String] :inp_file Path to the input file
+    # @option params [String] :out_file Path to the output file
+    def initialize(params)
+      self.inp_file = params[:inp_file]
+      self.out_file = params[:out_file]
+    end
+
+    # Parses the input csv file and converts to a json file
+    def parse
+      output = File.open out_file, 'w'
+      File.open(inp_file).each do |line|
+        # CSV parse returns an array of rows - we need only the first
+        parsed_line = CSV.parse(line.chomp, col_sep: "\t", liberal_parsing: true).first
+        json_output = csv_row_to_json(parsed_line)
+        p json_output[:details]['name']
+        output.puts json_output
+      end
+      output.close
+    end
+
+    private
+
+    # Convert the given row values to a json object
+    # @param row_values [Array] Csv row values
+    # @return [Hash] Json value
+    def csv_row_to_json(row_values)
+      {
+        type: row_values[0],
+        key: row_values[1],
+        revision: row_values[2],
+        last_modified: row_values[3],
+        details: JSON.parse(row_values[4])
+      }
+    end
+  end
+end

data/lib/ol_dump_parser/version.rb

@@ -0,0 +1,3 @@
+module OlDumpParser
+  VERSION = '1.0.0'
+end

metadata

@@ -1,24 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: ol_dump_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Arjun M Das
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-27 00:00:00.000000000 Z
-dependencies: []
-description: "  Open Library provides dumps of all its data, generated every month.
-  ol_dump_parser will act as a simple parser for this data.\n"
+date: 2021-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: "  ol_dump_parser parses the Open Library Dump into a simple json file
+  for easy processing\n"
 email: arjundas.27586@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/ol_dump_parser.rb
-homepage:
+- lib/ol_dump_parser/parser.rb
+- lib/ol_dump_parser/version.rb
+homepage: https://github.com/thearjunmdas/openlibrary-dump-parser
 licenses:
 - MIT
 metadata: {}