praxis 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f9e3125f14a1661de76a4f8f5af8749dcc0b2c1
-  data.tar.gz: 5e88bc49232b9ad8dbd7c20b046c49905d14f52c
+  metadata.gz: 3cc6641a8ee79fff261135fc27c46987c5118963
+  data.tar.gz: 23e6e0f445620738409e10818044f66f923c940a
 SHA512:
-  metadata.gz: 5f0fa85f2dbb7d145f9e56f49aa755a2dc5cf4db65db107f73c468d3b71908e832c404d1b5cc96ac55b6f8a93c9724d7ed43192cb2f5a6fe45b18f8e2ce944b9
-  data.tar.gz: c451e56a47994d560fc3b739bc8f63a08c5f9ffb6ba7136a9b343059bb3c3e5c34c31382e8cdcf2ec2065b00d9d81ff5a7afd7da375d22a582d02eda18469369
+  metadata.gz: 2f956167d5bf702c127b12b632a1b4d7ac3a404088d9f1fc226c813ffcd5bb93d4c857747bcd24acd07f449fb4123240e768716c0f433182588fd33d85143682
+  data.tar.gz: 956e4d47a1b7fecdb9f41da2343422f1f243b777b64402fccd9fd3c2e92a0b878b2c907f7c79d39b7d38b1a81f2a8a7564fc5f80ad43acce3144d778c46c6b6f

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## next
 
+## 0.20.1
+
+* Doc generation: handle SimpleMediaTypes so that they don’t show up in the generated schemas.
+* Ensure we require AS#Enumerable extension is loaded, which is required in the generator code.
+* Add Date to the list of primitive types so that it does not show in the generated schemas.
+* Enhance the `:created` response_template, so that it can take the associated media_type
+* Doc Browser: fix route display to have the captures instead of the example
+
 ## 0.20.0
 
 * You can now add a `bower.json` file to your `docs` folder. Any dependencies

data/lib/api_browser/app/js/directives/request_examples.js

@@ -12,7 +12,9 @@ app.directive('requestExamples', function(Examples, $timeout) {
       var keys = _.keys(scope.examples);
       if (keys.length === 1) {
         scope.examples[keys[0]].template.then(function(templateFn) {
-          element.empty().append(templateFn(scope));
+          $timeout(function() {
+            element.empty().append(templateFn(scope));
+          }, 100);
         });
       } else {
         scope.select = function(template) {

data/lib/api_browser/app/js/directives/url.js

@@ -5,12 +5,11 @@ app.directive('url', function() {
   return {
     restrict: 'EA',
     scope: {
-      action: '=',
-      example: '@'
+      action: '='
     },
     templateUrl: 'views/directives/url.html',
     link: function(scope, element, attrs) {
-      scope.showExample = scope.example == 'example' || scope.example == 'true' || 'example' in attrs;
+      scope.showExample = 'example' in attrs;
     }
   };
 });

data/lib/praxis/api_definition.rb

@@ -98,7 +98,8 @@ module Praxis
         description 'Standard response for successful HTTP requests.'
       end
 
-      api.response_template :created do |location: nil|
+      api.response_template :created do |location: nil, media_type: nil|
+        media_type media_type if media_type
         location location
         status 201
         description 'The request has been fulfilled and resulted in a new resource being created.'

data/lib/praxis/docs/generator.rb

@@ -2,6 +2,8 @@ module Praxis
   module Docs
 
     class Generator
+      require 'active_support/core_ext/enumerable' # For index_by
+
       API_DOCS_DIRNAME = 'docs/api'
 
       attr_reader :resources_by_version, :types_by_id, :infos_by_version
@@ -11,6 +13,7 @@ module Praxis
         Attributor::Boolean,
         Attributor::CSV,
         Attributor::DateTime,
+        Attributor::Date,
         Attributor::Float,
         Attributor::Hash,
         Attributor::Ids,
@@ -85,9 +88,9 @@ module Praxis
         when Hash
           if data.key?(:type) && data[:type].kind_of?(Hash) && ( [:id,:name,:family] - data[:type].keys ).empty?
             type_id = data[:type][:id]
-            unless type_id.nil?
+            unless type_id.nil? || type_id == Praxis::SimpleMediaType.id #SimpleTypes shouldn't be collected
               unless types_by_id[type_id]
-                raise "Error! We have detected a reference to a 'Type' which is not derived from Attributor::Type" +
+                raise "Error! We have detected a reference to a 'Type' with id='#{type_id}' which is not derived from Attributor::Type" +
                       " Document generation cannot proceed."
               end
               reachable_types << types_by_id[type_id]

data/lib/praxis/simple_media_type.rb

@@ -6,14 +6,20 @@ module Praxis
   # @see Praxis::MediaType
   # @see Praxis::Types::MediaTypeCommon
   SimpleMediaType = Struct.new(:identifier) do
+
     def name
       self.class.name
     end
 
+    def self.id
+      "Praxis-SimpleMediaType".freeze
+    end
+
     def id
-      self.class.name.gsub("::",'-')
+      self.class.id
     end
 
+
     def describe(shallow=true)
       {name: name, family: "string", id: id, identifier: identifier}
     end

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.20.0'
+  VERSION = '0.20.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -725,7 +725,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Building APIs the way you want it.