microcms-ruby-sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678191607289752b9a2386131264cd89431df1547a88884a33e67955b68c484d
-  data.tar.gz: c14c1456eff2800d550e27e726bdb0e6759c30e3153141ef2baa2f2d915eadf7
+  metadata.gz: 7981b7722c57e9c32a2ca0681228addc23c92576c8ade1259874de877bbeb5c1
+  data.tar.gz: c5cf56769dca274a7fffb90e73f6c9814ca8570288e24e9a00fdc0e6eb349b1e
 SHA512:
-  metadata.gz: b0700d1b1c2d2d405d51ec2e109d972ee6acc431b846ea748c7a524f577ae6e4b27e8f18c77915d00cb051af24e6a1a6587734a5f27448b8e19d020f6bdb5481
-  data.tar.gz: 13d7a4e0a57332cb7ab0d3e53ac5de7eb534cb9c1aced647b0014d8521ca694ea52277227b3ece61c909f9f3eae5e52e069cf350c594772c6d76ea0c71d3733d
+  metadata.gz: e5265db69895b973b8f877017b108c59ab854ed3699de6fa13f158d36f2e401f14180495575c8b7efd28ff50b26ba05194d8535e081b6bde52b7124890dec824
+  data.tar.gz: 2ee9017853f3803eb9ef9c2672457b21b18a9a92bacf41ea5d2e7b514f24eaf866e8d5435b2a43f80e3299ef4f4e7e0257c15503f77e004012a1bf027e13891c

data/.rubocop.yml

@@ -5,3 +5,7 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/**/*'

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',
+    {
+        draft_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
@@ -62,4 +152,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/microcms.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/microcmsio/microcms-ruby-sdk>.

data/examples/examples.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-MicroCMS.service_domain = ENV['YOUR_DOMAIN']
-MicroCMS.api_key = ENV['YOUR_API_KEY']
+MicroCMS.service_domain = ENV.fetch('YOUR_DOMAIN', nil)
+MicroCMS.api_key = ENV.fetch('YOUR_API_KEY', nil)
 
-endpoint = ENV['YOUR_ENDPOINT']
+endpoint = ENV.fetch('YOUR_ENDPOINT', nil)
 
 puts MicroCMS.list(endpoint)
 

data/lib/microcms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MicroCMS
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 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 = {})
@@ -91,9 +96,9 @@ module MicroCMS
       req = build_request(method, uri, body)
       res = http.request(req)
 
-      raise "microCMS response error: Status is #{res.code}, Body is #{res.body}" if res.code.to_i >= 400
+      raise APIError.new(status_code: res.code.to_i, body: res.body) if res.code.to_i >= 400
 
-      JSON.parse(res.body, object_class: OpenStruct) if res.header['Content-Type'].include?('application/json')
+      JSON.parse(res.body, object_class: OpenStruct) if res.header['Content-Type'].include?('application/json') # rubocop:disable Style/OpenStructUse
     end
 
     def get_request_class(method)
@@ -137,4 +142,29 @@ module MicroCMS
       http
     end
   end
+
+  # APIError
+  class APIError < StandardError
+    attr_accessor :status_code, :body
+
+    def initialize(status_code:, body:)
+      @status_code = status_code
+      @body = parse_body(body)
+
+      message = @body['message'] || 'Unknown error occured.'
+      super(message)
+    end
+
+    def inspect
+      "#<#{self.class.name} @status_code=#{status_code}, @body=#{body.inspect} @message=#{message.inspect}>"
+    end
+
+    private
+
+    def parse_body(body)
+      JSON.parse(body)
+    rescue JSON::ParserError
+      {}
+    end
+  end
 end

data/microcms.gemspec

@@ -12,9 +12,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/microcmsio/microcms-ruby-sdk'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/microcmsio/microcms-ruby-sdk'
-  spec.metadata['changelog_uri'] = 'https://github.com/microcmsio/microcms-ruby-sdk'
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri']   = spec.homepage
+
+  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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microcms-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - microCMS
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies: []
 description: microCMS Ruby SDK
 email: 
@@ -38,6 +38,7 @@ metadata:
   homepage_uri: https://github.com/microcmsio/microcms-ruby-sdk
   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: