scalar_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 665e34004852e3c7508b7d672ce7222f1de09183a4549bff71f82144975e476c
+  data.tar.gz: 60d68fdb4072cc5dff56e25911270ce05828c7231b9f7cc49aa1b8cc66138100
+SHA512:
+  metadata.gz: bb139b0a28acb3e42418370b36611a7eb7ea8c885f02c11c3fda2662b5424a71bb1f5be5c117173662c5ba45ae0dcf8b0ae05475964199335eb242323910718e
+  data.tar.gz: 0e27fe32e65004da16237aaa7a4300f5a005f61367fe4d8d0fa3028ec9e0d88d7c1d3d9eb438f5b84de8884cfdea0dd5957e5ce773905f2f8356f4edc6126d83

data/README.md

@@ -0,0 +1,105 @@
+# Scalar API Reference for Ruby
+
+This gem simplifies the integration of [Scalar](https://scalar.com), a modern open-source developer experience platform for your APIs into Ruby applications.
+
+## Installation
+
+Add the gem to your application's Gemfile by executing in the terminal:
+
+```bash
+bundle add scalar_ruby
+```
+
+## Getting Started
+
+Statistically, you will likely use the gem for the Ruby on Rails application, so here are instructions on how to set up the Scalar for this framework. In the future, we'll add examples for other popular Ruby frameworks.
+
+Once you have installed the gem, go to `config/routes.rb` and mount the `Scalar::UI` to your application.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount Scalar::UI, at: '/docs'
+  ...
+end
+```
+
+Restart the Rails server, and hit `localhost:3000/docs`. You'll see the default view of the Scalar API reference. It uses the `@scalar/galaxy` OpenAPI reference so that you will have something to play with immediately.
+
+Then, if you want to use your OpenAPI specification, you need to re-configure the Scalar.
+
+First, create an initializer, say `config/initializers/scalar.rb`. Then, set the desired specification as `config.specification` using the `Scalar.setup` method:
+
+```ruby
+# config/initializers/scalar.rb
+
+Scalar.setup do |config|
+  config.specification = File.read(Rails.root.join('docs/openapi.yml'))
+end
+```
+
+Also, you can pass a URL to the specification:
+
+```ruby
+# config/initializers/scalar.rb
+
+Scalar.setup do |config|
+  config.specification = "#{ActionMailer::Base.default_url_options[:host]/openapi.json}"
+end
+```
+
+And that's it! More detailed information on other configuration options is in the section below.
+
+## Configuration
+
+Once mounted to your application, the library requires no further configuration. You can immediately start playing with the provided API reference example.
+
+Having default configurations set may be an excellent way to validate whether the Scalar fits your project. However, most users would love to utilize their specifications and be able to alter settings.
+
+The default configuration can be changed using the `Scalar.setup` method in `config/initializers/scalar.rb`.
+
+```ruby
+# config/initializers/scalar.rb
+
+Scalar.setup do |config|
+ config.page_title = 'My awesome API!'
+end
+```
+
+Below, you’ll find a complete list of configuration settings:
+
+Parameter                                  | Description                                             | Default
+-------------------------------------------|---------------------------------------------------------|------------------------
+`config.page_title`                        | Defines the page title displayed in the browser tab.    | API Reference
+`config.library_url`                       | Allows to set a specific version of Scalar. By default, it uses the latest version of Scalar, so users get the latest updates and bug fixes.   | https://cdn.jsdelivr.net/npm/@scalar/api-reference
+`config.scalar_configuration`              | Scalar has a rich set of configuration options if you want to change how it works and looks. A complete list of configuration options can be found [here](https://github.com/scalar/scalar/blob/main/documentation/configuration.md).   | {}
+`config.specification`                     | Allows users to pass their OpenAPI specification to Scalar. It can be a URL to specification or a string object in JSON or YAML format.    | https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml
+
+Example of setting configuration options:
+
+```ruby
+# config/initializers/scalar.rb
+
+Scalar.setup do |config|
+ config.scalar_configuration = { theme: 'purple' }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Run `bundle exec rake install` to install this gem onto your local machine. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dmytroshevchuk/scalar_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dmytroshevchuk/scalar_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Scalar::Ruby project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/dmytroshevchuk/scalar_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/scalar/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'singleton'
+
+module Scalar
+  class Config
+    include Singleton
+
+    DEFAULT_LIBRARY_URL = 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
+    DEFAULT_PAGE_TITLE = 'API Reference'
+    DEFAULT_SCALAR_CONFIGURATION = {}.freeze
+    DEFAULT_SPECIFICATION = 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml'
+
+    attr_accessor :library_url,
+                  :page_title,
+                  :scalar_configuration,
+                  :specification
+
+    def initialize
+      set_defaults!
+    end
+
+    def scalar_configuration_to_json
+      JSON.dump(scalar_configuration)
+    end
+
+    def set_defaults!
+      @library_url = DEFAULT_LIBRARY_URL
+      @page_title = DEFAULT_PAGE_TITLE
+      @scalar_configuration = DEFAULT_SCALAR_CONFIGURATION
+      @specification = DEFAULT_SPECIFICATION
+    end
+  end
+end

data/lib/scalar/template.erb

@@ -0,0 +1,20 @@
+<!doctype html>
+<html>
+  <head>
+    <title><%= config.page_title %></title>
+
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+
+  <body>
+    <script
+      id="api-reference"
+      data-configuration=<%= config.scalar_configuration_to_json %>
+    >
+      <%= config.specification %>
+    </script>
+
+    <script src="<%= config.library_url %>"></script>
+  </body>
+</html>

data/lib/scalar/ui.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'erb'
+require_relative 'config'
+
+module Scalar
+  class UI
+    def self.call(_env)
+      [
+        200,
+        { 'Content-Type' => 'text/html; charset=utf-8' },
+        [template.result_with_hash(config: Scalar::Config.instance)]
+      ]
+    end
+
+    def self.template
+      ERB.new(File.read("#{Scalar::LIB_PATH}/scalar/template.erb"))
+    end
+  end
+end

data/lib/scalar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Scalar
+  VERSION = '1.0.0'
+end

data/lib/scalar_ruby.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'scalar/config'
+require_relative 'scalar/ui'
+
+module Scalar
+  LIB_PATH = File.expand_path(File.dirname(__FILE__).to_s)
+
+  module_function
+
+  def setup
+    yield Scalar::Config.instance
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: scalar_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dmytro Shevchuk
+- Serhii Ponomarov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-29 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- dmytro@hey.com
+- sergii.ponomarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/scalar/config.rb
+- lib/scalar/template.erb
+- lib/scalar/ui.rb
+- lib/scalar/version.rb
+- lib/scalar_ruby.rb
+homepage: https://github.com/dmytroshevchuk/scalar_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dmytroshevchuk/scalar_ruby
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/dmytroshevchuk/scalar_ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A gem to automate using Scalar with Ruby apps
+test_files: []