frisk 0.0.1.alpha

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ZTJmZjMzMDZhNDVmNmM2YmJhNTZjNjE4ZDFkODI2OTg3MDUyZmJiYw==
5
+ data.tar.gz: !binary |-
6
+ YzE3ZTQ5ZTBjM2QxNDYxZDU5NjE0YmI4MzgyNDcyOGJmNzMwZmI2MA==
7
+ SHA512:
8
+ metadata.gz: !binary |-
9
+ YmEyYmNhYzlmMDdhYTFmMTBmYmY5ZDYxZWI1M2U5M2YzODUxZGY3NmNlYTVi
10
+ YzE4ZDU3OTk1OGYxZjA3ZjYzMjIwNzcxYjhjZGZjNWE3MTcxMThmMWViNmNm
11
+ YzE3MzAyMDc4YWZhOTY0YTAyNjBiMjVjYWQyY2JhNTA3YjQ0ZDU=
12
+ data.tar.gz: !binary |-
13
+ ZTA2NmEwNWM4MGQ0ZjIyYmRiYjFmNmVmYWM2OTNjZjJiNTdmYTc5NzJhNGE4
14
+ NmE4ZWU4OGE3YWIwMDIxNjliNzdlY2I3ZjgxZTUzM2NmMmJjYzdhMTg2OTcx
15
+ Y2IxNjlhMTk2MzA1NDZhY2M0NmM1MGM3MjVlYTBmY2RhNjFkYjI=
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2014 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,20 @@
1
+ Frisk
2
+ =====
3
+
4
+
5
+ ## What's frisk ?
6
+
7
+ Frisk is a mountable Rails engine which
8
+
9
+ * documents your API
10
+ * acts as your API health check
11
+ * gives you an API explorer
12
+
13
+ ## Installation
14
+
15
+ Add this to your Gemfile and run `bundle install`:
16
+
17
+ gem 'frisk'
18
+
19
+ This will install the gem and mount frisk on `/frisk`
20
+ path of your application.
data/Rakefile ADDED
@@ -0,0 +1,30 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'Frisk'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.rdoc')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+ APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
18
+ load 'rails/tasks/engine.rake'
19
+
20
+
21
+
22
+ Bundler::GemHelper.install_tasks
23
+
24
+ require 'rspec/core'
25
+ require 'rspec/core/rake_task'
26
+
27
+ desc "Run all specs in spec directory (excluding plugin specs)"
28
+ RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
29
+
30
+ task :default => :spec
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,13 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
@@ -0,0 +1,7 @@
1
+ module Frisk
2
+ class ApplicationController < ActionController::Base
3
+ rescue_from ActionController::ParameterMissing do |e|
4
+ render json: e.message, status: :bad_request
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,27 @@
1
+ require 'frisk/http_client'
2
+ require 'frisk/errors'
3
+
4
+ module Frisk
5
+ class RequestsController < ApplicationController
6
+ def create
7
+ response = HttpClient.new(api_host_url).request!(request_params)
8
+ render json: response, status: :ok
9
+ rescue HttpRequestError => e
10
+ render json: e.message, status: :internal_server_error
11
+ end
12
+
13
+ private
14
+
15
+ def api_host_url
16
+ params.require(:api_host_url)
17
+ end
18
+
19
+ def request_params
20
+ params
21
+ .tap{|x| x.require(:method)}
22
+ .tap{|x| x.require(:resource)}
23
+ .permit(:method, :resource, :body, :headers)
24
+ .symbolize_keys
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,4 @@
1
+ module Frisk
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,23 @@
1
+ require 'frisk/http_client'
2
+ require 'frisk/errors'
3
+ module Frisk
4
+ class Request
5
+ include ActiveModel::Validations
6
+ attr_accessor :api_host_url, :method, :resource, :body, :headers
7
+ validates :api_host_url, :method, :resource, presence: true
8
+
9
+ def initialize(params)
10
+ api_host_url = params[:api_host_url]
11
+ method = params[:method]
12
+ resource = params[:resource]
13
+ body = params[:body]
14
+ headers = params[:headers]
15
+ end
16
+
17
+ def send!
18
+ raise Frisk::ValidationError if invalid?
19
+ client = Frisk::HttpClient.new(api_host_url)
20
+ client.request!(method, resource, body, headers)
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Frisk</title>
5
+ <%= stylesheet_link_tag "frisk/application", media: "all" %>
6
+ <%= javascript_include_tag "frisk/application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
data/config/routes.rb ADDED
@@ -0,0 +1,3 @@
1
+ Frisk::Engine.routes.draw do
2
+ resources :requests, only: [:create]
3
+ end
data/lib/frisk.rb ADDED
@@ -0,0 +1,4 @@
1
+ require "frisk/engine"
2
+
3
+ module Frisk
4
+ end
@@ -0,0 +1,11 @@
1
+ module Frisk
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Frisk
4
+
5
+ config.generators do |g|
6
+ g.test_framework :rspec, :fixture => false
7
+ g.assets false
8
+ g.helper false
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,4 @@
1
+ module Frisk
2
+ class FriskError < StandardError; end
3
+ class HttpRequestError < FriskError; end
4
+ end
@@ -0,0 +1,23 @@
1
+ require 'faraday'
2
+ require 'faraday_middleware'
3
+ require 'frisk/errors'
4
+
5
+ module Frisk
6
+ class HttpClient
7
+ def initialize(api_host_url)
8
+ @connection = Faraday.new(url: api_host_url) do |conn|
9
+ conn.response :raise_error
10
+ conn.response :json
11
+ conn.adapter Faraday.default_adapter
12
+ end
13
+ end
14
+
15
+ def request!(params)
16
+ @connection
17
+ .run_request(params[:method].to_sym, params[:resource],
18
+ params[:body], params[:headers])
19
+ rescue Exception => e
20
+ raise Frisk::HttpRequestError, e.message
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,3 @@
1
+ module Frisk
2
+ VERSION = "0.0.1.alpha"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :frisk do
3
+ # # Task goes here
4
+ # end
metadata ADDED
@@ -0,0 +1,102 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: frisk
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1.alpha
5
+ platform: ruby
6
+ authors:
7
+ - Emil Soman
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-01-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: 4.0.2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: 4.0.2
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ! '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ! '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: faraday_middleware
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ! '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ! '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: Coming soon
56
+ email:
57
+ - emil.soman@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - app/assets/javascripts/frisk/application.js
63
+ - app/assets/stylesheets/frisk/application.css
64
+ - app/controllers/frisk/application_controller.rb
65
+ - app/controllers/frisk/requests_controller.rb
66
+ - app/helpers/frisk/application_helper.rb
67
+ - app/models/frisk/request.rb
68
+ - app/views/layouts/frisk/application.html.erb
69
+ - config/routes.rb
70
+ - lib/frisk/engine.rb
71
+ - lib/frisk/errors.rb
72
+ - lib/frisk/http_client.rb
73
+ - lib/frisk/version.rb
74
+ - lib/frisk.rb
75
+ - lib/tasks/frisk_tasks.rake
76
+ - MIT-LICENSE
77
+ - Rakefile
78
+ - README.md
79
+ homepage: ''
80
+ licenses: []
81
+ metadata: {}
82
+ post_install_message:
83
+ rdoc_options: []
84
+ require_paths:
85
+ - lib
86
+ required_ruby_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ! '>='
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ required_rubygems_version: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ! '>'
94
+ - !ruby/object:Gem::Version
95
+ version: 1.3.1
96
+ requirements: []
97
+ rubyforge_project:
98
+ rubygems_version: 2.1.11
99
+ signing_key:
100
+ specification_version: 4
101
+ summary: A tool to test/document your APIs
102
+ test_files: []