tinycms 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0c4fb70348684b50ca97c4fda49dc8e09952033b95bcbfbeee6b4dfd840960
-  data.tar.gz: e98b821a13fe0ee239fd5c0850eed29ed8b16e4076c0f610aa0939556ffa7875
+  metadata.gz: 8b26637277ab8f25e0a52fb3a922f75e70c26f12c76f8eeb65e7da52e09626be
+  data.tar.gz: f6d26c1525168d41de67c5175f74018b44a6de8890382b1f523af1bfae539e40
 SHA512:
-  metadata.gz: a01e12267ac40b99680234a8354258682ff1bbf208b9bb7d68b4e68d85c646ef1b5a5f4bbcb2027f0368e4cfe5791f7f4402f67109a835f41ac6c0055d7ab372
-  data.tar.gz: a03f502dc00ab0157ceb9d7f23a09b1e13d4da4f55f6ca50514d3a0e289679d5e8294f18af31b9229df6644d4785003b9328c754a7ef10a75575116169c959d1
+  metadata.gz: fbecea65017edf08c97cdc8dca717c38f798dcad8da08653de8bec9d526c095cec21992edcc2e5bb18764dbcb722d82ddacb7313199734d1d60f2d78ec0e06e7
+  data.tar.gz: ae10dc67c6c6a015bf98d0145e9be5bb5b03013632d8ac2bd0a01d734421dd5455d9db6778f143ef53b0dedad28d9fc028049dc91268932343ec97de3b07a74f

data/README.md

