microcms-ruby-sdk 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +109 -19
  3. data/lib/microcms/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 678191607289752b9a2386131264cd89431df1547a88884a33e67955b68c484d
4
- data.tar.gz: c14c1456eff2800d550e27e726bdb0e6759c30e3153141ef2baa2f2d915eadf7
3
+ metadata.gz: 2892962110d682580cb5eb813bea75f334d47a7dde30f7aa67c07f0d7c8fc05c
4
+ data.tar.gz: 822122a22a386cd1a46b3a605f5b1f162f5c700acd99e1fe34fda37f9f2b34d1
5
5
  SHA512:
6
- metadata.gz: b0700d1b1c2d2d405d51ec2e109d972ee6acc431b846ea748c7a524f577ae6e4b27e8f18c77915d00cb051af24e6a1a6587734a5f27448b8e19d020f6bdb5481
7
- data.tar.gz: 13d7a4e0a57332cb7ab0d3e53ac5de7eb534cb9c1aced647b0014d8521ca694ea52277227b3ece61c909f9f3eae5e52e069cf350c594772c6d76ea0c71d3733d
6
+ metadata.gz: 5b31e0ff740a05af775a86893ae6a3d502439878ced5665266ce8ea49031bf34518a52e1057820af2dd6a0dcd9e47ee219baf5f5e726698a75536299993cb571
7
+ data.tar.gz: 95f62f1b8271769675dc06ce7a73c082183c04a0256507ec28854d0dffe8a3f0bc63f0bc1044fe5b1a50238bdffe143642aa2a3834b6b07959b7c74fbd39a39d
data/README.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  [microCMS](https://document.microcms.io/manual/api-request) Ruby SDK.
4
4
 
5
+ ## Tutorial
6
+
7
+ See [official tutorial](https://document.microcms.io/tutorial/ruby/ruby-top).
8
+
5
9
  ## Installation
6
10
 
7
11
  Add this line to your application's Gemfile:
@@ -20,38 +24,124 @@ Or install it yourself as:
20
24
 
21
25
  ## Usage
22
26
 
27
+ ### Import
28
+
23
29
  ```rb
24
30
  require 'microcms'
31
+ ```
25
32
 
26
- MicroCMS.service_domain = ENV['YOUR_DOMAIN']
27
- MicroCMS.api_key = ENV['YOUR_API_KEY']
33
+ ### Create client object
28
34
 
29
- endpoint = ENV['YOUR_ENDPOINT']
35
+ ```rb
36
+ MicroCMS.service_domain = 'YOUR_DOMAIN'
37
+ MicroCMS.api_key = 'YOUR_API_KEY'
38
+ ```
30
39
 
31
- puts MicroCMS.list(endpoint)
40
+ ### Get content list
32
41
 
33
- puts MicroCMS.list(endpoint, {
34
- limit: 100,
35
- offset: 1,
36
- orders: ['updatedAt'],
37
- q: 'Hello',
38
- fields: %w[id title],
39
- filters: 'publishedAt[greater_than]2021-01-01'
40
- })
42
+ ```rb
43
+ puts MicroCMS.list('endpoint')
44
+ ```
41
45
 
42
- puts MicroCMS.get(endpoint, 'ruby')
46
+ ### Get content list with parameters
43
47
 
44
- puts MicroCMS.get(endpoint, 'ruby', { draft_key: 'abcdef1234' })
48
+ ```rb
49
+ puts MicroCMS.list(
50
+ 'endpoint',
51
+ {
52
+ drarf_key: "abcd",
53
+ limit: 100,
54
+ offset: 1,
55
+ orders: ['updatedAt'],
56
+ q: 'Hello',
57
+ fields: %w[id title],
58
+ ids: ['foo'],
59
+ filters: 'publishedAt[greater_than]2021-01-01',
60
+ depth: 1,
61
+ },
62
+ )
63
+ ```
45
64
 
46
- puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' })
65
+ ### Get single content
47
66
 
48
- puts MicroCMS.create(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk!' })
67
+ ```rb
68
+ puts MicroCMS.get('endpoint', 'ruby')
69
+ ```
70
+
71
+ ### Get single content with parameters
72
+
73
+ ```rb
74
+ puts MicroCMS.get(
75
+ 'endpoint',
76
+ 'ruby',
77
+ {
78
+ draft_key: 'abcdef1234',
79
+ fields: %w[title publishedAt],
80
+ depth: 1,
81
+ },
82
+ )
83
+ ```
49
84
 
50
- puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' }, { status: 'draft' })
85
+ ### Get object form content
51
86
 
52
- puts MicroCMS.update(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk update method!' })
87
+ ```rb
88
+ puts MicroCMS.get('endpoint')
89
+ ```
90
+
91
+ ### Create content
53
92
 
54
- MicroCMS.delete(endpoint, 'microcms-ruby-sdk')
93
+ ```rb
94
+ puts MicroCMS.create('endpoint', { text: 'Hello, microcms-ruby-sdk!' })
95
+ ```
96
+
97
+ ### Create content with specified ID
98
+
99
+ ```rb
100
+ puts MicroCMS.create(
101
+ 'endpoint',
102
+ {
103
+ id: 'my-content-id',
104
+ text: 'Hello, microcms-ruby-sdk!',
105
+ },
106
+ )
107
+ ```
108
+
109
+ ### Create draft content
110
+
111
+ ```rb
112
+ puts MicroCMS.create(
113
+ 'endpoint',
114
+ {
115
+ id: 'my-content-id',
116
+ text: 'Hello, microcms-ruby-sdk!',
117
+ },
118
+ { status: 'draft' },
119
+ )
120
+ ```
121
+
122
+ ### Update content
123
+
124
+ ```rb
125
+
126
+ puts MicroCMS.update(
127
+ 'endpoint',
128
+ {
129
+ id: 'microcms-ruby-sdk',
130
+ text: 'Hello, microcms-ruby-sdk update method!',
131
+ },
132
+ )
133
+ ```
134
+
135
+ ### Update object form content
136
+
137
+ ```rb
138
+ puts MicroCMS.update('endpoint', { text: 'Hello, microcms-ruby-sdk update method!' })
139
+ ```
140
+
141
+ ### Delete content
142
+
143
+ ```rb
144
+ MicroCMS.delete('endpoint', 'microcms-ruby-sdk')
55
145
  ```
56
146
 
57
147
  ## Development
data/lib/microcms/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module MicroCMS
4
- VERSION = '1.0.0'
4
+ VERSION = '1.0.1'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: microcms-ruby-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - microCMS
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-11-01 00:00:00.000000000 Z
11
+ date: 2021-11-05 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: microCMS Ruby SDK
14
14
  email: