jpie 0.4.5 → 1.0.0

data/examples/pagination.md

@@ -1,303 +0,0 @@
-# Pagination Example
-
-This example demonstrates how to implement pagination with JPie resources using both simple and JSON:API standard pagination parameters.
-
-## Setup
-
-### 1. Model (`app/models/article.rb`)
-```ruby
-class Article < ActiveRecord::Base
-  validates :title, presence: true
-  validates :content, presence: true
-end
-```
-
-### 2. Resource (`app/resources/article_resource.rb`)
-```ruby
-class ArticleResource < JPie::Resource
-  attributes :title, :content, :published_at
-end
-```
-
-### 3. Controller (`app/controllers/articles_controller.rb`)
-```ruby
-class ArticlesController < ApplicationController
-  include JPie::Controller
-end
-```
-
-### 4. Routes (`config/routes.rb`)
-```ruby
-Rails.application.routes.draw do
-  resources :articles
-end
-```
-
-## HTTP Examples
-
-### Simple Pagination Parameters
-
-#### Get First Page with 5 Articles
-```http
-GET /articles?page=1&per_page=5
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    {
-      "id": "1",
-      "type": "articles",
-      "attributes": {
-        "title": "First Article",
-        "content": "Content of first article",
-        "published_at": "2024-01-01T10:00:00Z"
-      }
-    },
-    {
-      "id": "2",
-      "type": "articles",
-      "attributes": {
-        "title": "Second Article",
-        "content": "Content of second article",
-        "published_at": "2024-01-02T10:00:00Z"
-      }
-    }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 1,
-      "per_page": 5,
-      "total_pages": 4,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?page=1&per_page=5",
-    "first": "http://example.com/articles?page=1&per_page=5",
-    "last": "http://example.com/articles?page=4&per_page=5",
-    "next": "http://example.com/articles?page=2&per_page=5"
-  }
-}
-```
-
-#### Get Second Page
-```http
-GET /articles?page=2&per_page=5
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    {
-      "id": "6",
-      "type": "articles",
-      "attributes": {
-        "title": "Sixth Article",
-        "content": "Content of sixth article",
-        "published_at": "2024-01-06T10:00:00Z"
-      }
-    }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 2,
-      "per_page": 5,
-      "total_pages": 4,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?page=2&per_page=5",
-    "first": "http://example.com/articles?page=1&per_page=5",
-    "last": "http://example.com/articles?page=4&per_page=5",
-    "prev": "http://example.com/articles?page=1&per_page=5",
-    "next": "http://example.com/articles?page=3&per_page=5"
-  }
-}
-```
-
-### JSON:API Standard Pagination Parameters
-
-#### Get First Page Using JSON:API Format
-```http
-GET /articles?page[number]=1&page[size]=3
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    {
-      "id": "1",
-      "type": "articles",
-      "attributes": {
-        "title": "First Article",
-        "content": "Content of first article",
-        "published_at": "2024-01-01T10:00:00Z"
-      }
-    },
-    {
-      "id": "2",
-      "type": "articles",
-      "attributes": {
-        "title": "Second Article",
-        "content": "Content of second article",
-        "published_at": "2024-01-02T10:00:00Z"
-      }
-    },
-    {
-      "id": "3",
-      "type": "articles",
-      "attributes": {
-        "title": "Third Article",
-        "content": "Content of third article",
-        "published_at": "2024-01-03T10:00:00Z"
-      }
-    }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 1,
-      "per_page": 3,
-      "total_pages": 7,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?page=1&per_page=3",
-    "first": "http://example.com/articles?page=1&per_page=3",
-    "last": "http://example.com/articles?page=7&per_page=3",
-    "next": "http://example.com/articles?page=2&per_page=3"
-  }
-}
-```
-
-### Pagination with Sorting
-
-#### Get Sorted and Paginated Results
-```http
-GET /articles?sort=-published_at&page=1&per_page=3
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    {
-      "id": "20",
-      "type": "articles",
-      "attributes": {
-        "title": "Latest Article",
-        "content": "Most recent content",
-        "published_at": "2024-01-20T10:00:00Z"
-      }
-    },
-    {
-      "id": "19",
-      "type": "articles",
-      "attributes": {
-        "title": "Second Latest Article",
-        "content": "Second most recent content",
-        "published_at": "2024-01-19T10:00:00Z"
-      }
-    },
-    {
-      "id": "18",
-      "type": "articles",
-      "attributes": {
-        "title": "Third Latest Article",
-        "content": "Third most recent content",
-        "published_at": "2024-01-18T10:00:00Z"
-      }
-    }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 1,
-      "per_page": 3,
-      "total_pages": 7,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?sort=-published_at&page=1&per_page=3",
-    "first": "http://example.com/articles?sort=-published_at&page=1&per_page=3",
-    "last": "http://example.com/articles?sort=-published_at&page=7&per_page=3",
-    "next": "http://example.com/articles?sort=-published_at&page=2&per_page=3"
-  }
-}
-```
-
-### Last Page Response
-
-#### Get Last Page
-```http
-GET /articles?page=4&per_page=5
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    {
-      "id": "20",
-      "type": "articles",
-      "attributes": {
-        "title": "Last Article",
-        "content": "Content of last article",
-        "published_at": "2024-01-20T10:00:00Z"
-      }
-    }
-  ],
-  "meta": {
-    "pagination": {
-      "page": 4,
-      "per_page": 5,
-      "total_pages": 4,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?page=4&per_page=5",
-    "first": "http://example.com/articles?page=1&per_page=5",
-    "last": "http://example.com/articles?page=4&per_page=5",
-    "prev": "http://example.com/articles?page=3&per_page=5"
-  }
-}
-```
-
-### Empty Results
-
-#### Get Page Beyond Available Data
-```http
-GET /articles?page=10&per_page=5
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": [],
-  "meta": {
-    "pagination": {
-      "page": 10,
-      "per_page": 5,
-      "total_pages": 4,
-      "total_count": 20
-    }
-  },
-  "links": {
-    "self": "http://example.com/articles?page=10&per_page=5",
-    "first": "http://example.com/articles?page=1&per_page=5",
-    "last": "http://example.com/articles?page=4&per_page=5"
-  }
-}
-``` 

