microcms-ruby-sdk 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ac22f7433f5c15562d37eb291ab04297082a36b02fe34b14206f578fdd8a6cb
-  data.tar.gz: 5411bed835d189ca46f280fada06bb7b25a2eb937d0fda8d478be9b52fe43560
+  metadata.gz: 2f0a496c76ac71e67e1bd4f6f1994dd89ec164201389947e1d776405096612b3
+  data.tar.gz: cce04b74bb27adda2b0cb643f89db8f00ccd7dc7c4d3d6b80bbbd3870ca86c54
 SHA512:
-  metadata.gz: 294a44d8524dadb0389169bbb0022055dbfd94c53da7f99c74c37c8f88baa64192bb56f08a8b8c0915cad6297ac56c470ed2ba4de609d87320b7146fc9b5da6e
-  data.tar.gz: d0fb8d0095703342ddaa6145483691669c54f69f59a1a8446112bb353e0f28251bb6368f48b73e4d559a81d28e25f2cf702b51f5e93d6663963ea7fe65b8aaa5
+  metadata.gz: 86dd4071bf65b8870e3f45150d0ade1b2e5e9d032dac128c8fd922667b1cdcaeedb8fdf3e9093b615c908507704c1a1d844bb88011d84e887d0888baf5ebed9a
+  data.tar.gz: 3ed31472193dd1a833dc5b0b1c97691e9ded099d277a7fe244bfbe31653cdb0343baba30a0c9344836765416f7f619b4ab89dbc6cda444877b3eac6f58b2bd93

data/README.md

@@ -1,49 +1,57 @@
 # microCMS Ruby SDK
 
