haveapi 0.3.2 → 0.4.0

data/lib/haveapi/validators/length.rb

@@ -0,0 +1,71 @@
+module HaveAPI
+  # Checks the length of a string. It does not have a short form.
+  #
+  # Full form:
+  #   string :param, length: {
+  #     min: 3,
+  #     max: 10
+  #     message: 'the error message'
+  #   }
+  #
+  #   string :param, length: {
+  #     equals: 8
+  #   }
+  class Validators::Length < Validator
+    name :length
+    takes :length
+
+    def setup
+      @min = take(:min)
+      @max = take(:max)
+      @equals = take(:equals)
+
+      if (@min || @max) && @equals
+        fail 'cannot mix min/max with equals'
+
+      elsif !@min && !@max && !@equals
+        fail 'must use either min, max or equals'
+      end
+
+      msg = if @equals
+        "length has to be #{@equals}"
+
+      elsif @min && !@max
+        "length has to be minimally #{@min}"
+
+      elsif !@min && @max
+        "length has to be maximally #{@max}"
+
+      else
+        "length has to be in range <#{@min}, #{@max}>"
+      end
+
+      @message = take(:message, msg)
+    end
+
+    def describe
+      ret = {
+          message: @message,
+      }
+
+      if @equals
+        ret[:equals] = @equals
+
+      else
+        ret[:min] = @min if @min
+        ret[:max] = @max if @max
+      end
+
+      ret
+    end
+
+    def valid?(v)
+      len = v.length
+
+      return len == @equals if @equals
+      return len >= @min if @min && !@max
+      return len <= @max if !@min && @max
+      len >= @min && len <= @max
+    end
+  end
+end

data/lib/haveapi/validators/numericality.rb

@@ -0,0 +1,104 @@
+module HaveAPI
+  # Checks the value is a number or a string containing only digits.
+  #
+  # Full form:
+  #   string :param, number: {
+  #     min: 3,
+  #     max: 10,
+  #     step: 2,
+  #     message: 'the error message'
+  #   }
+  # 
+  # Will allow values +3+, +5+, +7+ and +9+.
+  #
+  #   string :param, number: {
+  #     min: 3,
+  #     max: 10,
+  #     mod: 2,
+  #   }
+  # 
+  # Will allow values +4+, +6+, +8+ and +10+.
+  class Validators::Numericality < Validator
+    name :number
+    takes :number
+
+    def setup
+      @min = take(:min)
+      @max = take(:max)
+      @step = take(:step)
+      @mod = take(:mod)
+      @even = take(:even)
+      @odd = take(:odd)
+
+      msg = if @min && !@max
+        "has to be minimally #{@min}"
+
+      elsif !@min && @max
+        "has to be maximally #{@max}"
+
+      elsif @min && @max
+        "has to be in range <#{@min}, #{@max}>"
+
+      else
+        'has to be a number'
+      end
+
+      if @step
+        msg += '; ' unless msg.empty?
+        msg += "in steps of #{@step}"
+      end
+      
+      if @mod
+        msg += '; ' unless msg.empty?
+        msg += "mod #{@step} must equal zero"
+      end
+      
+      if @odd
+        msg += '; ' unless msg.empty?
+        msg += "odd"
+      end
+      
+      if @even
+        msg += '; ' unless msg.empty?
+        msg += "even"
+      end
+
+      if @odd && @even
+        fail 'cannot be both odd and even at the same time'
+      end
+
+      @message = take(:message, msg)
+    end
+
+    def describe
+      ret = {
+          message: @message,
+      }
+
+      ret[:min] = @min if @min
+      ret[:max] = @max if @max
+      ret[:step] = @step if @step
+      ret[:mod] = @mod if @mod
+      ret[:odd] = @odd if @odd
+      ret[:even] = @even if @even
+
+      ret
+    end
+
+    def valid?(v)
+      if v.is_a?(::String)
+        return false if /\A\d+\z/ !~ v
+        v = v.to_i
+      end
+
+      ret = true
+      ret = false if @min && v < @min
+      ret = false if @max && v > @max
+      ret = false if @step && (v - (@min || 0)) % @step != 0
+      ret = false if @mod && v % @mod != 0
+      ret = false if @odd && v % 2 == 0
+      ret = false if @even && v % 2 > 0
+      ret
+    end
+  end
+end

