microcms-ruby-sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678191607289752b9a2386131264cd89431df1547a88884a33e67955b68c484d
-  data.tar.gz: c14c1456eff2800d550e27e726bdb0e6759c30e3153141ef2baa2f2d915eadf7
+  metadata.gz: 2892962110d682580cb5eb813bea75f334d47a7dde30f7aa67c07f0d7c8fc05c
+  data.tar.gz: 822122a22a386cd1a46b3a605f5b1f162f5c700acd99e1fe34fda37f9f2b34d1
 SHA512:
-  metadata.gz: b0700d1b1c2d2d405d51ec2e109d972ee6acc431b846ea748c7a524f577ae6e4b27e8f18c77915d00cb051af24e6a1a6587734a5f27448b8e19d020f6bdb5481
-  data.tar.gz: 13d7a4e0a57332cb7ab0d3e53ac5de7eb534cb9c1aced647b0014d8521ca694ea52277227b3ece61c909f9f3eae5e52e069cf350c594772c6d76ea0c71d3733d
+  metadata.gz: 5b31e0ff740a05af775a86893ae6a3d502439878ced5665266ce8ea49031bf34518a52e1057820af2dd6a0dcd9e47ee219baf5f5e726698a75536299993cb571
+  data.tar.gz: 95f62f1b8271769675dc06ce7a73c082183c04a0256507ec28854d0dffe8a3f0bc63f0bc1044fe5b1a50238bdffe143642aa2a3834b6b07959b7c74fbd39a39d

data/README.md

@@ -2,6 +2,10 @@
 
 [microCMS](https://document.microcms.io/manual/api-request) Ruby SDK.
 
+## Tutorial
+
+See [official tutorial](https://document.microcms.io/tutorial/ruby/ruby-top).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,38 +24,124 @@ Or install it yourself as:
 
 ## Usage
 
+### Import
+
 ```rb
 require 'microcms'
+```
 
-MicroCMS.service_domain = ENV['YOUR_DOMAIN']
-MicroCMS.api_key = ENV['YOUR_API_KEY']
+### Create client object
 
-endpoint = ENV['YOUR_ENDPOINT']
+```rb
+MicroCMS.service_domain = 'YOUR_DOMAIN'
+MicroCMS.api_key = 'YOUR_API_KEY'
+```
 
-puts MicroCMS.list(endpoint)
+### Get content list
 
-puts MicroCMS.list(endpoint, {
-                     limit: 100,
-                     offset: 1,
-                     orders: ['updatedAt'],
-                     q: 'Hello',
-                     fields: %w[id title],
-                     filters: 'publishedAt[greater_than]2021-01-01'
-                   })
+```rb
+puts MicroCMS.list('endpoint')
+```
 
-puts MicroCMS.get(endpoint, 'ruby')
+### Get content list with parameters
 
-puts MicroCMS.get(endpoint, 'ruby', { draft_key: 'abcdef1234' })
+```rb
+puts MicroCMS.list(
+    'endpoint',
+    {
+        drarf_key: "abcd",
+        limit: 100,
+        offset: 1,
+        orders: ['updatedAt'],
+        q: 'Hello',
+        fields: %w[id title],
+        ids: ['foo'],
+        filters: 'publishedAt[greater_than]2021-01-01',
+        depth: 1,
+    },
+)
+```
 
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' })
+### Get single content
 
-puts MicroCMS.create(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk!' })
+```rb
+puts MicroCMS.get('endpoint', 'ruby')
+```
+
+### Get single content with parameters
+
+```rb
+puts MicroCMS.get(
+    'endpoint',
+    'ruby',
+    {
+        draft_key: 'abcdef1234',
+        fields: %w[title publishedAt],
+        depth: 1,
+    },
+)
+```
 
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' }, { status: 'draft' })
+### Get object form content
 
-puts MicroCMS.update(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk update method!' })
+```rb
+puts MicroCMS.get('endpoint')
+```
+
+### Create content
 
-MicroCMS.delete(endpoint, 'microcms-ruby-sdk')
+```rb
+puts MicroCMS.create('endpoint', { text: 'Hello, microcms-ruby-sdk!' })
+```
+
+### Create content with specified ID
+
+```rb
+puts MicroCMS.create(
+    'endpoint',
+    {
+        id: 'my-content-id',
+        text: 'Hello, microcms-ruby-sdk!',
+    },
+)
+```
+
+### Create draft content
+
+```rb
+puts MicroCMS.create(
+    'endpoint',
+    {
+        id: 'my-content-id',
+        text: 'Hello, microcms-ruby-sdk!',
+    },
+    { status: 'draft' },
+)
+```
+
+### Update content
+
+```rb
+
+puts MicroCMS.update(
+    'endpoint',
+    {
+        id: 'microcms-ruby-sdk',
+        text: 'Hello, microcms-ruby-sdk update method!',
+    },
+)
+```
+
+### Update object form content
+
+```rb
+puts MicroCMS.update('endpoint', { text: 'Hello, microcms-ruby-sdk update method!' })
+```
+
+### Delete content
+
+```rb
+MicroCMS.delete('endpoint', 'microcms-ruby-sdk')
 ```
 
 ## Development

data/lib/microcms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MicroCMS
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microcms-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - microCMS
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies: []
 description: microCMS Ruby SDK
 email: