mc_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45add1ffe0738ebb9f9d925f7e66a733fa80dfc52afd51f1b578383976f151c1
+  data.tar.gz: 3006284b78f0a555e562c95f8c1be07cc966148f714e8f096377eefa6774e0c7
+SHA512:
+  metadata.gz: e89b677a6711cd704253ce9802958fd1b19c9522476d9cca6ba42dc6756ab6c4bcf6e431d2c74fb38d5798e871722c303ee75e311f68f76f35e39a0d2a815534
+  data.tar.gz: 95a932b56203ddfadebf6f03fbec2aba09ba2466a2834704d44cd605c044d9c847a656f1874c008fb4b8e452626ab3428efc0c6f1263fbef70c12cece97e0904

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mc_record.gemspec
+gemspec
+
+gem "activesupport", "7.0.6"
+gem "microcms-ruby-sdk", "1.2.0"
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    mc_record (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.2.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    microcms-ruby-sdk (1.2.0)
+    minitest (5.18.1)
+    rake (13.0.6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (= 7.0.6)
+  mc_record!
+  microcms-ruby-sdk (= 1.2.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Akira kure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,8 @@
+TBD...
+
+# McRecord
+
+## Installation
+
+
+## Usage

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/mc_record/base.rb

@@ -0,0 +1,193 @@
+require "active_support"
+require "microcms"
+require "date"
+
+module McRecord
+  class ContentNotFound < StandardError
+  end
+
+  class Base
+    extend ActiveSupport::Concern
+
+    # @param [OpenStruct]
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def self.config(service_domain:, api_key:, end_point:)
+      MicroCMS.service_domain = service_domain
+      MicroCMS.api_key = api_key
+      @@end_point = end_point
+    end
+
+    # return Array<OpenStruct>
+    def self.all
+      contents = fetch_contents
+      contents.flatten!
+
+      open_structs_to_instances(contents)
+    rescue MicroCMS::APIError
+      raise ContentNotFound
+    end
+
+    # @param [String]
+    def self.find(id)
+      raise ".find is only support String parameter." unless id.instance_of?(String)
+
+      # OpenStruct
+      api_result = MicroCMS.get(
+                    @@end_point,
+                    id
+                  )
+
+      attr_names = api_result.to_h.keys
+      attr_names.each do |attr_name|
+        define_method_attribute_if_needed(attr_name)
+      end
+
+      self.new(api_result)
+    rescue MicroCMS::APIError
+      raise ContentNotFound
+    end
+
+    # @param [Hash]
+    def self.where(arg)
+      param = build_filter_params(arg)
+
+      raise "param not specified" if param == ""
+
+      contents = fetch_contents(param)
+      contents.flatten!
+
+      open_structs_to_instances(contents)
+    end
+
+    # @param [Hash]
+    def self.where_not(arg)
+      param = build_not_filter_params(arg)
+
+      raise "param not specified" if param == ""
+
+      contents = fetch_contents(param)
+      contents.flatten!
+
+      open_structs_to_instances(contents)
+    end
+
+    class << self
+      private
+
+      def define_method_attribute_if_needed(attr_name)
+        unless self.method_defined?(attr_name)
+          class_eval %Q{
+            def #{attr_name}
+              read_attribute("#{attr_name}")
+            end
+          }
+        end
+
+        unless self.method_defined?("=#{attr_name}")
+          class_eval %Q{
+            def #{attr_name}=(value)
+              write_attribute("#{attr_name}", value)
+            end
+          }
+        end
+      end
+
+      # @param [Hash]
+      # @return [String]
+      def build_filter_params(arg)
+        filters_value = ""
+        arg.map do |k, v|
+          if v.instance_of?(Range)
+            begin_ = v.begin
+            end_ = v.end
+
+            result = ""
+            unless begin_.nil?
+              result += "#{k}[greater_than]#{begin_}"
+            end
+
+            unless end_.nil?
+              result += unless result == ""
+                          "[and]#{k}[less_than]#{end_}"
+                        else
+                          "#{k}[less_than]#{end_}"
+                        end
+            end
+
+            result
+          else
+            "#{k}[equals]#{v}"
+          end
+        end.join("[and]")
+      end
+
+      # @param [Hash]
+      # @return [String]
+      def build_not_filter_params(arg)
+        filters_value = ""
+        arg.map do |k, v|
+          if v.instance_of?(Range)
+            rais "not support parameter"
+          else
+            "#{k}[not_equals]#{v}"
+          end
+        end.join("[and]")
+      end
+
+      # @param [Array<OpenStruct>]
+      # @return [Array<Object>]
+      def open_structs_to_instances(contents)
+        contents.map do |content|
+          attr_names = content.to_h.keys
+          attr_names.each do |attr_name|
+            define_method_attribute_if_needed(attr_name)
+          end
+
+          self.new(content)
+        end
+      end
+
+      # @return [Array<OpenStruct>]
+      def fetch_contents(param = nil)
+        contents = []
+        limit = 10
+        offset_number = 0
+
+        print "fetching contents ."
+        loop do
+          print "."
+          api_result = MicroCMS.list(
+                      @@end_point,
+                      {
+                        offset: offset_number,
+                        limit: limit,
+                        filters: param,
+                      }
+                    )
+
+          total_count = api_result.total_count
+          contents << api_result.contents
+
+          if total_count >= offset_number + 1
+            offset_number += limit
+          else
+            break
+          end
+        end
+
+        contents
+      end
+    end
+
+    def read_attribute(attr_name)
+      @attributes.to_h[attr_name.to_sym]
+    end
+
+    def write_attribute(attr_name, value)
+      @attributes[attr_name] = value
+    end
+  end
+end

data/lib/mc_record/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module McRecord
+  VERSION = "0.1.0"
+end

data/lib/mc_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "mc_record/base"
+require_relative "mc_record/version"
+
+module McRecord
+end

data/mc_record.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/mc_record/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mc_record"
+  spec.version = McRecord::VERSION
+  spec.authors = ["Akira Kure"]
+  spec.email = ["kuredev@gmail.com"]
+
+  spec.summary = "MicroCMS API's ORM like ActiveRecord for Ruby."
+  spec.description = "MicroCMS API's ORM like ActiveRecord for Ruby."
+  spec.homepage = "https://github.com/kuredev/mc_record"
+  spec.required_ruby_version = ">= 2.6.0"
+
+#   spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kuredev/mc_record"
+  spec.metadata["changelog_uri"] = "https://github.com/kuredev/mc_record"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/mc_record.rbs

@@ -0,0 +1,4 @@
+module McRecord
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: mc_record
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Kure
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-30 00:00:00.000000000 Z
+dependencies: []
+description: MicroCMS API's ORM like ActiveRecord for Ruby.
+email:
+- kuredev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mc_record.rb
+- lib/mc_record/base.rb
+- lib/mc_record/version.rb
+- mc_record.gemspec
+- sig/mc_record.rbs
+homepage: https://github.com/kuredev/mc_record
+licenses: []
+metadata:
+  homepage_uri: https://github.com/kuredev/mc_record
+  source_code_uri: https://github.com/kuredev/mc_record
+  changelog_uri: https://github.com/kuredev/mc_record
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: MicroCMS API's ORM like ActiveRecord for Ruby.
+test_files: []