substack_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7caeccaf6a01d7ec1b6856382bdb5ea3ee6b50866fc816d48f166b76037b3fd9
+  data.tar.gz: c595ce2474e5b84c5c8b7006d4619eb70f59a5e7485bd37dc1b12c15c68430cf
+SHA512:
+  metadata.gz: 38da37ef304349fb1bdb68db7c1a83f404d25aec10aa3a86f1861d1cb590cd60e5b14811e3610d0c2ca6f6d397d6a025fed9387eb4025ce14712ac0971efd8cf
+  data.tar.gz: 6b9fbc7c8748bd34354a41268eb181df853c4849b848ca8020c3d81ad340ffb1f818cf2daed54e64f58c98f450c25f9d9b6b55685079caddc7b250b953e2e238

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+substack_parser

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in substack_parser.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'rubyzip', '~> 1.2.1'
+gem "csv", "~> 3.2"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    substack_parser (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    csv (3.2.7)
+    diff-lcs (1.5.0)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.7.1)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubyzip (1.2.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  csv (~> 3.2)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubyzip (~> 1.2.1)
+  substack_parser!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mathew Thomas
+
+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,124 @@
+# SubstackParser
+This gem is to help parse [Substack](https://substack.com/) exports.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'substack_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install substack_parser
+
+## Usage
+To parse the export:
+```ruby
+parser = SubstackParser.new("path/to/substack_export")
+```
+
+Substack provides data for mailing lists, posts, post visits, and posts mailed.
+
+### Mailing List
+```ruby
+parser.mailing_list # List of mailing lists
+
+[
+    {
+        "email"=>"dummy_email1@example.com",
+        "active_subscription"=>"FALSE",
+        "expiry"=>nil,
+        "plan"=>"other",
+        "email_disabled"=>"FALSE"
+         "digest_enabled"=>"FALSE",
+        "created_at"=>"2022-11-15T07:55:22.660Z"
+    }, .....
+]
+
+
+
+```
+### Post List
+```ruby
+parser.post_list # List of posts
+
+[
+    {
+        "post_id"=>1,
+        "post_date"=>"2023-06-22T04:58:05.613Z",
+        "is_published"=>"TRUE",
+        "email_sent_at"=>"2023-06-22T04:58:05.675Z",
+        "inbox_sent_at"=>"2023-06-22T04:58:05.675Z",
+        "type"=>"newsletter",
+        "audience"=>"only_paid",
+        "title"=>"One",
+        "subtitle"=>"Lorem ipsum dolor",
+        "podcast_url"=>nil,
+        "content"=>"<p>Lorem ipsum dolor ........</p>"
+    }, ....
+]
+
+```
+### Read List
+
+```ruby
+parser.read_list #To get all the read list
+
+[
+    {
+        "post_id"=>"1",
+        "timestamp"=>"2023-01-05T10:36:08.164Z",
+        "email"=>"dummy_email1@gmail.com",
+        "post_type"=>"newsletter",
+        "post_audience"=>"founding",
+        "active_subscription"=>"TRUE",
+        "country"=>nil,
+        "city"=>nil,
+        "region"=>nil,
+        "device_type"=>nil,
+        "client_os"=>nil,
+        "client_type"=>nil,
+        "user_agent"=>"Mozilla/5.0"
+    }
+]
+
+parser.get_read_list_for_post(post_id) #To get read list a post
+```
+
+### Post Email List
+```ruby
+
+parser.emails_sent_list #To get all the post emails that were sent
+
+[
+    {
+        "post_id"=>"1",
+        "timestamp"=>"2023-01-05T10:35:15.735Z",
+        "email"=>"dummy_email1@gmail.com",
+        "post_type"=>"newsletter",
+        "post_audience"=>"founding",
+        "active_subscription"=>"FALSE"
+    } ......
+]
+
+
+parser.get_emails_sent_list_for_post(post_id) #To get emails sent for a post
+
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/betacraft/substack_parser.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "substack_parser"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/substack_parser.rb

@@ -0,0 +1,86 @@
+require 'zip'
+require 'csv'
+
+class SubstackParser
+  attr_reader :file_path
+
+  def initialize(file_path)
+    @file_path = file_path
+    validate_zip
+  end
+
+  def mailing_list
+    raise "email_list could not be found" if email_list_file.nil?
+    parse_csv(email_list_file.name)
+  end
+
+  def post_list
+    posts = parse_csv('posts.csv')
+    posts.map do |post|
+      post_id = post["post_id"]
+      post["post_id"] = post_id.to_i
+      post.merge(post_content(post_id))
+    end
+  end
+
+  def get_read_list_for_post(post_id)
+    parse_csv("posts/#{post_id}.opens.csv")
+  end
+
+  def get_emails_sent_list_for_post(post_id)
+    parse_csv("posts/#{post_id}.delivers.csv")
+  end
+
+  def read_list
+    grouped_post_details('posts/*.opens.csv')
+  end
+
+  def emails_sent_list
+    grouped_post_details('posts/*.delivers.csv')
+  end
+
+  private
+
+  def unzip_file
+    @unzip_file ||= Zip::File.open(file_path)
+  end
+
+  def email_list_file
+    unzip_file.select{|tt| tt.name.start_with? "email_list"}.first
+  end
+
+  def parse_csv(filename)
+    content = get_zipped_file_content(filename)
+    if content.nil?
+      {}
+    else
+      CSV.parse(content, headers: true).map(&:to_h)
+    end
+  end
+
+  def post_content(post_id)
+    content = get_zipped_file_content("posts/#{post_id}.html")
+    { "content" => content }
+  end
+
+  def get_zipped_file_content(filename)
+    entry = unzip_file.glob(filename).first
+    begin
+      entry.get_input_stream.read
+    rescue NoMethodError
+      nil
+    end
+  end
+
+  def grouped_post_details(path)
+    unzip_file.glob(path).flat_map do |file|
+      content = file.get_input_stream.read
+      CSV.parse(content, headers: true).map(&:to_h)
+    end
+  end
+
+  def validate_zip
+    raise "File is not a zip" unless file_path.end_with?('.zip')
+    raise "File not found" unless File.exist?(file_path)
+  end
+end

data/substack_parser.gemspec

@@ -0,0 +1,24 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "substack_parser"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Mathew Thomas"]
+  spec.email         = ["mathew@betacraft.com"]
+
+  spec.summary       = %q{This gem is to help parse Substack exports.}
+  spec.homepage      = "https://github.com/betacraft/substack_parser"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = "https://github.com/betacraft/substack_parser"
+  spec.metadata["source_code_uri"] = "https://github.com/betacraft/substack_parser"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency("csv", "~> 3.2")
+  spec.add_dependency("rubyzip", "~> 1.2.1")
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: substack_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathew Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+description: 
+email:
+- mathew@betacraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/substack_parser.rb
+- substack_parser.gemspec
+homepage: https://github.com/betacraft/substack_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/betacraft/substack_parser
+  source_code_uri: https://github.com/betacraft/substack_parser
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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 is to help parse Substack exports.
+test_files: []