try_api 0.0.18 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2ecbc0b9fe2f833f16c373593fd4b7d3082d30e
-  data.tar.gz: ae4f6997359ec3c60ffbdb2f4dc882ae8452a567
+  metadata.gz: f1be98ca7c3fedb211242e6cddd502f43e8652a4
+  data.tar.gz: cee90258aeafce44cd621d57c568732ccc1f4fde
 SHA512:
-  metadata.gz: 4673b1f0d0df87785799af919b2a7982038b6313ec6489096992e6bb426408c2b18285d57ceda82c34d355cd4051ca29e36a050a33529c8c760d6f97ec88ef91
-  data.tar.gz: 282f6fdbdcefcdb69b3ef7eaec7ce7649bb247f517b5376771e3a0c1b2f3542c4b07a90051328f14c029c5301c14e1e3207e448cfffea8ef06a05e50783fc847
+  metadata.gz: 4557d9706bf50eccc771b4106fe81cc16d1fe360057e8dc6bee7b955d8a85e0e9b1311ed4a0d55b98b4a1ed8495cefff5231948e7239c01c1fce9924e4b34288
+  data.tar.gz: 511ff5f84d86367023a7f5cde72ad5e3fe0b779c5f3cccdb205a3ba37f999593a99f8228e2cbd80a5f94e4218c5ea355edcd274283260a10fd9af54b157a6086

data/app/assets/javascripts/try_api/application.js.coffee

@@ -1,10 +1,3 @@
-#= require try_api/bower_components/highlightjs/highlight.pack.min.js
-#= require try_api/bower_components/angular-bootstrap/ui-bootstrap.js
-#= require try_api/bower_components/angular-bootstrap/ui-bootstrap-tpls.js
-#= require try_api/bower_components/angular-highlightjs/angular-highlightjs.min.js
-#= require try_api/bower_components/ladda/dist/spin.min.js
-#= require try_api/bower_components/ladda/dist/ladda.min.js
-#= require try_api/bower_components/angular-ladda/dist/angular-ladda.min.js
 #= require try_api/params.directive
 #= require try_api/param.directive
 #= require try_api/paramsarray.directive
@@ -52,31 +45,6 @@ TryApiApp.run [
   ($http, $rootScope) ->
 ]
 