data/lib/haveapi/validators/presence.rb

@@ -0,0 +1,40 @@
+module HaveAPI
+  # Checks the value is a number or a string containing only digits.
+  #
+  # Short form:
+  #   string :param, required: true
+  #
+  # Full form:
+  #   string :param, required: {
+  #     empty: true/false,
+  #     message: 'the error message'
+  #   }
+  class Validators::Presence < Validator
+    name :present
+    takes :required, :present
+
+    def setup
+      return useless if simple? && !take
+
+      @empty = take(:empty, false)
+      @message = take(
+          :message,
+          @empty ? 'must be present' : 'must be present and non-empty'
+      )
+    end
+
+    def describe
+      {
+          empty: @empty,
+          message: @message,
+      }
+    end
+
+    def valid?(v)
+      return false if v.nil?
+      return !v.strip.empty? if !@empty && v.is_a?(::String)
+      # FIXME: other data types?
+      true
+    end
+  end
+end

data/lib/haveapi/version.rb

@@ -1,3 +1,4 @@
 module HaveAPI
-  VERSION = '0.3.2'
+  PROTOCOL_VERSION = '1.0'
+  VERSION = '0.4.0'
 end

data/lib/haveapi/views/doc_sidebars/json-schema.erb

@@ -0,0 +1,7 @@
+<h1>Contents</h1>
+<ul class="top-level">
+  <li><a href="#envelope">Envelope</a></li>
+  <li><a href="#all">OPTIONS /</a></li>
+  <li><a href="#versions">OPTIONS /?describe=versions</a></li>
+  <li><a href="#default">OPTIONS /?describe=default</a></li>
+</ul>

data/lib/haveapi/views/main_layout.erb

@@ -34,6 +34,17 @@
     .table-of-contents li.active > a {
       font-weight: bold;
     }
+    dl {
+      border: 1px solid #ccc;
+    }
+    dl dt {
+      background: #ddd none repeat scroll 0% 0%;
+      padding-left: 5px;
+    }
+    dl dd {
+      padding: 5px 0px;
+      margin-left: 18px;
+    }
   </style>
 </head>
 <body data-spy="scroll" data-target=".table-of-contents">

data/lib/haveapi/views/version_page.erb

@@ -1,3 +1,26 @@
+<%
+def format_param_type(param)
+  return param[:type] if param[:type] != 'Resource'
+  "<a href=\"#root-#{param[:resource].join('-')}-show\">#{param[:type]}</a>"
+end
+
+def format_validators(validators)
+  ret = ''
+  return ret if validators.nil?
+
+  validators.each do |name, opts|
+    ret += "<h5>#{name.to_s.capitalize}</h5>"
+    ret += '<dl>'
+    opts.each do |k, v|
+      ret += "<dt>#{k}</dt><dd>#{v}</dd>"
+    end
+    ret += '</dl>'
+  end
+
+  ret
+end
+%>
+
 <% def render_resource_body(resource, info, prefix='root', name=nil) %>
   <% name ||= resource.humanize %>
   <h2 class="resource" id="<%= "#{prefix}-#{resource}" %>"><%= resource.humanize %></h2>
@@ -46,8 +69,8 @@
                     <td><%= info[:label] %></td>
                     <td><%= param %></td>
                     <td><%= info[:required] ? 'yes' : 'no' %></td>
-                    <td><%= info[:type] %></td>
-                    <td><%= info[:validators] %></td>
+                    <td><%= format_param_type(info) %></td>
+                    <td><%= format_validators(info[:validators]) %></td>
                     <td><%= info[:default] == :_nil ? '' : info[:default] %></td>
                     <td><%= info[:description] %></td>
                   </tr>
