microcms-ruby-sdk 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2892962110d682580cb5eb813bea75f334d47a7dde30f7aa67c07f0d7c8fc05c
-  data.tar.gz: 822122a22a386cd1a46b3a605f5b1f162f5c700acd99e1fe34fda37f9f2b34d1
+  metadata.gz: 2ac22f7433f5c15562d37eb291ab04297082a36b02fe34b14206f578fdd8a6cb
+  data.tar.gz: 5411bed835d189ca46f280fada06bb7b25a2eb937d0fda8d478be9b52fe43560
 SHA512:
-  metadata.gz: 5b31e0ff740a05af775a86893ae6a3d502439878ced5665266ce8ea49031bf34518a52e1057820af2dd6a0dcd9e47ee219baf5f5e726698a75536299993cb571
-  data.tar.gz: 95f62f1b8271769675dc06ce7a73c082183c04a0256507ec28854d0dffe8a3f0bc63f0bc1044fe5b1a50238bdffe143642aa2a3834b6b07959b7c74fbd39a39d
+  metadata.gz: 294a44d8524dadb0389169bbb0022055dbfd94c53da7f99c74c37c8f88baa64192bb56f08a8b8c0915cad6297ac56c470ed2ba4de609d87320b7146fc9b5da6e
+  data.tar.gz: d0fb8d0095703342ddaa6145483691669c54f69f59a1a8446112bb353e0f28251bb6368f48b73e4d559a81d28e25f2cf702b51f5e93d6663963ea7fe65b8aaa5

data/.rubocop.yml

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

data/README.md

@@ -49,7 +49,7 @@ puts MicroCMS.list('endpoint')
 puts MicroCMS.list(
     'endpoint',
     {
-        drarf_key: "abcd",
+        draft_key: "abcd",
         limit: 100,
         offset: 1,
         orders: ['updatedAt'],
@@ -152,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.1'
+  VERSION = '1.2.0'
 end

data/lib/microcms.rb

@@ -20,15 +20,79 @@ module MicroCMS
     end
   end
 
+  # HttpUtil
+  module HttpUtil
+    def send_http_request(method, endpoint, path, query = nil, body = nil)
+      uri = build_uri(endpoint, path, query)
+      http = build_http(uri)
+      req = build_request(method, uri, body)
+      res = http.request(req)
+
+      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') # rubocop:disable Style/OpenStructUse
+    end
+
+    private
+
+    def get_request_class(method)
+      {
+        GET: Net::HTTP::Get,
+        POST: Net::HTTP::Post,
+        PUT: Net::HTTP::Put,
+        PATCH: Net::HTTP::Patch,
+        DELETE: Net::HTTP::Delete
+      }[method]
+    end
+
+    def build_request(method, uri, body)
+      req = get_request_class(method.to_sym).new(uri.request_uri)
+      req['X-MICROCMS-API-KEY'] = @api_key
+      if body
+        req['Content-Type'] = 'application/json'
+        req.body = JSON.dump(body)
+      end
+
+      req
+    end
+
+    def build_uri(endpoint, path, query)
+      origin = "https://#{@service_domain}.microcms.io"
+      path_with_id = path ? "/api/v1/#{endpoint}/#{path}" : "/api/v1/#{endpoint}"
+      encoded_query =
+        if !query || query.size.zero?
+          ''
+        else
+          "?#{URI.encode_www_form(query)}"
+        end
+
+      URI.parse("#{origin}#{path_with_id}#{encoded_query}")
+    end
+
+    def build_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      http
+    end
+  end
+
   # Client
   class Client
+    include HttpUtil
+
     def initialize(service_domain, api_key)
       @service_domain = service_domain
       @api_key = api_key
     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 = {})
@@ -63,6 +127,7 @@ module MicroCMS
 
     private
 
+    # rubocop:disable Style/MethodLength
     def build_query(option)
       {
         draftKey: option[:draftKey],
@@ -72,9 +137,11 @@ module MicroCMS
         q: option[:q],
         fields: option[:fields] ? option[:fields].join(',') : nil,
         filters: option[:filters],
-        depth: option[:depth]
+        depth: option[:depth],
+        ids: option[:ids] ? option[:ids].join(',') : nil
       }.select { |_key, value| value }
     end
+    # rubocop:enable Style/MethodLength
 
     def put(endpoint, content, option = {})
       body = content.reject { |key, _value| key == :id }
@@ -84,57 +151,30 @@ module MicroCMS
     def post(endpoint, content, option = {})
       send_http_request('POST', endpoint, nil, option, content)
     end
+  end
 
-    def send_http_request(method, endpoint, path, query = nil, body = nil)
-      uri = build_uri(endpoint, path, query)
-      http = build_http(uri)
-      req = build_request(method, uri, body)
-      res = http.request(req)
+  # APIError
+  class APIError < StandardError
+    attr_accessor :status_code, :body
 
-      raise "microCMS response error: Status is #{res.code}, Body is #{res.body}" if res.code.to_i >= 400
+    def initialize(status_code:, body:)
+      @status_code = status_code
+      @body = parse_body(body)
 
-      JSON.parse(res.body, object_class: OpenStruct) if res.header['Content-Type'].include?('application/json')
+      message = @body['message'] || 'Unknown error occured.'
+      super(message)
     end
 
-    def get_request_class(method)
-      {
-        GET: Net::HTTP::Get,
-        POST: Net::HTTP::Post,
-        PUT: Net::HTTP::Put,
-        PATCH: Net::HTTP::Patch,
-        DELETE: Net::HTTP::Delete
-      }[method]
+    def inspect
+      "#<#{self.class.name} @status_code=#{status_code}, @body=#{body.inspect} @message=#{message.inspect}>"
     end
 
-    def build_request(method, uri, body)
-      req = get_request_class(method.to_sym).new(uri.request_uri)
-      req['X-MICROCMS-API-KEY'] = @api_key
-      if body
-        req['Content-Type'] = 'application/json'
-        req.body = JSON.dump(body)
-      end
-
-      req
-    end
-
-    def build_uri(endpoint, path, query)
-      origin = "https://#{@service_domain}.microcms.io"
-      path_with_id = path ? "/api/v1/#{endpoint}/#{path}" : "/api/v1/#{endpoint}"
-      encoded_query =
-        if !query || query.size.zero?
-          ''
-        else
-          "?#{URI.encode_www_form(query)}"
-        end
-
-      URI.parse("#{origin}#{path_with_id}#{encoded_query}")
-    end
-
-    def build_http(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
+    private
 
-      http
+    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.1
+  version: 1.2.0
 platform: ruby
 authors:
 - microCMS
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-06-02 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: