frisk 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTJmZjMzMDZhNDVmNmM2YmJhNTZjNjE4ZDFkODI2OTg3MDUyZmJiYw==
+  data.tar.gz: !binary |-
+    YzE3ZTQ5ZTBjM2QxNDYxZDU5NjE0YmI4MzgyNDcyOGJmNzMwZmI2MA==
+SHA512:
+  metadata.gz: !binary |-
+    YmEyYmNhYzlmMDdhYTFmMTBmYmY5ZDYxZWI1M2U5M2YzODUxZGY3NmNlYTVi
+    YzE4ZDU3OTk1OGYxZjA3ZjYzMjIwNzcxYjhjZGZjNWE3MTcxMThmMWViNmNm
+    YzE3MzAyMDc4YWZhOTY0YTAyNjBiMjVjYWQyY2JhNTA3YjQ0ZDU=
+  data.tar.gz: !binary |-
+    ZTA2NmEwNWM4MGQ0ZjIyYmRiYjFmNmVmYWM2OTNjZjJiNTdmYTc5NzJhNGE4
+    NmE4ZWU4OGE3YWIwMDIxNjliNzdlY2I3ZjgxZTUzM2NmMmJjYzdhMTg2OTcx
+    Y2IxNjlhMTk2MzA1NDZhY2M0NmM1MGM3MjVlYTBmY2RhNjFkYjI=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,20 @@
+Frisk
+=====
+
+
+## What's frisk ?
+
+Frisk is a mountable Rails engine which
+
+* documents your API
+* acts as your API health check
+* gives you an API explorer
+
+## Installation
+
+Add this to your Gemfile and run `bundle install`:
+
+    gem 'frisk'
+
+This will install the gem and mount frisk on `/frisk`
+path of your application.

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Frisk'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/frisk/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/frisk/application_controller.rb

@@ -0,0 +1,7 @@
+module Frisk
+  class ApplicationController < ActionController::Base
+    rescue_from ActionController::ParameterMissing do |e|
+      render json: e.message, status: :bad_request
+    end
+  end
+end

data/app/controllers/frisk/requests_controller.rb

@@ -0,0 +1,27 @@
+require 'frisk/http_client'
+require 'frisk/errors'
+
+module Frisk
+  class RequestsController < ApplicationController
+    def create
+      response = HttpClient.new(api_host_url).request!(request_params)
+      render json: response, status: :ok
+    rescue HttpRequestError => e
+      render json: e.message, status: :internal_server_error
+    end
+
+    private
+
+      def api_host_url
+        params.require(:api_host_url)
+      end
+
+      def request_params
+        params
+          .tap{|x| x.require(:method)}
+          .tap{|x| x.require(:resource)}
+          .permit(:method, :resource, :body, :headers)
+          .symbolize_keys
+      end
+  end
+end

data/app/helpers/frisk/application_helper.rb

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

data/app/models/frisk/request.rb

@@ -0,0 +1,23 @@
+require 'frisk/http_client'
+require 'frisk/errors'
+module Frisk
+  class Request
+    include ActiveModel::Validations
+    attr_accessor :api_host_url, :method, :resource, :body, :headers
+    validates :api_host_url, :method, :resource, presence: true
+
+    def initialize(params)
+      api_host_url = params[:api_host_url]
+      method = params[:method]
+      resource = params[:resource]
+      body = params[:body]
+      headers = params[:headers]
+    end
+
+    def send!
+      raise Frisk::ValidationError if invalid?
+      client = Frisk::HttpClient.new(api_host_url)
+      client.request!(method, resource, body, headers)
+    end
+  end
+end

data/app/views/layouts/frisk/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Frisk</title>
+  <%= stylesheet_link_tag    "frisk/application", media: "all" %>
+  <%= javascript_include_tag "frisk/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Frisk::Engine.routes.draw do
+  resources :requests, only: [:create]
+end

data/lib/frisk.rb

@@ -0,0 +1,4 @@
+require "frisk/engine"
+
+module Frisk
+end

data/lib/frisk/engine.rb

@@ -0,0 +1,11 @@
+module Frisk
+  class Engine < ::Rails::Engine
+    isolate_namespace Frisk
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/frisk/errors.rb

@@ -0,0 +1,4 @@
+module Frisk
+  class FriskError < StandardError; end
+  class HttpRequestError < FriskError; end
+end

data/lib/frisk/http_client.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'frisk/errors'
+
+module Frisk
+  class HttpClient
+    def initialize(api_host_url)
+      @connection = Faraday.new(url: api_host_url) do |conn|
+        conn.response :raise_error
+        conn.response :json
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def request!(params)
+      @connection
+        .run_request(params[:method].to_sym, params[:resource],
+                     params[:body], params[:headers])
+    rescue Exception => e
+      raise Frisk::HttpRequestError, e.message
+    end
+  end
+end

data/lib/frisk/version.rb

@@ -0,0 +1,3 @@
+module Frisk
+  VERSION = "0.0.1.alpha"
+end

data/lib/tasks/frisk_tasks.rake

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: frisk
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Emil Soman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Coming soon
+email:
+- emil.soman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/frisk/application.js
+- app/assets/stylesheets/frisk/application.css
+- app/controllers/frisk/application_controller.rb
+- app/controllers/frisk/requests_controller.rb
+- app/helpers/frisk/application_helper.rb
+- app/models/frisk/request.rb
+- app/views/layouts/frisk/application.html.erb
+- config/routes.rb
+- lib/frisk/engine.rb
+- lib/frisk/errors.rb
+- lib/frisk/http_client.rb
+- lib/frisk/version.rb
+- lib/frisk.rb
+- lib/tasks/frisk_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A tool to test/document your APIs
+test_files: []