leetcoder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a695bd749e273d75cc9b1f0fd871f897471f9da4381b33b95717e7a278c20316
-  data.tar.gz: c9ef673c5aed97868002a8d03517836f8c9babc4d61366baf0996df513cfdad9
+  metadata.gz: 4ed539ebbfa265645b33930912bbc686284cf9dd7a00cae912331b6a034eb634
+  data.tar.gz: d5e94973e36895f844fb62fb3074acd6866e61190bb4bcf8aae88839990053a9
 SHA512:
-  metadata.gz: 3c298b6ad2567f858b35b6a16b2f59b7f73ae45850da5d26be7209b70271ed20ca30f3b101b977f6fe09c2118d4d6efc76d90d80ecdc328ebc2e42111491949a
-  data.tar.gz: 91ca7837e54a0e4f955ca2562750c59c3e45b104ca70afa8999b294a36fcb455f81b6f991b5167d5daa4648f28e30ad9774cf90f6b44de6dbacd36eee6505b50
+  metadata.gz: 40b998b4714b7a431f1dce223d3ba2f0d65eabb7e6a32cafdd616b749c6c55fa1d056d375bc8868a35db1f656d27525460e0ace812c7fa58e176b41bec76e703
+  data.tar.gz: 91a4b1341c86870c4bf08191b50e3ef5d2f38e4c51641763771a4e5ef72514fa4cf84de7dd269877f0a44e9a325fb13463ed954f1bb10c21f1811d497b804f59

data/Dockerfile

@@ -1,5 +1,4 @@
-# syntax=docker/dockerfile:1
-FROM ruby:3.1.1
+FROM ruby:3.1.1-slim
 RUN apt-get update -qq
 WORKDIR /leetcoder
 

data/README.md

@@ -1,19 +1,52 @@
-# LeetCoder
+<p align="center">
+  <img src="./spec/cassettes/leetcoder.png" alt="leetcoder"/>
+</p>
 