data/examples/relationships.md

@@ -1,114 +0,0 @@
-# JSON:API Relationship Management
-
-This example demonstrates how to manage relationships using JPie's JSON:API compliant relationship endpoints.
-
-## Setup
-
-Define your resources with relationships:
-
-```ruby
-# app/resources/user_resource.rb
-class UserResource < JPie::Resource
-  model User
-  attributes :name, :email
-  has_many :posts
-end
-
-# app/resources/post_resource.rb  
-class PostResource < JPie::Resource
-  model Post
-  attributes :title, :content
-  has_one :author, resource: 'UserResource'
-end
-
-# app/controllers/users_controller.rb
-class UsersController < ApplicationController
-  include JPie::Controller
-end
-```
-
-Configure routes:
-
-```ruby
-# config/routes.rb
-Rails.application.routes.draw do
-  jpie_resources :users
-  jpie_resources :posts
-end
-```
-
-## Relationship Operations
-
-### Get Relationship Linkage
-
-```http
-GET /users/1/relationships/posts
-
-Response:
-{
-  "data": [
-    { "type": "posts", "id": "1" },
-    { "type": "posts", "id": "3" }
-  ]
-}
-```
-
-### Replace Relationship
-
-```http
-PATCH /users/1/relationships/posts
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    { "type": "posts", "id": "2" },
-    { "type": "posts", "id": "4" }
-  ]
-}
-```
-
-### Add to Relationship
-
-```http
-POST /users/1/relationships/posts
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    { "type": "posts", "id": "5" }
-  ]
-}
-```
-
-### Remove from Relationship
-
-```http
-DELETE /users/1/relationships/posts
-Content-Type: application/vnd.api+json
-
-{
-  "data": [
-    { "type": "posts", "id": "2" }
-  ]
-}
-```
-
-### Get Related Resources
-
-```http
-GET /users/1/posts
-
-Response:
-{
-  "data": [
-    {
-      "type": "posts",
-      "id": "1",
-      "attributes": {
-        "title": "First Post",
-        "content": "Hello world!"
-      }
-    }
-  ]
-}
-```

