strapi_ruby 0.1.0

data/lib/strapi_ruby/tasks/config.rake

@@ -0,0 +1,28 @@
+namespace :strapi_ruby do
+  desc "Generates a configuration file within Rails applications"
+  task :config do
+    # Directory path for the config directory
+    initializers_dir = File.join(Rails.root, "config", "initializers")
+
+    # Configuration file path
+    config_file = File.join(initializers_dir, "strapi_ruby.rb")
+
+    # Check if the configuration file exists, and create it with default content if not
+    if File.exist?(config_file)
+      puts "StrapiRuby configuration file already exists."
+    else
+      # Define the configuration data (contents of strapi_ruby.rb)
+      config = <<-CONFIG
+  # Your StrapiRuby configuration goes here
+  # Check documentation for more configuration options
+  # https://github.com/saint-james-fr/strapi_ruby
+  StrapiRuby.configure do |config|
+    config.strapi_server_uri = "YOUR_SERVER_URI"
+    config.strapi_token = "YOUR_TOKEN"
+  end
+  CONFIG
+      File.write(config_file, config)
+      puts "StrapiRuby configuration file created at config/initializers/strapi_ruby.rb."
+    end
+  end
+end

data/lib/strapi_ruby/validations.rb

@@ -0,0 +1,63 @@
+module StrapiRuby
+  module Validations
+    def validate_data_presence(options)
+      raise ArgumentError, ErrorMessage.missing_data unless options.key?(:data)
+    end
+
+    def validate_config(config)
+      validate_mandatory_config_params(config.strapi_server_uri, config.strapi_token)
+      validate_faraday_block(config.faraday)
+      validate_show_endpoint_config(config.show_endpoint)
+      validate_convert_to_html(config.convert_to_html)
+    end
+
+    def validate_options(options)
+      validate_config_presence
+      validate_resource(options)
+      validate_id(options)
+      validate_show_endpoint_params(options)
+      validate_body(options)
+    end
+
+    private
+
+    def validate_convert_to_html(convert_to_html)
+      raise TypeError, "#{ErrorMessage.expected_array}. Got #{convert_to_html.class.name}" unless convert_to_html.is_a?(Array)
+    end
+
+    def validate_show_endpoint_config(show_endpoint)
+      raise TypeError, "#{ErrorMessage.expected_boolean}" unless [true, false].include?(show_endpoint)
+    end
+
+    def validate_faraday_block(faraday)
+      raise TypeError, "#{ErrorMessage.expected_proc} Got #{faraday.class.name}" if !faraday.nil? && !faraday.is_a?(Proc)
+    end
+
+    def validate_mandatory_config_params(strapi_server_uri, strapi_token)
+      raise ConfigurationError, ErrorMessage.missing_strapi_server_uri if strapi_server_uri.nil? || strapi_server_uri.empty?
+      raise ConfigurationError, ErrorMessage.missing_strapi_token if strapi_token.nil? || strapi_token.empty?
+    end
+
+    def validate_config_presence
+      raise ConfigurationError, ErrorMessage.missing_configuration if @config.nil?
+    end
+
+    def validate_resource(options)
+      raise ArgumentError, ErrorMessage.missing_resource unless options.key?(:resource)
+      raise TypeError, "#{ErrorMessage.expected_string_symbol} Got #{options[:resource].class.name}" unless options[:resource].is_a?(String) || options[:resource].is_a?(Symbol)
+    end
+
+    def validate_id(options)
+      raise TypeError, "#{ErrorMessage.expected_integer} Got #{options[:id].class.name}" if options.key?(:id) && !options[:id].is_a?(Integer)
+    end
+
+    def validate_show_endpoint_params(options)
+      raise TypeError, "#{ErrorMessage.expected_boolean}" if options[:show_endpoint] && ![true, false].include?(options[:show_endpoint])
+    end
+
+    def validate_body(options)
+      return unless options.key?(:data)
+      raise TypeError, "#{ErrorMessage.expected_hash} Got #{options[:data].class.name}" unless options[:data].is_a?(Hash)
+    end
+  end
+end