@@ -1,24 +1,127 @@
 # Tinycms
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tinycms`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is used to integrate your Rails app with the Tinycms headless CMS. Add the gem to your Rails app, set the api_key in the initializer, and you're ready to go.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+This gem is meant to be used with Rails apps.
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add tinycms
+
+Create an initializer in `config/initializers/tinycms.rb`. And configure the initializer as:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+Tinycms.configure do |config|
+  config.api_key = `YOUR-API-KEY`
+end
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+To get the api key, sign up for [TinyCMS](https://www.tinycms.app) and grab the api key in the settings page.
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem is simple, meant to pull down blogs and posts.
+
+### Blogs
+```ruby
+# get all blogs
+Tinycms::Blogs::Api.get_all
+
+# get blog via blog_id or slug
+Tinycms::Blogs::Api.get(<blog_id>)
+# or
+Tinycms::Blogs::Api.api.get(<slug>)
+```
+
+The blogs api will return instance(s) of blog(s) with a list of posts. You can use the post ids that you get in this endpoint to make requests to the posts endpoint.
+
+### Posts
+```ruby
+# get post via post_id or slug
+Tinycms::Posts::Api.get(<post_id>)
+Tinycms::Posts::Api.get(<slug>)
+```
+
+The posts api will return an instance of a post with the author information.
+
+### Rendering Blogs and Posts
+
+Add to your routes file `config/routes.rb` the following routes. Customize the routes to your needs/preferences.
+
+```ruby
+Rails.application.routes.draw do
+  get "blogs", to: "blogs#index"
+  get "blogs/:id", to: "blogs#show"
+
+  get "posts/:id", to: "posts#show"
+
+  # OR...
+  resources :blogs, only: [:index, :show]
+  resources :posts, only: :show
+end
+```
+
+Rendering blogs and posts
+
+```ruby
+class BlogsController < ApplicationController
+  def index
+    @blogs = Tinycms::Blogs::Api.get_all
+  end
+
+  def show
+    @blog = Tinycms::Blogs::Api.get(params[:id])
+  end
+end
+```
+
+```html
+# index.html.erb
+# link via via blog id
+<ul>
+  <% @blogs.each do |blog| %>
+    <li><%= link_to blog.name, blog_path(id: blog.id) %></li>
+  <% end %>
+</ul>
+
+# link via via blog slug
+<ul>
+  <% @blogs.each do |blog| %>
+    <li><%= link_to blog.name, blog_path(id: blog.slug) %></li>
+  <% end %>
+</ul>
+
+# show.html.erb
+# link via post id
+<ul>
+  <% @blog.posts.each do |post| %>
+    <li><%= link_to post.title, post_path(id: post.id) %></li>
+  <% end %>
+</ul>
+
+# link via post slug
+<ul>
+  <% @blog.posts.each do |post| %>
+    <li><%= link_to post.title, post_path(id: post.slug) %></li>
+  <% end %>
+</ul>
+```
+
+Rendering a post
+
+```ruby
+class PostsController < ApplicationController
+  def show
+    @post = Tinycms::Posts::Api.get(params[:id])
+  end
+end
+```
+
+```html
+<%= @post.content.html_safe %>
+```
 
 ## Development
 
@@ -28,7 +131,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tinycms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tinycms/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/typefastco/tinycms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/typefastco/tinycms/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/tinycms/author.rb

@@ -2,13 +2,15 @@
 
 module Tinycms
   class Author
-    def initialize(id:, email:, first_name:, last_name:)
+    def initialize(id:, email:, first_name:, last_name:, created_at:, updated_at:)
       @id = id
       @email = email
       @first_name = first_name
       @last_name = last_name
+      @created_at = created_at
+      @updated_at = updated_at
     end
 
-    attr_reader :id, :email, :first_name, :last_name
+    attr_reader :id, :email, :first_name, :last_name, :created_at, :updated_at
   end
 end

data/lib/tinycms/authors/mapper.rb

@@ -8,7 +8,9 @@ module Tinycms
           id: response_body["id"],
           email: response_body["email"],
           first_name: response_body["first_name"],
-          last_name: response_body["last_name"]
+          last_name: response_body["last_name"],
+          created_at: response_body["created_at"],
+          updated_at: response_body["updated_at"]
         )
       end
     end

data/lib/tinycms/base_api.rb

@@ -2,8 +2,8 @@
 
 module Tinycms
   class BaseApi
-    def client
-      @client ||= Tinycms::Client.new.client
+    def self.client
+      Tinycms::Client.new.client
     end
   end
 end

data/lib/tinycms/blog.rb

@@ -2,13 +2,15 @@
 
 module Tinycms
   class Blog
-    def initialize(id:, name:, description:, posts: [])
+    def initialize(id:, name:, description:, posts: [], created_at:, updated_at:)
       @id = id
       @name = name
       @description = description
       @posts = posts
+      @created_at = created_at
+      @updated_at = updated_at
     end
 
-    attr_reader :id, :name, :description, :posts
+    attr_reader :id, :name, :description, :posts, :created_at, :updated_at
   end
 end

data/lib/tinycms/blogs/api.rb

@@ -5,7 +5,7 @@ require "retriable"
 module Tinycms
   module Blogs
     class Api < BaseApi
-      def get_all
+      def self.get_all
         Retriable.retriable do
           response = client.get("/api/blogs")
           blogs = response.body
@@ -15,7 +15,7 @@ module Tinycms
         end
       end
 
-      def get(blog_id)
+      def self.get(blog_id)
         Retriable.retriable do
           response = client.get("/api/blogs/#{blog_id}")
           Tinycms::Blogs::Mapper.map(response.body)

data/lib/tinycms/blogs/mapper.rb

@@ -11,7 +11,9 @@ module Tinycms
           id: response_body["id"],
           name: response_body["name"],
           description: response_body["description"],
-          posts: posts
+          posts: posts,
+          created_at: response_body["created_at"],
+          updated_at: response_body["updated_at"]
         )
       end
     end

data/lib/tinycms/post.rb

@@ -2,13 +2,15 @@
 
 module Tinycms
   class Post
-    def initialize(id:, title:, author:, content:)
+    def initialize(id:, title:, author:, content:, created_at:, updated_at:)
       @id = id
       @title = title
       @author = author
       @content = content
+      @created_at = created_at
+      @updated_at = updated_at
     end
 
-    attr_reader :id, :title, :author, :content
+    attr_reader :id, :title, :author, :content, :created_at, :updated_at
   end
 end

data/lib/tinycms/posts/api.rb

@@ -5,7 +5,7 @@ require "retriable"
 module Tinycms
   module Posts
     class Api < BaseApi
-      def get(post_id)
+      def self.get(post_id)
         Retriable.retriable do
           response = client.get("/api/posts/#{post_id}")
           Tinycms::Posts::Mapper.map(response.body)

data/lib/tinycms/posts/mapper.rb

@@ -8,7 +8,9 @@ module Tinycms
           id: response_body["id"],
           title: response_body["title"],
           author: ::Tinycms::Authors::Mapper.map(response_body["author"]),
-          content: response_body["content"]
+          content: response_body["content"],
+          created_at: response_body["created_at"],
+          updated_at: response_body["updated_at"]
         )
       end
     end

data/lib/tinycms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tinycms
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinycms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Chris Jeon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-04 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable