rails_http_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3ef19162093ef69b8a3156754f3678cbbf04524
+  data.tar.gz: b8618274ececbaa1af1c4412bb2182b6d994ea31
+SHA512:
+  metadata.gz: 9b70176673e7a3efb7bd1dba6317b6af2c3674d06da2dd0f41769312994648cbe85e50420208cdf9f61162ae2a708457a785251644eb0d6293a88a527cb22a00
+  data.tar.gz: 521f1ccd9fd4df229a05b5adafb6e16af744c1d2930da3cf2c5aebd5f0daeafa9d6b0427e07a4ffaae3d9248c1e37cf3d3a7d3cbaa014f6662ec7f71c0555dd2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_http_options.gemspec
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+# RailsHttpOptions
+
+Simple gem that allows you to handle HTTP OPTIONS in Rails.
+Ideal for API introspection, like fetching request/response schemas and other
+meaningful for the client information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_http_options'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_http_options
+
+## Usage
+Include `RailsHttpOptions` in your application controller.
+Then add a Rails route in your routes.rb denoting that you want to handle all
+HTTP OPTIONS in `option` method, defined by this gem.
+
+```ruby
+  match '*path', {
+    controller: 'application',
+    action: 'options',
+    constraints: { method: 'OPTIONS' },
+    via: [:options]
+  }
+```
+
+Then in any of your resource-based controller, add your options response:
+
+```ruby
+  class Api::V1::UsersController < ApplicationController
+    options do
+      {
+        schemas: {
+          accepts: Company.json_schema,
+          returns: Company.json_schema
+        },
+        meta: { max_per_page: 100 }
+      }
+    end
+  end
+```
+
+You can also respond differently depending on request information.
+
+Specifically, you get route details param
+coming from Rails routing mechanism and it's a simple hash.
+However, you have access to the regular request/response context inside the block,
+because just before is being called its context is changed to a controller's method,
+defined by this gem. Hence, you can access
+[request](http://api.rubyonrails.org/classes/ActionDispatch/Request.html),
+[response](http://api.rubyonrails.org/v5.0.1/classes/ActionDispatch/Response.html),
+[params](http://api.rubyonrails.org/classes/ActionController/Parameters.html) etc,
+like a regular controller method.
+
+
+```ruby
+  class Api::V1::UsersController < ApplicationController
+    options do |route_details|
+      if route_details[:id] #member route
+        {
+          schemas: { #params is available through context switching
+            accepts: Company.find(params[:id]).introspection_schema,
+            returns: Company.find(params[:id]).introspection_schema,
+          }
+        }
+      else #collection route
+        {
+          schemas: {
+            returns: [Company.introspection_schema]
+          },
+          meta: { max_per_page: 100 }
+        }
+      end
+    end
+  end
+```
+
+The response is always in JSON, but if you need something else (like yaml or XML),
+you can always override the default
+[`options`](https://github.com/kollegorna/rails_http_options/blob/master/lib/rails_http_options.rb#L16-L25) method.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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 tags, 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/kollegorna/rails_http_options.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_http_options"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_http_options.rb

@@ -0,0 +1,53 @@
+require "rails_http_options/version"
+
+module RailsHttpOptions
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def options(&options_block)
+      @options_block = options_block if block_given?
+
+      return @options_block
+    end
+  end
+
+  def options
+    return head :ok if controller_for(url: request.url).options.nil?
+
+    return render({
+      json: instance_exec(
+        route_details_for(request.url),
+        &controller_for(url: request.url).options
+      )
+    })
+  end
+
+  private
+    def controller_for(url:)
+      route_details = route_details_for(url)
+      name = route_details[:controller].titleize.gsub('/', '::').gsub(' ','')
+
+      return "#{name}Controller".constantize
+    end
+
+    def route_details_for(url)
+      @route_details ||= begin
+        methods = [:get, :post, :put, :patch, :delete]
+        method = methods[0]
+        tries ||= 0
+        route_details = nil
+        begin
+          route_details = Rails.application.routes.recognize_path(url, method: method)
+          raise ActionController::RoutingError, '' if route_details[:action] == 'route_not_found'
+        rescue ActionController::RoutingError => _
+          method = methods[tries]
+          retry unless (tries += 1) == 5
+        else
+          return route_details
+        end
+      end
+    end
+
+end

data/lib/rails_http_options/version.rb

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

data/rails_http_options.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_http_options/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_http_options"
+  spec.version       = RailsHttpOptions::VERSION
+  spec.authors       = ["Filippos Vasilakis", "Kollegorna"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+
+  spec.summary       = %q{Simple gem that makes it easy to handle HTTP OPTIONS requests in Rails.}
+  spec.description   = %q{Simple gem that makes it easy to handle HTTP OPTIONS requests in Rails.}
+  spec.homepage      = "https://github.com/kollegorna/rails_http_options"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "Rails", "> 3.2.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rails_http_options
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Filippos Vasilakis
+- Kollegorna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: Rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple gem that makes it easy to handle HTTP OPTIONS requests in Rails.
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_http_options.rb
+- lib/rails_http_options/version.rb
+- rails_http_options.gemspec
+homepage: https://github.com/kollegorna/rails_http_options
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Simple gem that makes it easy to handle HTTP OPTIONS requests in Rails.
+test_files: []