-[microCMS](https://document.microcms.io/manual/api-request) Ruby SDK.
+[microCMS](https://document.microcms.io/) のRuby SDKです。
 
-## Tutorial
+## 保守方針
 
-See [official tutorial](https://document.microcms.io/tutorial/ruby/ruby-top).
+このSDKの現在の保守レベルは `Maintenance` です。
 
-## Installation
+詳細は[SDKの保守方針](https://document.microcms.io/manual/limitations#hc2b0bc6659)をご覧ください。
 
-Add this line to your application's Gemfile:
+## チュートリアル
+
+[公式チュートリアル](https://document.microcms.io/tutorial/ruby/ruby-top)をご覧ください。
+
+## インストール
+
+アプリケーションのGemfileに以下を追加します。
 
 ```ruby
 gem 'microcms-ruby-sdk'
 ```
 
-And then execute:
+その後、以下を実行します。
 
     $ bundle install
 
-Or install it yourself as:
+または、以下のコマンドで直接インストールできます。
 
     $ gem install microcms-ruby-sdk
 
-## Usage
+## 使い方
 
-### Import
+### インポート
 
 ```rb
 require 'microcms'
 ```
 
-### Create client object
+### クライアントオブジェクトの作成
 
 ```rb
 MicroCMS.service_domain = 'YOUR_DOMAIN'
 MicroCMS.api_key = 'YOUR_API_KEY'
 ```
 
-### Get content list
+`YOUR_DOMAIN` にはサービスのサブドメイン名（`XXXX.microcms.io` の `XXXX` の部分）を指定してください。FQDNではありません。
+
+### コンテンツ一覧の取得
 
 ```rb
 puts MicroCMS.list('endpoint')
 ```
 
-### Get content list with parameters
+### パラメータを指定したコンテンツ一覧の取得
 
 ```rb
 puts MicroCMS.list(
@@ -53,7 +61,7 @@ puts MicroCMS.list(
         limit: 100,
         offset: 1,
         orders: ['updatedAt'],
-        q: 'Hello',
+        q: 'こんにちは',
         fields: %w[id title],
         ids: ['foo'],
         filters: 'publishedAt[greater_than]2021-01-01',
@@ -62,13 +70,13 @@ puts MicroCMS.list(
 )
 ```
 
-### Get single content
+### 単一コンテンツの取得
 
 ```rb
 puts MicroCMS.get('endpoint', 'ruby')
 ```
 
-### Get single content with parameters
+### パラメータを指定した単一コンテンツの取得
 
 ```rb
 puts MicroCMS.get(
@@ -82,74 +90,73 @@ puts MicroCMS.get(
 )
 ```
 
-### Get object form content
+### オブジェクト形式のコンテンツの取得
 
 ```rb
 puts MicroCMS.get('endpoint')
 ```
 
-### Create content
+### コンテンツの作成
 
 ```rb
-puts MicroCMS.create('endpoint', { text: 'Hello, microcms-ruby-sdk!' })
+puts MicroCMS.create('endpoint', { text: 'こんにちは、microcms-ruby-sdk！' })
 ```
 
-### Create content with specified ID
+### IDを指定したコンテンツの作成
 
 ```rb
 puts MicroCMS.create(
     'endpoint',
     {
         id: 'my-content-id',
-        text: 'Hello, microcms-ruby-sdk!',
+        text: 'こんにちは、microcms-ruby-sdk！',
     },
 )
 ```
 
-### Create draft content
+### 下書きコンテンツの作成
 
 ```rb
 puts MicroCMS.create(
     'endpoint',
     {
         id: 'my-content-id',
-        text: 'Hello, microcms-ruby-sdk!',
+        text: 'こんにちは、microcms-ruby-sdk！',
     },
     { status: 'draft' },
 )
 ```
 
-### Update content
+### コンテンツの更新
 
 ```rb
-
 puts MicroCMS.update(
     'endpoint',
     {
         id: 'microcms-ruby-sdk',
-        text: 'Hello, microcms-ruby-sdk update method!',
+        text: 'こんにちは、microcms-ruby-sdkのupdateメソッド！',
     },
 )
 ```
 
-### Update object form content
+### オブジェクト形式のコンテンツの更新
 
 ```rb
-puts MicroCMS.update('endpoint', { text: 'Hello, microcms-ruby-sdk update method!' })
+puts MicroCMS.update('endpoint', { text: 'こんにちは、microcms-ruby-sdkのupdateメソッド！' })
 ```
 
-### Delete content
+### コンテンツの削除
 
 ```rb
 MicroCMS.delete('endpoint', 'microcms-ruby-sdk')
 ```
 
-## Development
+## 開発
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+リポジトリをチェックアウトした後、`bin/setup` を実行して依存関係をインストールしてください。`bin/console` を実行すると、対話形式で動作を確認できます。
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+このgemをローカル環境にインストールするには、`bundle exec rake install` を実行してください。新しいバージョンをリリースするには、`version.rb` のバージョン番号を更新してから `bundle exec rake release` を実行します。このコマンドはバージョンのgitタグを作成し、gitのコミットとタグをpushした後、`.gem` ファイルを[rubygems.org](https://rubygems.org)にpushします。
 
-## Contributing
+## コントリビュート
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/microcmsio/microcms-ruby-sdk>.
+バグ報告やプルリクエストは、[GitHub](https://github.com/microcmsio/microcms-ruby-sdk)で受け付けています。

data/lib/microcms/version.rb

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

data/lib/microcms.rb

@@ -5,6 +5,7 @@ require 'net/http'
 require 'uri'
 require 'json'
 require 'forwardable'
+require 'ostruct'
 
 # MicroCMS
 module MicroCMS
@@ -161,7 +162,7 @@ module MicroCMS
       @status_code = status_code
       @body = parse_body(body)
 
-      message = @body['message'] || 'Unknown error occured.'
+      message = @body['message'] || 'Unknown error occurred.'
       super(message)
     end
 

data/microcms.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # `ruby -e "puts Gem::Specification.load('microcms.gemspec').files.sort"` で確認可能
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z lib LICENSE README.md microcms.gemspec`.split("\x0").reject(&:empty?)
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  spec.add_dependency 'ostruct'
 end

metadata

@@ -1,34 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: microcms-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - microCMS
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: microCMS Ruby SDK
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".github/workflows/publish.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- examples/examples.rb
 - lib/microcms.rb
 - lib/microcms/version.rb
 - microcms.gemspec
@@ -39,7 +40,6 @@ metadata:
   source_code_uri: https://github.com/microcmsio/microcms-ruby-sdk
   changelog_uri: https://github.com/microcmsio/microcms-ruby-sdk
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: microCMS Ruby SDK
 test_files: []

data/.github/workflows/ci.yml

@@ -1,42 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup Ruby and install gems
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7
-          bundler-cache: true
-
-      - name: Run linters
-        run: |
-          bundle install && bundle exec rubocop
-
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: [2.6, 2.7, 3.0]
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-
-    - name: test
-      run: |
-        bundle install && bundle exec rspec

data/.github/workflows/publish.yml

@@ -1,32 +0,0 @@
-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/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.rubocop.yml

@@ -1,11 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-  NewCops: enable
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-
-Style/OpenStructUse:
-  Exclude:
-    - 'spec/**/*'

data/.ruby-version

@@ -1 +0,0 @@
-2.7.2

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in microcms.gemspec
-gemspec
-
-gem 'rake', '~> 12.0'
-
-gem 'rubocop', require: false
-
-gem 'rspec', require: false

data/Rakefile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'microcms'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/examples.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-MicroCMS.service_domain = ENV.fetch('YOUR_DOMAIN', nil)
-MicroCMS.api_key = ENV.fetch('YOUR_API_KEY', nil)
-
-endpoint = ENV.fetch('YOUR_ENDPOINT', nil)
-
-puts MicroCMS.list(endpoint)
-
-puts MicroCMS.list(endpoint, {
-                     limit: 100,
-                     offset: 1,
-                     orders: ['updatedAt'],
-                     q: 'Hello',
-                     fields: %w[id title],
-                     filters: 'publishedAt[greater_than]2021-01-01'
-                   })
-
-puts MicroCMS.get(endpoint, 'ruby')
-
-puts MicroCMS.get(endpoint, 'ruby', { draft_key: 'abcdef1234' })
-
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' })
-
-puts MicroCMS.create(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk!' })
-
-puts MicroCMS.create(endpoint, { text: 'Hello, microcms-ruby-sdk!' }, { status: 'draft' })
-
-puts MicroCMS.update(endpoint, { id: 'microcms-ruby-sdk', text: 'Hello, microcms-ruby-sdk update method!' })
-
-MicroCMS.delete(endpoint, 'microcms-ruby-sdk')