skeleton 0.2.0 → 0.3.0

data/lib/skeleton/helpers/controller_helpers.rb

@@ -0,0 +1,25 @@
+require 'skeleton/structure'
+
+module Skeleton
+  module Helpers
+    module ControllerHelpers
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        def define_api_path(resource, &block)
+          Skeleton.config.path(resource, &block)
+        end
+
+        def define_global_parameter(location, name, &block)
+          Skeleton.config.parameter(location, name, &block)
+        end
+      end
+
+      def get_api_path(resource)
+        Skeleton.config.path(resource)
+      end
+    end
+  end
+end

data/lib/skeleton/info.rb

@@ -0,0 +1,40 @@
+require 'skeleton/model'
+require 'skeleton/license'
+require 'skeleton/contact'
+
+module Skeleton
+  class Info < Model
+    attr_accessor :title, :description, :terms_of_service, :license, :version
+    attr_presence :title, :description, :terms_of_service, :license, :version
+
+    def contact
+      @contact ||= Skeleton::Contact.new
+    end
+
+    def license
+      @license ||= Skeleton::License.new
+    end
+
+    def to_h
+      hash = {}
+      hash[:title]            = title            if title?
+      hash[:description]      = description      if description?
+      hash[:version]          = version          if version?
+      hash[:terms_of_service] = terms_of_service if terms_of_service?
+      hash[:license]          = license.to_h
+      hash[:contact]          = contact.to_h
+      hash
+    end
+
+    def to_swagger_hash
+      hash = {}
+      hash[:title]          = title            if title?
+      hash[:description]    = description      if description?
+      hash[:version]        = version          if version?
+      hash[:termsOfService] = terms_of_service if terms_of_service?
+      hash[:license]        = license.to_swagger_hash
+      hash[:contact]        = contact.to_swagger_hash
+      hash
+    end
+  end
+end

data/lib/skeleton/item.rb

@@ -0,0 +1,99 @@
+require 'skeleton/model'
+
+module Skeleton
+  class Item < Model
+    attr_accessor :type, :format, :title, :description, :default, :multiple_of,
+                  :maximum, :exclusive_maximum, :minimum, :exclusive_minimum,
+                  :max_length, :min_length, :pattern, :max_items, :min_items,
+                  :unique_items, :max_properties, :min_properties, :items
+
+    attr_writer :enum
+    attr_presence :exclusive_maximum, :exclusive_minimum, :unique_items, :items
+
+    def enum
+      @enum ||= []
+    end
+
+    def enum?
+      !enum.empty?
+    end
+
+    def array?
+      @type == 'array'
+    end
+
+    def string?
+      @type == 'string'
+    end
+
+    def number?
+      @type == 'number'
+    end
+
+    def integer?
+      @type == 'integer'
+    end
+
+    def boolean?
+      @type == 'boolean'
+    end
+
+    def file?
+      @type == 'file'
+    end
+
+    def to_h
+      hash = {}
+      hash[:type]              = type              if type?
+      hash[:format]            = format            if format?
+
+      hash[:items] = items.to_hash if items?
+
+      hash[:title]             = title             if title?
+      hash[:description]       = description       if description?
+      hash[:default]           = default           if default?
+      hash[:multiple_of]       = multiple_of       if multiple_of?
+      hash[:maximum]           = maximum           if maximum?
+      hash[:exclusive_maximum] = exclusive_maximum if exclusive_maximum?
+      hash[:minimum]           = minimum           if minimum?
+      hash[:exclusive_minimum] = exclusive_minimum if exclusive_minimum?
+      hash[:max_length]        = max_length        if max_length?
+      hash[:min_length]        = min_length        if min_length?
+      hash[:pattern]           = pattern           if pattern?
+      hash[:max_items]         = max_items         if max_items?
+      hash[:min_items]         = min_items         if min_items?
+      hash[:unique_items]      = unique_items      if unique_items?
+      hash[:max_properties]    = max_properties    if max_properties?
+      hash[:min_properties]    = min_properties    if min_properties?
+      hash[:enum]              = enum              if enum?
+      hash
+    end
+
+    def to_swagger_hash
+      hash = {}
+      hash[:type]             = type              if type?
+      hash[:format]           = format            if format?
+
+      hash[:items] = items.to_swagger_hash if items?
+
+      hash[:title]            = title             if title?
+      hash[:description]      = description       if description?
+      hash[:default]          = default           if default?
+      hash[:multipleOf]       = multiple_of       if multiple_of?
+      hash[:maximum]          = maximum           if maximum?
+      hash[:exclusiveMaximum] = exclusive_maximum if exclusive_maximum?
+      hash[:minimum]          = minimum           if minimum?
+      hash[:exclusiveMinimum] = exclusive_minimum if exclusive_minimum?
+      hash[:maxLength]        = max_length        if max_length?
+      hash[:minLength]        = min_length        if min_length?
+      hash[:pattern]          = pattern           if pattern?
+      hash[:maxItems]         = max_items         if max_items?
+      hash[:minItems]         = min_items         if min_items?
+      hash[:uniqueItems]      = unique_items      if unique_items?
+      hash[:maxProperties]    = max_properties    if max_properties?
+      hash[:minProperties]    = min_properties    if min_properties?
+      hash[:enum]             = enum              if enum?
+      hash
+    end
+  end
+end