@@ -79,7 +102,7 @@
                   <tr>
                     <td><%= info[:label] %></td>
                     <td><%= param %></td>
-                    <td><%= info[:type] %></td>
+                    <td><%= format_param_type(info) %></td>
                     <td><%= info[:description] %></td>
                   </tr>
                 <% end %>

data/lib/haveapi.rb

@@ -1,7 +1,9 @@
+ar = defined?(:ActiveRecord)
+
 require 'require_all'
-require 'active_record'
+require 'active_record' if ar
 require 'sinatra/base'
-require 'sinatra/activerecord'
+require 'sinatra/activerecord' if ar
 require 'pp'
 require 'github/markdown'
 
@@ -13,10 +15,11 @@ end
 require_relative 'haveapi/params'
 require_rel 'haveapi/params/'
 require_rel 'haveapi/*.rb'
-require_rel 'haveapi/model_adapters/'
+require_rel 'haveapi/model_adapters/hash'
+require_rel 'haveapi/model_adapters/active_record' if ar
 require_rel 'haveapi/authentication'
 require_rel 'haveapi/actions/*.rb'
 require_rel 'haveapi/output_formatters/base.rb'
 require_rel 'haveapi/output_formatters/'
+require_rel 'haveapi/validators/'
 require_rel 'haveapi/extensions'
-

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.1.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.1.6
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -56,44 +42,44 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
-  name: mysql
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
-  name: sinatra-activerecord
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,56 +100,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: 0.6.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.6
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.9
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: nesty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.0.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
 description: Framework for creating self-describing APIs
 email: jakub.skokan@vpsfree.cz
 executables: []
@@ -171,13 +129,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - doc/create-client.md
+- doc/hooks.erb
 - doc/index.md
+- doc/json-schema.erb
 - doc/protocol.md
+- doc/protocol.plantuml
 - haveapi.gemspec
 - lib/haveapi.rb
 - lib/haveapi/action.rb
@@ -193,6 +155,7 @@ files:
 - lib/haveapi/common.rb
 - lib/haveapi/context.rb
 - lib/haveapi/example.rb
+- lib/haveapi/exceptions.rb
 - lib/haveapi/extensions/action_exceptions.rb
 - lib/haveapi/extensions/base.rb
 - lib/haveapi/hooks.rb
@@ -208,16 +171,31 @@ files:
 - lib/haveapi/params/resource.rb
 - lib/haveapi/public/css/bootstrap-theme.min.css
 - lib/haveapi/public/css/bootstrap.min.css
+- lib/haveapi/public/doc/protocol.png
 - lib/haveapi/public/js/bootstrap.min.js
 - lib/haveapi/public/js/jquery-1.11.1.min.js
 - lib/haveapi/resource.rb
 - lib/haveapi/route.rb
 - lib/haveapi/server.rb
 - lib/haveapi/spec/helpers.rb
+- lib/haveapi/tasks/hooks.rb
+- lib/haveapi/tasks/yard.rb
 - lib/haveapi/types.rb
+- lib/haveapi/validator.rb
+- lib/haveapi/validator_chain.rb
+- lib/haveapi/validators/acceptance.rb
+- lib/haveapi/validators/confirmation.rb
+- lib/haveapi/validators/custom.rb
+- lib/haveapi/validators/exclusion.rb
+- lib/haveapi/validators/format.rb
+- lib/haveapi/validators/inclusion.rb
+- lib/haveapi/validators/length.rb
+- lib/haveapi/validators/numericality.rb
+- lib/haveapi/validators/presence.rb
 - lib/haveapi/version.rb
 - lib/haveapi/views/doc_layout.erb
 - lib/haveapi/views/doc_sidebars/create-client.erb
+- lib/haveapi/views/doc_sidebars/json-schema.erb
 - lib/haveapi/views/doc_sidebars/protocol.erb
 - lib/haveapi/views/index.erb
 - lib/haveapi/views/main_layout.erb
@@ -248,3 +226,4 @@ signing_key:
 specification_version: 4
 summary: Framework for creating self-describing APIs
 test_files: []
+has_rdoc: