try_api 0.0.6

data/app/views/try_api/pages/index.html

@@ -0,0 +1,92 @@
+<div class="try-api-sidebar">
+    <div class="try-api-sidebar-header"><b>{{ project.name }}</b> API</div>
+    <div class="try-api-sidebar-menu-container" id="tryApiScrollspy">
+        <ul class="try-api-sidebar-menu try-api-sidebar-menu-items nav">
+            <li class="try-api-sidebar-menu-item" ng-repeat="menu_item in project.menu_items track by menu_item.id"><a
+                    href="{{ &#39;#section&#39; + menu_item.id }}">{{ menu_item.title }}</a>
+                <ul class="second-level-menu-items nav" ng-show="menu_item.methods">
+                    <li ng-repeat="method in menu_item.methods track by method.id"><a
+                            href="{{ &#39;#section&#39; + menu_item.id + method.id }}">{{ method.title }}</a></li>
+                </ul>
+            </li>
+        </ul>
+    </div>
+</div>
+<div class="try-api-container">
+    <div class="row method is-flex">
+        <div class="col-md-6 method-try"><h2 class="method-try-heading">{{ project.name }}</h2></div>
+        <div class="col-md-6 method-example">API endpoint
+            <div class="method-example-code">{{ project.endpoint }}</div>
+        </div>
+    </div>
+    <div ng-repeat="menu_item in project.menu_items track by menu_item.id">
+        <div class="row method" id="&#39;section&#39; + menu_item.id">
+            <div class="col-md-12 method-try"><h3>{{ menu_item.title }}</h3>{{ menu_item.description }}
+                <div ng-bind-html="getHtml(menu_item.html)"></div>
+            </div>
+        </div>
+        <div ng-repeat="method in menu_item.methods track by method.id">
+            <div class="row method" id="{{ &#39;section&#39; + menu_item.id + method.id }}" ng-if="method.html">
+                <div class="col-md-12 method-try"><h3>{{ method.title }}</h3>
+                    <div ng-bind-html="getHtml(method.html)"></div>
+                </div>
+            </div>
+            <div class="row method is-flex"
+                 id="{{ method.html ? &#39;&#39; : (&#39;section&#39; + menu_item.id + method.id) }}">
+                <div class="col-md-6 method-try"><h4>{{ method.title }}</h4>
+                    <h4>
+                        <div class="label label-info">{{ method.method }}</div>
+                        {{ method.local_path }}
+                    </h4>
+                    <div ng-if="method.headers.length &gt; 0"><label>Headers:</label>
+                        <div class="row parameter" ng-repeat="header in method.headers">
+                            <div class="col-md-3 text-right"><b>{{header.name }}</b></div>
+                            <div class="col-md-9"><input class="form-control" ng-model="header.value" type="text"/>
+                                <div class="text-muted small">
+                                    <div ng-trust-html="getHtml(header.description)"></div>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                    <div ng-if="method.parameters.length &gt; 0"><label>Parameters:</label>
+                        <div ng-model="method.parameters" params=""></div>
+                    </div>
+                    <br/>
+                    <div class="text-right progress-demo">
+                        <button class="btn btn-success ladda-button" data-color="mint" data-style="expand-right"
+                                ladda="method.pending" ng-click="method.submit()" sata-size="s"><span
+                                class="ladda-label">Try it</span><span class="ladda-spinner"></span>
+                            <div class="ladda-progress" style="width: 100px"></div>
+                        </button>
+                    </div>
+                    <br/>
+                    <div class="method-example-code" id="method.response" ng-show="method.response">
+                        <div class="label">Status code: <span ng-class="getStatusCodeClass(method.response.status)">{{ method.response.status }}</span>
+                        </div>
+                        <br/>
+                        <div class="label">Data:</div>
+                        <div hljs="" hljs-language="json" hljs-source="method.response.data"></div>
+                        <br/>
+                        <div class="label">Headers:</div>
+                        <div hljs="" hljs-language="json" hljs-source="method.response.headers"></div>
+                    </div>
+                </div>
+                <div class="col-md-6 method-example"><h1>Example responses</h1>
+                    <div ng-repeat="example in method.example_responses">
+                        <div class="response"><span class="label label-{{ example.color }}">{{ example.code }}</span> {{
+                            example.description }}
+                        </div>
+                        <div hljs="" hljs-language="{{ example.type }}" hljs-source="example.response"></div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <div class="row method is-flex">
+        <div class="col-md-6 method-try"></div>
+        <div class="col-md-6 method-example">
+            <div class="text-right"><strong>Created using <a href="https://github.com/mskubenich/try_api">try_api <i
+                    class="fa fa-github"></i></a></strong></div>
+        </div>
+    </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,7 @@
+TryApi::Engine.routes.draw do
+
+  root to: 'pages#index'
+
+  resources :projects
+
+end

data/lib/generators/try_api/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+
+module TryApi
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    desc "This generator generates config file for API interface."
+
+    def init_environment
+      app = ::Rails.application
+      @app_name = app.class.to_s.split("::").first
+    end
+
+    def create_config_file
+      template 'config/try_api.yml', 'config/try_api.yml'
+
+      # Bundler.with_clean_env do
+      #   run "mkdir vendor/assets/try_api"
+      #   run "cd vendor/assets/try_api && bower install jquery"
+      #   run "cd vendor/assets/try_api && bower install bootstrap"
+      #   run "cd vendor/assets/try_api && bower install slimScroll"
+      #   run "cd vendor/assets/try_api && bower install highlightjs"
+      #   run "cd vendor/assets/try_api && bower install angular"
+      #   run "cd vendor/assets/try_api && bower install angular-bootstrap"
+      #   run "cd vendor/assets/try_api && bower install angular-highlightjs"
+      # end
+
+    end
+  end
+end

data/lib/generators/try_api/templates/config/try_api.yml

@@ -0,0 +1,352 @@
+project_name: 'My awesome project'
+host: 'http://localhost'
+port: 3000
+api_prefix: 'api/v1'
+menu_items:
+  -
+    title: 'Introduction'
+    description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+                  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+                  Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+                  Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
+  -
+    title: 'Article'
+    description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+                  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
+  -
+    title: 'Sessions'
+    methods:
+      -
+        title: 'Login'
+        description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
+        path: '/login'
+        method: 'post'
+        parameters:
+          -
+            name: 'email'
+            type: 'string'
+          -
+            name: 'password'
+            type: 'string'
+            description: 'user password'
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "session_token": "86c07402ac0be5e1be29ef194b11da6ecbb86d2b8debddfe462d71063d071fdd"
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": [
+                  "Wrong login/password combination."
+                ]
+              }
+            type: 'json'
+      -
+        title: 'Login with facebook'
+        description: ''
+        path: '/login/facebook'
+        method: 'post'
+        parameters:
+          -
+            name: 'access_token'
+            type: 'string'
+            description: 'facebook access token'
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "session_token": "86c07402ac0be5e1be29ef194b11da6ecbb86d2b8debddfe462d71063d071fdd"
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": [
+                  "An active access token must be used to query information about the current user."
+                ]
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": [
+                  "You need to register first."
+                ]
+              }
+            type: 'json'
+      -
+        title: 'Logout'
+        path: '/logout'
+        method: 'delete'
+        headers:
+          -
+            name: 'Session-Token'
+            description: 'Session token received <a href="#section5">on login</a>'
+            global: true
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "session_token": "86c07402ac0be5e1be29ef194b11da6ecbb86d2b8debddfe462d71063d071fdd"
+              }
+            type: 'ruby'
+          -
+            code: 401
+            response: >
+
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "ok": true
+              }
+            type: 'json'
+          -
+            code: 401
+            response: >
+              {
+                "error": "Access Denied !"
+              }
+            type: 'json'
+  -
+    title: 'Registration steps'
+    methods:
+      -
+        title: 'Step 1. Address'
+        path: '/registration'
+        method: 'post'
+        html: >
+          <p style="font-size: 16px;">
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+          </p>
+        parameters:
+          -
+            name: 'step'
+            type: 'integer'
+            description: "for stylist's step 1 this parameter should be '1'"
+          -
+            name: 'home_postcode'
+            type: 'string'
+          -
+            name: 'home_address'
+            type: 'string'
+            description: "address string from '/addresses' endpoint ?"
+          -
+            name: 'distance'
+            type: 'string'
+            description: "distance i'm willing to travel in miles. Should be 5, 10, 20, 30, 50, 100, National or Global."
+          -
+            name: 'offer_in_salon'
+            type: 'boolean'
+            description: "Should be true or false."
+            required: false
+          -
+            name: 'salon_postcode'
+            type: 'string'
+            required: false
+          -
+            name: 'salon_address'
+            type: 'string'
+            required: false
+            description: "address string from '/addresses' endpoint ?"
+
+        headers:
+          -
+            name: 'Session-Token'
+            description: 'Session token received <a href="#section5">on login</a>'
+            global: true
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "ok": true
+              }
+            type: 'json'
+          -
+            code: 401
+            response: >
+              {
+                "errors": ["Access Denied !"]
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": "Wrong step. Your allowed step is 1"
+              }
+            type: 'json'
+          -
+            code: 500
+            response: >
+              {
+                "errors": [
+                  "User is not stylist."
+                ]
+              }
+            type: 'json'
+      -
+        title: 'Step 2'
+        path: '/registration'
+        method: 'post'
+        html: >
+          <p style="font-size: 16px;">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+        parameters:
+          -
+            name: 'step'
+            type: 'integer'
+            description: "for stylist's step 3 this parameter should be '3'. Available working hours should be index from array 07:00, 07:30, 08:00, ... , 19:30, 20:00, 20:30, 21:00"
+          -
+            name: 'days'
+            type: 'array'
+            parameters:
+              -
+                name: 'enabled'
+                type: 'boolean'
+              -
+                name: 'day'
+                type: 'integer'
+                description: 'monday -> 0, tuesday -> 1, wednesday -> 2, thursday -> 3, friday -> 4, saturday -> 5, sunday -> 6'
+              -
+                name: 'start_hour'
+                type: 'integer'
+              -
+                name: 'end_hour'
+                type: 'integer'
+
+        headers:
+          -
+            name: 'Session-Token'
+            description: 'Session token received <a href="#section5">on login</a>'
+            global: true
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "ok": true
+              }
+            type: 'json'
+          -
+            code: 401
+            response: >
+              {
+                "errors": ["Access Denied !"]
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": "Wrong step. Your allowed step is 1"
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": [
+                  "Monday available start hour can't be blank",
+                  "Monday available start hour is not included in the list",
+                  "Monday available end hour can't be blank",
+                  "Monday available end hour is not included in the list",
+                  "Monday available end hour is not a number",
+                  "Tuesday available can't be blank",
+                  "Wednesday available can't be blank",
+                  "Thursday available can't be blank",
+                  "Friday available can't be blank",
+                  "Saturday available can't be blank",
+                  "Sunday available can't be blank"
+                ]
+              }
+            type: 'json'
+          -
+            code: 500
+            response: >
+              {
+                "errors": [
+                  "User is not stylist."
+                ]
+              }
+            type: 'json'
+      -
+        title: 'Step 3. Profile photos'
+        path: '/registration'
+        method: 'post'
+        html: >
+          <p>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+          Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+          Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+          Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+          </p>
+        parameters:
+          -
+            name: 'step'
+            type: 'integer'
+            description: "for stylist's step 6 this parameter should be '6'."
+          -
+            name: 'left_photo'
+            type: 'image'
+          -
+            name: 'mine_photo'
+            type: 'image'
+          -
+            name: 'right_photo'
+            type: 'image'
+          -
+            name: 'verification_document'
+            type: 'image'
+        headers:
+          -
+            name: 'Session-Token'
+            description: 'Session token received <a href="#section5">on login</a>'
+            global: true
+        example_responses:
+          -
+            code: 200
+            response: >
+              {
+                "ok": true
+              }
+            type: 'json'
+          -
+            code: 401
+            response: >
+              {
+                "errors": ["Access Denied !"]
+              }
+            type: 'json'
+          -
+            code: 422
+            response: >
+              {
+                "errors": "Wrong step. Your allowed step is 1"
+              }
+            type: 'json'
+          -
+            code: 500
+            response: >
+              {
+                "errors": [
+                  "User is not stylist."
+                ]
+              }
+            type: 'json'

data/lib/tasks/try_api_tasks.rake

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

data/lib/try_api/engine.rb

@@ -0,0 +1,5 @@
+module TryApi
+  class Engine < ::Rails::Engine
+    isolate_namespace TryApi
+  end
+end

data/lib/try_api/exceptions.rb

@@ -0,0 +1,12 @@
+module TryApi
+  class ConfigFileNotFound < StandardError
+    def message
+      "Configuration file config/try_api.yml not found. Run 'rails generate try_api:install' to generate it."
+    end
+  end
+  class ArgumentError < ArgumentError
+    def message
+      "Type not allowed here."
+    end
+  end
+end

data/lib/try_api/version.rb

@@ -0,0 +1,3 @@
+module TryApi
+  VERSION = "0.0.6"
+end

data/lib/try_api.rb

@@ -0,0 +1,4 @@
+require "try_api/engine"
+
+module TryApi
+end