data/lib/skeleton/license.rb

@@ -0,0 +1,16 @@
+require 'skeleton/model'
+
+module Skeleton
+  class License < Model
+    attr_accessor :name, :url
+    attr_presence :name, :url
+
+    def to_h
+      hash = {}
+      hash[:name] = name if name?
+      hash[:url] = url if url?
+      hash
+    end
+    alias_method :to_swagger_hash, :to_h
+  end
+end

data/lib/skeleton/model.rb

@@ -0,0 +1,31 @@
+require 'multi_json'
+require 'skeleton/attributes'
+
+module Skeleton
+  class Model
+    extend Skeleton::Attributes
+
+    def initialize(args={})
+      args.each do |k, v|
+        setter = "#{k}="
+        self.public_send(setter, v) if self.respond_to?(setter)
+      end
+    end
+
+    def to_swagger_hash
+      raise(NotImplementedError)
+    end
+
+    def to_h
+      raise(NotImplementedError)
+    end
+
+    def to_json
+      MultiJson.dump(to_h)
+    end
+
+    def to_swagger_json
+      MultiJson.dump(to_swagger_hash)
+    end
+  end
+end

data/lib/skeleton/operation.rb

@@ -0,0 +1,157 @@
+require 'skeleton/model'
+require 'skeleton/parameter'
+require 'skeleton/responses'
+
+module Skeleton
+  class Operation < Model
+    attr_accessor :summary, :description, :external_docs, :operation_id, :deprecated
+    attr_presence :summary, :description, :external_docs, :operation_id, :deprecated
+    attr_not_empty :tags, :consumes, :produces, :responses, :schemes, :security, :parameters
+
+    attr_writer :responses
+
+    def consumes
+      @consumes ||= []
+    end
+
+    def consumes=(value)
+      @consumes = Array(value)
+    end
+
+    def produces
+      @produces ||= []
+    end
+
+    def produces=(value)
+      @produces = Array(value)
+    end
+
+    def parameters
+      @parameters ||= []
+    end
+
+    def parameters=(value)
+      @parameters = Array(value)
+    end
+
+    def schemes
+      @schemes ||= []
+    end
+
+    def schemes=(value)
+      @schemes = Array(value)
+    end
+
+    def security
+      @security ||= []
+    end
+
+    def security=(value)
+      @security = Array(value)
+    end
+
+    def responses
+      @responses ||= Skeleton::Responses.new
+    end
+
+    def tags=(value)
+      @tags = Array(value)
+    end
+
+    def tags
+      @tags ||= []
+    end
+
+    def response(name, args={})
+      responses.set(name, args)
+    end
+
+    def tag(value)
+      tags << value
+    end
+
+    def parameter(location, name, &block)
+      param = Parameter.new(location: location, name: name)
+      yield(param) if block
+      parameters << param
+    end
+
+    def to_h
+      hash = {}
+      hash[:tags]          = self.tags          if self.tags?
+      hash[:summary]       = self.summary       if self.summary?
+      hash[:description]   = self.description   if self.description?
+      hash[:external_docs] = self.external_docs if self.external_docs?
+      hash[:operation_id]  = self.operation_id  if self.operation_id?
+      hash[:consumes]      = self.consumes      if self.consumes?
+      hash[:produces]      = self.produces      if self.produces?
+
+      if self.parameters?
+        hash[:parameters] = []
+        self.parameters.each do |parameter|
+          if parameter.respond_to?(:to_h)
+            hash[:parameters] << parameter.to_h
+          else
+            hash[:parameters] = parameter
+          end
+        end
+      end
+
+      hash[:responses]  = self.responses.to_h if self.responses?
+      hash[:schemes]    = self.schemes        if self.schemes?
+      hash[:deprecated] = self.deprecated     if self.deprecated?
+      if self.security?
+        hash[:security] = []
+        self.security.each do |sec|
+          if sec.respond_to?(:to_h)
+            hash[:secuirty] << sec.to_h
+          else
+            hash[:security] << sec
+          end
+        end
+      end
+      hash[:security] = self.deprecated if self.deprecated?
+      hash
+    end
+
+    def to_swagger_hash
+      hash = {}
+      hash[:tags]         = self.tags          if self.tags?
+      hash[:summary]      = self.summary       if self.summary?
+      hash[:description]  = self.description   if self.description?
+      hash[:externalDocs] = self.external_docs if self.external_docs?
+      hash[:operationId]  = self.operation_id  if self.operation_id?
+      hash[:consumes]     = self.consumes      if self.consumes?
+      hash[:produces]     = self.produces      if self.produces?
+
+      if self.parameters?
+        hash[:parameters] = []
+        self.parameters.each do |parameter|
+          if parameter.respond_to?(:to_swagger_hash)
+            hash[:parameters] << parameter.to_swagger_hash
+          else
+            hash[:parameters] = parameter
+          end
+        end
+      end
+
+      hash[:responses]  = self.responses.to_swagger_hash if self.responses?
+
+      hash[:schemes]    = self.schemes    if self.schemes?
+      hash[:deprecated] = self.deprecated if self.deprecated?
+
+      if self.security?
+        hash[:security] = []
+        self.security.each do |sec|
+          if sec.respond_to?(:to_swagger_hash)
+            hash[:secuirty] << sec.to_swagger_hash
+          else
+            hash[:security] << sec
+          end
+        end
+      end
+      hash[:security] = self.deprecated if self.deprecated?
+      hash
+    end
+  end
+end

data/lib/skeleton/parameter.rb

@@ -1,32 +1,112 @@
+require 'skeleton/model'
+
 module Skeleton
-  class Parameter
-    attr_accessor :type, :description, :required, :allowed, :default, :restrictions
+  class Parameter < Model
+    attr_accessor :name, :location, :description, :required, :schema, :type,
+                  :format, :items, :collection_format, :default, :maximum,
+                  :exclusive_maximum, :minimum, :exclusive_minimum, :max_length,
+                  :min_length, :unique_items, :multiple_of, :min_items,
+                  :max_items, :pattern
+
+    attr_writer :enum
+    attr_presence :pattern, :multiple_of, :unique_items, :max_items, :min_items,
+                  :min_length, :max_length, :minimum, :maximum, :default,
+                  :collection_format, :items, :format, :type, :schema, :required,
+                  :description, :location, :name, :exclusive_maximum,
+                  :exclusive_minimum, :unique_items
+
+    def enum
+      @enum ||= []
+    end
+
+    def enum?
+      !enum.empty?
+    end
+
+    def array?
+      @type == 'array'
+    end
+
+    def string?
+      @type == 'string'
+    end
+
+    def number?
+      @type == 'number'
+    end
 
-    def initialize(args={})
-      @required = false
-      @allowed = []
-      @restrictions = []
+    def integer?
+      @type == 'integer'
+    end
 
-      args.each do |k, v|
-        self.send("#{k}=", v) if self.respond_to?("#{k}=")
-      end
+    def boolean?
+      @type == 'boolean'
     end
 
-    def restriction(desc)
-      @restrictions.push(desc)
+    def file?
+      @type == 'file'
     end
 
     def to_h
-      hash = {
-        'type' => type,
-        'description' => description,
-        'required' => required
-      }
-      hash['default'] = default if default
-      hash['allowed'] = allowed if allowed
-      hash['restrictions'] = restrictions unless restrictions.empty?
+      hash = {}
+      hash[:name]              = name              if name?
+      hash[:location]          = location          if location?
+      hash[:description]       = description       if description?
+      hash[:required]          = required          if required?
+
+      hash[:schema] = schema.to_h if schema?
+
+      hash[:type]              = type              if type?
+      hash[:format]            = format            if format?
+
+      hash[:items] = items.to_h if items?
+
+      hash[:collection_format] = collection_format if collection_format?
+      hash[:default]           = default           if default?
+      hash[:maximum]           = maximum           if maximum?
+      hash[:exclusive_maximum] = exclusive_maximum if exclusive_maximum?
+      hash[:minimum]           = minimum           if minimum?
+      hash[:exclusive_minimum] = exclusive_minimum if exclusive_minimum?
+      hash[:max_length]        = max_length        if max_length?
+      hash[:min_length]        = min_length        if min_length?
+      hash[:unique_items]      = unique_items      if unique_items?
+      hash[:multiple_of]       = multiple_of       if multiple_of?
+      hash[:min_items]         = min_items         if min_items?
+      hash[:max_items]         = max_items         if max_items?
+      hash[:pattern]           = pattern           if pattern?
+      hash[:enum]              = enum              if enum?
+      hash
+    end
+
+    def to_swagger_hash
+      hash = {}
+      hash[:name]             = name              if name?
+      hash[:location]         = location          if location?
+      hash[:description]      = description       if description?
+      hash[:required]         = required          if required?
+
+      hash[:schema] = schema.to_swagger_json if schema?
+
+      hash[:type]             = type              if type?
+      hash[:format]           = format            if format?
+
+      hash[:items] = items.to_swagger_json if items?
+
+      hash[:collectionFormat] = collection_format if collection_format?
+      hash[:default]          = default           if default?
+      hash[:maximum]          = maximum           if maximum?
+      hash[:exclusiveMaximum] = exclusive_maximum if exclusive_maximum?
+      hash[:minimum]          = minimum           if minimum?
+      hash[:exclusiveMinimum] = exclusive_minimum if exclusive_minimum?
+      hash[:maxLength]        = max_length        if max_length?
+      hash[:minLength]        = min_length        if min_length?
+      hash[:uniqueItems]      = unique_items      if unique_items?
+      hash[:multipleOf]       = multiple_of       if multiple_of?
+      hash[:minItems]         = min_items         if min_items?
+      hash[:maxItems]         = max_items         if max_items?
+      hash[:pattern]          = pattern           if pattern?
+      hash[:enum]             = enum              if enum?
       hash
     end
-    alias_method :to_hash, :to_h
   end
 end