microcms-ruby-sdk 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a385106245efd6bff8bb32a5080188cc526452d2a6646c78e8b4a3dd6e0c7a
-  data.tar.gz: f69e0cae151baa48de93ae0ec0439d4cf6fa914b10385004bb364a1b6c362c6d
+  metadata.gz: ce42fc094821080f133ac9faf93e5efbe4cc7fec65ad4930e65e61a4eb3e4add
+  data.tar.gz: bf9c56b513719887e1ac417db6e903d2b299e583a66f6a39c515e315dc54b714
 SHA512:
-  metadata.gz: 04cc22687f37accb8ddfebf7597ec5722da698fd4bcc1f9a700a0ca4b675c2fdde6856a0036d1c0fa00587f198e2de2d50ef81780a7004987d5c97e3d82841c1
-  data.tar.gz: 228aa61af54530e1ff3569d1e1ee1c07e896ea1342968740630db43c9e23060ccda55eadebc0333adc90deb1d0c879cbfc473a115a459d71c16bf90d655b79f7
+  metadata.gz: 18650d072175f4ce851f0d66cb60b6e2a6bd588bb6184bd88b8424783a73f183391e60b2a2ac07f75546efba1c29bf863939edccd5c74d6f35796ebfc1013ebf
+  data.tar.gz: 6f92d78767727676f97041bbb4bbc934ead25ab774b73322517c7664640cca91c9589c1dd47340da2fca434655977cc9a715d6966a8914145fd9177e84659f9c

data/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/README.md

@@ -2,12 +2,16 @@
 
 [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:
 
 ```ruby
-gem 'microcms'
+gem 'microcms-ruby-sdk'
 ```
 
 And then execute:
@@ -20,36 +24,124 @@ Or install it yourself as:
 
 ## Usage
 
+### Import
+
+```rb
+require 'microcms'
+```
+
+### Create client object
+
+```rb
+MicroCMS.service_domain = 'YOUR_DOMAIN'
+MicroCMS.api_key = 'YOUR_API_KEY'
+```
+
+### Get content list
+
+```rb
+puts MicroCMS.list('endpoint')
+```
+
+### Get content list with parameters
+
+```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,
+    },
+)
+```
+
+### Get single content
+
+```rb
+puts MicroCMS.get('endpoint', 'ruby')
+```
+
+### Get single content with parameters
+
 ```rb
-MicroCMS.service_domain = ENV['YOUR_DOMAIN']
-MicroCMS.api_key = ENV['YOUR_API_KEY']
+puts MicroCMS.get(
+    'endpoint',
+    'ruby',
+    {
+        draft_key: 'abcdef1234',
+        fields: %w[title publishedAt],
+        depth: 1,
+    },
+)
+```
 
-endpoint = ENV['YOUR_ENDPOINT']
+### Get object form content
 
-puts MicroCMS.list(endpoint)
+```rb
+puts MicroCMS.get('endpoint')
+```
 
-puts MicroCMS.list(endpoint, {
-                     limit: 100,
-                     offset: 1,
-                     orders: ['updatedAt'],
-                     q: 'Hello',
-                     fields: %w[id title],
-                     filters: 'publishedAt[greater_than]2021-01-01'
-                   })
+### Create content
 
-puts MicroCMS.get(endpoint, 'ruby')
+```rb
+puts MicroCMS.create('endpoint', { text: 'Hello, microcms-ruby-sdk!' })
+```
 
-puts MicroCMS.get(endpoint, 'ruby', { draft_key: 'abcdef1234' })
+### Create content with specified ID
 
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' })
+```rb
+puts MicroCMS.create(
+    'endpoint',
+    {
+        id: 'my-content-id',
+        text: 'Hello, microcms-ruby-sdk!',
+    },
+)
+```
 
-puts MicroCMS.create(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk!' })
+### Create draft content
 
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' }, { status: 'draft' })
+```rb
+puts MicroCMS.create(
+    'endpoint',
+    {
+        id: 'my-content-id',
+        text: 'Hello, microcms-ruby-sdk!',
+    },
+    { status: 'draft' },
+)
+```
 
-puts MicroCMS.update(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk update method!' })
+### Update content
 
-MicroCMS.delete(endpoint, 'microcms-ruby-sdk')
+```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 = '0.2.0'
+  VERSION = '1.0.2'
 end

data/lib/microcms.rb

@@ -28,7 +28,12 @@ module MicroCMS
     end
 
     def list(endpoint, option = {})
-      send_http_request('GET', endpoint, nil, build_query(option))
+      list = send_http_request('GET', endpoint, nil, build_query(option))
+      if list[:totalCount]
+        list[:total_count] = list[:totalCount]
+        list.delete_field(:totalCount)
+      end
+      list
     end
 
     def get(endpoint, id = '', option = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microcms-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - microCMS
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies: []
 description: microCMS Ruby SDK
 email: 
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -52,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: microCMS Ruby SDK