data/examples/resource_attribute_configuration.md

@@ -1,147 +0,0 @@
-# Resource Attribute Configuration Example
-
-This example demonstrates all the different ways to configure resource attributes in JPie, showcasing the various configuration patterns and customization techniques available for attributes.
-
-## Setup
-
-### 1. Model (`app/models/user.rb`)
-```ruby
-class User < ActiveRecord::Base
-  validates :first_name, presence: true
-  validates :last_name, presence: true
-  validates :email, presence: true, uniqueness: true
-  validates :username, presence: true, uniqueness: true
-  
-  def active?
-    true # Simple boolean for demonstration
-  end
-end
-```
-
-### 2. Resource with All Attribute Configuration Types (`app/resources/user_resource.rb`)
-```ruby
-class UserResource < JPie::Resource
-  # 1. Basic attributes - direct model attribute access
-  attributes :email, :first_name, :last_name
-  
-  # 2. Attribute with custom attr mapping (maps to different model attribute)
-  attribute :display_name, attr: :username
-  
-  # 3. Attribute with block override
-  attribute :status do
-    object.active? ? 'active' : 'inactive'
-  end
-  
-  # 4. Attribute with custom method override
-  attribute :full_name
-  
-  private
-  
-  # Custom method for attribute override
-  def full_name
-    "#{object.first_name} #{object.last_name}".strip
-  end
-end
-```
-
-### 3. Controller (`app/controllers/users_controller.rb`)
-```ruby
-class UsersController < ApplicationController
-  include JPie::Controller
-end
-```
-
-## HTTP Examples
-
-### Create User
-```http
-POST /users
-Content-Type: application/vnd.api+json
-
-{
-  "data": {
-    "type": "users",
-    "attributes": {
-      "email": "john.doe@example.com",
-      "first_name": "John",
-      "last_name": "Doe"
-    }
-  }
-}
-
-HTTP/1.1 201 Created
-Content-Type: application/vnd.api+json
-
-{
-  "data": {
-    "id": "1",
-    "type": "users",
-    "attributes": {
-      "email": "john.doe@example.com",
-      "first_name": "John",
-      "last_name": "Doe",
-      "display_name": "johndoe",
-      "status": "active",
-      "full_name": "John Doe"
-    }
-  }
-}
-```
-
-### Update User
-```http
-PATCH /users/1
-Content-Type: application/vnd.api+json
-
-{
-  "data": {
-    "id": "1",
-    "type": "users",
-    "attributes": {
-      "first_name": "Jonathan"
-    }
-  }
-}
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": {
-    "id": "1",
-    "type": "users",
-    "attributes": {
-      "email": "john.doe@example.com",
-      "first_name": "Jonathan",
-      "last_name": "Doe",
-      "display_name": "johndoe",
-      "status": "active",
-      "full_name": "Jonathan Doe"
-    }
-  }
-}
-```
-
-### Get User with All Attribute Configuration Types
-```http
-GET /users/1
-Accept: application/vnd.api+json
-
-HTTP/1.1 200 OK
-Content-Type: application/vnd.api+json
-
-{
-  "data": {
-    "id": "1",
-    "type": "users",
-    "attributes": {
-      "email": "john.doe@example.com",
-      "first_name": "John",
-      "last_name": "Doe",
-      "display_name": "johndoe",
-      "status": "active",
-      "full_name": "John Doe"
-    }
-  }
-}
-```