data/lib/strapi_ruby/version.rb

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

data/lib/strapi_ruby.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "strapi_ruby/version"
+require_relative "strapi_ruby/validations"
+require_relative "strapi_ruby/endpoint/builder"
+require_relative "strapi_ruby/endpoint/strapi_parameters"
+require_relative "strapi_ruby/endpoint/query"
+require_relative "strapi_ruby/markdown"
+require_relative "strapi_ruby/formatter"
+require_relative "strapi_ruby/interface"
+require_relative "strapi_ruby/client"
+require_relative "strapi_ruby/configuration"
+require_relative "strapi_ruby/config"
+
+# Load errors
+require_relative "strapi_ruby/errors/client_error"
+require_relative "strapi_ruby/errors/configuration_error"
+require_relative "strapi_ruby/errors/error_message"
+
+# Load Rake tasks within Rails applications
+require_relative "strapi_ruby/railtie" if defined?(Rails)
+
+module StrapiRuby
+  extend Configuration
+  extend Interface
+end
+

data/rubocop.txt

@@ -0,0 +1,4 @@
+Inspecting 18 files
+..................
+
+18 files inspected, no offenses detected

data/sig/strapi_ruby.rbs

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

data/strapi_ruby.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/strapi_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "strapi_ruby"
+  spec.version = StrapiRuby::VERSION
+  spec.authors = ["Maxence Robinet"]
+  spec.email = ["contact@maxencerobinet.fr"]
+
+  spec.summary = "Ruby wrapper around Strapi API."
+  spec.description = <<-DESC
+  StrapiRuby is a Ruby gem designed to simplify interactions
+  with the Strapi CMS API. It provides an easy-to-use interface for
+  making requests to a Strapi server and handling responses.
+  DESC
+
+  spec.homepage = "https://github.com/saint-james-fr/strapi_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/saint-james-fr/strapi_ruby/blob/master/CHANGELOG.md"
+
+  # 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 Gemfile])
+    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 "faraday", "~> 2.7"
+  spec.add_dependency "redcarpet", "~> 3.6"
+
+  spec.add_development_dependency "dotenv", "~> 2.8"
+  spec.add_development_dependency "webmock", "~> 3.19"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: strapi_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxence Robinet
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: |2
+    StrapiRuby is a Ruby gem designed to simplify interactions
+    with the Strapi CMS API. It provides an easy-to-use interface for
+    making requests to a Strapi server and handling responses.
+email:
+- contact@maxencerobinet.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/strapi_ruby_logo.png
+- features.md
+- lib/strapi_ruby.rb
+- lib/strapi_ruby/client.rb
+- lib/strapi_ruby/config.rb
+- lib/strapi_ruby/configuration.rb
+- lib/strapi_ruby/endpoint/builder.rb
+- lib/strapi_ruby/endpoint/query.rb
+- lib/strapi_ruby/endpoint/strapi_parameters.rb
+- lib/strapi_ruby/errors/client_error.rb
+- lib/strapi_ruby/errors/configuration_error.rb
+- lib/strapi_ruby/errors/error_code.yml
+- lib/strapi_ruby/errors/error_message.rb
+- lib/strapi_ruby/errors/error_text.yml
+- lib/strapi_ruby/formatter.rb
+- lib/strapi_ruby/interface.rb
+- lib/strapi_ruby/markdown.rb
+- lib/strapi_ruby/railtie.rb
+- lib/strapi_ruby/tasks/config.rake
+- lib/strapi_ruby/validations.rb
+- lib/strapi_ruby/version.rb
+- rubocop.txt
+- sig/strapi_ruby.rbs
+- strapi_ruby.gemspec
+homepage: https://github.com/saint-james-fr/strapi_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/saint-james-fr/strapi_ruby
+  source_code_uri: https://github.com/saint-james-fr/strapi_ruby
+  changelog_uri: https://github.com/saint-james-fr/strapi_ruby/blob/master/CHANGELOG.md
+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.7
+signing_key:
+specification_version: 4
+summary: Ruby wrapper around Strapi API.
+test_files: []