postwave-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcf237beec10b8cff85f7ca70cb4f63a23b43555c70a0fa00d20fbbf01abc7d2
+  data.tar.gz: 6400cff762bb34f29084d3ca21de96c97e395239e79592bc53c476ac636b46cf
+SHA512:
+  metadata.gz: 2c4611af08d26282c042f9695a7291d07ab1eb103fadf082e6a505f63297c20411848c9dba7669c9a63d7beeb15f5ef5ed0b52c83a0b6bbd72ce7a0cbd8fe5ba
+  data.tar.gz: 7314600e6fea02aac7cfb9359f8ac82d254efc54f5bf302a278e1dd6f5cf358d2d2a233371a455c45472501a6699a62b78ba67c66acb8d2a66884f4cc2113e0b

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,95 @@
+# Postwave Ruby Client 🌊
+
+A Ruby client for displaying [Postwave](https://github.com/dorkrawk/postwave) blogs.
+
+## Installation 
+
+```
+gem install postwave-client
+```
+
+## Usage
+
+### Create a Postwave Client
+```ruby
+postwave_client = Postwave::Client.new("path/to/config/postwave.yaml")
+```
+
+If you'd like to preload all the posts:
+```ruby
+postwave_client = Postwave::Client.new("path/to/config/postwave.yaml", preload: true)
+```
+
+### Get a Single Post
+
+Pass in the stub (the filename without '.md') for the post.
+```ruby
+post = postwave_client.post("my-great-post")
+
+# <Postwave::Post title="My Great Post", date=<Time ...>, tags=["tag1"], body="bla bla bla..">
+
+puts post.title
+# "My Great Post"
+```
+
+### Get a Collection of Posts
+
+This will give you a list of posts for displaying on a page.
+
+You can also filter by tags and specify offsets and limits (useful for pagination).
+
+```ruby
+posts = postwave_client.posts
+
+# [<Postwave::Post ...>, <Postwave::Post ...>, ...]
+
+tagged_posts = postwave_client.posts(tag: "lizards")
+
+page2_posts = postwave_client.posts(offset: 10, limit: 10)
+```
+Posts will be in reverse chronological order.
+
+### Get an Index of Posts
+
+This will give you a quick list of post summaries containing the title, date, and stub, useful for building an archive page or quick index of posts.
+
+You can also specify offsets and limits (useful for pagination).
+```ruby
+index = postwave_client(index)
+
+# [<Postwave::PostStub title="My Great Post", date=<Time ...>, stub="my-great-post">, <Postwave::PostStub ...>, ...]
+
+puts index.first.stub
+# my-great-post
+
+page2_index = postwave_client.index(offset: 10, limit: 10)
+```
+Index will be in reverse chronological order.
+
+### Get Tags Used In the Blog
+
+```ruby
+tags = postwave_client.tags
+
+# ["tag1", "tag2", "another-tag"]
+```
+
+### Get Details For A Tag
+
+```ruby
+tag = postwave_clinet.tag("tag1")
+
+# <Postwave::Tag tile="tag1", count=1, post_slugs=["my-great-post"]>
+```
+
+## Want To Know More About Postwave?
+
+Check out the [Postwave](https://github.com/dorkrawk/postwave) repo.
+
+## Development
+
+### Run the Tests!
+
+```
+rake test
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+
+# rake test
+task :default => :test

data/lib/postwave/blog_utilities.rb

@@ -0,0 +1,40 @@
+module Postwave
+  module BlogUtilities
+    CONFIG_FILE_NAME = "postwave.yaml"
+    INDEX_FILE_NAME = "index.csv"
+    SUMMARY_FILE_NAME = "summary.yaml"
+    POSTS_DIR = "_posts"
+    META_DIR = "meta"
+    TAGS_DIR = "tags"
+
+    def is_set_up?(blog_root)
+      missing_paths = find_missing_paths(blog_root)
+      missing_paths.empty?
+    end
+
+    def file_paths(blog_root)
+      [
+        File.join(blog_root, CONFIG_FILE_NAME),
+        File.join(blog_root, POSTS_DIR, META_DIR, INDEX_FILE_NAME),
+        File.join(blog_root, POSTS_DIR, META_DIR, SUMMARY_FILE_NAME),
+      ]
+    end
+
+    def directory_paths(blog_root)
+      [
+        File.join(blog_root, POSTS_DIR),
+        File.join(blog_root, POSTS_DIR, META_DIR),
+        File.join(blog_root, POSTS_DIR, META_DIR, TAGS_DIR),
+      ]
+    end
+
+    def find_missing_paths(blog_root)
+      paths_to_check = directory_paths(blog_root) + file_paths(blog_root)
+      missing_paths = []
+      paths_to_check.each do |path|
+        missing_paths << path if !FileTest.exist?(path)
+      end
+      missing_paths
+    end
+  end
+end

data/lib/postwave/client.rb

@@ -0,0 +1,92 @@
+require_relative "post"
+require_relative "errors"
+require_relative "blog_utilities"
+
+require "csv"
+require "time"
+require "yaml"
+
+module Postwave
+  class Client
+    include BlogUtilities
+
+    def initialize(config_path, preload: false)
+      raise MissingConfigError unless is_valid_config?(config_path)
+      
+      @blog_root = File.dirname(config_path)
+      raise InvalidBlogError unless is_set_up?(@blog_root)
+
+      @all_posts = get_all_posts if preload
+    end
+
+    # returns: an array of PostStub Structs - [<struct PostStub date=Time, title="", stub="">]
+    def index(offset: 0, limit: nil)
+      working_index = @full_index || get_full_index
+      count = limit || working_index.size
+      working_index[offset, count]
+    end
+
+    # returns: a post - Postwave::Post
+    def post(slug)
+      post_file_path = Dir["#{File.join(@blog_root, POSTS_DIR)}/*#{slug}.md"].first
+      
+      raise PostNotFoundError unless post_file_path && File.exist?(post_file_path)
+
+      Postwave::Post.new_from_file_path(post_file_path)
+    end
+
+    # returns: an array of posts - [Postwave::Post]
+    def posts(offset: 0, limit: nil, tag: nil)
+      posts = @all_posts || get_all_posts
+      posts = posts.select { |post| post.tags.include?(tag) } if tag
+      count = limit || posts.size
+      posts[offset, count]
+    end
+
+    # returns: an array of tags - [String]
+    def tags
+      summary = @blog_summary || get_summary
+      summary[:tags]
+    end
+
+    # returns: a Tag Struct - <Tag tag: "", count: Integer, post_slugs: ["post-slug",..]
+    def tag(tag)
+      tag_file_path = File.join(@blog_root, POSTS_DIR, META_DIR, TAGS_DIR, "#{tag}.yaml")
+      raise TagNotFoundError unless File.exist?(tag_file_path)
+
+      tag_info = YAML.load_file(tag_file_path)
+
+      Postwave::Tag.new(tag, tag_info[:count], tag_info[:post_slugs])
+    end
+
+    private
+
+    def is_valid_config?(config_path)
+      File.exist?(config_path)
+    end
+
+    def get_all_posts
+      posts = []
+      Dir.glob(File.join(@blog_root, POSTS_DIR, "*.md")) do |post_file_path|
+        posts << Postwave::Post.new_from_file_path(post_file_path)
+      end
+      posts.reject! { |p| p.draft if p.respond_to? :draft }
+      posts.sort_by { |p| p.date }.reverse
+    end
+
+    def get_full_index
+      full_index = []
+      index_contents = CSV.read(File.join(@blog_root, POSTS_DIR, META_DIR, INDEX_FILE_NAME))
+      index_contents.shift # skip header                 
+      index_contents.each do |post|
+      full_index << Postwave::PostStub.new(Time.parse(post[1]), post[2], post[0])
+      end
+      full_index
+    end
+
+    def get_summary
+      summary_file_path = File.join(@blog_root, POSTS_DIR, META_DIR, SUMMARY_FILE_NAME)
+      YAML.load_file(summary_file_path)
+    end
+  end
+end

data/lib/postwave/errors.rb

@@ -0,0 +1,16 @@
+module Postwave
+  class PostwaveError < StandardError
+  end
+
+  class MissingConfigError < PostwaveError
+  end
+
+  class InvalidBlogError < PostwaveError
+  end
+
+  class PostNotFoundError < PostwaveError
+  end
+
+  class TagNotFoundError < PostwaveError
+  end
+end

data/lib/postwave/post.rb

@@ -0,0 +1,67 @@
+require_relative "blog_utilities"
+
+module Postwave
+  class Post
+    include BlogUtilities
+
+    MEATADATA_DELIMTER = "---"
+
+    attr_reader :file_name, :slug
+
+    def self.new_from_file_path(path)
+      metadata_delimter_count = 0
+      body_buffer_count = 0
+      field_content = { "body" => "" }
+
+      File.readlines(path).each do |line|
+        clean_line = line.chomp
+        if clean_line == MEATADATA_DELIMTER
+          metadata_delimter_count += 1
+          next
+        end
+
+        if metadata_delimter_count == 0
+          next
+        elsif metadata_delimter_count == 1
+          field, value = clean_line.split(":", 2).map(&:strip)
+          field_content[field] = value
+        else
+          if body_buffer_count == 0
+            body_buffer_count += 1
+            next if clean_line.empty?
+          end
+
+          field_content["body"] += "#{line}\n"
+        end
+      end
+
+      # turn "date" into a Time object
+      field_content["date"] = Time.parse(field_content["date"])
+
+      # turn "tags" into an array
+      if field_content["tags"]
+        field_content["tags"] = field_content["tags"].split(",").map do |tag|
+          tag.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+        end
+      end
+
+      # turn "draft" into boolean
+      if field_content["draft"]
+        field_content["draft"] = field_content["draft"].downcase == "true"
+      end
+
+      self.new(path, field_content)
+    end
+    
+    def initialize(file_name, field_content = {})
+      @file_name = file_name
+      @slug = file_name.split("/").last[...-3] # cut off ".md"
+
+      field_content.each do |field, value|
+        instance_variable_set("@#{field}", value) unless self.instance_variables.include?("@#{field}".to_sym)
+        self.class.send(:attr_reader, field) unless self.public_methods.include?(field.to_sym)
+      end
+    end
+  end
+end
+

data/lib/postwave/version.rb

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

data/lib/postwave.rb

@@ -0,0 +1,6 @@
+require_relative "postwave/client"
+
+module Postwave
+  PostStub = Struct.new(:date, :title, :slug)
+  Tag = Struct.new(:name, :count, :post_slugs)
+end

data/postwave-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postwave/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "postwave-client"
+  spec.version       = Postwave::VERSION
+  spec.authors       = ["Dave Schwantes"]
+  spec.email         = ["dave.schwantes@gmail.com"]
+
+  spec.summary       = "A Ruby client for interacting with Postwave blogs."
+  spec.description   = "Write your posts statically. Interact with them dynamically."
+  spec.homepage      = "https://github.com/dorkrawk/postwave-client-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency ""
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.3"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: postwave-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Schwantes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: Write your posts statically. Interact with them dynamically.
+email:
+- dave.schwantes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- lib/postwave.rb
+- lib/postwave/blog_utilities.rb
+- lib/postwave/client.rb
+- lib/postwave/errors.rb
+- lib/postwave/post.rb
+- lib/postwave/version.rb
+- postwave-client.gemspec
+homepage: https://github.com/dorkrawk/postwave-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A Ruby client for interacting with Postwave blogs.
+test_files: []