-TryApiApp.controller 'HomeController', [
-  '$scope'
-  '$timeout'
-  '$sce'
-  '$http'
-  ($scope, $timeout, $sce, $http) ->
-
-    $scope.getStatusCodeClass = (code) ->
-      switch true
-        when code >= 200 && code < 300
-          return 'text-success'
-        when code >= 300 && code < 400
-          return 'text-warning'
-        when code >= 400 && code < 500
-          return 'text-danger'
-        when code >= 500
-          return 'text-danger'
-        else
-          return 'text-info'
-
-    $scope.headers = []
-    $scope.params = []
-
-]
-
 TryApiApp.controller 'HomeController', [
   '$scope'
   '$timeout'
@@ -105,7 +73,7 @@ TryApiApp.controller 'HomeController', [
     $scope.global_headers = {}
     $scope.params = []
 
-    $http.get('/developers/projects.json').success (data) ->
+    $http.get('/developers/projects.json').success (data) -> # TODO this should depends from app routes
       $scope.project = data.project
       $.each $scope.project.menu_items, () ->
         menu_item = this
@@ -131,20 +99,23 @@ TryApiApp.controller 'HomeController', [
               header = this
               headers[header.name] = header.value
 
+            path = $scope.project.host + ':' + $scope.project.port + '/' + method.submit_path
+
             switch method.method.toLowerCase()
               when 'post'
                 fd = new FormData
+                fd.append 'a', 'a' # TODO sending empty array causes EOFError
 
                 $.each method.parameters, (i) ->
                   $scope.addParameterToForm fd, this
 
-                $http.post method.submit_path, fd,
+                $http.post path, fd,
                   transformRequest: angular.identity
                   headers: headers
                 .success method.response_handler
                 .error method.response_handler
               when 'delete'
-                $http.delete method.submit_path,
+                $http.delete path,
                   transformRequest: angular.identity
                   headers: headers
                 .success method.response_handler
@@ -156,18 +127,19 @@ TryApiApp.controller 'HomeController', [
                   parameter = this
                   fd = fd + parameter.name + '=' + (parameter.value || '') + '&'
 
-                $http.get method.submit_path + '?' + fd,
+                $http.get path + '?' + fd,
                   transformRequest: angular.identity
                   headers: headers
                 .success method.response_handler
                 .error method.response_handler
               when 'put'
                 fd = new FormData
+                fd.append 'a', 'a' # TODO sending empty array causes EOFError
 
                 $.each method.parameters, (i) ->
                   $scope.addParameterToForm fd, this
 
-                $http.put method.submit_path, fd,
+                $http.put path, fd,
                   transformRequest: angular.identity
                   headers: headers
                 .success method.response_handler

data/app/assets/javascripts/try_api/param.directive.js.coffee

@@ -22,9 +22,9 @@ angular.module('TryApi').directive 'param', [
         '</div>' +
         '<div class="col-md-8" ng-if=\'parameter.type != "array"\'>' +
         '  <div ng-switch="parameter.type">' +
-        '    <input ng-switch-when="string" type="text" class="form-control" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
-        '    <textarea ng-switch-when="text" class="form-control" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\' style="max-width: 100%" />' +
-        '    <input ng-switch-when="integer" type="number" class="form-control" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
+        '    <input ng-switch-when="string" type="text" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
+        '    <textarea ng-switch-when="text" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\' style="max-width: 100%" />' +
+        '    <input ng-switch-when="integer" type="number" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
         '    <div ng-switch-when="boolean" class="onoffswitch">' +
         '      <input class="onoffswitch-checkbox" ng-model="parameter.value" type="checkbox" id="{{ unique_id }}-on-off-switch">' +
         '      <label class="onoffswitch-label" for="{{ unique_id }}-on-off-switch"></label>' +
@@ -32,7 +32,7 @@ angular.module('TryApi').directive 'param', [
         '      <span class="onoffswitch-switch"></span>' +
         '    </div>' +
         '    <div ng-switch-when="image" image=true" ng-model="parameter.value"></div>' +
-        '    <input ng-switch-default type="text" class="form-control" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
+        '    <input ng-switch-default type="text" ng-model="parameter.value" placeholder=\'{{ parameter.required ? "required" : "optional"}}\'>' +
         '  </div>' +
         '  <div class="text-muted small" ng-bind-html="getHtml(parameter.description)"></div>' +
         '</div>' +

data/app/assets/javascripts/try_api/url.directive.js.coffee

@@ -20,10 +20,17 @@ angular.module('TryApi').directive 'url', [
 
       scope.$watch 'parts', ->
         scope.url = scope.parts.map((i)->
-          i.value
+          if i.value == '' then '0' else i.value
         ).join('/')
       , true
 
+      scope.inputStyle = (part) ->
+        charWidth = 13.3;
+        return  {
+          "width": ((part.value).length + 1) * charWidth + "px",
+          "min-width": ((part.placeholder).length) * charWidth + "px"
+        }
+
     return {
       link: link
       restrict: 'A'
@@ -34,7 +41,7 @@ angular.module('TryApi').directive 'url', [
       template: '<span ng-repeat="part in parts track by $index">' +
         '/' +
         '<span ng-if="!isParameter(part.placeholder)">{{ part.value }}</span>' +
-        '<input ng-if="isParameter(part.placeholder)" ng-model="part.value" placeholder="{{ part.placeholder }}"/>' +
+        '<input ng-if="isParameter(part.placeholder)" ng-model="part.value" class="url-input" ng-style="inputStyle(part)" placeholder="{{ part.placeholder }}" scope="max-width: 90%; font-family:monospace;"/>' +
         '</span>'
     }
-]
+]

data/app/assets/stylesheets/try_api/application.css.sass

@@ -1,14 +1,25 @@
-//= require try_api/bower_components/highlightjs/styles/agate.css
-//= require try_api/bower_components/angular-bootstrap/ui-bootstrap-csp.css
-//= require try_api/bower_components/ladda/dist/ladda.min.css
-//= require try_api/bower_components/ladda/dist/ladda-themeless.min.css
-//= require try_api/bower_components/components-font-awesome/css/font-awesome.css
-
 body
   margin: 0
   background-color: #f3f3f4
   font-family: Arial, Helvetica, sans-serif
 
+  input, textarea
+    border: 0
+    border-bottom: 2px solid #19B698
+    outline: none
+    &:not(.url-input)
+      width: 100%
+
+
+  ::-webkit-input-placeholder
+    color: #19B698
+  ::-moz-placeholder
+    color: #19B698
+  :-moz-placeholder
+    color: #19B698
+  :-ms-input-placeholder
+    color: #19B698
+
   pre
     padding: 0
     margin: 0
@@ -84,8 +95,8 @@ body
 
         &-items
           list-style-type: none
-          padding: 0
           font-size: 16px
+          padding-bottom: 60px
           .second-level-menu-items
             list-style-type: none
             font-size: 14px
@@ -176,9 +187,8 @@ body
 
 
   .parameter
-    border-bottom: 1px solid #e8e8e8
-    padding-bottom: 7px
-    padding-top: 7px
+    padding-bottom: 5px
+    padding-top: 5px
 
 .nav > li > a
   padding: 1px 11px

data/app/models/try_api/base.rb

@@ -4,6 +4,7 @@ class FalseClass; include Boolean; end
 
 module TryApi
   class Base
+
     def self.typesafe_accessor(name, type, options={})
 
       define_method(name) do
@@ -12,26 +13,44 @@ module TryApi
 
       define_method("#{name}=") do |value|
         if value.is_a?(type) || value.nil?
-          value = options[:default] if value.nil? && !options[:default].nil?
-          instance_variable_set("@#{name}", value)
+          if options[:items_type].try(:<, TryApi::Base)
+
+            items = []
+            if value.is_a? Array
+              value.each do |item|
+                item = load_inclusion(item[:include!]) if item[:include!].present?
+
+                items << options[:items_type].new({ parent: self }.merge(item))
+              end
+            end
+
+            instance_variable_set("@#{name}", items)
+          else
+            value = options[:default] if value.nil? && !options[:default].nil?
+            instance_variable_set("@#{name}", value)
+          end
         else
           raise TryApi::ArgumentError.new
         end
       end
     end
 
+    attr_accessor :id
+    typesafe_accessor :parent, TryApi::Base
+    @@instances_count = 0
+
     def to_json
       result = {}
 
       self.instance_variables.each do |i|
         value = self.instance_variable_get(i)
         if value.instance_of?(Array)
-          result[i.to_s.gsub('@', '')] = value.map(&:to_json)
+          result[i.to_s.delete('@')] = value.map(&:to_json)
         else
-          if i == :@project
+          if i == :@parent
 
           else
-            result[i.to_s.gsub('@', '')] = value
+            result[i.to_s.delete('@')] = value
           end
         end
       end
@@ -40,13 +59,38 @@ module TryApi
       result.with_indifferent_access
     end
 
-    @@instances_count = 0
-
-    attr_accessor :id
+    def project
+      self.is_a?(TryApi::Project) ? self : self.parent.try(:project)
+    end
 
-    def initialize()
-      super
+    def initialize(hash)
       self.id = @@instances_count += 1
+      result_hash = {}
+      hash.to_h.each do |k, v|
+        if k.to_s == 'include!'
+          result_hash.merge! load_inclusion(v)
+        else
+          result_hash[k] = v
+        end
+      end
+
+      result_hash.to_h.each do |k, v|
+        v = self.project.variables[v.gsub('var:', '')] if v.is_a?(String) && v.start_with?('var:')
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
+    end
+
+    def self.load_inclusion(filename)
+      if File.exist?("#{ Rails.root }/config/try_api/#{ filename }.yml")
+        hash = YAML.load_file("#{ Rails.root }/config/try_api/#{ filename }.yml")
+        hash.with_indifferent_access
+      else
+        raise ConfigFileNotFound
+      end
+    end
+
+    def load_inclusion(filename)
+      self.class.load_inclusion filename
     end
   end
 end

data/app/models/try_api/config_parser.rb

@@ -3,12 +3,7 @@ module TryApi
     class << self
 
       def read
-        if File.exists?("#{ Rails.root }/config/try_api.yml")
-          hash = YAML.load_file("#{ Rails.root }/config/try_api.yml")
-          TryApi::Project.parse hash.with_indifferent_access
-        else
-          raise ConfigFileNotFound
-        end
+        TryApi::Project.new TryApi::Base.load_inclusion(:base)
       end
 
     end

data/app/models/try_api/example_response.rb

@@ -3,7 +3,6 @@ module TryApi
     typesafe_accessor :code, Integer
     typesafe_accessor :response, String
     typesafe_accessor :type, String
-    typesafe_accessor :project, TryApi::Project
 
     class << self
       def parse(hash:, project:)
@@ -19,9 +18,19 @@ module TryApi
       def descriptions
         {
             200 => :success,
+            201 => :created,
+            204 => :no_content,
+            304 => :not_modified,
+            400 => :bad_request,
             401 => :unauthorized,
+            403 => :forbidden,
+            404 => :not_found,
+            408 => :request_timeout,
             422 => :unprocessable_entity,
             500 => :internal_server_error,
+            502 => :bad_gateway,
+            503 => :service_unavailable,
+            504 => :gateway_timeout
         }
       end
     end
@@ -50,13 +59,5 @@ module TryApi
     def to_json
       super.merge color: color, description: description, isCollapsed: true
     end
-
-    def response=(input)
-      if input['var:']
-        @response = self.project.variables[input.gsub('var:', '')]
-      else
-        @response = input
-      end
-    end
   end
 end

data/app/models/try_api/header.rb

@@ -3,15 +3,5 @@ module TryApi
     typesafe_accessor :name, String
     typesafe_accessor :description, String
     typesafe_accessor :global, Boolean, default: false
-
-    class << self
-      def parse(hash)
-        instance = self.new
-        instance.name = hash[:name]
-        instance.global = hash[:global]
-        instance.description = hash[:description]
-        instance
-      end
-    end
   end
 end

data/app/models/try_api/menu_item.rb

@@ -3,23 +3,6 @@ module TryApi
     typesafe_accessor :title, String
     typesafe_accessor :html_template, String
     typesafe_accessor :description, String
-    typesafe_accessor :methods, Array
-    typesafe_accessor :project, TryApi::Project
-
-    class << self
-      def parse(hash:, project:)
-        instance = self.new
-        instance.project = project
-        instance.title = hash[:title]
-        instance.description = hash[:description]
-        instance.methods = []
-        unless hash[:methods].blank?
-          hash[:methods].each do |second_level_meny_item|
-            instance.methods << TryApi::Method.parse(project: instance.project, hash: second_level_meny_item)
-          end
-        end
-        instance
-      end
-    end
+    typesafe_accessor :methods, Array, items_type: TryApi::Method
   end
 end

data/app/models/try_api/method.rb

@@ -2,54 +2,11 @@ module TryApi
   class Method < TryApi::Base
     typesafe_accessor :title, String
     typesafe_accessor :description, String
-    typesafe_accessor :parameters, Array
-    typesafe_accessor :headers, Array
+    typesafe_accessor :parameters, Array, items_type: TryApi::Parameter
+    typesafe_accessor :headers, Array, items_type: TryApi::Header
     typesafe_accessor :path, String
     typesafe_accessor :method, String
-    typesafe_accessor :example_responses, Array
-    typesafe_accessor :project, TryApi::Project
-
-    class << self
-      def parse(hash:, project:)
-        return nil if hash.blank?
-        instance = self.new
-        instance.project = project
-        instance.title = hash[:title]
-        instance.description = hash[:description]
-        instance.parameters = hash[:parameters]
-        instance.headers = hash[:headers]
-        instance.method = hash[:method].try(:upcase)
-        instance.path = hash[:path]
-
-        instance.example_responses = []
-        if hash[:example_responses].is_a? Array
-          hash[:example_responses].each do |example|
-            instance.example_responses << TryApi::ExampleResponse.parse(hash: example, project: project)
-          end
-        else
-        #   TODO raise exception ?
-        end
-
-        instance.parameters = []
-        if hash[:parameters].is_a? Array
-          hash[:parameters].each do |parameter|
-            instance.parameters << TryApi::Parameter.parse(parameter)
-          end
-        else
-        #   TODO raise exception ?
-        end
-
-        instance.headers = []
-        if hash[:headers].is_a? Array
-          hash[:headers].each do |header|
-            instance.headers << TryApi::Header.parse(header)
-          end
-        else
-        #   TODO raise exception ?
-        end
-        instance
-      end
-    end
+    typesafe_accessor :example_responses, Array, items_type: TryApi::ExampleResponse
 
     def to_json
       super.merge local_path: local_path, full_path: full_path
@@ -60,7 +17,7 @@ module TryApi
     end
 
     def local_path
-      "/#{ project.api_prefix }#{ self.path }"
+      "/#{ self.project.api_prefix }#{ self.path }"
     end
   end
 end