meta_field_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e26ab3c5d220dccf1972335777c12912fe5c024863a9ae638e8df34241f62657
+  data.tar.gz: 5615ab1badb6c8d5d20b43a71813907ad6cea692374b7993e53d0891ad119620
+SHA512:
+  metadata.gz: 5a5e63e21d64aa4610ec43dbec867dcc28db7817c90d841b9aa76a4a5ef4c29c5474acc8cbdf64a7e717d1090fc74c1ffbdcc392eaadd34be3420e1e1670cbcb
+  data.tar.gz: 7bf30741db00b061f8e32f711456ba617399834a2a317d64209a400eb71c18f7404e4d51a1357ee28eb6b3dea86f7e55f1fb68f9aeecfe7b0d8b69a36a5afdf6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 RumanOnMove
+
+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,28 @@
+# MetaFieldApi
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "meta_field_api"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install meta_field_api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/meta_field_api_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/meta_field_api .css

data/app/assets/stylesheets/meta_field_api/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/meta_field_api/application_controller.rb

@@ -0,0 +1,4 @@
+module MetaFieldApi
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/meta_field_api/metafields_controller.rb

@@ -0,0 +1,69 @@
+module MetaFieldApi
+  class MetafieldsController < ApplicationController
+    # List of all metafields
+    def index
+      # Get the filter parameters from the params hash
+      owner_type = params[:owner_type].presence
+      owner_id = params[:owner_id].presence
+      key = params[:key].presence
+      namespace = params[:namespace].presence
+
+      metafields = Metafield.filter_by(owner_type, owner_id, key, namespace)
+      render json: { metafields: metafields, message: 'Metafields retrieved successfully!' }, status: :ok
+    end
+
+    # Store metafields
+    def create
+      metafield = Metafield.new(metafield_params)
+
+      if metafield.save
+        render json: { metafield: metafield, message: 'Metafield created successfully!' }, status: :created
+      else
+        render json: { error: metafield.errors }, status: :unprocessable_entity
+        end
+    rescue StandardError => e
+      render json: { error: e.message }, status: :unprocessable_entity
+    end
+
+    # Show specific metafield
+    def show
+      metafield = Metafield.find_by(id: params[:id])
+
+      if metafield
+        render json: { metafield: metafield, message: 'Metafield retrieved successfully!' }, status: :ok
+      else
+        render json: { message: 'Metafield not found' }, status: :not_found
+      end
+    end
+
+    # Update specific metafield
+    def update
+      metafield = Metafield.find_by(id: params[:id])
+
+      if metafield.update(metafield_params)
+        render json: { metafield: metafield, message: 'Metafield updated successfully!' }, status: :ok
+      else
+        render json: { error: metafield.errors }, status: :unprocessable_entity
+      end
+    rescue StandardError => e
+      render json: { error: e.message }
+    end
+
+    def destroy
+      metafield = Metafield.find_by(id: params[:id])
+
+      if metafield&.destroy
+        render json: { message: 'Metafield deleted successfully!' }, status: :ok
+      else
+        render json: { error: 'Metafield not found or could not be deleted' }, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    # Metafield params
+    def metafield_params
+      params.permit(:namespace, :key, :value, :description, :my_type, :owner_type, :owner_id)
+    end
+  end
+end

data/app/helpers/meta_field_api/application_helper.rb

@@ -0,0 +1,4 @@
+module MetaFieldApi
+  module ApplicationHelper
+  end
+end

data/app/helpers/meta_field_api/meta_fields_helper.rb

@@ -0,0 +1,4 @@
+module MetaFieldApi
+  module MetaFieldsHelper
+  end
+end

data/app/jobs/meta_field_api/application_job.rb

@@ -0,0 +1,4 @@
+module MetaFieldApi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/meta_field_api/application_mailer.rb

@@ -0,0 +1,6 @@
+module MetaFieldApi
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/meta_field_api/application_record.rb

@@ -0,0 +1,3 @@
+module UserExtension
+  extend ActiveSupport::Concern
+end

data/app/models/meta_field_api/metafield.rb