-<!-- ![Leetcoder](/spec/cassettes/leetcoder.png) -->
-<img src="/spec/cassettes/leet_coder.png" alt="leetcoder" float="right" height="300px"/>
+A Ruby [LeetCode](https://www.leetcode.com) Client to help you download all your accepted leetcode submissions with problem description. LeetCode cookie is used for authentication.
 
-A Ruby Leetcode Client to help you download all your accepted Leetcode submissions with problem description.
+- [Leetcoder](#)
+  - [Screenshot](#screenshot)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Run Through Docker](#run-through-docker)
+    - [Run Through Github Action](#run-through-github-action)
+  - [Author](#author)
+
+## Screenshot
+
+![screenshot](./spec/cassettes/leetcoder_screenshot.png)
+
+## Requirements
+  - Ruby 3.1.1
+  - Desire to automate the boring stuff
 
 ## Installation
 
-```
+```bash
 gem install leetcoder
 ```
 
 ## Usage
 
+After installing the gem, follow these steps:
+
+ - Sign in to [leetcode.com](www.leetcode.com) from any browser
+ - Copy the `cookie` value of a leetcode request using the browser network tab
+
+   ![leetcode cookie](./spec/cassettes/leetcode%20cookie.jpg)
+
+ - Save your cookie by running `leetcoder --cookie` from terminal
+ - Run `leetcoder --download` to start downloading.
+
+```bash
+leetcoder --cookie                    # prompt you to save the leetcode cookie
+leetcoder --download all --folder ./  # download all accepted submissions in current folder
 ```
+
+```bash
+> leetcoder --help
+
 Usage: leetcoder [command]
 
 * indicates default value
@@ -26,6 +59,40 @@ commands:
     -h, --help                       Show available commands
 ```
 
-## Authors
+## Run through Github Action
+
+Create a new repository in github and set your leetcode cookie under `Repository Secrets` with name `LEETCODE_COOKIE` in
+
+```text
+https://github.com/<username>/<repo_name>/settings/secrets/actions
+```
+
+Then, Download and commit this [leetcoder.yml](./leetcoder.yml) file inside `.github/wrokflows/` folder in your repo.
+
+This will automatically download and commit the downloaded submissions every week.
+You can customize the frequency using the cron syntax inside the yml file.
+
+This is the most convenient and recommended way to backup your submissions using the app.
+
+## Run through Docker
+
+If you don't have ruby setup locally, you can run the app through docker.
+
+First, open terminal and cd to the directory where you want to download the submissions.
+
+Then run,
+
+```bash
+docker run -it -v `pwd`:`pwd` -w `pwd` imamrb/leetcoder:latest
+```
+
+This will run the [leetcoder docker image](https://hub.docker.com/repository/docker/imamrb/leetcoder) and mount your current directory to container working directory. You can now continue using the app from here.
+
+The downloaded submissions will be saved to your current directory.
+
+Caveat: You will need to provide the leetcode cookie every time since the stored configuration will be lost when you exit from the container.
+
+## Author
+
 Imam Hossain <br>
 Email: imam.swe@gmail.com

data/leetcoder.yml

@@ -0,0 +1,35 @@
+name: leetcoder auto download
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+jobs:
+  leetcoder-download:
+    runs-on: leetcoder:latest
+    env:
+      LEETCODE_COOKIE: ${{ secrets.LEETCODE_COOKIE }}
+      DOWNLOAD_FOLDER: './'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.1
+          bundler-cache: true
+
+      - name: Install leetcoder
+        run: gem install leetcoder
+
+      - name: Download Submissions
+        run: leetcode -d all -f $DOWNLOAD_FOLDER
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'leetcoder: updated leetcode submissions'
+          commit_user_email: leetcoder+github-actions[bot]@users.noreply.github.com
+          commit_author:  Name <your-name@email.address>

data/lib/leetcoder/leetcoder/client.rb

@@ -2,6 +2,7 @@
 
 require 'faraday'
 require 'faraday/net_http'
+require 'faraday/retry'
 
 module Leetcoder
   class Client
@@ -38,6 +39,7 @@ module Leetcoder
         f.response :json, content_type: /\bjson$/, parser_options: { symbolize_names: true }
         f.request :multipart
         f.adapter :net_http
+        f.request :retry, retry_options
       end
     end
 
@@ -45,6 +47,18 @@ module Leetcoder
 
     attr_reader :cookie
 
+    def retry_options
+      {
+        max: 2,
+        interval: 0.1,
+        interval_randomness: 0.5,
+        backoff_factor: 2,
+        methods: %i[get post put],
+        exceptions: [Errno::ETIMEDOUT, Timeout::Error, Faraday::TimeoutError, Faraday::ClientError],
+        retry_statuses: [500, 429]
+      }.freeze
+    end
+
     def valid_response?(response)
       return false unless (200...299).cover?(response.status)
       return true unless response.body.is_a? Hash
@@ -72,6 +86,9 @@ module Leetcoder
       when 200, 400
         raise ApiError, "status: #{response.status},\n" \
                         "code: GRAPHQL_ERROR, \nerrors: #{response.body[:errors]}"
+      when 429
+        raise ApiError, "status: #{response.status},\n" \
+                        "code: RATE_LIMIT_EXCEEDED, \nerrors: [Please try again.]"
       when 404
         raise ApiError, "status: #{response.status},\n" \
                         "code: NOT_FOUND_ERROR,\n" \

data/lib/leetcoder/leetcoder/download.rb

@@ -17,7 +17,11 @@ module Leetcoder
 
     def call
       Dir.chdir(@root_directory) do
+        log_message(:initiate_download, dir: @root_directory)
+
         download_accepted_submissions
+
+        log_message(:completed_download)
       end
     end
 
@@ -28,9 +32,9 @@ module Leetcoder
     def download_accepted_submissions
       accepted_questions.each do |question|
         question_dir = "#{question.frontendQuestionId}.#{question.titleSlug}"
-        next log_message(:skip, question_dir:) unless Dir.glob("#{question_dir}/*solution*").empty?
+        next log_message(:skip_submission, question_dir:) unless Dir.glob("#{question_dir}/*solution*").empty?
 
-        log_message(:download, question_dir:)
+        log_message(:submission_download, question_dir:)
 
         Dir.chdir(create_directory(question_dir)) do
           process_question(question)

data/lib/leetcoder/leetcoder/helpers/logger.rb

@@ -11,10 +11,14 @@ module Leetcoder
 
       def message(key, args)
         case key
-        when :skip
+        when :skip_submission
           "Skipping Download for #{args[:question_dir]}. Already Exist."
-        when :download
+        when :submission_download
           "Downloading sumbimissions for #{args[:question_dir]}"
+        when :initiate_download
+          "Starting download in location: #{File.expand_path args[:dir]}\n"
+        when :completed_download
+          "\nDownload completed!"
         end
       end
     end

data/lib/leetcoder/leetcoder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leetcoder
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leetcoder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Imam Hossain
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,7 @@ files:
 - README.md
 - Rakefile
 - bin/leetcoder
+- leetcoder.yml
 - lib/leetcoder/leetcoder.rb
 - lib/leetcoder/leetcoder/cli.rb
 - lib/leetcoder/leetcoder/client.rb
@@ -84,9 +85,9 @@ licenses:
 metadata:
   homepage_uri: https://www.github.com/imamrb/leetcoder
   source_code_uri: https://www.github.com/imamrb/leetcoder
-  changelog_uri: https://www.github.com/imamrb/leetcoder/CHANGELOG.md
+  changelog_uri: https://www.github.com/imamrb/leetcoder/tree/v0.1.2/CHANGELOG.md
   rubygems_mfa_required: 'false'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: A Ruby Leetcode Client to help you download and backup all your accepted
-  leetcode submissions
+summary: A Ruby Leetcode Client to backup accepted submissions
 test_files: []