@@ -0,0 +1,38 @@
+module MetaFieldApi
+  class Metafield < ApplicationRecord
+    # Associations
+    belongs_to :owner, polymorphic: true
+
+    # Validations
+    validates :namespace, presence: true, length: {maximum: 55}
+    validates :key, presence: true, length: {maximum: 55}
+    validates :value, presence: true
+    validates :description, presence: false, length: {maximum: 255}
+    validates :my_type, presence: true, length: {maximum: 55}
+    validates :owner_id, presence: true
+    validates :owner_type, presence: true
+
+    # Attributes
+    self.table_name = "meta_field_api_metafields"
+    self.inheritance_column = :my_type
+
+    # Alias for type column to avoid conflict with Rails' inheritance column
+    def my_type
+      read_attribute(:type)
+    end
+
+    def my_type=(value)
+      write_attribute(:type, value)
+    end
+
+    # Scope
+    scope :filter_by, -> (owner_type = nil, owner_id = nil, key = nil, namespace = nil) do
+      filter_params = {}
+      filter_params[:owner_type] = owner_type if owner_type.present?
+      filter_params[:owner_id] = owner_id if owner_id.present?
+      filter_params[:key] = key if key.present?
+      filter_params[:namespace] = namespace if namespace.present?
+      where(filter_params)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+MetaFieldApi::Engine.routes.draw do
+    resources :metafields, only: [:index, :show, :create, :update, :destroy]
+end

data/db/migrate/20230502083945_create_meta_field_api_metafields.rb

@@ -0,0 +1,14 @@
+class CreateMetaFieldApiMetafields < ActiveRecord::Migration[7.0]
+  def change
+    create_table :meta_field_api_metafields do |t|
+      t.string :namespace
+      t.string :key
+      t.text :value
+      t.text :description
+      t.text :type
+      t.references :owner, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/meta_field_api/engine.rb

@@ -0,0 +1,14 @@
+module MetaFieldApi
+  class Engine < ::Rails::Engine
+    isolate_namespace MetaFieldApi
+
+    # Add this line to load migrations
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match?(root.to_s)
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/meta_field_api/has_metafields.rb

@@ -0,0 +1,12 @@
+module MetaFieldApi
+  module HasMetafields
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :metafields, as: :owner, class_name: "MetaFieldApi::Metafield"
+      def as_json(options = {})
+        super(options.merge(include: :metafields))
+      end
+    end
+  end
+end

data/lib/meta_field_api/version.rb

@@ -0,0 +1,3 @@
+module MetaFieldApi
+  VERSION = "0.1.0"
+end

data/lib/meta_field_api.rb

@@ -0,0 +1,7 @@
+require "meta_field_api/version"
+require "meta_field_api/engine"
+require "meta_field_api/has_metafields"
+
+module MetaFieldApi
+
+end

data/lib/tasks/meta_field_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :meta_field_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: meta_field_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RumanOnMove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+description: This Rails engine provides APIs for managing meta fields through a RESTful
+  interface. It includes a migration for creating the necessary database table and
+  a controller with methods for index, show, create, update, and delete.
+email:
+- oruman@moveon.com.bd
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/meta_field_api_manifest.js
+- app/assets/stylesheets/meta_field_api/application.css
+- app/controllers/meta_field_api/application_controller.rb
+- app/controllers/meta_field_api/metafields_controller.rb
+- app/helpers/meta_field_api/application_helper.rb
+- app/helpers/meta_field_api/meta_fields_helper.rb
+- app/jobs/meta_field_api/application_job.rb
+- app/mailers/meta_field_api/application_mailer.rb
+- app/models/meta_field_api/application_record.rb
+- app/models/meta_field_api/metafield.rb
+- config/routes.rb
+- db/migrate/20230502083945_create_meta_field_api_metafields.rb
+- lib/meta_field_api.rb
+- lib/meta_field_api/engine.rb
+- lib/meta_field_api/has_metafields.rb
+- lib/meta_field_api/version.rb
+- lib/tasks/meta_field_api_tasks.rake
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/RumanOnMove/meta_field_api
+  changelog_uri: https://github.com/RumanOnMove/meta_field_api/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: A Rails engine for managing meta fields
+test_files: []